aerogel-configurator 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e67be32b16833293c9ac19c0ce496bc306e8b47a
-  data.tar.gz: a552d6da5a60a15d92e802e5ddcadb0b2905db93
+  metadata.gz: 042aa549ffd9d4f413d6a8de433bf0ae8946c456
+  data.tar.gz: 41b201f4106c00992e80817d725a523f54c4f105
 SHA512:
-  metadata.gz: 7bbb903dbf8278511398f116e39602a289de0ae6b7a8d9451c769fa66b0900e51a9bf8afbc4a23a89ce9e22808e3023f6ebfa52939d1b3ff44e1e67c5c22b5ed
-  data.tar.gz: 37ae8ca12aeea1ad9ade209095e14bc11ea61c1f41154d6c2348039e8735eb250b980dc39c681c0dac6947a6c90dbf561dc192c370cf093d1861551b9de15c1b
+  metadata.gz: b04a7ab68eba0eff985fc3f4772801dd9ee3d212da69d92d280ffd040a8c81d1ee97fb2ebd1cffd8b1103204a3a5bab2e227c85c5a0f1d8ceb97c54c20e0175e
+  data.tar.gz: 61dfb5acaf68e312755bef0533272fd3a5f38560f0213e6c3be69e36a6c6e2dd0d6570f0a0ae5794e1b461ee31a85736eb8990bd251cd6c1a3d6746b15d868ef

data/README.md

@@ -227,7 +227,39 @@ config.foo # => 123
 config.bar # => 'abc'
 ```
 
-### 9. More examples?
+
+### 9. Iterating over config
+You can always iterate over undelying Hash like this:
+```ruby
+config.to_hash.each {|name, value| ... }
+```
+But in case you have used deferred parameters, these values won't be automatically evaluated.
+A built-in iterator solves this problem:
+```ruby
+# my.conf
+root_path "/default/path"
+path_to_file lambda{ root_path+"/dir/filename.txt" }
+```
+```ruby
+# my_app.rb
+require 'aerogel/configurator'
+
+config = Configurator.new "my.conf"
+
+config.each do |name, value|
+  puts "#{name}: #{value}"
+end
+# =>
+# root_path: /default/path
+# path_to_file: /default/path/dir/filename.txt
+```
+
+Of course, any config parameter containing nested group of parameters responds to ```#each```iterator too:
+```ruby
+config.group1.subgroup2.each {|name, value| ... }
+```
+
+### 10. More examples?
 See ```examples/``` folder.
 
 ## Feedback

data/examples/ex8.conf

@@ -0,0 +1,15 @@
+# nested groups and reused values example
+foo "hello"
+bar 42
+a_group {
+  boolean_param true
+  a_nested_group {
+    bar 123
+
+    # reusing value of 'bar'
+    inner bar
+
+    # reusing value of a_group.a_nested_group.bar
+    ar_var [1, 2, a_group.a_nested_group.bar]
+  }
+}

data/examples/ex8.rb

@@ -0,0 +1,12 @@
+require 'aerogel/configurator'
+
+
+config = Configurator.load File.dirname( __FILE__ )+"/ex8.conf"
+
+
+puts "config: #{config.to_hash}"
+
+puts "config.each:"
+config.each do |name, value|
+  puts "#{name}: #{value}"
+end

data/examples/ex9.conf

@@ -0,0 +1,5 @@
+# iterating over deferred parameters example
+
+root_path "/default/path"
+
+path_to_file lambda{ root_path+"/dir/filename.txt" }

data/examples/ex9.rb

@@ -0,0 +1,12 @@
+require 'aerogel/configurator'
+
+
+config = Configurator.load File.dirname( __FILE__ )+"/ex9.conf"
+
+
+puts "config: #{config.to_hash}"
+
+puts "config.each:"
+config.each do |name, value|
+  puts "#{name}: #{value}"
+end

data/lib/aerogel/configurator/configurator.rb

@@ -14,9 +14,13 @@ class Configurator
   end
 
 
-  def method_missing(method, *args)
+  def method_missing(method, *args, &block)
     # puts "Configurator.method_missing: #{method}"
-    Parameter.new( @params ).send method, *args
+    Parameter.new( @params ).send method, *args, &block
+  end
+
+  def respond_to?(method, include_private = false)
+    super || Parameter.new( @params ).respond_to?(method, include_private)
   end
 
   # Loads parameters from +source+.

data/lib/aerogel/configurator/parameter.rb

@@ -34,6 +34,15 @@ private
       @data.inspect
     end
 
+    # Iterates over parameter group.
+    #
+    def each( &block )
+      @data.keys.each do |method|
+        value = send method
+        yield method, value
+      end
+    end
+
     # Undefined is a parameter that was not set yet.
     # It allows accessing its sub-parameters and defines the entire
     # chain once an assignement method on a sub-parameter is called.

data/lib/aerogel/configurator/version.rb

@@ -1,3 +1,3 @@
 class Configurator
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/spec/lib/configurator_spec.rb

@@ -11,6 +11,12 @@ describe Configurator do
         :b => 2
       }
     }
+    @flat_params = {
+      :foo1 => "abc1",
+      :foo2 => "abc2",
+      :foo3 => "abc3",
+      :foo4 => "abc4"
+    }
   end
 
   it "should respond to 'load' and return a Configurator instance" do
@@ -133,6 +139,27 @@ describe Configurator do
       config.group.to_hash.should eql @default_params[:group]
     end
 
+    it "should respond to #to_hash on each level" do
+      config = Configurator.new @default_params
+      expect { config.to_hash }.to_not raise_error
+      config.to_hash.should be_instance_of Hash
+      config.to_hash.should eql @default_params
+      config.group.to_hash.should be_instance_of Hash
+      config.group.to_hash.should eql @default_params[:group]
+    end
+
+    it "should respond to #each" do
+      config = Configurator.new @default_params
+      config.should respond_to(:each)
+    end
+
+    it "#each should iterate over parameters" do
+      # TODO: figure out a way to properly test #each iterator for the nested parameters case
+      config = Configurator.new @flat_params
+      params_each_list = @flat_params.to_a
+      expect {|b| config.each(&b)}.to yield_successive_args( *params_each_list )
+    end
+
   end
 end # describe Configurator
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aerogel-configurator
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Alex Kukushkin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-08 00:00:00.000000000 Z
+date: 2013-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -79,6 +79,10 @@ files:
 - examples/ex6.rb
 - examples/ex7.rb
 - examples/ex7.yml
+- examples/ex8.conf
+- examples/ex8.rb
+- examples/ex9.conf
+- examples/ex9.rb
 - lib/aerogel/configurator.rb
 - lib/aerogel/configurator/configurator.rb
 - lib/aerogel/configurator/dsl.rb