cascading-configuration-hash 1.6.2 → 2.0.0

data/lib/cascading-configuration-hash.rb

@@ -1,12 +1,13 @@
 
-require 'cascading-configuration-variable'
-#require_relative '../../variable/lib/cascading-configuration-variable.rb'
+if $__cascading_configuration__spec__development
+  require_relative '../../variable/lib/cascading-configuration-variable.rb'
+else
+  require 'cascading-configuration-variable'
+end
 
 module CascadingConfiguration
   module Hash
     class CompositingHash < ::Hash
-      class LocalConfigurationHash < ::Hash
-      end
     end
     module Interface
       module GettersSetters
@@ -15,7 +16,6 @@ module CascadingConfiguration
   end
 end
 
-require_relative 'cascading-configuration-hash/_private_/CascadingConfiguration/Hash/CompositingHash/LocalConfigurationHash.rb'
 require_relative 'cascading-configuration-hash/_private_/CascadingConfiguration/Hash/CompositingHash.rb'
 require_relative 'cascading-configuration-hash/_private_/CascadingConfiguration/Hash/Interface/GettersSetters.rb'
 require_relative 'cascading-configuration-hash/_private_/CascadingConfiguration/Hash/ModuleSupportMethods.rb'

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

@@ -8,15 +8,15 @@ module CascadingConfiguration::Hash::Interface
   #  attr_configuration_hash  #
   #############################
 
-	# defines configuration in class or module
-	# configuration cascades downward to instance including all classes or modules in-between
+  # defines configuration in class or module
+  # configuration cascades downward to instance including all classes or modules in-between
   def attr_configuration_hash( *configuration_names, & compositing_block )
     
     configuration_names.each do |this_configuration_name|
       if block_given?
-			  ::CascadingConfiguration::Variable.set_compositing_proc( self, 
-			                                                                                 this_configuration_name,
-			                                                                                 compositing_block )
+        ::CascadingConfiguration::Variable.set_compositing_proc( self, 
+                                                                                       this_configuration_name,
+                                                                                       compositing_block )
       end
       # define configuration setter
       define_cascading_hash_setter( this_configuration_name )
@@ -32,15 +32,15 @@ module CascadingConfiguration::Hash::Interface
   #  attr_module_configuration_hash  #
   ####################################
 
-	# defines configuration in class or module
-	# configuration cascades downward to last class or module
+  # defines configuration in class or module
+  # configuration cascades downward to last class or module
   def attr_module_configuration_hash( *configuration_names, & compositing_block )
     
     configuration_names.each do |this_configuration_name|
       if block_given?
-			  ::CascadingConfiguration::Variable.set_compositing_proc( self, 
-			                                                                                 this_configuration_name,
-			                                                                                 compositing_block )
+        ::CascadingConfiguration::Variable.set_compositing_proc( self, 
+                                                                                       this_configuration_name,
+                                                                                       compositing_block )
       end
       # define configuration setter
       define_class_configuration_hash_setter( this_configuration_name )
@@ -51,23 +51,23 @@ module CascadingConfiguration::Hash::Interface
     return self
 
   end
-	alias_method :attr_class_configuration_hash, :attr_module_configuration_hash
+  alias_method :attr_class_configuration_hash, :attr_module_configuration_hash
 
   ###################################
   #  attr_local_configuration_hash  #
   ###################################
 
-	# defines configuration in present class or module context
-	# configuration does not cascade
+  # defines configuration in present class or module context
+  # configuration does not cascade
   def attr_local_configuration_hash( *configuration_names, & compositing_block )
 
-		::CascadingConfiguration::Variable.create_local_instance_configuration_support_module( self )
+    ::CascadingConfiguration::Variable.create_local_instance_configuration_support_module( self )
 
     configuration_names.each do |this_configuration_name|
       if block_given?
-			  ::CascadingConfiguration::Variable.set_compositing_proc( self, 
-			                                                                                 this_configuration_name,
-			                                                                                 compositing_block )
+        ::CascadingConfiguration::Variable.set_compositing_proc( self, 
+                                                                                       this_configuration_name,
+                                                                                       compositing_block )
       end
       # define configuration setter
       define_local_configuration_hash_setter( this_configuration_name )
@@ -83,17 +83,17 @@ module CascadingConfiguration::Hash::Interface
   #  attr_object_configuration_hash  #
   ####################################
 
-	# defines configuration in present class or module context
-	# configuration does not cascade
+  # defines configuration in present class or module context
+  # configuration does not cascade
   def attr_object_configuration_hash( *configuration_names, & compositing_block )
 
-		::CascadingConfiguration::Variable.create_local_instance_configuration_support_module( self )
+    ::CascadingConfiguration::Variable.create_local_instance_configuration_support_module( self )
 
     configuration_names.each do |this_configuration_name|
       if block_given?
-			  ::CascadingConfiguration::Variable.set_compositing_proc( self, 
-			                                                                                 this_configuration_name,
-			                                                                                 compositing_block )
+        ::CascadingConfiguration::Variable.set_compositing_proc( self, 
+                                                                                       this_configuration_name,
+                                                                                       compositing_block )
       end
       # define configuration setter
       define_object_configuration_hash_setter( this_configuration_name )
@@ -109,15 +109,15 @@ module CascadingConfiguration::Hash::Interface
   #  attr_instance_configuration_hash  #
   ######################################
 
-	# defines configuration in present class or module context
-	# configuration does not cascade
+  # 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?
-			  ::CascadingConfiguration::Variable.set_compositing_proc( self, 
-			                                                                                 this_configuration_name,
-			                                                                                 compositing_block )
+        ::CascadingConfiguration::Variable.set_compositing_proc( self, 
+                                                                                       this_configuration_name,
+                                                                                       compositing_block )
       end
       # define configuration setter
       define_instance_configuration_hash_setter( this_configuration_name )

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

@@ -1,7 +1,5 @@
 
-class CascadingConfiguration::Hash::CompositingHash < ::Hash
-
-  attr_accessor  :local_cascading_hash
+class ::CascadingConfiguration::Hash::CompositingHash < ::Hash
 
   ################
   #  initialize  #
@@ -9,45 +7,55 @@ class CascadingConfiguration::Hash::CompositingHash < ::Hash
   
   def initialize( configuration_instance, configuration_name )
 
-    @configuration_instance = configuration_instance
-    
+    @configuration_instance = configuration_instance    
     @configuration_name = configuration_name
 
+    @replaced_parents = {}
+
     # store self for sub composites
-    ::CascadingConfiguration::Variable.set_configuration_variable( configuration_instance, configuration_name, self )
+    ::CascadingConfiguration::Variable.set_configuration_variable( configuration_instance, 
+                                                                   configuration_name, 
+                                                                   self )
+    
+    # get compositing proc if we have one
+    @compositing_proc = ::CascadingConfiguration::Variable.
+                          get_compositing_proc_searching_upward( configuration_instance, @configuration_name )
+    
+    # we may later have our own child composites that register with us
+    @sub_composite_hashes = [ ]
 
-    # if first ancestor can have a composite hash, register self with it in case it gets updated in the future
-    if ancestor = ::CascadingConfiguration::Variable.ancestor( configuration_instance, configuration_name )
+    # if first ancestor can have a composite hash, 
+    # register self with it in case it gets updated in the future
+    if ancestor = ::CascadingConfiguration::Variable.ancestor( configuration_instance, 
+                                                               configuration_name )
 
-      @super_composite_hash = ::CascadingConfiguration::Variable.get_configuration_variable( ancestor, 
-                                                                                                                   configuration_name )
+      @super_composite_hash = ::CascadingConfiguration::Variable.
+                                get_configuration_variable( ancestor, 
+                                                            configuration_name )
 
       if @super_composite_hash.respond_to?( :register_sub_composite_hash )
         @super_composite_hash.register_sub_composite_hash( self )
+        merge!( @super_composite_hash )
       else
         @super_composite_hash = nil
       end
 
     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 = [ ]
-    
-    # initialize self status for parent and local
-    update_self_as_cascading_composite
-
   end
 
+  ###################################  Sub-Hash Management  #######################################
+
   #################################
   #  register_sub_composite_hash  #
   #################################
 
   def register_sub_composite_hash( sub_composite_hash )
+
     @sub_composite_hashes.push( sub_composite_hash )
+
     return self
+
   end
 
   ###################################
@@ -55,17 +63,37 @@ class CascadingConfiguration::Hash::CompositingHash < ::Hash
   ###################################
 
   def unregister_sub_composite_hash( sub_composite_hash )
+
     @sub_composite_hashes.delete( sub_composite_hash )
+
     return self
+
   end
 
+  #####################################  Self Management  ##########################################
+
   #########
   #  []=  #
   #########
 
-  def []=( key, value )
-    @local_cascading_hash[ key ] = value
-    update_adding_composite_elements( key => value )
+  private
+    alias_method :non_cascading_store, :store
+  public
+  
+  def []=( key, object )
+
+    @replaced_parents[ key ] = true
+
+    non_cascading_store( key, object )
+
+    @sub_composite_hashes.each do |this_sub_hash|
+      this_sub_hash.instance_eval do
+        update_as_sub_hash_for_parent_store( key, object )
+      end
+    end
+    
+    return object
+
   end
   alias_method :store, :[]=
 
@@ -73,37 +101,147 @@ class CascadingConfiguration::Hash::CompositingHash < ::Hash
   #  delete  #
   ############
 
-  alias_method :super_delete, :delete
+  private
+    alias_method :non_cascading_delete, :delete
+  public
+  
   def delete( key )
-    value = self[ key ]
-    @local_cascading_hash.delete( key )
-    update_removing_composite_elements( key )
-    return value
+
+    @replaced_parents.delete( key )
+
+    object = non_cascading_delete( key )
+
+    @sub_composite_hashes.each do |this_sub_hash|
+      this_sub_hash.instance_eval do
+        update_as_sub_hash_for_parent_delete( key )
+      end
+    end
+
+    return object
+
+  end
+
+  ###############
+  #  delete_if  #
+  ###############
+
+  def delete_if
+
+    return to_enum unless block_given?
+
+    indexes = [ ]
+    
+    self.each do |this_key, this_object|
+      if yield( this_key, this_object )
+        delete( this_key )
+      end
+    end
+        
+    return self
+
+  end
+
+  #############
+  #  reject!  #
+  #############
+
+  def reject!
+
+    return to_enum unless block_given?
+    
+    return_value = nil
+    
+    self.each do |this_key, this_object|
+      if yield( this_key, this_object )
+        delete( this_key )
+        return_value = self
+      end
+    end
+    
+    return return_value
+
+  end
+
+  #############
+  #  keep_if  #
+  #############
+
+  def keep_if
+
+    return to_enum unless block_given?
+
+    indexes = [ ]
+    
+    self.each do |this_key, this_object|
+      unless yield( this_key, this_object )
+        delete( this_key )
+      end
+    end
+        
+    return self
+
+
+  end
+
+  #############
+  #  select!  #
+  #############
+
+  def select!
+
+    return to_enum unless block_given?
+    
+    return_value = nil
+    
+    self.each do |this_key, this_object|
+      unless yield( this_key, this_object )
+        delete( this_key )
+        return_value = self
+      end
+    end
+    
+    return return_value
+
   end
 
   ############
   #  merge!  #
+  #  update  #
   ############
   
-  alias_method :super_merge!, :merge!
+  private
+    alias_method :non_cascading_merge!, :merge!
+  public
+
   def merge!( other_hash )
-    @local_cascading_hash.merge!( other_hash )
-    update_adding_composite_elements( other_hash )
+
+    other_hash.each do |this_key, this_object|
+      if @compositing_proc
+        self[ this_key ] = @compositing_proc.call( self, this_key, this_object )
+      else
+        self[ this_key ] = this_object
+      end
+    end
+
     return self
+
   end
+  alias_method :update, :merge!
   
   #############
   #  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
 
   ###########
@@ -111,25 +249,30 @@ class CascadingConfiguration::Hash::CompositingHash < ::Hash
   ###########
   
   def shift
-    element = super
-    key = element[ 0 ]
-    @local_cascading_hash.delete( key )
-    update_removing_composite_elements( key )
-    return element
+    
+    object = nil
+    
+    unless empty?
+      last_key = first[ 0 ]
+      object = delete( last_key )
+    end    
+
+    return [ last_key, object ]
+
   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
   
   #############
@@ -139,90 +282,59 @@ class CascadingConfiguration::Hash::CompositingHash < ::Hash
   # 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
+    if @super_composite_hash
+      @super_composite_hash.unregister_sub_composite_hash( self )
+    end
     
     return self
     
   end
 
-  ###########################################################################################################
-      private ###############################################################################################
-  ###########################################################################################################
+  ##################################################################################################
+      private ######################################################################################
+  ##################################################################################################
 
-  ########################################
-  #  update_self_as_cascading_composite  #
-  ########################################
+  #########################  Self-as-Sub Management for Parent Updates  ############################
 
-  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 )
+  #########################################
+  #  update_as_sub_hash_for_parent_store  #
+  #########################################
+
+  def update_as_sub_hash_for_parent_store( key, object )
+    
+    unless @replaced_parents[ key ]
+    
+      non_cascading_store( key, object )
+    
+      @sub_composite_hashes.each do |this_hash|
+        this_hash.instance_eval do
+          update_as_sub_hash_for_parent_store( key, object )
+        end
       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 )
-	  
-		if compositing_proc = ::CascadingConfiguration::Variable.get_compositing_proc_searching_upward( @configuration_instance, @configuration_name )
-			# if we have a compositing proc defined, use its result to replace
-			parent_hash_copy = { }
-			parent_hash_copy.merge!( parent_hash ) if parent_hash
-			second_hash_copy = { }
-			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 }
+  ##########################################
+  #  update_as_sub_hash_for_parent_delete  #
+  ##########################################
+
+  def update_as_sub_hash_for_parent_delete( key )
+    
+    unless @replaced_parents[ key ]
+    
+      non_cascading_delete( key )
+    
+      @sub_composite_hashes.each do |this_hash|
+        this_hash.instance_eval do
+          update_as_sub_hash_for_parent_delete( key )
+        end
+      end
+    
     end
+    
   end
   
 end