aerogel-configurator 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 042aa549ffd9d4f413d6a8de433bf0ae8946c456
-  data.tar.gz: 41b201f4106c00992e80817d725a523f54c4f105
+  metadata.gz: d5d485f6753454a181a98d543f720a6663768b07
+  data.tar.gz: b4be097519b528236c765ef58a425c53d1e8fb38
 SHA512:
-  metadata.gz: b04a7ab68eba0eff985fc3f4772801dd9ee3d212da69d92d280ffd040a8c81d1ee97fb2ebd1cffd8b1103204a3a5bab2e227c85c5a0f1d8ceb97c54c20e0175e
-  data.tar.gz: 61dfb5acaf68e312755bef0533272fd3a5f38560f0213e6c3be69e36a6c6e2dd0d6570f0a0ae5794e1b461ee31a85736eb8990bd251cd6c1a3d6746b15d868ef
+  metadata.gz: 48e3384130d3f26e2ea6678b55893eb513dc604370f94463964abc798ef4430c0a69b6d900ed04368cf572944fb1facef1c8c74c19371d1cb6c18b93da1ba9ae
+  data.tar.gz: e946c8587ecc1cad999d7ba6b5ba5be89fca136980004bea93603c3904ae4dab8a865e8220712cd552c94c8a31b7b1e5f57b900ceb25b74ff453e2cc71af1497

data/.gitignore

@@ -17,4 +17,6 @@ test/version_tmp
 tmp
 *.sublime-project
 *.sublime-workspace
-.rspec
+.rspec
+*.ruby-version
+*.ruby-gemset

data/README.md

@@ -63,6 +63,11 @@ config.foobar # => Configurator::Parameter::Undefined
 # however:
 config.foobar.nil? # => true
 
+# there are helper methods for handling undefined parameters:
+config.foo! # => 'bar'
+config.foobar! # => ArgumentError 'Undefined parameter: .foobar'
+config.foo? # => true, defined and not false or nil
+config.foobar? # => false, undefined or is false or nil
 ```
 
 ### 2. Setting configuration parameters in your ruby code

data/Rakefile

@@ -3,4 +3,10 @@ require "bundler/gem_tasks"
 desc "Run tests"
 task :default do
   system "bundle exec rspec"
+end
+
+desc "Load current gem in console"
+task :console do
+  cmd = "irb"
+  sh "#{cmd} -I./lib -r 'aerogel/configurator'"
 end

data/examples/ex10.conf

@@ -0,0 +1,3 @@
+foo "hello"
+bar true
+foobar false

data/examples/ex10.rb

@@ -0,0 +1,27 @@
+require 'aerogel/configurator'
+
+def test( config, param_chain )
+  config_param = "config.#{param_chain}"
+  begin
+    value = eval config_param
+    puts "#{config_param}: #{value.inspect}"
+  rescue StandardError => e
+    puts "#{config_param}: <error>: #{e}"
+  end
+end
+
+config = Configurator.load File.dirname( __FILE__ )+"/ex10.conf"
+
+
+puts "config: #{config.to_hash}"
+
+test config, "foo!"
+test config, "foo?"
+test config, "bar!"
+test config, "bar?"
+test config, "foobar!"
+test config, "foobar?"
+test config, "fuu!"
+test config, "fuu?"
+test config, "fuu.fuu.fuu!"
+test config, "fuu.fuu.fuu?"

data/lib/aerogel/configurator/configurator.rb

@@ -20,7 +20,7 @@ class Configurator
   end
 
   def respond_to?(method, include_private = false)
-    super || Parameter.new( @params ).respond_to?(method, include_private)
+    super || (Parameter.new( @params ).respond_to? method, include_private)
   end
 
   # Loads parameters from +source+.

data/lib/aerogel/configurator/parameter.rb

@@ -2,26 +2,49 @@ class Configurator
 private
   class Parameter
 
-    def initialize( data = {} )
+    METHOD_NAME_REGEXP = /^([^\[\]=!?]*)[\[\]=!?]?$/
+
+    def initialize( data = {}, fullname = "" )
       @data = data
+      @fullname = fullname
     end
 
     def method_missing(method, *args)
-      # puts "Parameter.method_missing: '#{method}' in #{@data}"
+      param_name = method.to_s.match(METHOD_NAME_REGEXP)[1].to_sym
+      force_value = false
+      force_boolean = false
+      # puts "Parameter.method_missing: #{@fullname}.#{method} '(#{param_name}) in #{@data}"
       if method.to_s =~ /=$/
-        @data[method.to_s.match(/^(.*)=$/)[1].to_sym] = args.first
-      elsif @data[method].is_a?(Hash)
-        Parameter.new @data[method]
-      elsif @data[method].nil?
-        Undefined.new @data, [method]
-      elsif @data[method].is_a? Proc
-        @data[method].call
+        return @data[param_name] = args.first
+      elsif method.to_s =~ /\!$/
+        force_value = true
+      elsif method.to_s =~ /\?$/
+        force_boolean = true
+      end
+
+      # evaluate param
+      if @data[param_name].is_a?(Hash)
+        force_boolean ? true : Parameter.new( @data[param_name], "#{@fullname}.#{param_name}" )
+      elsif @data[param_name].nil?
+        raise ArgumentError.new "Undefined parameter: #{@fullname}.#{param_name}" if force_value
+        force_boolean ? false : Undefined.new( @data, [param_name], "#{@fullname}.#{param_name}" )
+      elsif @data[param_name].is_a? Proc
+        force_boolean ? !!@data[param_name].call : @data[param_name].call
       else
         # it's a leaf
-        @data[method]
+        force_boolean ? !!@data[param_name] : @data[param_name]
       end
     end
 
+    def respond_to?( method, include_private = false )
+      super || respond_to_missing?( method, include_private )
+    end
+
+    # any valid identifier ending with '=', '!' or '?' is a valid method
+    def respond_to_missing?( method, include_private = false )
+      super || (method.to_s =~ METHOD_NAME_REGEXP ) || true
+    end
+
     def raw
       @data
     end
@@ -51,15 +74,21 @@ private
     # +name+ is an Array of chained names starting from mount point
     #
     class Undefined
-      def initialize( root, name )
+      def initialize( root, name, fullname )
         # puts "Undefined.new: root=#{root} name=#{name.to_s} "
         @root = root
         @name = name # convert to array
+        @fullname = fullname
       end
 
       def method_missing(method, *args)
+        param_name = method.to_s.match(METHOD_NAME_REGEXP)[1].to_sym
         # puts "Undefined.method_missing: #{method} root=#{@root} names=#{@names}"
-        if method.to_s =~ /=$/
+        if method.to_s =~ /!$/
+          raise ArgumentError.new "Undefined parameter: #{@fullname}.#{param_name}"
+        elsif method.to_s =~ /\?$/
+          false
+        elsif method.to_s =~ /=$/
           method = method.to_s.match(/^(.*)=$/)[1].to_sym
           # deep assign
           d = ( @root[@name.shift] ||= {} )
@@ -68,7 +97,7 @@ private
           end
           d[method] = args.first
         else
-          Undefined.new( @root, @name+[method])
+          Undefined.new( @root, @name+[method], "#{@fullname}.#{@name.shift}" )
         end
       end
 

data/lib/aerogel/configurator/version.rb

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

data/spec/conf/f.conf

@@ -0,0 +1,3 @@
+foo "hello"
+bar true
+foobar false

data/spec/lib/dsl_spec.rb

@@ -22,4 +22,55 @@ describe "Configurator::DSL" do
     config.bar.should eql "hello"
   end
 
+  describe "<param>! method" do
+    it "should be provided for existing and non-existing parameters" do
+      config = Configurator.load test_filename('conf/f.conf')
+      config.should respond_to(:foo!)
+      config.should respond_to(:nofoo!)
+    end
+
+    it "should return parameter value for existing parameter" do
+      config = Configurator.load test_filename('conf/f.conf')
+      config.foo!.should eql("hello")
+    end
+
+    it "should raise ArgumentError for undefined parameter" do
+      config = Configurator.load test_filename('conf/f.conf')
+      expect { config.nofoo! }.to raise_error(ArgumentError)
+    end
+
+    it "should work at the end of a chain of undefined parameters" do
+      config = Configurator.load test_filename('conf/f.conf')
+      expect { config.nofoo.nofoo }.not_to raise_error
+      expect { config.nofoo.nofoo! }.to raise_error(ArgumentError)
+    end
+  end
+
+  describe "<param>? method" do
+    it "should be provided for existing and non-existing parameters" do
+      config = Configurator.load test_filename('conf/f.conf')
+      config.should respond_to(:foo?)
+      config.should respond_to(:nofoo?)
+    end
+
+    it "should return value coerced to Boolean for existing parameter" do
+      config = Configurator.load test_filename('conf/f.conf')
+      config.foo?.should be true
+      config.bar?.should be true
+      config.foobar?.should be false
+    end
+
+    it "should return false for non-existing parameter" do
+      config = Configurator.load test_filename('conf/f.conf')
+      config.nofoo?.should be false
+    end
+
+    it "should work at the end of a chain of undefined parameters" do
+      config = Configurator.load test_filename('conf/f.conf')
+      config.nofoo.nofoo.should be_nil
+      config.nofoo.nofoo?.should be false
+    end
+
+  end
+
 end # describe Configurator::DSL

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aerogel-configurator
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Alex Kukushkin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-05 00:00:00.000000000 Z
+date: 2014-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -67,6 +67,8 @@ files:
 - Rakefile
 - aerogel-configurator.gemspec
 - examples/ex1.rb
+- examples/ex10.conf
+- examples/ex10.rb
 - examples/ex2.conf
 - examples/ex2.rb
 - examples/ex3.conf
@@ -93,6 +95,7 @@ files:
 - spec/conf/c.conf
 - spec/conf/d.conf
 - spec/conf/e.conf
+- spec/conf/f.conf
 - spec/lib/configurator_spec.rb
 - spec/lib/dsl_spec.rb
 - spec/spec_helper.rb
@@ -116,7 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.6
 signing_key: 
 specification_version: 4
 summary: Simple configuration files for Ruby applications
@@ -126,6 +129,7 @@ test_files:
 - spec/conf/c.conf
 - spec/conf/d.conf
 - spec/conf/e.conf
+- spec/conf/f.conf
 - spec/lib/configurator_spec.rb
 - spec/lib/dsl_spec.rb
 - spec/spec_helper.rb