mislav / choices Goto Github PK

Easy external settings for your app

License: MIT License

Ruby 100.00%

choices's Introduction

Choices for Rails

Easy-peasy external settings for your Rails app.

# Gemfile
gem 'choices'

In your app initializer block:

config.from_file 'settings.yml'

This will read configuration from "config/settings.yml" and, additionally, "settings.local.yml" if it exists. You should check the main file into version control, but not the ".local" file which is to be used for per-machine configuration: tweaks in development or private keys in production, for example.

# .gitignore
config/settings.local.yml

Configuration files can contain ERB; this is useful for reading in dynamic config such as from environment variables:

# settings.yml
defaults: &defaults
  secret_token: <%= ENV['COOKIE_SECRET'] %>
  heroku: <%= !!ENV['HEROKU_TYPE'] %>
  mongodb:
    uri: <%= ENV['MONGOHQ_URL'] %>

development:
  <<: *defaults

test: &testing
  <<: *defaults
  secret_token: <%= "banana" * 5 %>
  mongodb:
    database: myapp_test

cucumber:
  <<: *testing

The ".local" file can contain overrides for your development environment:

# settings.local.yml
development:
  mongodb:
    database: myapp_dev

Finally, the config keys can be read in your app as such:

Rails.configuration.heroku              #=> false
Rails.configuration.mongodb.database    #=> "myapp_dev"

choices's People

Contributors

Stargazers

Watchers

Forkers

alexreisner marcinbunsch redbooth cakesifu remi sunny pier-oliviert jrgifford conf kondratenko-valeriy vireshas youracclaim

choices's Issues

Can't Configure Choices Within An Engine

Choices isn't usable within an Engine.

# ./engines/foo/foo.gemspec
Gem::Specification.new do |s|
  s.add_dependency 'choices'
end

# ./engines/foo/lib/foo.rb
require 'choices'

# ./engines/foo/lib/foo/engine.rb
class Engine < ::Rails::Engine
  isolate_namespace Foo

  config.from_file "settings.yml"
end

# ./engines/foo/config/settings.yml
defaults: &defaults
  secret_token: <%= ENV['SECRET_TOKEN'] %>

development:
  <<: *defaults

$ bundle exec rails server

railties-3.2.13/lib/rails/railtie/configuration.rb:85:in `method_missing': undefined method `from_file' for #<Rails::Engine::Configuration:0x007f7fa80fbe58> (NoMethodError)
    from /Users/simeon/Sites/lessonplanet/engines/foo/lib/foo/engine.rb:5:in `<class:Engine>'
    from /Users/simeon/Sites/lessonplanet/engines/foo/lib/foo/engine.rb:2:in `<module:Foo>'
    from /Users/simeon/Sites/lessonplanet/engines/foo/lib/foo/foo.rb:1:in `<top (required)>'
    from /Users/simeon/.rbenv/versions/1.9.3-p327-perf/lib/ruby/gems/1.9.1/gems/activesupport-3.2.13/lib/active_support/dependencies.rb:251:in `require'
    from /Users/simeon/.rbenv/versions/1.9.3-p327-perf/lib/ruby/gems/1.9.1/gems/activesupport-3.2.13/lib/active_support/dependencies.rb:251:in `block in require'
    from /Users/simeon/.rbenv/versions/1.9.3-p327-perf/lib/ruby/gems/1.9.1/gems/activesupport-3.2.13/lib/active_support/dependencies.rb:236:in `load_dependency'
    from /Users/simeon/.rbenv/versions/1.9.3-p327-perf/lib/ruby/gems/1.9.1/gems/activesupport-3.2.13/lib/active_support/dependencies.rb:251:in `require'
    from /Users/simeon/Sites/lessonplanet/engines/foo/lib/foo.rb:11:in `<top (required)>'

Allow configs to be scoped out

Currently using choices with multiple engines though they all use Rails.configuration as the root.

Recommend allowing a scope
config.from_file "my_engine.yml", "my_engine"

So you can avoid clobbering other configs

Rails.configuration.my_engine.some_config_key

Syck has been removed

Choices is great! Thanks for it!

I'm using Rails 4.0.0.rc1 and Ruby 2.0.0.

When choices is loaded, I'm notified, twice, that "syck has been removed". My research shows that it indeed has. I never noticed that Psych was broken in 1.9.2, but it seems to be working in 2.0.0. Can the code be updated to intelligently check for the Ruby version and not try to load syck in Ruby 2.0?

Yaml to Rails (action_dispatch, action_view, …) options

I'd like to write yaml settings like this :

development:
  action_mailer:
    perform_deliveries: true
    raise_delivery_errors: false

That would translate in Rails's config block to :

config.action_mailer.perform_deliveries = true
config.action_mailer.raise_delivery_errors = true

Could that be possible ?

mislav / choices Goto Github PK

choices's Introduction

Choices for Rails

choices's People

Contributors

Stargazers

Watchers

Forkers

choices's Issues

Can't Configure Choices Within An Engine

Allow configs to be scoped out

Syck has been removed

Yaml to Rails (action_dispatch, action_view, …) options

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent