lib/configatron/proc.rb spec/configatron/delayed_spec.rb spec/configatron/dynamic_spec.rb @@ -104,31 +104,7 @@ Of course you can update a single parameter n levels deep as well: configatron.email.smtp.address # => "smtp.example.com" </code></pre> -h3. Misc. - -Even if parameters haven't been set, you can still call them, but you'll get a @Configatron::Store@ object back. The Configatron::Store class, however, will respond true to @.nil?@ if there are no parameters configured on it. - -<pre><code> - configatron.i.dont.exist.nil? # => true - configatron.i.dont.exist # => Configatron::Store -</code></pre> - -If you want to get back an actual @nil@ then you can use the @retrieve@ method: - -<pre><code> - configatron.i.do.exist = [:some, :array] - configatron.i.dont.retrieve(:exist, nil) # => nil - configatron.i.do.retrieve(:exist, :foo) # => [:some, :array] -</code></pre> - -You can set 'default' values for parameters. If there is already a setting, it won't be replaced. This is useful if you've already done your 'configuration' and you call a library, that needs to have parameters set. The library can set its defaults, without worrying that it might have overridden your custom settings. - -<pre><code> - configatron.set_default(:name, 'Mark Bates') - configatron.name # => 'Mark Bates' - configatron.set_default(:name, 'Me') - configatron.name # => 'Mark Bates' -</code></pre> +h3. Temp Configurations Sometimes in testing, or other situations, you want to temporarily change some settings. You can do this with the @temp@ method: @@ -168,6 +144,82 @@ You can also pass in an optional Hash to the @temp@: configatron.letters.c # => nil </code></pre> +h3. Delayed and Dynamic Configurations + +There are times when you want to refer to one configuration setting in another configuration setting. Let's look at a fairly contrived example: + +<pre><code> + configatron.memcached.servers = ['127.0.0.1:11211'] + configatron.page_caching.servers = configatron.memcached.servers + configatron.object_caching.servers = configatron.memcached.servers + + if RAILS_ENV == 'production' + configatron.memcached.servers = ['192.168.0.1:11211'] + configatron.page_caching.servers = configatron.memcached.servers + configatron.object_caching.servers = configatron.memcached.servers + elsif RAILS_ENV == 'staging' + configatron.memcached.servers = ['192.168.0.2:11211'] + configatron.page_caching.servers = configatron.memcached.servers + configatron.object_caching.servers = configatron.memcached.servers + end +</code></pre> + +Now, we could've written that slightly differently, but it helps to illustrate the point. With Configatron you can create <code>Delayed</code> and <code>Dynamic</code> settings. + +h4. Delayed + +With <code>Delayed</code> settings execution of the setting doesn't happen until the first time it is executed. + +<pre><code> + configatron.memcached.servers = ['127.0.0.1:11211'] + configatron.page_caching.servers = Configatron::Delayed.new {configatron.memcached.servers} + configatron.object_caching.servers = Configatron::Delayed.new {configatron.memcached.servers} + + if RAILS_ENV == 'production' + configatron.memcached.servers = ['192.168.0.1:11211'] + elsif RAILS_ENV == 'staging' + configatron.memcached.servers = ['192.168.0.2:11211'] + end +</code></pre> + +Execution occurs once and after that the result of that execution is returned. So in our case the first time someone calls the setting <code>configatron.page_caching.servers</code> it will find the <code>configatron.memcached.servers</code> setting and return that. After that point if the <code>configatron.memcached.servers</code> setting is changed, the original settings are returned by <code>configatron.page_caching.servers</code>. + +h4. Dynamic + +<code>Dynamic</code> settings are very similar to <code>Delayed</code> settings, but with one big difference. Every time you call a <code>Dynamic</code> setting is executed. Take this example: + +<pre><code> + configatron.current.time = Configatron::Dynamic.new {Time.now} +</code></pre> + +Each time you call <code>configatron.current.time</code> it will return a new value to you. While this seems a bit useless, it is pretty useful if you have ever changing configurations. + +h3. Misc. + +Even if parameters haven't been set, you can still call them, but you'll get a @Configatron::Store@ object back. The Configatron::Store class, however, will respond true to @.nil?@ if there are no parameters configured on it. + +<pre><code> + configatron.i.dont.exist.nil? # => true + configatron.i.dont.exist # => Configatron::Store +</code></pre> + +If you want to get back an actual @nil@ then you can use the @retrieve@ method: + +<pre><code> + configatron.i.do.exist = [:some, :array] + configatron.i.dont.retrieve(:exist, nil) # => nil + configatron.i.do.retrieve(:exist, :foo) # => [:some, :array] +</code></pre> + +You can set 'default' values for parameters. If there is already a setting, it won't be replaced. This is useful if you've already done your 'configuration' and you call a library, that needs to have parameters set. The library can set its defaults, without worrying that it might have overridden your custom settings. + +<pre><code> + configatron.set_default(:name, 'Mark Bates') + configatron.name # => 'Mark Bates' + configatron.set_default(:name, 'Me') + configatron.name # => 'Mark Bates' +</code></pre> + Enjoy! h2. Contact README.textile @@ -2,7 +2,7 @@ Gem::Specification.new do |s| s.name = %q{configatron} - s.version = "2.4.2.20090909140253" + s.version = "2.4.2.20090909154619" s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version= s.authors = ["markbates"] @@ -10,7 +10,7 @@ Gem::Specification.new do |s| s.description = %q{configatron was developed by: markbates} s.email = %q{mark@markbates.com} s.extra_rdoc_files = ["README", "LICENSE"] - s.files = ["lib/configatron/configatron.rb", "lib/configatron/core_ext/class.rb", "lib/configatron/core_ext/kernel.rb", "lib/configatron/core_ext/object.rb", "lib/configatron/core_ext/string.rb", "lib/configatron/errors.rb", "lib/configatron/rails.rb", "lib/configatron/store.rb", "lib/configatron.rb", "README", "LICENSE", "generators/configatron_generator.rb", "generators/templates/configatron/cucumber.rb", "generators/templates/configatron/defaults.rb", "generators/templates/configatron/development.rb", "generators/templates/configatron/production.rb", "generators/templates/configatron/test.rb", "generators/templates/initializers/configatron.rb"] + s.files = ["lib/configatron/configatron.rb", "lib/configatron/core_ext/class.rb", "lib/configatron/core_ext/kernel.rb", "lib/configatron/core_ext/object.rb", "lib/configatron/core_ext/string.rb", "lib/configatron/errors.rb", "lib/configatron/proc.rb", "lib/configatron/rails.rb", "lib/configatron/store.rb", "lib/configatron.rb", "README", "LICENSE", "generators/configatron_generator.rb", "generators/templates/configatron/cucumber.rb", "generators/templates/configatron/defaults.rb", "generators/templates/configatron/development.rb", "generators/templates/configatron/production.rb", "generators/templates/configatron/test.rb", "generators/templates/initializers/configatron.rb"] s.homepage = %q{http://www.metabates.com} s.require_paths = ["lib"] s.rubyforge_project = %q{magrathea} configatron.gemspec @@ -8,4 +8,5 @@ require File.join(base, 'core_ext', 'kernel') require File.join(base, 'core_ext', 'object') require File.join(base, 'core_ext', 'string') require File.join(base, 'core_ext', 'class') -require File.join(base, 'rails') \ No newline at end of file +require File.join(base, 'rails') +require File.join(base, 'proc') \ No newline at end of file lib/configatron.rb @@ -113,7 +113,8 @@ class Configatron # it won't set the value. def set_default(name, default_value) unless @_store[name.to_sym] - @_store[name.to_sym] = parse_options(default_value) + # @_store[name.to_sym] = parse_options(default_value) + self.send("#{name}=", default_value) end end @@ -124,7 +125,15 @@ class Configatron raise Configatron::LockedNamespace.new(@_name) if @_locked && !@_store.has_key?(name) @_store[name] = parse_options(*args) elsif @_store.has_key?(sym) - return @_store[sym] + val = @_store[sym] + if val.is_a?(Configatron::Proc) + res = val.execute + if val.finalize? + @_store[sym] = res + end + return res + end + return val else store = Configatron::Store.new({}, sym, self) @_store[sym] = store lib/configatron/store.rb 88844d20a81851fe722c2c9eaaab8d0d183e1636 Mark Bates mark@markbates.com http://github.com/markbates/configatron/commit/449373ddc73f6a6afc101a7ffc943dd38bcdd7ba 449373ddc73f6a6afc101a7ffc943dd38bcdd7ba 2009-09-09T13:05:57-07:00 2009-09-09T13:05:57-07:00 Added Dynamic and Delayed configurations 61c0a1eaefc2d0bfc866b6b01144b6f06bc0196a Mark Bates mark@markbates.com