cascading-configuration-array 1.1.4 → 1.1.5

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

@@ -0,0 +1,216 @@
+
+class CascadingConfiguration::CompositingArray < Array
+
+  attr_accessor  :working_instance, :local_cascading_array
+
+  ################
+  #  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_array_for_cascading_configuration )
+      @parent_composite_array = first_ancestor.composite_array_for_cascading_configuration( @cascading_name )
+      @parent_composite_array.register_child_composite_array( self )
+    end
+    # get local cascading array (not included in parent composite)
+    @local_cascading_array = ::CascadingConfiguration::LocalConfigurationArray.new
+    # we may later have our own child composites
+    @child_composite_arrays = ::Array.new
+    # initialize self status for parent and local
+    update_self_as_cascading_composite
+  end
+
+  ####################################
+  #  register_child_composite_array  #
+  ####################################
+
+  def register_child_composite_array( child_composite_array )
+    @child_composite_arrays.push( child_composite_array )
+    return self
+  end
+
+  ######################################
+  #  unregister_child_composite_array  #
+  ######################################
+
+  def unregister_child_composite_array( child_composite_array )
+    @child_composite_arrays.delete( child_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
+    @parent_composite_array.unregister_child_composite_array( self ) if @parent_composite_array
+    
+    return self
+    
+  end
+    
+end

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

@@ -0,0 +1,166 @@
+
+class CascadingConfiguration::LocalConfigurationArray < Array
+
+  attr_accessor  :exclude_array
+  
+  ################
+  #  initialize  #
+  ################
+
+  def initialize()
+    @exclude_array = ::Array.new
+  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 +( *element_arrays )
+    element_arrays.each do |this_element_array|
+      push( *this_element_array )
+    end
+    return self
+  end
+
+  ##########
+  #  push  #
+  ##########
+  
+  def push( *elements )
+    
+    # add elements to configuration array
+    super
+
+    # sort and uniq self
+    sort!.uniq!
+    
+    # make sure we don't still have any elements noted as excluded at this level
+    remove_from_exclude_array( *elements )
+
+    return self
+    
+  end
+  
+  ############
+  #  concat  #
+  ############
+  
+  def concat( *arrays )
+
+    arrays.each do |this_array|
+      push( *this_array )
+    end
+
+    return self
+
+  end
+  
+  #######
+  #  -  #
+  #######
+  
+  def -( *arrays )
+
+    arrays.each do |this_array|
+      delete( *this_array )
+    end
+
+    return self
+  
+  end
+
+  ############
+  #  delete  #
+  ############
+  
+  def delete( *elements )
+
+    elements.each do |this_element|
+      super( this_element )
+    end
+    # add subtracted elements to exclude array
+    add_to_exclude_array( *elements )
+
+    return self
+  
+  end
+
+  #########
+  #  pop  #
+  #########
+  
+  def pop
+    
+    element = super
+    
+    # add popped element to exclude array
+    add_to_exclude_array( element )
+    
+    return element
+  
+  end
+
+  ###########
+  #  shift  #
+  ###########
+  
+  def shift
+
+    element = super
+
+    # add shifted element to exclude array
+    add_to_exclude_array( element )
+
+    return element
+
+  end
+
+  ############
+  #  slice!  #
+  ############
+  
+  def slice!( *args )
+
+    elements = super
+
+    # add sliced elements to exclude array
+    delete( *elements )
+
+    return elements
+
+  end
+  
+  ###########
+  #  clear  #
+  ###########
+  
+  def clear
+
+    # add all existing values to exclude array
+    delete( *self )
+
+    # clear existing values
+    super
+
+  end
+  
+end

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

@@ -0,0 +1,57 @@
+
+class CascadingConfiguration::CompositingArray < Array
+  
+  ###########################################################################################################
+      private ###############################################################################################
+  ###########################################################################################################
+  
+  ########################################
+  #  update_self_as_cascading_composite  #
+  ########################################
+
+  def update_self_as_cascading_composite
+    # start fresh
+    super_clear
+    # add parent config
+    super_push( *@parent_composite_array ) if @parent_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_child_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_child_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_child_composite_arrays
+  end
+
+  ###################################
+  #  update_child_composite_arrays  #
+  ###################################
+  
+  def update_child_composite_arrays
+    @child_composite_arrays.each do |this_composite_array|
+      this_composite_array.instance_eval { update_self_as_cascading_composite }
+    end
+  end
+  
+end

data/lib/cascading-configuration-array/CascadingConfiguration/_private_/LocalConfigurationArray.rb

@@ -0,0 +1,26 @@
+
+class CascadingConfiguration::LocalConfigurationArray < Array
+
+  ###########################################################################################################
+      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.rb

@@ -0,0 +1,35 @@
+
+if $cascading_configuration_development
+	require_relative '../../variable/lib/cascading-configuration-variable.rb'
+else
+	require 'cascading-configuration-variable'
+end
+
+module CascadingConfiguration
+  class CompositingArray < Array
+    module Instance
+    end
+  end
+  class LocalConfigurationArray < Array
+  end
+  module Array
+    module Accessors
+    end
+    module ClassInstance
+    end
+    module ObjectInstance
+    end
+    module ModuleInstance
+    end
+  end
+end
+
+require_relative 'cascading-configuration-array/CascadingConfiguration/CompositingArray.rb'
+require_relative 'cascading-configuration-array/CascadingConfiguration/_private_/CompositingArray.rb'
+require_relative 'cascading-configuration-array/CascadingConfiguration/CompositingArray/Instance.rb'
+require_relative 'cascading-configuration-array/CascadingConfiguration/LocalConfigurationArray.rb'
+require_relative 'cascading-configuration-array/CascadingConfiguration/_private_/LocalConfigurationArray.rb'
+require_relative 'cascading-configuration-array/CascadingConfiguration/Array.rb'
+require_relative 'cascading-configuration-array/CascadingConfiguration/Array/Accessors.rb'
+require_relative 'cascading-configuration-array/CascadingConfiguration/Array/ClassInstance.rb'
+require_relative 'cascading-configuration-array/CascadingConfiguration/Array/ModuleInstance.rb'

data/spec/CascadingConfiguration/Array/Accessors_spec.rb

@@ -0,0 +1,28 @@
+
+require_relative '../../../lib/cascading-configuration-array.rb'
+
+describe CascadingConfiguration::Array::Accessors do
+
+  ###################################
+  #  define_cascading_array_setter  #
+  #  define_cascading_array_getter  #
+  ###################################
+
+  it 'can define a method to get and modify the configuration array' do
+    class CascadingConfiguration::Array::Mock
+      include CascadingConfiguration::Variable
+      extend  CascadingConfiguration::Array::Accessors
+      include CascadingConfiguration::Array::ObjectInstance
+      extend  CascadingConfiguration::Array::ClassInstance
+    end
+    # setter
+    CascadingConfiguration::Array::Mock.define_cascading_array_setter( :some_configuration )
+    CascadingConfiguration::Array::Mock.methods.include?( :some_configuration= ).should == true
+    CascadingConfiguration::Array::Mock.instance_methods.include?( :some_configuration= ).should == true
+    # getter
+    CascadingConfiguration::Array::Mock.define_cascading_array_getter( :some_configuration )
+    CascadingConfiguration::Array::Mock.methods.include?( :some_configuration ).should == true
+    CascadingConfiguration::Array::Mock.instance_methods.include?( :some_configuration ).should == true
+  end
+
+end

data/spec/CascadingConfiguration/Array_spec.rb

@@ -0,0 +1,90 @@
+
+require_relative '../../lib/cascading-configuration-array.rb'
+
+describe CascadingConfiguration::Array do
+  
+  ##############################
+  #  attr_configuration_array  #
+  ##############################
+  
+  it 'can define a configuration array, which is the primary interface' do
+
+    module CascadingConfiguration::Array::MockModule
+      include CascadingConfiguration::Array
+      attr_configuration_array :configuration_setting
+      configuration_setting.should == []
+      configuration_setting.push( :a_configuration )
+      configuration_setting.should == [ :a_configuration ]
+    end
+
+    module CascadingConfiguration::Array::MockModule2
+      include CascadingConfiguration::Array::MockModule
+      configuration_setting.should == [ :a_configuration ]
+      configuration_setting.push( :another_configuration )
+      configuration_setting.should == [ :a_configuration, :another_configuration ]
+    end
+    
+    module CascadingConfiguration::Array::MockModule3
+      include CascadingConfiguration::Array::MockModule2
+      configuration_setting.should == [ :a_configuration, :another_configuration ]
+    end
+    
+    class CascadingConfiguration::Array::MockClass
+      include CascadingConfiguration::Array::MockModule3
+      configuration_setting.should == [ :a_configuration, :another_configuration ]
+      configuration_setting.delete( :another_configuration )
+      configuration_setting.should == [ :a_configuration ]
+    end
+
+    object_instance_one = CascadingConfiguration::Array::MockClass.new
+    object_instance_one.configuration_setting.should == [ :a_configuration ]
+    object_instance_one.configuration_setting.push( :some_other_configuration )
+    object_instance_one.configuration_setting.should == [ :a_configuration, :some_other_configuration ]
+    
+    class CascadingConfiguration::Array::MockClassSub1 < CascadingConfiguration::Array::MockClass
+      configuration_setting.should == [ :a_configuration ]
+      configuration_setting.push( :another_configuration)
+      configuration_setting.should == [ :a_configuration, :another_configuration ]
+    end
+
+    object_instance_two = CascadingConfiguration::Array::MockClassSub1.new
+    object_instance_two.configuration_setting.should == [ :a_configuration, :another_configuration ]
+    object_instance_two.configuration_setting.push( :some_other_configuration )
+    object_instance_two.configuration_setting.should == [ :a_configuration, :another_configuration, :some_other_configuration ]
+
+    # change ancestor setting
+    CascadingConfiguration::Array::MockClass.configuration_setting.push( :a_yet_unused_configuration )
+    CascadingConfiguration::Array::MockClass.configuration_setting.should == [ :a_configuration, :a_yet_unused_configuration ]
+    object_instance_one.configuration_setting.should == [ :a_configuration, :a_yet_unused_configuration, :some_other_configuration ]
+    CascadingConfiguration::Array::MockClassSub1.configuration_setting.should == [ :a_configuration, :a_yet_unused_configuration, :another_configuration ]
+    object_instance_two.configuration_setting.should == [ :a_configuration, :a_yet_unused_configuration, :another_configuration, :some_other_configuration ]
+    
+    # freeze ancestor setting
+    object_instance_one.configuration_setting.freeze!
+    object_instance_one.configuration_setting.should == [ :a_configuration, :a_yet_unused_configuration, :some_other_configuration ]
+    CascadingConfiguration::Array::MockClassSub1.configuration_setting.freeze!
+    CascadingConfiguration::Array::MockClassSub1.configuration_setting.should == [ :a_configuration, :a_yet_unused_configuration, :another_configuration ]
+    CascadingConfiguration::Array::MockClass.configuration_setting.push( :non_cascading_configuration )
+    CascadingConfiguration::Array::MockClass.configuration_setting.should == [ :a_configuration, :a_yet_unused_configuration, :non_cascading_configuration ]
+    object_instance_one.configuration_setting.should == [ :a_configuration, :a_yet_unused_configuration, :some_other_configuration ]
+    CascadingConfiguration::Array::MockClassSub1.configuration_setting.should == [ :a_configuration, :a_yet_unused_configuration, :another_configuration ]
+    object_instance_two.configuration_setting.should == [ :a_configuration, :a_yet_unused_configuration, :another_configuration, :some_other_configuration ]
+    
+    # test two
+    
+    module CascadingConfiguration::Array::MockModuleExtended
+      include CascadingConfiguration::Array
+      attr_configuration_array :configuration_setting
+      configuration_setting.should == []
+      configuration_setting.push( :a_configuration )
+      configuration_setting.should == [ :a_configuration ]
+    end
+
+    class CascadingConfiguration::Array::MockClassExtended
+      extend CascadingConfiguration::Array::MockModuleExtended
+      configuration_setting.should == [ :a_configuration ]
+    end
+    
+  end
+  
+end