iqeo-conf 0.0.2 → 0.0.3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    iqeo-conf (0.0.2)
+    iqeo-conf (0.0.3)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -12,12 +12,14 @@ $ gem install iqeo-conf
 
 ## Usage
 
-### Defining a configuration
+Require it...
 
 ```ruby
 require 'iqeo/configuration'
 ```
 
+### Create a configuration
+
 Set values...
 
 #### Directly on a configuration object
@@ -46,7 +48,7 @@ conf = Iqeo::Configuration.new do |c|
 end
 ```
 
-### Configuration DSL instance_eval style
+#### Configuration DSL instance_eval style
 
 ```ruby
 conf = Iqeo::Configuration.new do
@@ -72,24 +74,33 @@ conf.delta      =>  [ 1, 2, 3 ]
 
 ## Other features
 
-This README may not be complete, see rspec tests for all features.
+This README may not be complete, see rspec tests for all working features.
 
-## Todo
+## Done
+
+Need docs...
 
-* Hash operators [] & []= - done!
-* Nested configurations - done!
+* Hash operators [] & []=
+* Nested configurations
 * Nested configurations inherit settings
 * Nested configurations override inherited settings
-* Indifferent hash access, symbol, strings, case sensitivity optional ?
-* Iterate over items hash - access to hash / mixin enumerable / delegation to hash ?
 * Load configurations from a string or file at creation
-* Load configurations from a string or file after creation / in DSL
-* Configuration file load path - array of Dir.glob like file specs ?
-* Load other formats ? - No need... DSL is just ruby, just do it natively.
-* Blank slate for DSL ? - optional ?
+* Iterate over items hash - by delegation to hash
+* Indifferent hash access - using ActiveSupport/HashWithIndifferentAccess
+
+## Todo
+
+Need time (have motivation)...
+
+* Configuration file load path
 * Use an existing configuration for defaults
+* Clean DSL syntax for creating a nested configuration - just a block ?
+* Load configurations from a string or file after creation / in DSL block
+* Option to get hash directly to prevent polluting namespace with delegated hash methods
+* Blank slate for DSL ? - optional ?
 * Global configuration - watch for collisions ?
-* Consider issues around deferred interpolation / procs / lambdas etc...
+* Issues around deferred interpolation / procs / lambdas etc...
+* Load other formats into configuration - YAML, CSV, ...anything Enumerable should be easy enough.
 
 ## License
 

data/lib/iqeo/configuration/hash_with_indifferent_access.rb

@@ -0,0 +1,169 @@
+
+module Iqeo
+
+  # from ActiveSupport 3.2.3 @ http://github.com/rails/rails/tree/3-2-stable/activesupport/lib/active_support
+  # did not want dependency on all of ActiveSupport
+
+  class HashWithIndifferentAccess < Hash
+
+    # Always returns true, so that <tt>Array#extract_options!</tt> finds members of this class.
+    def extractable_options?
+      true
+    end
+
+    def with_indifferent_access
+      dup
+    end
+
+    def nested_under_indifferent_access
+      self
+    end
+
+    def initialize(constructor = {})
+      if constructor.is_a?(Hash)
+        super()
+        update(constructor)
+      else
+        super(constructor)
+      end
+    end
+
+    def default(key = nil)
+      if key.is_a?(Symbol) && include?(key = key.to_s)
+        self[key]
+      else
+        super
+      end
+    end
+
+    def self.new_from_hash_copying_default(hash)
+      new(hash).tap do |new_hash|
+        new_hash.default = hash.default
+      end
+    end
+
+    alias_method :regular_writer, :[]= unless method_defined?(:regular_writer)
+    alias_method :regular_update, :update unless method_defined?(:regular_update)
+
+    # Assigns a new value to the hash:
+    #
+    #   hash = HashWithIndifferentAccess.new
+    #   hash[:key] = "value"
+    #
+    def []=(key, value)
+      regular_writer(convert_key(key), convert_value(value))
+    end
+
+    alias_method :store, :[]=
+
+    # Updates the instantized hash with values from the second:
+    #
+    #   hash_1 = HashWithIndifferentAccess.new
+    #   hash_1[:key] = "value"
+    #
+    #   hash_2 = HashWithIndifferentAccess.new
+    #   hash_2[:key] = "New Value!"
+    #
+    #   hash_1.update(hash_2) # => {"key"=>"New Value!"}
+    #
+    def update(other_hash)
+      if other_hash.is_a? HashWithIndifferentAccess
+        super(other_hash)
+      else
+        other_hash.each_pair { |key, value| regular_writer(convert_key(key), convert_value(value)) }
+        self
+      end
+    end
+
+    alias_method :merge!, :update
+
+    # Checks the hash for a key matching the argument passed in:
+    #
+    #   hash = HashWithIndifferentAccess.new
+    #   hash["key"] = "value"
+    #   hash.key? :key  # => true
+    #   hash.key? "key" # => true
+    #
+    def key?(key)
+      super(convert_key(key))
+    end
+
+    alias_method :include?, :key?
+    alias_method :has_key?, :key?
+    alias_method :member?, :key?
+
+    # Fetches the value for the specified key, same as doing hash[key]
+    def fetch(key, *extras)
+      super(convert_key(key), *extras)
+    end
+
+    # Returns an array of the values at the specified indices:
+    #
+    #   hash = HashWithIndifferentAccess.new
+    #   hash[:a] = "x"
+    #   hash[:b] = "y"
+    #   hash.values_at("a", "b") # => ["x", "y"]
+    #
+    def values_at(*indices)
+      indices.collect {|key| self[convert_key(key)]}
+    end
+
+    # Returns an exact copy of the hash.
+    def dup
+      self.class.new(self).tap do |new_hash|
+        new_hash.default = default
+      end
+    end
+
+    # Merges the instantized and the specified hashes together, giving precedence to the values from the second hash.
+    # Does not overwrite the existing hash.
+    def merge(hash)
+      self.dup.update(hash)
+    end
+
+    # Performs the opposite of merge, with the keys and values from the first hash taking precedence over the second.
+    # This overloaded definition prevents returning a regular hash, if reverse_merge is called on a <tt>HashWithDifferentAccess</tt>.
+    def reverse_merge(other_hash)
+      super self.class.new_from_hash_copying_default(other_hash)
+    end
+
+    def reverse_merge!(other_hash)
+      replace(reverse_merge( other_hash ))
+    end
+
+    # Removes a specified key from the hash.
+    def delete(key)
+      super(convert_key(key))
+    end
+
+    def stringify_keys!; self end
+    def stringify_keys; dup end
+    # undef :symbolize_keys! # was causing error in Iqeo::Configuration
+    def symbolize_keys; to_hash.symbolize_keys end
+    def to_options!; self end
+
+    # Convert to a Hash with String keys.
+    def to_hash
+      Hash.new(default).merge!(self)
+    end
+
+    protected
+
+    def convert_key(key)
+      key.kind_of?(Symbol) ? key.to_s : key
+    end
+
+    def convert_value(value)
+      if value.is_a? Hash
+        # value.nested_under_indifferent_access : this would require modifying Hash - we're not going to do that!
+        HashWithIndifferentAccess.new_from_hash_copying_default(value)
+      elsif value.is_a?(Array)
+        value.dup.replace(value.map { |e| convert_value(e) })
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/iqeo/configuration/version.rb

@@ -1,5 +1,5 @@
 module Iqeo
   class Configuration
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

data/lib/iqeo/configuration.rb

@@ -1,15 +1,15 @@
 
 require_relative "configuration/version"
+require_relative "configuration/hash_with_indifferent_access"
 
-# todo: inherited settings for nested configurations - POLS ?
-# todo: load configurations from string & file
-# todo: configuration file load path
-# todo: iterate over items hash - access to hash / mixin enumerable / delegation to hash ?
-# todo: indifferent hash access
+# todo: configuration file load path - array of Dir.glob like file specs ?
 # todo: use an existing configuration for defaults
+# todo: clean DSL syntax for creating a configuration - just a block ?
+# todo: load configurations from a string or file after creation / in DSL block
+# todo: option to get hash directly to prevent polluting namespace with delegated hash methods
+# todo: blank slate for DSL - optional ?
 # todo: global configuration - watch for collisions ?
 # todo: deferred interpolation / procs / lambdas etc...
-# todo: blank slate for DSL - optional ?
 # todo: load other formats from string & file - YAML, XML?
 
 module Iqeo
@@ -20,8 +20,19 @@ module Iqeo
       VERSION
     end
 
+    def self.read string
+      conf = self.new
+      conf.instance_eval string
+      conf
+    end
+
+    def self.file file
+      return self.read file.respond_to?(:read) ? file.read : File.read(file)
+    end
+
     def initialize &block
-      @items = {}
+      @items = HashWithIndifferentAccess.new
+      @_parent = nil
       if block_given?
        if block.arity == 1
          yield self
@@ -32,17 +43,37 @@ module Iqeo
     end
 
     def method_missing name, *values
-      case name
-      when :[]= then return @items[values.shift] = values.size > 1 ? values : values.first
-      when :[]  then return @items[values.shift]
-      else
-        name = name.to_s.chomp('=').to_sym
-        return @items[name] if values.empty?
-        return @items[name] = values if values.size > 1
-        return @items[name] = values.first
+      return @items.send name, *values if @items.respond_to? name
+      # this is unreachable since these methods are delegated to @items hash
+      # but keep it around for when we make selective delegation an option
+      #case name
+      #when :[]= then return _set values.shift, values.size > 1 ? values : values.first
+      #when :[]  then return _get values.shift
+      #end
+      name = name.to_s.chomp('=')        # todo: write a test case for a non-string object as key being converted by .to_s
+      return _get name if values.empty?
+      return _set name, values if values.size > 1
+      return _set name, values.first
+    end
+
+    attr_accessor :_parent  # todo: should attr_writer be protected ?
+
+    def _set key, value
+      # todo: extend parenting for enumerable with configurations at arbitrary depth ?
+      case
+      when value.kind_of?( Configuration ) then value._parent = self
+      when value.kind_of?( Enumerable )    then value.each { |v| v._parent = self if v.kind_of? Configuration }
       end
+      @items[key] = value
     end
- end
+
+    def _get key
+      return @items[key] unless @items[key].nil?
+      return @items[key] if  _parent.nil?
+      return _parent._get key
+    end
+
+  end
 
 end
 

data/spec/configuration_spec.rb

@@ -1,5 +1,6 @@
 require 'spec_helper'
 require 'iqeo/configuration'
+require 'stringio'
 
 include Iqeo
 
@@ -53,31 +54,27 @@ describe Configuration do
       expect do
         conf = Configuration.new
         conf.alpha 1
-        conf.bravo "two"
+        conf.bravo 'two'
         conf.charlie 3.0
         conf.delta :four
       end.to_not raise_error
       conf.should_not be_nil
       conf.alpha.should   == 1     and conf.alpha.should be_a Fixnum
-      conf.bravo.should   == "two" and conf.bravo.should be_a String
+      conf.bravo.should   == 'two' and conf.bravo.should be_a String
       conf.charlie.should == 3.0   and conf.charlie.should be_a Float
       conf.delta.should == :four   and conf.delta.should be_a Symbol
     end
 
     it 'accepts complex values' do
-      conf = nil
-      expect do
-        conf = Configuration.new
-        conf.alpha = [ :a, :b, :c ]
-        conf.bravo = { :a => 1, :b => 2, :c => 3 }
-      end.to_not raise_error
-      conf.should_not be_nil
+      conf = Configuration.new
+      conf.alpha = [ :a, :b, :c ]
+      conf.bravo = { :a => 1, :b => 2, :c => 3 }
       conf.alpha.should == [ :a, :b, :c] and conf.alpha.should be_an Array
       conf.alpha.size.should == 3
       conf.alpha[0].should == :a
       conf.alpha[1].should == :b
       conf.alpha[2].should == :c
-      conf.bravo.should == { :a => 1, :b => 2, :c => 3} and conf.bravo.should be_a Hash
+      conf.bravo.should == { 'a' => 1, 'b' => 2, 'c' => 3} and conf.bravo.should be_a Hash
       conf.bravo.size.should == 3
       conf.bravo[:a].should == 1
       conf.bravo[:b].should == 2
@@ -89,13 +86,9 @@ describe Configuration do
   context 'multiple value setting' do
 
     it 'accepts hash without brackets' do
-      conf = nil
-      expect do
-        conf = Configuration.new
-        conf.alpha :a => 1, :b => 2, :c => 3
-      end.to_not raise_error
-      conf.should_not be_nil
-      conf.alpha.should == { :a => 1, :b => 2, :c => 3} and conf.alpha.should be_a Hash
+      conf = Configuration.new
+      conf.alpha :a => 1, :b => 2, :c => 3
+      conf.alpha.should == { 'a' => 1, 'b' => 2, 'c' => 3} and conf.alpha.should be_a Hash
     end
 
     it 'treats multiple values as an array' do
@@ -109,13 +102,9 @@ describe Configuration do
     end
 
     it 'treats hash without brackets after multiple values as last element of array' do
-      conf = nil
-      expect do
-        conf = Configuration.new
-        conf.alpha 1, 2, 3, :a => 4, :b => 5, :c => 6
-      end.to_not raise_error
-      conf.should_not be_nil
-      conf.alpha.should == [ 1, 2, 3, { :a => 4, :b => 5, :c => 6} ] and conf.alpha.should be_a Array
+      conf = Configuration.new
+      conf.alpha 1, 2, 3, :a => 4, :b => 5, :c => 6
+      conf.alpha.should == [ 1, 2, 3, { 'a' => 4, 'b' => 5, 'c' => 6} ] and conf.alpha.should be_a Array
     end
 
   end
@@ -159,12 +148,64 @@ describe Configuration do
       conf.alpha.bravo.charlie.should be_true
     end
 
+    it 'knows its parent when referenced directly' do
+      conf = nil
+      expect do
+        conf = Configuration.new
+        conf.alpha Configuration.new
+        conf.alpha.bravo Configuration.new
+        conf.alpha.bravo.charlie true
+      end.to_not raise_error
+      conf.should_not be_nil
+      conf.alpha.bravo._parent.should be conf.alpha
+      conf.alpha._parent.should be conf
+      conf._parent.should be_nil
+    end
+
+    it 'knows its parent when contained in an enumerable' do
+      conf = nil
+      expect do
+        conf = Configuration.new
+        conf.alpha Configuration.new, Configuration.new, Configuration.new
+      end.to_not raise_error
+      conf.should_not be_nil
+      conf.alpha.each { |child| child._parent.should be conf }
+      conf._parent.should be_nil
+    end
+
     it 'inherits settings' do
-      pending 'todo'
+      conf = nil
+      expect do
+        conf = Configuration.new
+        conf.alpha Configuration.new
+        conf.alpha.bravo Configuration.new
+        conf.top = true
+        conf.alpha.middle = true
+        conf.alpha.bravo.bottom = true
+      end.to_not raise_error
+      conf.should_not be_nil
+      conf.top.should be_true
+      conf.alpha.top.should be_true
+      conf.alpha.middle.should be_true
+      conf.alpha.bravo.top.should be_true
+      conf.alpha.bravo.middle.should be_true
+      conf.alpha.bravo.bottom.should be_true
     end
 
     it 'can override inherited settings' do
-      pending 'todo'
+      conf = nil
+      expect do
+        conf = Configuration.new
+        conf.alpha Configuration.new
+        conf.alpha.bravo Configuration.new
+        conf.level = 1
+        conf.alpha.level = 2
+        conf.alpha.bravo.level = 3
+      end.to_not raise_error
+      conf.should_not be_nil
+      conf.level.should == 1
+      conf.alpha.level.should == 2
+      conf.alpha.bravo.level.should == 3
     end
 
   end
@@ -277,4 +318,78 @@ describe Configuration do
 
   end
 
+  context 'loads' do
+
+    it 'simple eval DSL from string' do
+      string = "alpha 1\nbravo 'two'\ncharlie 3.0\ndelta :four"
+      conf = nil
+      expect do
+        conf = Configuration.read string
+      end.to_not raise_error
+      conf.should_not be_nil
+      conf.alpha.should   == 1     and conf.alpha.should be_a Fixnum
+      conf.bravo.should   == "two" and conf.bravo.should be_a String
+      conf.charlie.should == 3.0   and conf.charlie.should be_a Float
+      conf.delta.should   == :four and conf.delta.should be_a Symbol
+    end
+
+    it 'simple eval DSL from file (by StringIO fake)' do
+      io = StringIO.new "alpha 1\nbravo 'two'\ncharlie 3.0\ndelta :four"
+      conf = nil
+      expect do
+        conf = Configuration.file io
+      end.to_not raise_error
+      conf.should_not be_nil
+      conf.alpha.should   == 1     and conf.alpha.should be_a Fixnum
+      conf.bravo.should   == "two" and conf.bravo.should be_a String
+      conf.charlie.should == 3.0   and conf.charlie.should be_a Float
+      conf.delta.should   == :four and conf.delta.should be_a Symbol
+    end
+
+    it 'simple eval DSL from file (by mock and expected methods)' do
+      file = mock
+      file.should_receive( :respond_to? ).with( :read ).and_return true
+      file.should_receive( :read ).and_return "alpha 1\nbravo 'two'\ncharlie 3.0\ndelta :four"
+      conf = nil
+      expect do
+        conf = Configuration.file file
+      end.to_not raise_error
+      conf.should_not be_nil
+      conf.alpha.should   == 1     and conf.alpha.should be_a Fixnum
+      conf.bravo.should   == "two" and conf.bravo.should be_a String
+      conf.charlie.should == 3.0   and conf.charlie.should be_a Float
+      conf.delta.should   == :four and conf.delta.should be_a Symbol
+    end
+
+    it 'simple eval DSL from filename (by expected methods)' do
+      File.should_receive( :read ).with( "filename" ).and_return "alpha 1\nbravo 'two'\ncharlie 3.0\ndelta :four"
+      conf = nil
+      expect do
+        conf = Configuration.file "filename"
+      end.to_not raise_error
+      conf.should_not be_nil
+      conf.alpha.should   == 1     and conf.alpha.should be_a Fixnum
+      conf.bravo.should   == "two" and conf.bravo.should be_a String
+      conf.charlie.should == 3.0   and conf.charlie.should be_a Float
+      conf.delta.should   == :four and conf.delta.should be_a Symbol
+    end
+
+  end
+
+  it 'delegates hash methods to internal hash' do
+    conf = nil
+    expect do
+      conf = Configuration.new
+      conf.alpha 1
+      conf.bravo 'two'
+      conf.charlie 3.0
+      conf.delta :four
+    end.to_not raise_error
+    conf.should_not be_nil
+    expect do
+      conf.each { |k,v| x = v }
+    end.to_not raise_error
+    conf.size.should == 4
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: iqeo-conf
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-24 00:00:00.000000000 Z
+date: 2012-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -61,10 +61,10 @@ files:
 - Rakefile
 - iqeo-conf.gemspec
 - lib/iqeo/configuration.rb
+- lib/iqeo/configuration/hash_with_indifferent_access.rb
 - lib/iqeo/configuration/version.rb
 - pkg/iqeo-conf-0.0.1.gem
 - pkg/iqeo-conf-0.0.2.gem
-- scratch.txt
 - spec/configuration_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/iqeo/iqeo-conf

data/scratch.txt

@@ -1,122 +0,0 @@
-conf = Conf.new 'name_0' do
-
-  # values
-
-  var_str "String"
-  var_int 123
-  var_arr [ 1, 2, 3]
-  var_hsh { :a => 1, :b => 2, :c => 3 }
-
-  # sub configs in different ways
-
-  var_conf_1 Conf.new 'name_1' do
-    ...
-  end
-
-  var_conf_2 Conf.new do
-    ...
-  end
-
-  var_conf_3 'name_3' do
-    ...
-  end
-
-  var_conf_4 do
-    ...
-  end
-
-  level 1
-
-  var_conf_5 'name_5' do
-
-    level 2
-
-    var_conf_6 'name_6' do
-
-      level 3
-
-      var_conf_7 'name_7' do
-
-        # Conf.inherit ?
-        level 4
-
-      end
-
-    end
-
-  end
-
-  other Conf.load 'file...' # etc...
-
-end
-
-
-# include config files
-
-## return either a single Conf hierarchy or an array of Conf depending upon the file contents
-
-Conf.path = [ '*' , '**/*.rb', "config/config.rb" ]
-Conf.load                => Conf...  # no parameter defaults to Conf::path value
-Conf.load filename       => Conf...
-Conf.load glob           => Conf... / [Conf..., ...]
-Conf.load [filename,...] => Conf... / [Conf..., ...]
-Conf.load [glob,...]     => Conf... / [Conf..., ...]
-
-# usage
-
-## retrieve values
-
-conf.name      => 'name_0'
-conf.var_str   => "String"
-conf.var_int   => 123
-conf.var_arr   => [1,2,3]
-conf.var_hsh   => { :a => 1, :b => 2, :c => 3 }
-
-## retrieve sub-configurations
-
-conf.var_conf_1 => Conf...
-conf.var_conf_1.name => 'name_1'
-
-## nested configurations
-
-conf.level                                  => 1
-conf.var_conf_5.level                       => 2
-conf.var_conf_5.var_conf_6.level            => 3
-conf.var_conf_5.var_conf_6.var_conf_7.level => 4
-
-## set or create values
-
-conf.existing_item "change to this"
-conf.new_item "new value"
-
-## indifferent keys
-
-conf.name      =>  'name_0'
-conf[:name]    =>  'name_0'
-conf['name']   =>  'name_0'
-
-## enumeration
-
-conf.values                => # array of values like a hash
-
-conf.keys                  => # array of string keys
-conf.keys_as_strings       => # array of string keys
-conf.keys_as_symbols       => # array of symbol keys
-
-conf.to_hash               => # hash of string key + value pairs
-conf.to_hash_with_strings  => # hash of string key + value pairs
-conf.to_hash_with_symbols  => # hash of symbol key + value pairs
-
-conf.each do |key,value|           # key will be string
-  puts key + " = " + value
-end
-
-conf.each_with_strings |key,value| # key will be string
-...
-
-conf.each_with_symbols |key,value| # key will be hash
-...
-
-# how about hashes with keys other than strings and symbols ?
-# conf.to_hash { |k| k.method ... }
-