configatron 3.1.0 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 84ff6f84518b18e89af32df3249a42d4adde63c6
-  data.tar.gz: ed208d199f8334bda0b371098eeaf9f035f390a1
+  metadata.gz: 43ae27d34852f0d6b2bc628059ad7189f2695d04
+  data.tar.gz: 5c8e68f8aafbf7d9f30ddc3a95110cee6405f0fe
 SHA512:
-  metadata.gz: 68368a752c61057a128b2a84f610e1d384a2ac198ab104689ec7129fb1723a4183dc864550914a08394fee2bf0301b2a3a33c3cd18ba11cc0ae30fd9ff95df5e
-  data.tar.gz: 178b8532496c4c85ef94a478073283d333ca37be95ecaa9c811bd996c54a9e0181a0cdbb73cd6970e3d4d6b9500d35f2bcdd4529fc46b82b78da45e9bc6fe9d5
+  metadata.gz: 7f5ba8a9bcc0785bea2cbd94f8c3983485953456be4e308bdc49bb32c93ba0a31aa6c69afe97ca67a48525262b99294ff7425948b82ad0e01349235614d0ee16
+  data.tar.gz: cb430f0b8c6fbe6051745b23eb26e06f45ed78814fef5f1f464e1083368fe620c7ebc3ea4c02e8732292735ab8593543fdc8cc12cf7ae6afe1b5353bddbb826e

data/Gemfile.lock

@@ -9,7 +9,7 @@ GIT
 PATH
   remote: .
   specs:
-    configatron (3.1.0)
+    configatron (3.1.1)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -139,6 +139,56 @@ configatron.letters.b # => 'B'
 configatron.letters.c # => {}
 ```
 
+### 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:
+
+```ruby
+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 `Delayed` and `Dynamic` settings.
+
+#### Delayed
+
+With `Delayed` settings execution of the setting doesn't happen until the first time it is executed.
+
+```ruby
+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 `configatron.page_caching.servers` it will find the `configatron.memcached.servers` setting and return that. After that point if the `configatron.memcached.servers` setting is changed, the original settings are returned by `configatron.page_caching.servers`.
+
+#### Dynamic
+
+`Dynamic` settings are very similar to `Delayed` settings, but with one big difference. Every time you call a `Dynamic` setting is executed. Take this example:
+
+```ruby
+configatron.current.time = Configatron::Dynamic.new {Time.now}
+```
+
+Each time you call `configatron.current.time` it will return a new value to you. While this seems a bit useless, it is pretty useful if you have ever changing configurations.
+
 ### nil
 
 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?` or `.blank?` if there are no parameters configured on it.
@@ -241,8 +291,8 @@ configatron.to_h # => {:letters=>{:a=>"A", :b=>"BB", :c=>"C"}}
 * Mark Bates
 * Kurtis Rainbolt-Greene
 * Rob Sanheim
-* Greg Brockman
 * Jérémy Lecour
+* Greg Brockman
 * Cody Maggard
 * Jean-Denis Vauguet
 * Torsten Schönebaum
@@ -258,4 +308,4 @@ configatron.to_h # => {:letters=>{:a=>"A", :b=>"BB", :c=>"C"}}
 * joe miller
 * Brandon Dimcheff
 * Rick Fletcher
-* Josh Nichol
+* Josh Nichols

data/lib/configatron/version.rb

@@ -1,3 +1,3 @@
 class Configatron
-  VERSION = "3.1.0"
+  VERSION = "3.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: configatron
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.1.1
 platform: ruby
 authors:
 - Mark Bates