cascading-configuration-array 1.4.1 → 1.5.0

data/lib/cascading-configuration-array/CascadingConfiguration/Array/Interface.rb

@@ -1,21 +1,26 @@
 
 module CascadingConfiguration::Array::Interface
 
-	extend  CascadingConfiguration::InternalModuleStub
-
+  # Support methods that define configuration settings array methods
+	include ::CascadingConfiguration::Array::Interface::GettersSetters
+	
   ##############################
   #  attr_configuration_array  #
   ##############################
 
 	# defines configuration in class or module
 	# configuration cascades downward to instance including all classes or modules in-between
-  def attr_configuration_array( *property_names )
-    property_names.each do |this_property_name|
+  def attr_configuration_array( *configuration_names )
+
+    configuration_names.each do |this_configuration_name|
       # define configuration setter
-      define_cascading_array_setter( this_property_name )
+      define_cascading_array_setter( this_configuration_name )
       # define configuration getter
-      define_cascading_array_getter( this_property_name )
+      define_cascading_array_getter( this_configuration_name )
     end
+
+    return self
+
   end
 
   #####################################
@@ -24,13 +29,17 @@ module CascadingConfiguration::Array::Interface
 
 	# defines configuration in class or module
 	# configuration cascades downward to last class or module
-  def attr_module_configuration_array( *property_names )
-    property_names.each do |this_property_name|
+  def attr_module_configuration_array( *configuration_names )
+
+    configuration_names.each do |this_configuration_name|
       # define configuration setter
-      define_class_configuration_array_setter( this_property_name )
+      define_class_configuration_array_setter( this_configuration_name )
       # define configuration getter
-      define_class_configuration_array_getter( this_property_name )
+      define_class_configuration_array_getter( this_configuration_name )
     end
+
+    return self
+
   end
 	alias_method :attr_class_configuration_array, :attr_module_configuration_array
 
@@ -40,15 +49,19 @@ module CascadingConfiguration::Array::Interface
 
 	# defines configuration in present class or module context
 	# configuration does not cascade
-  def attr_local_configuration_array( *property_names )
-		CascadingConfiguration::Variable.define_accessor_local_instance_support( self )
-    property_names.each do |this_property_name|
+  def attr_local_configuration_array( *configuration_names )
+
+		CascadingConfiguration::Variable.initialize_local_instance_configuration_module( self )
+
+    configuration_names.each do |this_configuration_name|
       # define configuration setter
-      define_local_configuration_array_setter( this_property_name )
+      define_local_configuration_array_setter( this_configuration_name )
       # define configuration getter
-      define_local_configuration_array_getter( this_property_name )
+      define_local_configuration_array_getter( this_configuration_name )
     end
-    CascadingConfiguration::Variable.cascade_local_instance( self )
+
+    return self
+
   end
 
   #####################################
@@ -57,14 +70,38 @@ module CascadingConfiguration::Array::Interface
 
 	# defines configuration in present instance
 	# configuration does not cascade
-  def attr_object_configuration_array( *property_names )
-		CascadingConfiguration::Variable.define_accessor_local_instance_support( self )
-    property_names.each do |this_property_name|
+  def attr_object_configuration_array( *configuration_names )
+
+		CascadingConfiguration::Variable.initialize_local_instance_configuration_module( self )
+
+    configuration_names.each do |this_configuration_name|
+      # define configuration setter
+      define_object_configuration_array_setter( this_configuration_name )
+      # define configuration getter
+      define_object_configuration_array_getter( this_configuration_name )
+    end
+
+    return self
+
+  end
+
+  #######################################
+  #  attr_instance_configuration_array  #
+  #######################################
+
+	# defines configuration in present class or module context
+	# configuration does not cascade
+  def attr_instance_configuration_array( *configuration_names )
+
+    configuration_names.each do |this_configuration_name|
       # define configuration setter
-      define_object_configuration_array_setter( this_property_name )
+      define_instance_configuration_array_setter( this_configuration_name )
       # define configuration getter
-      define_object_configuration_array_getter( this_property_name )
+      define_instance_configuration_array_getter( this_configuration_name )
     end
+
+    return self
+
   end
 
 end

data/lib/cascading-configuration-array/CascadingConfiguration/Array.rb

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

data/lib/cascading-configuration-array/{CascadingConfiguration → _private_/CascadingConfiguration/Array/CompositingArray}/LocalConfigurationArray.rb

@@ -1,5 +1,9 @@
 
-class CascadingConfiguration::LocalConfigurationArray < Array
+class CascadingConfiguration::Array::CompositingArray::LocalConfigurationArray < Array
+
+  # A LocalConfigurationArray is a single layer of a CompositingArray.
+  # The LocalConfigurationArray holds the layer's settings and exclude values.
+  # CompositingArray uses LocalConfigurationArray to cascade.
 
   attr_accessor  :exclude_array
   
@@ -163,4 +167,26 @@ class CascadingConfiguration::LocalConfigurationArray < Array
 
   end
   
+  ###########################################################################################################
+      private ###############################################################################################
+  ###########################################################################################################
+
+  ##########################
+  #  add_to_exclude_array  #
+  ##########################
+
+  def add_to_exclude_array( *elements )
+    @exclude_array += elements
+    @exclude_array.sort!.uniq!
+  end
+
+  ###############################
+  #  remove_from_exclude_array  #
+  ###############################
+
+  def remove_from_exclude_array( *elements )
+    @exclude_array -= elements
+    @exclude_array.sort!.uniq!
+  end
+  
 end

data/lib/cascading-configuration-array/_private_/CascadingConfiguration/Array/CompositingArray.rb

@@ -0,0 +1,295 @@
+
+class CascadingConfiguration::Array::CompositingArray < Array
+
+  attr_accessor  :local_cascading_array
+
+  ################
+  #  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 array, 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_array = super_configuration_module.get_configuration_variable( configuration_name ) and 
+       @super_composite_array.respond_to?( :register_sub_composite_array )
+
+      @super_composite_array.register_sub_composite_array( self )
+
+    end
+    
+    # instantiate local cascading array
+    @local_cascading_array = ::CascadingConfiguration::Array::CompositingArray::LocalConfigurationArray.new
+    
+    # we may later have our own child composites that register with us
+    @sub_composite_arrays = ::Array.new
+    
+    # initialize self status for parent and local
+    update_self_as_cascading_composite
+    
+  end
+
+  ##################################
+  #  register_sub_composite_array  #
+  ##################################
+
+  def register_sub_composite_array( sub_composite_array )
+    @sub_composite_arrays.push( sub_composite_array )
+    return self
+  end
+
+  ####################################
+  #  unregister_sub_composite_array  #
+  ####################################
+
+  def unregister_sub_composite_array( sub_composite_array )
+    @sub_composite_arrays.delete( sub_composite_array )
+    return self
+  end
+
+  #########
+  #  []=  #
+  #########
+
+  def []=( index, element )
+    # we sort internally, so index is irrelevant
+    # no reason to differentiate from push
+    push( element )
+  end
+
+  ########
+  #  <<  #
+  ########
+  
+  def <<( *elements )
+    # no reason to differentiate from push
+    push( *elements )
+  end
+  
+  #######
+  #  +  #
+  #######
+
+  def +( *arrays )
+    # no reason to differentiate from push
+    arrays.each do |this_array|
+      push( *this_array )
+    end
+    return self
+  end
+
+  ############
+  #  concat  #
+  ############
+  
+  def concat( *arrays )
+    arrays.each do |this_array|
+      push( *this_array )
+    end
+  end
+  
+  ##########
+  #  push  #
+  ##########
+  
+  alias_method :super_push, :push
+  def push( *elements )
+
+    # we are a composite array
+    # that means we have to set the value for our class
+    @local_cascading_array.push( *elements )
+        
+    update_adding_composite_elements( *elements )
+    
+    return self
+
+  end
+  
+  #######
+  #  -  #
+  #######
+  
+  def -( *arrays )
+    
+    arrays.each do |this_array|
+      delete( *this_array )
+    end
+    
+    return self
+    
+  end
+
+  ############
+  #  delete  #
+  ############
+  
+  alias_method :super_delete, :delete
+  def delete( *elements )
+  
+    @local_cascading_array.delete( *elements )
+
+    update_removing_composite_elements( *elements )
+    
+    return self
+    
+  end
+
+  #########
+  #  pop  #
+  #########
+  
+  def pop
+
+    element = super
+
+    @local_cascading_array.delete( element )
+
+    update_removing_composite_elements( element )
+    
+    return element
+
+  end
+
+  ###########
+  #  shift  #
+  ###########
+  
+  def shift
+
+    element = super
+
+    @local_cascading_array.delete( element )
+
+    update_removing_composite_elements( element )
+
+    return element
+    
+  end
+
+  ############
+  #  slice!  #
+  ############
+  
+  def slice!( *args )
+
+    elements = super
+
+    @local_cascading_array.delete( *elements )
+
+    update_removing_composite_elements( *elements )
+    
+    return elements
+    
+  end
+  
+  ###########
+  #  clear  #
+  ###########
+  
+  alias_method :super_clear, :clear
+  def clear
+
+    # add all existing values to exclude array
+    @local_cascading_array.delete( *self )
+
+    update_removing_composite_elements( *self )
+
+    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_array.clear
+    @local_cascading_array.exclude_array.clear
+    @local_cascading_array.push( *self )
+    
+    # unregister with parent composite so we don't get future updates from it
+    @super_composite_array.unregister_sub_composite_array( self ) if @super_composite_array
+    
+    return self
+    
+  end
+    
+  ###########################################################################################################
+      private ###############################################################################################
+  ###########################################################################################################
+  
+  ########################################
+  #  update_self_as_cascading_composite  #
+  ########################################
+
+  def update_self_as_cascading_composite
+    # start fresh
+    super_clear
+    # add parent config
+    super_push( *@super_composite_array ) if @super_composite_array
+    # add additional local config
+    super_push( *@local_cascading_array )
+    # remove local exclude
+    super_delete( *@local_cascading_array.exclude_array ) unless @local_cascading_array.exclude_array.empty?
+    # 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 )
+    super_push( *elements_to_cascade )
+    sort!.uniq!
+    update_sub_composite_arrays
+  end
+
+  ########################################
+  #  update_removing_composite_elements  #
+  ########################################
+
+  def update_removing_composite_elements( *elements_to_exclude )
+    elements_to_exclude.each do |this_excluded_element|
+      super_delete( this_excluded_element )
+    end
+    update_sub_composite_arrays
+  end
+
+  ###################################
+  #  update_sub_composite_arrays  #
+  ###################################
+  
+  def update_sub_composite_arrays
+    @sub_composite_arrays.each do |this_composite_array|
+      this_composite_array.instance_eval { update_self_as_cascading_composite }
+    end
+  end
+  
+end