configatron 2.4.2 → 2.5.0

data/README

@@ -80,25 +80,7 @@ Of course you can update a single parameter n levels deep as well:
   configatron.email.pop.address # => "pop2.example.com"
   configatron.email.smtp.address # => "smtp.example.com"
 
-===Misc.
-
-Even if parameters haven't been set, you can still call them, but you'll get a <tt>Configatron::Store</tt> object back. The Configatron::Store class, however, will respond true to <tt>.nil?</tt> if there are no parameters configured on it.
-
-  configatron.i.dont.exist.nil? # => true
-  configatron.i.dont.exist # => Configatron::Store
-
-If you want to get back an actual <tt>nil</tt> then you can use the <tt>retrieve</tt> method:
-
-  configatron.i.do.exist = [:some, :array]
-  configatron.i.dont.retrieve(:exist, nil) # => nil
-  configatron.i.do.retrieve(:exist, :foo) # => [:some, :array]
-
-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.
-
-  configatron.set_default(:name, 'Mark Bates')
-  configatron.name # => 'Mark Bates'
-  configatron.set_default(:name, 'Me')
-  configatron.name # => 'Mark Bates'
+===Temp Configurations
 
 Sometimes in testing, or other situations, you want to temporarily change some settings. You can do this with the <tt>temp</tt> method:
 
@@ -134,6 +116,70 @@ You can also pass in an optional Hash to the <tt>temp</tt>:
   configatron.letters.b # => 'B'
   configatron.letters.c # => nil
 
+===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:
+
+  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
+
+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. 
+
+====Delayed
+
+With <code>Delayed</code> settings execution of the setting doesn't happen until the first time it is executed. 
+
+  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
+
+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>.
+
+====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:
+
+  configatron.current.time = Configatron::Dynamic.new {Time.now}
+
+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.
+
+===Misc.
+
+Even if parameters haven't been set, you can still call them, but you'll get a <tt>Configatron::Store</tt> object back. The Configatron::Store class, however, will respond true to <tt>.nil?</tt> if there are no parameters configured on it.
+
+  configatron.i.dont.exist.nil? # => true
+  configatron.i.dont.exist # => Configatron::Store
+
+If you want to get back an actual <tt>nil</tt> then you can use the <tt>retrieve</tt> method:
+
+  configatron.i.do.exist = [:some, :array]
+  configatron.i.dont.retrieve(:exist, nil) # => nil
+  configatron.i.do.retrieve(:exist, :foo) # => [:some, :array]
+
+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.
+
+  configatron.set_default(:name, 'Mark Bates')
+  configatron.name # => 'Mark Bates'
+  configatron.set_default(:name, 'Me')
+  configatron.name # => 'Mark Bates'
+
 Enjoy!
 
 ==Contact

data/lib/configatron.rb

@@ -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')
+require File.join(base, 'rails')
+require File.join(base, 'proc')

data/lib/configatron/proc.rb

@@ -0,0 +1,104 @@
+class Configatron
+  # This class can be used to give special powers to a Configatron setting.
+  # See Configatron::Delayed and Configatron::Dynamic as examples of how this
+  # works.
+  # 
+  # This class can be subclassed easily. The key is to override the <tt>finalize?</tt>
+  # method.
+  # 
+  # Example:
+  #   class RunThreeTimes < Configatron::Proc
+  #     def finalize?
+  #       self.execution_count == 3
+  #     end
+  #   end
+  # 
+  #   configatron.some.rand.generator = RunThreeTimes.new do
+  #     rand
+  #   end
+  #   
+  #   configatron.some.rand.generator # => 0.169280668547299
+  #   configatron.some.rand.generator # => 0.298880544243205
+  #   configatron.some.rand.generator # => 0.421091617110779
+  #   configatron.some.rand.generator # => 0.421091617110779
+  #   configatron.some.rand.generator # => 0.421091617110779
+  class Proc
+
+    # The number of times this Proc has been executed
+    attr_accessor :execution_count
+    # The block that you want executed when you call the <tt>execute</tt> method.
+    attr_accessor :block
+    
+    # Requires a block to be passed into it.
+    def initialize(&block)
+      self.execution_count = 0
+      self.block = block
+    end
+    
+    # Executes the <tt>block</tt> attribute, ticks up the 
+    # <tt>execution_count</tt> attribute by one and then
+    # returns the value of the executed <tt>block</tt>
+    def execute
+      val = self.block.call
+      self.execution_count += 1
+      return val
+    end
+    
+    # Returns <tt>true</tt> if Configatron should cache the
+    # results of the <tt>execute</tt> method, thereby never calling
+    # it again.
+    def finalize?
+      self.execution_count == 1
+    end
+    
+  end
+  
+  # Tells Configatron to always execute the block at runtime.
+  # The results will never be cached.
+  # 
+  # Example:
+  #   configatron.letters = 'a-b-c-d'
+  #   configatron.my.letters = Configatron::Delayed.new do
+  #     "My letters are: #{configatron.letters}"
+  #   end
+  #   configatron.my.other.letters = Configatron::Dynamic.new do
+  #     "My letters are: #{configatron.a.b.c.d}"
+  #   end
+  #   
+  #   configatron.my.letters # => 'My letters are: a-b-c-d'
+  #   configatron.my.other.letters # => 'My letters are: a-b-c-d'
+  #   
+  #   configatron.letters = 'a-b-c-d-e'
+  #   
+  #   configatron.my.letters # => 'My letters are: a-b-c-d'
+  #   configatron.my.other.letters # => 'My letters are: a-b-c-d-e'
+  class Dynamic < Configatron::Proc
+    def finalize?
+      false
+    end
+  end
+  
+  # Tells Configatron to delay execution of the block until
+  # runtime. Once run the results of the block will be cached,
+  # never to be run again.
+  # 
+  # Example:
+  #   configatron.letters = 'a-b-c-d'
+  #   configatron.my.letters = Configatron::Delayed.new do
+  #     "My letters are: #{configatron.letters}"
+  #   end
+  #   configatron.my.other.letters = Configatron::Dynamic.new do
+  #     "My letters are: #{configatron.a.b.c.d}"
+  #   end
+  #   
+  #   configatron.my.letters # => 'My letters are: a-b-c-d'
+  #   configatron.my.other.letters # => 'My letters are: a-b-c-d'
+  #   
+  #   configatron.letters = 'a-b-c-d-e'
+  #   
+  #   configatron.my.letters # => 'My letters are: a-b-c-d'
+  #   configatron.my.other.letters # => 'My letters are: a-b-c-d-e'
+  class Delayed < Configatron::Proc
+  end
+  
+end

data/lib/configatron/store.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

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: configatron
 version: !ruby/object:Gem::Version 
-  version: 2.4.2
+  version: 2.5.0
 platform: ruby
 authors: 
-- root
+- markbates
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-09-09 00:00:00 -04:00
+date: 2009-09-10 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,7 +22,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 0.1.0
     version: 
-description: "configatron was developed by: root"
+description: "configatron was developed by: markbates"
 email: mark@markbates.com
 executables: []
 
@@ -38,6 +38,7 @@ files:
 - 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