cascading-configuration-hash 1.4.1 → 1.5.0

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

@@ -1,7 +1,8 @@
 
 module CascadingConfiguration::Hash::Interface
 
-	extend  CascadingConfiguration::InternalModuleStub
+  # Support methods that define configuration settings hash methods
+  include ::CascadingConfiguration::Hash::Interface::GettersSetters
 
   #############################
   #  attr_configuration_hash  #
@@ -9,14 +10,22 @@ module CascadingConfiguration::Hash::Interface
 
 	# defines configuration in class or module
 	# configuration cascades downward to instance including all classes or modules in-between
-  def attr_configuration_hash( *property_names, & compositing_block )
+  def attr_configuration_hash( *configuration_names, & compositing_block )
     
-    property_names.each do |this_property_name|
-			accessor_module_support.set_compositing_proc( this_property_name, compositing_block ) if block_given?
+    configuration_names.each do |this_configuration_name|
+      if block_given?
+        module_configuration_support_module = CascadingConfiguration::Variable.module_configuration_support_module( self )
+    	  for_instance = false
+    	  if ! is_a?( Module ) and ! module_configuration_support_module
+    	    module_configuration_support_module = CascadingConfiguration::Variable.module_configuration_support_module( self.class )
+    	    for_instance = true
+			  end
+			  module_configuration_support_module.set_compositing_proc( this_configuration_name, compositing_block, for_instance )
+      end
       # define configuration setter
-      define_cascading_hash_setter( this_property_name )
+      define_cascading_hash_setter( this_configuration_name )
       # define configuration getter
-      define_cascading_hash_getter( this_property_name )
+      define_cascading_hash_getter( this_configuration_name )
     end
     
     return self
@@ -29,14 +38,22 @@ module CascadingConfiguration::Hash::Interface
 
 	# defines configuration in class or module
 	# configuration cascades downward to last class or module
-  def attr_module_configuration_hash( *property_names, & compositing_block )
+  def attr_module_configuration_hash( *configuration_names, & compositing_block )
     
-    property_names.each do |this_property_name|
-			accessor_module_support.set_compositing_proc( this_property_name, compositing_block ) if block_given?
+    configuration_names.each do |this_configuration_name|
+      if block_given?
+        module_configuration_support_module = CascadingConfiguration::Variable.module_configuration_support_module( self )
+    	  for_instance = false
+    	  if ! is_a?( Module ) and ! module_configuration_support_module
+    	    module_configuration_support_module = CascadingConfiguration::Variable.module_configuration_support_module( self.class )
+    	    for_instance = true
+			  end
+			  module_configuration_support_module.set_compositing_proc( this_configuration_name, compositing_block, for_instance )
+      end
       # define configuration setter
-      define_class_configuration_hash_setter( this_property_name )
+      define_class_configuration_hash_setter( this_configuration_name )
       # define configuration getter
-      define_class_configuration_hash_getter( this_property_name )
+      define_class_configuration_hash_getter( this_configuration_name )
     end
     
     return self
@@ -50,19 +67,25 @@ module CascadingConfiguration::Hash::Interface
 
 	# defines configuration in present class or module context
 	# configuration does not cascade
-  def attr_local_configuration_hash( *property_names, & compositing_block )
-
-		CascadingConfiguration::Variable.define_accessor_local_instance_support( self )
-
-    property_names.each do |this_property_name|
-			accessor_module_support.set_compositing_proc( this_property_name, compositing_block ) if block_given?
+  def attr_local_configuration_hash( *configuration_names, & compositing_block )
+
+		CascadingConfiguration::Variable.initialize_local_instance_configuration_module( self )
+
+    configuration_names.each do |this_configuration_name|
+      if block_given?
+        module_configuration_support_module = CascadingConfiguration::Variable.module_configuration_support_module( self )
+    	  for_instance = false
+    	  if ! is_a?( Module ) and ! module_configuration_support_module
+    	    module_configuration_support_module = CascadingConfiguration::Variable.module_configuration_support_module( self.class )
+    	    for_instance = true
+			  end
+			  module_configuration_support_module.set_compositing_proc( this_configuration_name, compositing_block, for_instance )
+      end
       # define configuration setter
-      define_local_configuration_hash_setter( this_property_name )
+      define_local_configuration_hash_setter( this_configuration_name )
       # define configuration getter
-      define_local_configuration_hash_getter( this_property_name )
+      define_local_configuration_hash_getter( this_configuration_name )
     end
-
-    CascadingConfiguration::Variable.cascade_local_instance( self )
     
     return self
 
@@ -74,16 +97,52 @@ module CascadingConfiguration::Hash::Interface
 
 	# defines configuration in present class or module context
 	# configuration does not cascade
-  def attr_object_configuration_hash( *property_names, & compositing_block )
+  def attr_object_configuration_hash( *configuration_names, & compositing_block )
+
+		CascadingConfiguration::Variable.initialize_local_instance_configuration_module( self )
+
+    configuration_names.each do |this_configuration_name|
+      if block_given?
+        module_configuration_support_module = CascadingConfiguration::Variable.module_configuration_support_module( self )
+    	  for_instance = false
+    	  if ! is_a?( Module ) and ! module_configuration_support_module
+    	    module_configuration_support_module = CascadingConfiguration::Variable.module_configuration_support_module( self.class )
+    	    for_instance = true
+			  end
+			  module_configuration_support_module.set_compositing_proc( this_configuration_name, compositing_block, for_instance )
+      end
+      # define configuration setter
+      define_object_configuration_hash_setter( this_configuration_name )
+      # define configuration getter
+      define_object_configuration_hash_getter( this_configuration_name )
+    end
+    
+    return self
+
+  end
 
-		CascadingConfiguration::Variable.define_accessor_local_instance_support( self )
+  ######################################
+  #  attr_instance_configuration_hash  #
+  ######################################
 
-    property_names.each do |this_property_name|
-			accessor_module_support.set_compositing_proc( this_property_name, compositing_block ) if block_given?
+	# defines configuration in present class or module context
+	# configuration does not cascade
+  def attr_instance_configuration_hash( *configuration_names, & compositing_block )
+
+    configuration_names.each do |this_configuration_name|
+      if block_given?
+        module_configuration_support_module = CascadingConfiguration::Variable.module_configuration_support_module( self )
+    	  for_instance = false
+    	  if ! is_a?( Module ) and ! module_configuration_support_module
+    	    module_configuration_support_module = CascadingConfiguration::Variable.module_configuration_support_module( self.class )
+    	    for_instance = true
+			  end
+			  module_configuration_support_module.set_compositing_proc( this_configuration_name, compositing_block, for_instance )
+      end
       # define configuration setter
-      define_object_configuration_hash_setter( this_property_name )
+      define_instance_configuration_hash_setter( this_configuration_name )
       # define configuration getter
-      define_object_configuration_hash_getter( this_property_name )
+      define_instance_configuration_hash_getter( this_configuration_name )
     end
     
     return self

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

@@ -1,28 +1,12 @@
 
 module CascadingConfiguration::Hash
   
-  extend ModuleCluster
-  
-	extend  CascadingConfiguration::InternalModuleStub
-
-  include CascadingConfiguration::Variable
-
-  include CascadingConfiguration::CompositingHash::Instance
-  include CascadingConfiguration::Hash::Interface
-  include CascadingConfiguration::Hash::AccessorDefinitionMethods
+  # Configuration modules for storage of settings hashes
+  include ::CascadingConfiguration::Variable
 
-  prepend_module_include do |class_or_module|
-    class_or_module.extend_also_extends( CascadingConfiguration::Variable::EigenclassConfigurationChain )
-  end
+  # Interface to declare configuration settings hashes
+  include ::CascadingConfiguration::Hash::Interface
 
-  include_cascades_extends( CascadingConfiguration::Hash::Interface::Instance )
-
-  include_cascades_extends( CascadingConfiguration::Hash )
+  extend ::CascadingConfiguration::Hash::ModuleSupportMethods
   
-  prepend_module_include do |class_or_module|
-    class_or_module.include_or_extend_cascades_prepending_extends do
-		  accessor_module_support
-	  end
-  end
-
 end

data/lib/cascading-configuration-hash/{CascadingConfiguration → _private_/CascadingConfiguration/Hash/CompositingHash}/LocalConfigurationHash.rb

@@ -1,6 +1,6 @@
 
-class CascadingConfiguration::LocalConfigurationHash < Hash
-  
+class CascadingConfiguration::Hash::CompositingHash::LocalConfigurationHash < Hash
+
   attr_accessor  :exclude_array
   
   ################
@@ -80,4 +80,31 @@ class CascadingConfiguration::LocalConfigurationHash < Hash
     super
   end
 
+  ###########################################################################################################
+      private ###############################################################################################
+  ###########################################################################################################
+
+  ##########################
+  #  add_to_exclude_array  #
+  ##########################
+
+  def add_to_exclude_array( *elements )
+    @exclude_array ||= ::Array.new
+    @exclude_array += elements
+    @exclude_array.sort!.uniq!
+  end
+
+  ###############################
+  #  remove_from_exclude_array  #
+  ###############################
+
+  def remove_from_exclude_array( *elements )
+    if @exclude_array
+      @exclude_array -= elements
+      @exclude_array.sort!.uniq!
+    else
+      @exclude_array ||= ::Array.new
+    end
+  end
+  
 end

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

@@ -0,0 +1,246 @@
+
+class CascadingConfiguration::Hash::CompositingHash < Hash
+
+  attr_accessor  :local_cascading_hash
+
+  ################
+  #  initialize  #
+  ################
+  
+  def initialize( configuration_instance, configuration_name )
+
+    for_instance = false
+
+    @configuration_instance = configuration_instance
+    
+    module_configuration_module = ::CascadingConfiguration::Variable.module_configuration_support_module( configuration_instance )
+    if ! module_configuration_module and ! configuration_instance.is_a?( Module )
+      module_configuration_module = ::CascadingConfiguration::Variable.module_configuration_support_module( configuration_instance.class )
+      for_instance = true 
+    end
+
+    @configuration_name = configuration_name
+
+    # store self for sub composites
+    module_configuration_module.set_configuration_variable( configuration_name, self, for_instance )
+    
+    # if first ancestor can have a composite hash, register self with it in case it gets updated in the future
+    super_configuration_module = nil
+    if for_instance
+      super_configuration_module = module_configuration_module
+    else
+      super_configuration_module = module_configuration_module.super_configuration_module
+    end
+    
+    if super_configuration_module                                                                          and 
+       @super_composite_hash = super_configuration_module.get_configuration_variable( configuration_name ) and 
+       @super_composite_hash.respond_to?( :register_sub_composite_hash )
+
+      @super_composite_hash.register_sub_composite_hash( self )
+
+    end
+
+    # instantiate local cascading hash
+    @local_cascading_hash = ::CascadingConfiguration::Hash::CompositingHash::LocalConfigurationHash.new
+    
+    # we may later have our own child composites that register with us
+    @sub_composite_hashes = ::Array.new
+    
+    # initialize self status for parent and local
+    update_self_as_cascading_composite
+
+  end
+
+  #################################
+  #  register_sub_composite_hash  #
+  #################################
+
+  def register_sub_composite_hash( sub_composite_hash )
+    @sub_composite_hashes.push( sub_composite_hash )
+    return self
+  end
+
+  ###################################
+  #  unregister_sub_composite_hash  #
+  ###################################
+
+  def unregister_sub_composite_hash( sub_composite_hash )
+    @sub_composite_hashes.delete( sub_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
+    @super_composite_hash.unregister_sub_composite_hash( self ) if @super_composite_hash
+    
+    return self
+    
+  end
+
+  ###########################################################################################################
+      private ###############################################################################################
+  ###########################################################################################################
+
+  ########################################
+  #  update_self_as_cascading_composite  #
+  ########################################
+
+  def update_self_as_cascading_composite
+    # start fresh
+    super_clear
+		update_composite_self_for_parent_hash( @super_composite_hash, @local_cascading_hash )
+    # remove local exclude
+    unless @local_cascading_hash.exclude_array.empty?
+      @local_cascading_hash.exclude_array.each do |this_excluded_element|
+        super_delete( this_excluded_element )
+      end
+    end
+    # notify children to update their composite status
+    update_sub_composite_arrays
+    return self
+  end
+  
+  ######################################
+  #  update_adding_composite_elements  #
+  ######################################
+
+  def update_adding_composite_elements( elements_to_cascade )
+		update_composite_self_for_parent_hash( self, elements_to_cascade )
+    update_sub_composite_arrays
+		return self
+  end
+
+  ###########################################
+  #  update_composite_self_for_parent_hash  #
+  ###########################################
+
+	def update_composite_self_for_parent_hash( parent_hash, second_hash )
+	  
+	  module_configuration_support_module = CascadingConfiguration::Variable.module_configuration_support_module( @configuration_instance )
+	  for_instance = false
+	  
+	  if ! module_configuration_support_module and ! is_a?( Module )
+	    module_configuration_support_module = CascadingConfiguration::Variable.module_configuration_support_module( @configuration_instance.class )
+	    for_instance = true
+    end
+    
+		if compositing_proc = module_configuration_support_module.get_compositing_proc( @configuration_name, for_instance )
+			# if we have a compositing proc defined, use its result to replace
+			parent_hash_copy = Hash.new
+			parent_hash_copy.merge!( parent_hash ) if parent_hash
+			second_hash_copy = Hash.new
+			second_hash_copy.merge!( second_hash ) if second_hash
+			composite_result = compositing_proc.call( parent_hash_copy, second_hash_copy )
+			super_replace( composite_result )
+		else
+			# otherwise we simply merge
+	    super_merge!( parent_hash ) if parent_hash
+	    super_merge!( second_hash ) if second_hash
+		end
+		return self
+	end
+
+  ########################################
+  #  update_removing_composite_elements  #
+  ########################################
+
+  def update_removing_composite_elements( *elements_to_exclude )
+    elements_to_exclude.each do |this_key|
+      super_delete( this_key )
+    end
+    update_sub_composite_arrays
+  end
+
+  ###################################
+  #  update_sub_composite_arrays  #
+  ###################################
+  
+  def update_sub_composite_arrays
+    @sub_composite_hashes.each do |this_composite_hash|
+      this_composite_hash.instance_eval { update_self_as_cascading_composite }
+    end
+  end
+  
+end