From de4891344ccc074f6d5693f4fac6ad610584e336 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rafael=20Mendon=C3=A7a=20Fran=C3=A7a?= Date: Mon, 18 Aug 2014 00:22:34 -0300 Subject: Improve custom configuration MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 1. Hashes can be assigned 2. We don't need a special level anymore The method chain only works in the top level. If users need a second level they need to assign a OrderedOptions to the key: config.resque.server = ActiveSupport::OrderedOptions.new config.resque.server.url = "http://localhost" config.resque.server.port = 3000 [Rafael Mendonça França + Carlos Antonio da Silva] --- guides/source/4_2_release_notes.md | 18 ++--- guides/source/configuring.md | 16 +++-- railties/CHANGELOG.md | 16 +++-- railties/lib/rails/application/configuration.rb | 14 +--- railties/lib/rails/railtie/configuration.rb | 42 ++++++++++- .../test/application/configuration/base_test.rb | 6 +- .../test/application/configuration/custom_test.rb | 81 ++++++++++++++++++++-- railties/test/railties/engine_test.rb | 2 +- 8 files changed, 149 insertions(+), 46 deletions(-) diff --git a/guides/source/4_2_release_notes.md b/guides/source/4_2_release_notes.md index 1c14519506..9937a947a5 100644 --- a/guides/source/4_2_release_notes.md +++ b/guides/source/4_2_release_notes.md @@ -75,22 +75,24 @@ Please refer to the [Changelog][railties] for detailed changes. * Introduced an `after_bundle` callback for use in Rails templates. ([Pull Request](https://github.com/rails/rails/pull/16359)) -* Introduced the `x` namespace for defining custom configuration options: +* Custom configuration options can be chained: ```ruby # config/environments/production.rb - config.x.payment_processing.schedule = :daily - config.x.payment_processing.retries = 3 - config.x.super_debugger = true + config.payment_processing.schedule = :daily + config.payment_processing.retries = 3 + config.resque = { timeout: 60, inline_jobs: :always } + config.super_debugger = true ``` These options are then available through the configuration object: ```ruby - Rails.configuration.x.payment_processing.schedule # => :daily - Rails.configuration.x.payment_processing.retries # => 3 - Rails.configuration.x.super_debugger # => true - Rails.configuration.x.super_debugger.not_set # => nil + Rails.configuration.payment_processing.schedule # => :daily + Rails.configuration.payment_processing.retries # => 3 + Rails.configuration.resque.timeout # => 60 + Rails.configuration.resque.inline_jobs # => :always + Rails.configuration.super_debugger # => true ``` ([Commit](https://github.com/rails/rails/commit/611849772dd66c2e4d005dcfe153f7ce79a8a7db)) diff --git a/guides/source/configuring.md b/guides/source/configuring.md index 801cef5ca6..6922dd681a 100644 --- a/guides/source/configuring.md +++ b/guides/source/configuring.md @@ -1006,16 +1006,18 @@ Custom configuration You can configure your own code through the Rails configuration object with custom configuration. It works like this: ```ruby - config.x.payment_processing.schedule = :daily - config.x.payment_processing.retries = 3 - config.x.super_debugger = true + config.payment_processing.schedule = :daily + config.payment_processing.retries = 3 + config.resque = { timeout: 60, inline_jobs: :always } + config.super_debugger = true ``` These configuration points are then available through the configuration object: ```ruby - Rails.configuration.x.payment_processing.schedule # => :daily - Rails.configuration.x.payment_processing.retries # => 3 - Rails.configuration.x.super_debugger # => true - Rails.configuration.x.super_debugger.not_set # => nil + Rails.configuration.payment_processing.schedule # => :daily + Rails.configuration.payment_processing.retries # => 3 + Rails.configuration.resque.timeout # => 60 + Rails.configuration.resque.inline_jobs # => :always + Rails.configuration.super_debugger # => true ``` diff --git a/railties/CHANGELOG.md b/railties/CHANGELOG.md index 5e2b82c3e9..72bf73cb26 100644 --- a/railties/CHANGELOG.md +++ b/railties/CHANGELOG.md @@ -13,16 +13,18 @@ configure your own code through the Rails configuration object with custom configuration: # config/environments/production.rb - config.x.payment_processing.schedule = :daily - config.x.payment_processing.retries = 3 - config.x.super_debugger = true + config.payment_processing.schedule = :daily + config.payment_processing.retries = 3 + config.resque = { timeout: 60, inline_jobs: :always } + config.super_debugger = true These configuration points are then available through the configuration object: - Rails.configuration.x.payment_processing.schedule # => :daily - Rails.configuration.x.payment_processing.retries # => 3 - Rails.configuration.x.super_debugger # => true - Rails.configuration.x.super_debugger.not_set # => nil + Rails.configuration.payment_processing.schedule # => :daily + Rails.configuration.payment_processing.retries # => 3 + Rails.configuration.resque.timeout # => 60 + Rails.configuration.resque.inline_jobs # => :always + Rails.configuration.super_debugger # => true *DHH* diff --git a/railties/lib/rails/application/configuration.rb b/railties/lib/rails/application/configuration.rb index 782bc4b0f1..5e8f4de847 100644 --- a/railties/lib/rails/application/configuration.rb +++ b/railties/lib/rails/application/configuration.rb @@ -13,7 +13,7 @@ module Rails :railties_order, :relative_url_root, :secret_key_base, :secret_token, :serve_static_assets, :ssl_options, :static_cache_control, :session_options, :time_zone, :reload_classes_only_on_change, - :beginning_of_week, :filter_redirect, :x + :beginning_of_week, :filter_redirect attr_writer :log_level attr_reader :encoding @@ -48,7 +48,6 @@ module Rails @eager_load = nil @secret_token = nil @secret_key_base = nil - @x = Custom.new @assets = ActiveSupport::OrderedOptions.new @assets.enabled = true @@ -155,17 +154,6 @@ module Rails def annotations SourceAnnotationExtractor::Annotation end - - private - class Custom - def initialize - @configurations = Hash.new - end - - def method_missing(method, *args) - @configurations[method] ||= ActiveSupport::OrderedOptions.new - end - end end end end diff --git a/railties/lib/rails/railtie/configuration.rb b/railties/lib/rails/railtie/configuration.rb index eb3b2d8ef4..406ed5ac61 100644 --- a/railties/lib/rails/railtie/configuration.rb +++ b/railties/lib/rails/railtie/configuration.rb @@ -88,11 +88,49 @@ module Rails def method_missing(name, *args, &blk) if name.to_s =~ /=$/ - @@options[$`.to_sym] = args.first + key = $`.to_sym + value = args.first + + if value.is_a?(Hash) + @@options[key] = ChainedConfigurationOptions.new value + else + @@options[key] = value + end elsif @@options.key?(name) @@options[name] else - super + @@options[name] = ActiveSupport::OrderedOptions.new + end + end + + class ChainedConfigurationOptions < ActiveSupport::OrderedOptions # :nodoc: + def initialize(value = nil) + if value.is_a?(Hash) + value.each_pair { |k, v| set_value k, v } + else + super + end + end + + def method_missing(meth, *args) + if meth =~ /=$/ + key = $`.to_sym + value = args.first + + set_value key, value + else + self.fetch(meth) { super } + end + end + + private + + def set_value(key, value) + if value.is_a?(Hash) + value = self.class.new(value) + end + + self[key] = value end end end diff --git a/railties/test/application/configuration/base_test.rb b/railties/test/application/configuration/base_test.rb index d6a82b139d..6e2b618160 100644 --- a/railties/test/application/configuration/base_test.rb +++ b/railties/test/application/configuration/base_test.rb @@ -5,6 +5,8 @@ require 'env_helpers' module ApplicationTests module ConfigurationTests class BaseTest < ActiveSupport::TestCase + include ActiveSupport::Testing::Isolation + def setup build_app boot_rails @@ -30,8 +32,8 @@ module ApplicationTests end def require_environment - require "#{app_path}/config/environment" + require "#{app_path}/config/environment" end end end -end \ No newline at end of file +end diff --git a/railties/test/application/configuration/custom_test.rb b/railties/test/application/configuration/custom_test.rb index 045537fc28..e8c7a37913 100644 --- a/railties/test/application/configuration/custom_test.rb +++ b/railties/test/application/configuration/custom_test.rb @@ -1,15 +1,84 @@ require 'application/configuration/base_test' class ApplicationTests::ConfigurationTests::CustomTest < ApplicationTests::ConfigurationTests::BaseTest - test 'access custom configuration point' do + test 'configuration top level can be chained' do add_to_config <<-RUBY - config.x.resque.inline_jobs = :always - config.x.resque.timeout = 60 + config.resque.inline_jobs = :always + config.resque.timeout = 60 RUBY require_environment - assert_equal :always, Rails.configuration.x.resque.inline_jobs - assert_equal 60, Rails.configuration.x.resque.timeout - assert_nil Rails.configuration.x.resque.nothing + assert_equal :always, Rails.configuration.resque.inline_jobs + assert_equal 60, Rails.configuration.resque.timeout + assert_nil Rails.configuration.resque.nothing + end + + test 'configuration top level accept normal values' do + add_to_config <<-RUBY + config.timeout = 60 + config.something_nil = nil + config.something_false = false + config.something_true = true + RUBY + require_environment + + assert_equal 60, Rails.configuration.timeout + assert_equal nil, Rails.configuration.something_nil + assert_equal false, Rails.configuration.something_false + assert_equal true, Rails.configuration.something_true + end + + test 'configuration top level builds options from hashes' do + add_to_config <<-RUBY + config.resque = { timeout: 60, inline_jobs: :always } + RUBY + require_environment + + assert_equal :always, Rails.configuration.resque.inline_jobs + assert_equal 60, Rails.configuration.resque.timeout + assert_nil Rails.configuration.resque.nothing + end + + test 'configuration top level builds options from hashes with string keys' do + add_to_config <<-RUBY + config.resque = { 'timeout' => 60, 'inline_jobs' => :always } + RUBY + require_environment + + assert_equal :always, Rails.configuration.resque.inline_jobs + assert_equal 60, Rails.configuration.resque.timeout + assert_nil Rails.configuration.resque.nothing + end + + test 'configuration top level builds nested options from hashes with symbol keys' do + add_to_config <<-RUBY + config.resque = { timeout: 60, inline_jobs: :always, url: { host: 'localhost', port: 8080 } } + config.resque.url.protocol = 'https' + config.resque.queues = { production: ['low_priority'] } + RUBY + require_environment + + assert_equal(:always, Rails.configuration.resque.inline_jobs) + assert_equal(60, Rails.configuration.resque.timeout) + assert_equal({ host: 'localhost', port: 8080, protocol: 'https' }, Rails.configuration.resque.url) + assert_equal('localhost', Rails.configuration.resque.url.host) + assert_equal(8080, Rails.configuration.resque.url.port) + assert_equal('https', Rails.configuration.resque.url.protocol) + assert_equal(['low_priority'], Rails.configuration.resque.queues.production) + assert_nil(Rails.configuration.resque.nothing) + end + + test 'configuration top level builds nested options from hashes with string keys' do + add_to_config <<-RUBY + config.resque = { 'timeout' => 60, 'inline_jobs' => :always, 'url' => { 'host' => 'localhost', 'port' => 8080 } } + RUBY + require_environment + + assert_equal(:always, Rails.configuration.resque.inline_jobs) + assert_equal(60, Rails.configuration.resque.timeout) + assert_equal({ host: 'localhost', port: 8080 }, Rails.configuration.resque.url) + assert_equal('localhost', Rails.configuration.resque.url.host) + assert_equal(8080, Rails.configuration.resque.url.port) + assert_nil(Rails.configuration.resque.nothing) end end diff --git a/railties/test/railties/engine_test.rb b/railties/test/railties/engine_test.rb index ec64ce5941..da4eccd2b7 100644 --- a/railties/test/railties/engine_test.rb +++ b/railties/test/railties/engine_test.rb @@ -840,7 +840,7 @@ YAML Rails.application.load_seed assert Rails.application.config.app_seeds_loaded - assert_raise(NoMethodError) { Bukkits::Engine.config.bukkits_seeds_loaded } + assert_empty Bukkits::Engine.config.bukkits_seeds_loaded Bukkits::Engine.load_seed assert Bukkits::Engine.config.bukkits_seeds_loaded -- cgit v1.2.3