cascading-configuration-hash 1.1.4 → 1.1.5

data/README.md

@@ -1,64 +1,343 @@
 # Cascading Configuration #
 
-http://rubygems.org/gems/cascading-configuration
+http://rubygems.org/gems/cascading-configuration-hash
 
 # Description #
 
-Adds methods for cascading configurations.
+Adds methods for cascading configuration hashes. Support package for cascading-configuration.
 
 # Summary #
 
-Cascading configuration methods for single settings, arrays, hashes.
-
-## :attr_configuration ##
+## :attr_configuration_hash ##
 
-:attr_configuration provides inheritable configuration that cascades downward. 
+:attr_configuration_hash provides inheritable configuration that cascades downward. 
 
 Configuration inheritance can cascade through modules, classes, and instances.
 
-:attr_configuration defines a single attribute accessor that searches upward for the first ancestor defining the configuration. 
+:attr_configuration_hash defines a single attribute accessor that composes the set of configuration values appropriate to the ancestor level being queried (merging downward from most distant ancestor to self). An internal cache is kept, and any configuration updates that occur to higher-level ancestors cascade immediately downward.
 
-## :attr_configuration_array ##
+# Install #
 
-:attr_configuration_array provides inheritable configuration that cascades downward. 
+* sudo gem install cascading-configuration-hash
 
-Configuration inheritance can cascade through modules, classes, and instances.
+# Usage #
 
-:attr_configuration_array defines a single attribute accessor that composes the set of configuration values appropriate to the ancestor level being queried (merging downward from most distant ancestor to self). An internal cache is kept, and any configuration updates that occur to higher-level ancestors cascade immediately downward.
+## First Module ##
 
-The array maintained by :attr_configuration_array is kept ordered and unique.
+1. Define initial configuration in a module.
 
-## :attr_configuration_hash ##
+A class works just as well, but we can't use a module in the same chain if we start with a class.
 
-:attr_configuration_hash provides inheritable configuration that cascades downward. 
+* Include module to enable attr_configuration_hash.
 
-Configuration inheritance can cascade through modules, classes, and instances.
+```ruby
 
-:attr_configuration_hash defines a single attribute accessor that composes the set of configuration values appropriate to the ancestor level being queried (merging downward from most distant ancestor to self). An internal cache is kept, and any configuration updates that occur to higher-level ancestors cascade immediately downward.
+  module CascadingConfiguration::MockModule
+	include CascadingConfiguration::Hash
+  end
 
-# Install #
+```
 
-* sudo gem install cascading-configuration
+* Declare attr_configuration_hash.
 
-# Usage #
+```ruby
+
+  module CascadingConfiguration::MockModule
+    attr_configuration_hash :some_hash_configuration
+  end
+
+```
+
+* Set initial value.
+
+```ruby
+
+  module CascadingConfiguration::MockModule
+    self.some_hash_configuration = { :some_value => :some_value }
+  end
+
+```
+
+* Verify initial configuration value
+
+```ruby
+
+  module CascadingConfiguration::MockModule
+    # => some_hash_configuration.should == { :some_value => :some_value }
+  end
+
+```
+
+## Including Module 1 ##
+
+2. Include initial module in another module.
+
+Including the module that has included a CascadingConfiguration module is the same as including a CascadingConfiguration module.
+
+```ruby
+
+  module CascadingConfiguration::MockModule2
+    include CascadingConfiguration::MockModule
+  end
+
+```
+
+* Verify inherited value
+
+```ruby
+
+  module CascadingConfiguration::MockModule2
+    # => some_hash_configuration.should == { :some_value => :some_value }
+  end
+
+```
+
+* Override inherited value
+
+```ruby
+
+  module CascadingConfiguration::MockModule2
+    self.some_hash_configuration = { :module_value => :some_value }
+  end
+
+```
+
+* Verify local override value
+
+```ruby
+
+  module CascadingConfiguration::MockModule2
+    # => some_hash_configuration.should == { :module_value => :some_value }
+  end
 
-Including CascadingConfiguration includes:
+```
 
-* CascadingConfiguration::Setting
-* CascadingConfiguration::Array
-* CascadingConfiguration::Hash
+## Including Module 2 ##
+
+3. Include second module in another module.
 
 ```ruby
-  module AnyModuleOrClass
-    include CascadingConfiguration
+
+  module CascadingConfiguration::MockModule3
+    include CascadingConfiguration::MockModule2
   end
+
 ```
 
-See supporting package README files for examples in each case:
+* Verify inherited value
+
+```ruby
+
+  module CascadingConfiguration::MockModule3
+    # => some_array_configuration.should == { :module_value => :some_value }
+  end
+
+```
+
+## Top Class ##
+
+4. Include third module in a class.
+
+```ruby
+
+  class CascadingConfiguration::MockClass
+    include CascadingConfiguration::MockModule3
+  end
+
+```
+
+* Verify inherited value
+
+```ruby
+
+  class CascadingConfiguration::MockClass
+    # => some_hash_configuration.should == { :module_value => :some_value }
+  end
+
+```
+
+* Override inherited value
+
+```ruby
+
+  class CascadingConfiguration::MockClass
+    self.some_hash_configuration = { :another_value => :some_value }
+  end
+
+```
+
+* Verify local override value
+
+```ruby
+
+  class CascadingConfiguration::MockClass
+    # => some_hash_configuration.should == { :another_value => :some_value }
+  end
+
+```
+
+## Instance of Top Class ##
+
+5. Instantiate class.
+
+```ruby
 
-* attr_configuration
-* attr_configuration_array
-* attr_configuration_hash
+  object_instance_one = CascadingConfiguration::MockClass.new
+
+```
+
+* Verify inherited value
+
+```ruby
+
+  # => object_instance_one.some_hash_configuration.should == { :another_value => :some_value }
+
+```
+
+* Override inherited value
+
+```ruby
+
+  object_instance_one.some_hash_configuration = { :yet_another_value => :some_value }
+
+```
+
+* Verify local override value
+
+```ruby
+
+  # => object_instance_one.some_hash_configuration.should == { :yet_another_value => :some_value }
+  # => CascadingConfiguration::MockClass.some_hash_configuration.should == { :another_value => :some_value }
+  # => CascadingConfiguration::MockModule.some_hash_configuration.should == { :some_value => :some_value }
+
+```
+
+# First Inheriting Class #
+
+6. Inheriting class.
+
+Inheriting class should not get any settings from instance of superclass.
+
+* Verify inherited value
+
+```ruby
+
+  class CascadingConfiguration::MockClassSub1 < CascadingConfiguration::MockClass
+    # => some_hash_configuration.should == { :another_value => :some_value }
+  end
+
+```
+
+* Override inherited value
+
+```ruby
+
+  class CascadingConfiguration::MockClassSub1 < CascadingConfiguration::MockClass
+    self.some_hash_configuration = { :a_value_not_yet_used => :some_value }
+  end
+
+```
+
+* Verify local override value
+
+```ruby
+
+  class CascadingConfiguration::MockClassSub1 < CascadingConfiguration::MockClass
+    # => some_hash_configuration.should == { :a_value_not_yet_used => :some_value }
+    # => CascadingConfiguration::MockClass.some_hash_configuration.should == { :another_value => :some_value }
+    # => CascadingConfiguration::MockModule.some_hash_configuration.should == { :some_value => :some_value }
+  end
+
+```
+
+## Instance of First Inheriting Class ##
+
+7. Instantiate first inheriting class.
+
+```ruby
+
+  object_instance_two = CascadingConfiguration::MockClassSub1.new
+
+```
+
+* Verify inherited value
+
+```ruby
+
+  # => object_instance_two.some_hash_configuration.should == { :a_value_not_yet_used => :some_value }
+  # => object_instance_one.some_hash_configuration.should == { :yet_another_value => :some_value }
+  # => CascadingConfiguration::MockClass.some_hash_configuration.should == { :another_value => :some_value }
+  # => CascadingConfiguration::MockModule.some_hash_configuration.should == { :some_value => :some_value }
+
+```
+
+## Second Inheriting Class ##
+
+8. Second inheriting class.
+
+* Verify inherited value
+
+```ruby
+
+  class CascadingConfiguration::MockClassSub2 < CascadingConfiguration::MockClassSub1
+    # => some_hash_configuration.should == { :a_value_not_yet_used => :some_value }
+  end
+
+```
+
+* Override inherited value
+
+```ruby
+
+  class CascadingConfiguration::MockClassSub2 < CascadingConfiguration::MockClassSub1
+    self.some_hash_configuration = { :another_value_not_yet_used => :some_value }
+  end
+
+```
+
+* Verify local override value
+
+```ruby
+
+  class CascadingConfiguration::MockClassSub2 < CascadingConfiguration::MockClassSub1
+    # => some_hash_configuration.should == { :another_value_not_yet_used => :some_value }
+  end
+
+```
+
+## Instance of Second Inheriting Class ##
+
+9. Instantiate Second Inheriting Class.
+
+```ruby
+
+  object_instance_three = CascadingConfiguration::MockClassSub2.new
+
+```
+
+* Verify inherited value
+
+```ruby
+
+  # => object_instance_three.some_hash_configuration.should == { :another_value_not_yet_used => :some_value }
+
+```
+
+* Override inherited value
+
+```ruby
+
+  object_instance_three.some_hash_configuration = { :one_more_unused_value => :some_value }
+
+```
+
+* Verify local override value
+
+```ruby
+
+  # => object_instance_three.some_hash_configuration.should == { :one_more_unused_value => :some_value }
+
+```
 
 # License #
 

data/README.rdoc

@@ -10,24 +10,6 @@ Adds methods for cascading configurations.
 
 Cascading configuration methods for single settings, arrays, hashes.
 
-== :attr_configuration
-
-:attr_configuration provides inheritable configuration that cascades downward. 
-
-Configuration inheritance can cascade through modules, classes, and instances.
-
-:attr_configuration defines a single attribute accessor that searches upward for the first ancestor defining the configuration. 
-
-== :attr_configuration_array
-
-:attr_configuration_array provides inheritable configuration that cascades downward. 
-
-Configuration inheritance can cascade through modules, classes, and instances.
-
-:attr_configuration_array defines a single attribute accessor that composes the set of configuration values appropriate to the ancestor level being queried (merging downward from most distant ancestor to self). An internal cache is kept, and any configuration updates that occur to higher-level ancestors cascade immediately downward.
-
-The array maintained by :attr_configuration_array is kept ordered and unique.
-
 == :attr_configuration_hash
 
 :attr_configuration_hash provides inheritable configuration that cascades downward. 
@@ -42,15 +24,7 @@ Configuration inheritance can cascade through modules, classes, and instances.
 
 == Usage
 
-module AnyModuleOrClass
-  include CascadingConfiguration
-end
-
-For further details, see supporting package README markdown files (README.md) for examples in each case:
-
-* attr_configuration
-* attr_configuration_array
-* attr_configuration_hash
+See supporting package README markdown files (README.md) for examples.
 
 == License
 

data/lib/cascading-configuration-hash/CascadingConfiguration/CompositingHash/Instance.rb

@@ -0,0 +1,39 @@
+
+module CascadingConfiguration::CompositingHash::Instance
+
+	extend  CascadingConfiguration::InternalModuleStub
+
+  ###################
+  #  self.included  #
+  ###################
+
+  def self.included( class_or_module )
+    module_self = self
+    class_or_module.instance_eval do
+      extend module_self
+    end
+  end
+
+  ################################################
+  #  composite_hash_for_cascading_configuration  #
+  ################################################
+
+  def composite_hash_for_cascading_configuration( cascading_name )
+    
+    composite_hash = nil
+
+		klass = ( is_a?( Module ) ? self : self.class )
+		accessor_support_module = klass::AccessorSupportModule
+		self_instance = self
+		accessor_support_module.instance_eval do
+			unless composite_hash = ( ( @composite_hashes ||= Hash.new )[ cascading_name ] ||= Hash.new )[ self_instance ]
+	      composite_hash = ::CascadingConfiguration::CompositingHash.new( cascading_name, self_instance )
+				@composite_hashes[ cascading_name ][ self_instance ] = composite_hash
+			end
+		end
+
+    return composite_hash
+    
+  end
+
+end

data/lib/cascading-configuration-hash/CascadingConfiguration/CompositingHash.rb

@@ -0,0 +1,136 @@
+
+class CascadingConfiguration::CompositingHash < Hash
+
+  attr_accessor  :working_instance, :local_cascading_hash
+
+  ################
+  #  initialize  #
+  ################
+  
+  def initialize( cascading_name, working_instance )
+    @cascading_name     = cascading_name
+		@working_class = ( working_instance.is_a?( Module ) ? working_instance : working_instance.class )
+    @cascading_variable = @working_class::AccessorSupportModule.cascading_variable_name( @cascading_name )
+    @working_instance   = working_instance
+    # if first ancestor can have a composite array, register self with it in case it gets updated in the future
+    if ( first_ancestor = @working_instance.first_ancestor ).respond_to?( :composite_hash_for_cascading_configuration )
+      @parent_composite_hash = first_ancestor.composite_hash_for_cascading_configuration( @cascading_name )
+      @parent_composite_hash.register_child_composite_hash( self )
+    end
+    # get local cascading array (not included in parent composite)
+    @local_cascading_hash = ::CascadingConfiguration::LocalConfigurationHash.new
+    # we may later have our own child composites
+    @child_composite_hashes = ::Array.new
+    # initialize self status for parent and local
+    update_self_as_cascading_composite
+  end
+
+  ###################################
+  #  register_child_composite_hash  #
+  ###################################
+
+  def register_child_composite_hash( child_composite_hash )
+    @child_composite_hashes.push( child_composite_hash )
+    return self
+  end
+
+  #####################################
+  #  unregister_child_composite_hash  #
+  #####################################
+
+  def unregister_child_composite_hash( child_composite_hash )
+    @child_composite_hashes.delete( child_composite_hash )
+    return self
+  end
+
+  #########
+  #  []=  #
+  #########
+
+  def []=( key, value )
+    @local_cascading_hash[ key ] = value
+    update_adding_composite_elements( key => value )
+  end
+  alias_method :store, :[]=
+
+  ############
+  #  delete  #
+  ############
+
+  alias_method :super_delete, :delete
+  def delete( key )
+    value = self[ key ]
+    @local_cascading_hash.delete( key )
+    update_removing_composite_elements( key )
+    return value
+  end
+
+  ############
+  #  merge!  #
+  ############
+  
+  alias_method :super_merge!, :merge!
+  def merge!( other_hash )
+    @local_cascading_hash.merge!( other_hash )
+    update_adding_composite_elements( other_hash )
+    return self
+  end
+  
+  #############
+  #  replace  #
+  #############
+  
+  alias_method :super_replace, :replace
+  def replace( other_hash )
+    # clear current values
+    clear
+    # merge replacement settings
+    merge!( other_hash )
+		update_self_as_cascading_composite
+    return self
+  end
+
+  ###########
+  #  shift  #
+  ###########
+  
+  def shift
+    element = super
+    key = element[ 0 ]
+    @local_cascading_hash.delete( key )
+    update_removing_composite_elements( key )
+    return element
+  end
+
+  ###########
+  #  clear  #
+  ###########
+  
+  alias_method :super_clear, :clear
+  def clear
+    # add all existing values to exclude array
+    keys.each do |this_key|
+      delete( this_key )
+    end
+    update_removing_composite_elements( *self.keys )
+    return self
+  end
+  
+  #############
+  #  freeze!  #
+  #############
+
+  # freezes configuration and prevents ancestors from changing this configuration in the future
+  def freeze!
+    
+    # move current configuration into local configuration
+    @local_cascading_hash.replace( self )
+    
+    # unregister with parent composite so we don't get future updates from it
+    @parent_composite_hash.unregister_child_composite_hash( self ) if @parent_composite_hash
+    
+    return self
+    
+  end
+  
+end

data/lib/cascading-configuration-hash/CascadingConfiguration/Hash/Accessors.rb

@@ -0,0 +1,33 @@
+
+module CascadingConfiguration::Hash::Accessors
+
+	extend  CascadingConfiguration::InternalModuleStub
+
+  ######################################
+  #  define_configuration_hash_setter  #
+  ######################################
+  
+  def define_configuration_hash_setter( configuration_name )
+    configuration_setter_name = ( configuration_name.to_s + '=' ).to_sym
+    self::AccessorSupportModule.module_eval do 
+	    define_method( configuration_setter_name ) do |hash|
+	      # we want the hash to supplant existing config
+	      return composite_hash_for_cascading_configuration( configuration_name ).replace( hash )
+	    end
+    end
+  end
+
+  ######################################
+  #  define_configuration_hash_getter  #
+  ######################################
+  
+  def define_configuration_hash_getter( configuration_name )
+    configuration_getter_name = configuration_name
+    self::AccessorSupportModule.module_eval do 
+	    define_method( configuration_getter_name ) do
+	      return composite_hash_for_cascading_configuration( configuration_name )
+	    end
+    end
+  end
+
+end

data/lib/cascading-configuration-hash/CascadingConfiguration/Hash/ClassInstance.rb

@@ -0,0 +1,24 @@
+
+module CascadingConfiguration::Hash::ClassInstance
+
+	extend  CascadingConfiguration::InternalModuleStub
+
+  #############################
+  #  attr_configuration_hash  #
+  #############################
+
+  def attr_configuration_hash( *property_names, & compositing_block )
+    
+    property_names.each do |this_property_name|
+			self::AccessorSupportModule.set_compositing_proc( this_property_name, compositing_block ) if block_given?
+      # define configuration setter
+      define_configuration_hash_setter( this_property_name )
+      # define configuration getter
+      define_configuration_hash_getter( this_property_name )
+    end
+    
+    return self
+
+  end
+
+end

data/lib/cascading-configuration-hash/CascadingConfiguration/Hash/ModuleInstance.rb

@@ -0,0 +1,34 @@
+
+module CascadingConfiguration::Hash::ModuleInstance
+  
+	extend  CascadingConfiguration::InternalModuleStub
+	
+  ##############
+  #  included  #
+  ##############
+  
+  def included( class_or_module )
+		super if method_defined?( :super )
+		# CascadingConfiguration::Hash
+    module_self = self
+    class_or_module.instance_eval do
+      # cascade CascadingConfiguration::Hash
+      include CascadingConfiguration::Hash
+    end
+  end
+
+  ##############
+  #  extended  #
+  ##############
+  
+  def extended( class_or_module )
+		super if method_defined?( :super )
+		# CascadingConfiguration::Hash
+    module_self = self
+    class_or_module.instance_eval do
+      # cascade CascadingConfiguration::Hash
+      include CascadingConfiguration::Hash
+    end
+  end
+  
+end

data/lib/cascading-configuration-hash/CascadingConfiguration/Hash.rb

@@ -0,0 +1,24 @@
+
+module CascadingConfiguration::Hash
+  
+	extend  CascadingConfiguration::InternalModuleStub
+
+  include CascadingConfiguration::Variable
+  include CascadingConfiguration::CompositingHash::Instance
+
+  ###################
+  #  self.included  #
+  ###################
+
+  def self.included( class_or_module )
+		module_self = self
+    class_or_module.instance_eval do
+      extend  module_self
+      extend  module_self::Accessors
+      extend  module_self::ClassInstance
+			# module support
+      extend CascadingConfiguration::Hash::ModuleInstance unless is_a?( Class )
+    end
+  end
+
+end