a stab at wildcards

Author: gfowley

README.md

@@ -121,12 +121,14 @@ conf.collect { |key,value| value }  # => [ 1, 2.0, :three, 'four' ]
 * defaults
 * merge configurations recursively
 * blank slate for DSL
+* wildcard * for chained usage: a.b.*.d
 
-## Fancy usage
+## Application
 
 * Dynamic settings by '[]' & '[]=' & 'self'
 * Multiple configuration files
 * Hierarchial configuration files
+* Validation: if a.b.*.d == true
 
 ## License
 

lib/iqeo/configuration.rb

@@ -59,8 +59,8 @@ def self.version
     #
     # Content should be in eval DSL format.
 
-    def self.read string
-      conf = self.new
+    def self.read string, options = {}
+      conf = self.new nil, options
       conf.instance_eval string
       conf
     end
@@ -69,22 +69,31 @@ def self.read string
     #
     # Content should be in eval DSL format.
 
-    def self.load file
+    def self.load file, options = {}
       return self.read file.respond_to?(:read) ? file.read : File.read(file)
     end
 
-    def self.new_defer_block_for_parent parent, &block
-      conf = Configuration.new
+    def self.new_defer_block_for_parent parent, options = {}, &block
+      conf = Configuration.new nil, options
       conf._parent = parent
       if block_given? && block.arity > 0
         block.call(conf)                                              # this is 'yield self' from the outside
       end
       conf
     end
 
-    attr_accessor :_parent, :_items
+    OPTIONS = {
+      :blankslate => true,
+      :case_sensitive => true
+    }
 
-    def initialize default = nil, &block
+    attr_accessor :_parent, :_items, :_options
+
+    # todo: why can't :_parent= be protected ?
+    #protected :_parent, :_items, :_items= #, :_get, :[], :_set, :[]=
+
+    def initialize default = nil, options = {}, &block
+      _process_options options
       @_items = HashWithIndifferentAccess.new
       @_parent = nil
       _merge! default if default.kind_of?( Configuration )
@@ -105,11 +114,11 @@ def method_missing name, *values, &block
 
       name = name.to_s.chomp('=')
 
-      if block_given?                                                 # block is a nested configuration
-        if block.arity == 1                                           # yield DSL needs deferred block to set parent without binding
-          return _set name, Configuration.new_defer_block_for_parent( self, &block )
+      if block_given?                                                  # block is a nested configuration
+        if block.arity == 1                                            # yield DSL needs deferred block to set parent without binding
+          return _set name, Configuration.new_defer_block_for_parent( self, @_options, &block )
         else
-          return _set name, Configuration.new( &block )               # eval DSL can set parent from block binding in initialize
+          return _set name, Configuration.new( nil, @_options, &block ) # eval DSL can set parent from block binding in initialize
         end
       end
 
@@ -161,9 +170,45 @@ def _merge other
       self.dup._merge! other
     end
 
-    # todo: why can't :_parent= be protected ?
+    def _configurations
+      @_items.values.select { |value| value.kind_of? Configuration }
+    end
+
+    def _process_options options
+      @_options = OPTIONS.merge options
+      #_wipe if @_options[:blankslate]         # todo: how to make blankslate optional ?
+    end
+
+    # todo: method '*' for wildcard dir glob like selections  eg top.*.bottom ?
+
+    def *
+      ConfigurationDelegator.new _configurations
+    end
+
+  end
 
-    protected :_parent, :_items, :_items=, :_get, :[], :_set, :[]=
+  class ConfigurationDelegator  # todo: inherit from < Blankslate ?
+
+    attr_reader :_confs
+
+    # protected :_confs
+
+    def initialize confs
+      @_confs = confs
+    end
+
+    def method_missing name, *values, &block
+      return @_confs.send( name, *values, &block ) if @_confs.respond_to? name     # @_confs methods are highest priority
+    end
+    #alias [] method_missing  # so we don't have to deal with [ and 'key' separately ( see alias [] _get in Configuration )
+
+    def empty?
+      @_confs.empty?
+    end
+
+    def *
+      ConfigurationDelegator.new( @_confs.inject([]) { |array,conf| array + conf._configurations } )
+    end
 
   end
 

lib/iqeo/configuration/version.rb

@@ -1,3 +1,3 @@
 module Iqeo
-  CONFIGURATION_VERSION = "1.0.1"
+  CONFIGURATION_VERSION = "1.1.0.pre.0"
 end

spec/configuration_spec.rb

@@ -951,13 +951,168 @@ def nested_configuration_example conf
 
   end # "v1.0"
 
-  #context 'v1.1' do
-  #
-  #  context 'merge' do
-  #
-  #  end
-  #
-  #end #v1.1
+  def simple_config_1
+    Configuration.new do
+      alpha   1
+      bravo   'one'
+      charlie 1.0
+      delta   :one
+    end
+  end
+
+  def simple_config_1_example conf
+    conf.should_not be_nil
+    conf.alpha.should   == 1     and conf.alpha.should be_a Fixnum
+    conf.bravo.should   == "one" and conf.bravo.should be_a String
+    conf.charlie.should == 1.0   and conf.charlie.should be_a Float
+    conf.delta.should   == :one  and conf.delta.should be_a Symbol
+  end
+
+  def simple_config_2
+    Configuration.new do
+      echo    2
+      foxtrot 'two'
+      hotel   2.0
+      india   :two
+    end
+  end
+
+  def simple_config_2_example conf
+    conf.should_not be_nil
+    conf.echo.should    == 2     and conf.echo.should be_a Fixnum
+    conf.foxtrot.should == "two" and conf.foxtrot.should be_a String
+    conf.hotel.should   == 2.0   and conf.hotel.should be_a Float
+    conf.india.should   == :two  and conf.india.should be_a Symbol
+    conf['echo']
+    #and conf[:echo].should be_a Fixnum
+
+  end
+
+  def simple_config_3
+    Configuration.new do
+      juliet 3
+      kilo   'three'
+      lima   3.0
+      mike   :three
+    end
+  end
+
+  def simple_config_3_example conf
+    conf.should_not be_nil
+    conf.juliet.should == 3       and conf.juliet.should be_a Fixnum
+    conf.kilo.should   == "three" and conf.kilo.should be_a String
+    conf.lima.should   == 3.0     and conf.lima.should be_a Float
+    conf.mike.should   == :three  and conf.mike.should be_a Symbol
+  end
+
+  context 'v1.1' do
+
+    context 'options' do
+
+      it 'have defaults at Configuration creation' do
+        conf = Configuration.new
+        conf._options[:blankslate].should be true
+        conf._options[:case_sensitive].should be true
+      end
+
+      it 'are accepted at Configuration creation' do
+        conf = Configuration.new nil, :blankslate => false, :case_sensitive => false
+        conf._options[:blankslate].should be false
+        conf._options[:case_sensitive].should be false
+      end
+
+    end
+
+    context 'wildcard *' do
+
+      it 'returns an empty ConfigurationDelegator for subject with no child configurations' do
+        conf = simple_config_1
+        simple_config_1_example conf
+        delegator = conf.*
+        delegator.should be_a ConfigurationDelegator
+        delegator.should be_empty
+      end
+
+      it 'returns ConfigurationDelegator containing child configurations for subject' do
+        conf = simple_config_1
+        conf.nested2 = simple_config_2
+        conf.nested3 = simple_config_3
+        simple_config_1_example conf
+        simple_config_2_example conf.nested2
+        simple_config_3_example conf.nested3
+        delegator = conf.*
+        delegator.should be_a ConfigurationDelegator
+        delegator.size.should be 2
+        delegator[0].should be conf.nested2
+        delegator[1].should be conf.nested3
+      end
+
+    end
+
+    context 'ConfigurationDelegator' do
+
+      it 'can be created with no child configurations' do
+        delegator = ConfigurationDelegator.new []
+        delegator.should be_a ConfigurationDelegator
+        delegator.should be_empty
+      end
+
+      context 'wildcard *' do
+
+        # todo: question : should wildcard return nil for already empty ConfigurationDelegator / overshoot ?
+
+        it 'returns an empty ConfigurationDelegator for ConfigurationDelegator with no child configurations' do
+          conf = simple_config_1
+          conf.nested2 = simple_config_2
+          conf.nested3 = simple_config_3
+          simple_config_1_example conf
+          simple_config_2_example conf.nested2
+          simple_config_3_example conf.nested3
+          delegator = conf.*.*
+          delegator.should be_a ConfigurationDelegator
+          delegator.should be_empty
+        end
+
+        it 'returns an empty ConfigurationDelegator when overshoots' do
+          conf = simple_config_1
+          conf.nested2 = simple_config_2
+          conf.nested3 = simple_config_3
+          simple_config_1_example conf
+          simple_config_2_example conf.nested2
+          simple_config_3_example conf.nested3
+          delegator = conf.*.*.*.*.*.*.*.*.*
+          delegator.should be_a ConfigurationDelegator
+          delegator.should be_empty
+        end
+
+        it 'returns ConfigurationDelegator containing child configurations for ConfigurationDelegator' do
+          conf = simple_config_1
+          conf.nested2 = simple_config_2
+          conf.nested3 = simple_config_3
+          conf.nested2.nested2 = simple_config_2
+          conf.nested2.nested3 = simple_config_3
+          conf.nested3.nested2 = simple_config_2
+          conf.nested3.nested3 = simple_config_3
+          simple_config_1_example conf
+          simple_config_2_example conf.nested2
+          simple_config_2_example conf.nested2.nested2
+          simple_config_2_example conf.nested3.nested2
+          simple_config_3_example conf.nested3
+          simple_config_3_example conf.nested2.nested3
+          simple_config_3_example conf.nested3.nested3
+          delegator = conf.*.*
+          delegator.size.should be 4
+          delegator[0].should be conf.nested2.nested2
+          delegator[1].should be conf.nested2.nested3
+          delegator[2].should be conf.nested3.nested2
+          delegator[3].should be conf.nested3.nested3
+        end
+
+      end # wildcard *
+
+    end # ConfigurationDelagator
+
+  end #v1.1
 
 end