cascading-configuration-array-unique 2.0.0

data/README.md

@@ -0,0 +1,225 @@
+# Cascading Configuration Array #
+
+http://rubygems.org/gems/cascading-configuration-array
+
+# Description #
+
+Adds methods for cascading configuration arrays. Support package for cascading-configuration.
+
+# Summary #
+
+Cascading configuration methods for arrays, which returns the appropriate lowest accumulated value. Configuration inheritance can cascade through modules, classes, and to instances.
+
+This means that we can create configuration modules, optionally setting configuration defaults, and include those configuration modules in other modules or classes.
+
+# Install #
+
+* sudo gem install cascading-configuration
+
+# Usage #
+
+Including the module will enable support for singleton and for instances.
+
+```ruby
+module AnyModuleOrClass
+  include CascadingConfiguration
+end
+```
+
+Extending the module will enable support for singleton only.
+
+```ruby
+module AnyModuleOrClass
+  extend CascadingConfiguration
+end
+```
+
+Including or extending CascadingConfiguration includes or extends:
+
+* CascadingConfiguration::Variable
+
+## :attr_configuration_unique_array ##
+
+:attr_configuration_unique_array provides inheritable array configurations that cascade downward. A composite sorted and unique array will be returned (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_unique_array is kept unique.
+
+Define initial configuration in a module or class:
+
+```ruby
+module SomeModule
+
+  include CascadingConfiguration::Array
+
+  attr_array_configuration :some_array_setting
+
+  some_array_setting # => nil
+
+  some_array_setting.push( :some_value )
+
+  some_array_setting # => [ :some_value ]
+
+end
+```
+
+Include initial module in a module or class:
+
+```ruby
+class SomeClass
+
+  include SomeModule
+
+  some_array_setting # => [ :some_value ]
+
+  self.some_array_setting = [ :some_other_value ]
+
+  some_array_setting # => [ :some_other_value ]
+
+  some_array_setting.push( :another_value ) # => [ :another_value, :some_other_value ]
+
+  SomeModule.some_array_setting # => [ :some_value ]
+
+end
+```
+
+And it cascades to instances:
+
+```ruby
+instance = SomeClass.new
+
+instance.some_array_setting.should == [ :another_value, :some_other_value ]
+
+instance.some_array_setting.delete( :some_other_value )
+
+instance.some_array_setting.should == [ :another_value ]
+```
+
+### :attr_module_configuration_unique_array, :attr_class_configuration_unique_array ###
+
+:attr_class_configuration_unique_array works like :attr_configuration_unique_array but does not cascade to instances.
+
+```ruby
+module SomeModule
+
+  include CascadingConfiguration::Array
+
+  attr_array_configuration :some_array_setting
+
+  some_array_setting # => nil
+
+  some_array_setting.push( :some_value )
+
+  some_array_setting # => [ :some_value ]
+
+end
+```
+
+Include initial module in a module or class:
+
+```ruby
+class SomeClass
+
+  include SomeModule
+
+  some_array_setting # => [ :some_value ]
+
+  self.some_array_setting = [ :some_other_value ]
+
+  some_array_setting # => [ :some_other_value ]
+
+  some_array_setting.push( :another_value ) # => [ :another_value, :some_other_value ]
+
+  SomeModule.some_array_setting # => [ :some_value ]
+
+end
+```
+
+And it does not cascade to instances:
+
+```ruby
+instance = SomeClass.new
+
+instance.respond_to?( :some_array_setting ).should == false
+```
+
+### :attr_local_configuration_unique_array ###
+
+:attr_local_configuration_unique_array works like :attr_configuration_unique_array but does not cascade. This is primarily useful for creating local configurations maintained in parallel with cascading configurations (for instance, with the same variable prefixes), for overriding the local configuration method, and for hiding the configuration variable (coming soon).
+
+```ruby
+module SomeModule
+
+  include CascadingConfiguration::Array
+
+  attr_array_configuration :some_array_setting
+
+  some_array_setting # => nil
+
+  some_array_setting.push( :some_value )
+
+  some_array_setting # => [ :some_value ]
+
+end
+```
+
+Include initial module in a module or class:
+
+```ruby
+class SomeClass
+
+  include SomeModule
+
+  respond_to?( :some_array_setting ).should == false
+
+end
+```
+
+## Additional Functionality ##
+
+Cascading-configuration also provides several other convenience functions. 
+
+### Method Redefinition ###
+
+Any declared configuration is defined in order to support locally redefining the method and accessing the original by calling super.
+
+```ruby
+module SomeModule
+
+  include CascadingConfiguration
+
+  attr_configuration :some_array_setting
+
+  def some_array_setting=( value )
+    puts 'Replacing configuration array!'
+    super
+  end
+
+end
+```
+
+# License #
+
+  (The MIT License)
+
+  Copyright (c) 2011 Asher
+
+  Permission is hereby granted, free of charge, to any person obtaining
+  a copy of this software and associated documentation files (the
+  'Software'), to deal in the Software without restriction, including
+  without limitation the rights to use, copy, modify, merge, publish,
+  distribute, sublicense, and/or sell copies of the Software, and to
+  permit persons to whom the Software is furnished to do so, subject to
+  the following conditions:
+
+  The above copyright notice and this permission notice shall be
+  included in all copies or substantial portions of the Software.
+
+  THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+  CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+  TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+  SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,58 @@
+== Cascading Configuration
+
+http://rubygems.org/gems/cascading-configuration-array
+
+== Description
+
+Adds methods for cascading configuration arrays. Support package for cascading-configuration.
+
+== Summary
+
+Cascading configuration methods for arrays, which returns the appropriate lowest accumulated value. Configuration inheritance can cascade through modules, classes, and to instances.
+
+This means that we can create configuration modules, optionally setting configuration defaults, and include those configuration modules in other modules or classes.
+
+== :attr_configuration_unique_array
+
+:attr_configuration_unique_array provides inheritable array configurations that cascade downward. A composite sorted and unique array will be returned (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_unique_array is kept unique.
+
+:attr_class_configuration_unique_array works like :attr_configuration_unique_array but does not cascade to instances.
+
+:attr_local_configuration_unique_array works like :attr_configuration_unique_array but does not cascade. This is primarily useful for creating local configurations maintained in parallel with cascading configurations (for instance, with the same variable prefixes), for overriding the local configuration method, and for hiding the configuration variable (coming soon).
+
+== Install
+
+* sudo gem install cascading-configuration
+
+== Usage
+
+See README.md
+
+== License
+
+  (The MIT License)
+
+  Copyright (c) 2011 Asher
+
+  Permission is hereby granted, free of charge, to any person obtaining
+  a copy of this software and associated documentation files (the
+  'Software'), to deal in the Software without restriction, including
+  without limitation the rights to use, copy, modify, merge, publish,
+  distribute, sublicense, and/or sell copies of the Software, and to
+  permit persons to whom the Software is furnished to do so, subject to
+  the following conditions:
+
+  The above copyright notice and this permission notice shall be
+  included in all copies or substantial portions of the Software.
+
+  THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+  CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+  TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+  SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/cascading-configuration-array-unique.rb

@@ -0,0 +1,28 @@
+
+if $__cascading_configuration__spec__development
+  require_relative '../../settings-array/lib/cascading-configuration-array.rb'
+else
+  require 'cascading-configuration-variable'
+end
+
+module CascadingConfiguration
+  module Array
+    module Unique
+      class CompositingArray < ::CascadingConfiguration::Array::CompositingArray
+      end
+      module ModuleSupportMethods
+      end
+      module Interface
+        module GettersSetters
+        end
+      end
+    end
+  end
+end
+
+require_relative 'cascading-configuration-array-unique/_private_/CascadingConfiguration/Array/Unique/CompositingArray.rb'
+require_relative 'cascading-configuration-array-unique/_private_/CascadingConfiguration/Array/Unique/Interface/GettersSetters.rb'
+require_relative 'cascading-configuration-array-unique/_private_/CascadingConfiguration/Array/Unique/ModuleSupportMethods.rb'
+
+require_relative 'cascading-configuration-array-unique/CascadingConfiguration/Array/Unique/Interface.rb'
+require_relative 'cascading-configuration-array-unique/CascadingConfiguration/Array/Unique.rb'

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

@@ -0,0 +1,12 @@
+
+module ::CascadingConfiguration::Array::Unique
+  
+  # Configuration modules for storage of settings arrays
+  include ::CascadingConfiguration::Variable
+  
+  # Interface to declare configuration settings arrays
+  include ::CascadingConfiguration::Array::Unique::Interface
+
+  extend ::CascadingConfiguration::Array::Unique::ModuleSupportMethods
+  
+end

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

@@ -0,0 +1,107 @@
+
+module ::CascadingConfiguration::Array::Unique::Interface
+
+  # Support methods that define configuration settings array methods
+  include ::CascadingConfiguration::Array::Unique::Interface::GettersSetters
+  
+  #####################################
+  #  attr_configuration_unique_array  #
+  #####################################
+
+  # defines configuration in class or module
+  # configuration cascades downward to instance including all classes or modules in-between
+  def attr_configuration_unique_array( *configuration_names )
+
+    configuration_names.each do |this_configuration_name|
+      # define configuration setter
+      define_cascading_unique_array_setter( this_configuration_name )
+      # define configuration getter
+      define_cascading_unique_array_getter( this_configuration_name )
+    end
+
+    return self
+
+  end
+
+  ############################################
+  #  attr_module_configuration_unique_array  #
+  ############################################
+
+  # defines configuration in class or module
+  # configuration cascades downward to last class or module
+  def attr_module_configuration_unique_array( *configuration_names )
+
+    configuration_names.each do |this_configuration_name|
+      # define configuration setter
+      define_class_configuration_unique_array_setter( this_configuration_name )
+      # define configuration getter
+      define_class_configuration_unique_array_getter( this_configuration_name )
+    end
+
+    return self
+
+  end
+  alias_method :attr_class_configuration_unique_array, :attr_module_configuration_unique_array
+
+  ###########################################
+  #  attr_local_configuration_unique_array  #
+  ###########################################
+
+  # defines configuration in present class or module context
+  # configuration does not cascade
+  def attr_local_configuration_unique_array( *configuration_names )
+
+    ::CascadingConfiguration::Variable.create_local_instance_configuration_support_module( self )
+
+    configuration_names.each do |this_configuration_name|
+      # define configuration setter
+      define_local_configuration_unique_array_setter( this_configuration_name )
+      # define configuration getter
+      define_local_configuration_unique_array_getter( this_configuration_name )
+    end
+
+    return self
+
+  end
+
+  ############################################
+  #  attr_object_configuration_unique_array  #
+  ############################################
+
+  # defines configuration in present instance
+  # configuration does not cascade
+  def attr_object_configuration_unique_array( *configuration_names )
+
+    ::CascadingConfiguration::Variable.create_local_instance_configuration_support_module( self )
+
+    configuration_names.each do |this_configuration_name|
+      # define configuration setter
+      define_object_configuration_unique_array_setter( this_configuration_name )
+      # define configuration getter
+      define_object_configuration_unique_array_getter( this_configuration_name )
+    end
+
+    return self
+
+  end
+
+  ##############################################
+  #  attr_instance_configuration_unique_array  #
+  ##############################################
+
+  # defines configuration in present class or module context
+  # configuration does not cascade
+  def attr_instance_configuration_unique_array( *configuration_names )
+
+    configuration_names.each do |this_configuration_name|
+      # define configuration setter
+      define_instance_configuration_unique_array_setter( this_configuration_name )
+      # define configuration getter
+      define_instance_configuration_unique_array_getter( this_configuration_name )
+    end
+
+    return self
+
+  end
+
+end

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

@@ -0,0 +1,166 @@
+
+class ::CascadingConfiguration::Array::Unique::CompositingArray < 
+      ::CascadingConfiguration::Array::CompositingArray
+
+  ################
+  #  initialize  #
+  ################
+  
+  def initialize( configuration_instance, configuration_name )
+
+    @unique_keys = { }
+    
+    super
+    
+  end
+
+  #####################################  Self Management  ##########################################
+
+  #########
+  #  []=  #
+  #########
+
+  def []=( index, object )
+
+    # we only set if we don't already have the object being inserted
+    # for this reason we return nil if no insert occurred
+
+    return_value = nil
+
+    # make sure that set is unique
+    unless @unique_keys.has_key?( object )
+
+      @unique_keys[ object ] = true
+
+      return_value = super
+
+    end
+    
+    return return_value
+    
+  end
+  
+  ############
+  #  insert  #
+  ############
+  
+  def insert( index, *objects )
+
+    # we only insert if we don't already have the object being inserted
+    # for this reason we return nil if no insert occurred
+
+    # if we have less elements in self than the index we are inserting at
+    # we need to make sure the nils inserted cascade
+    if index > count
+      if @unique_keys.has_key?( nil )
+        index -= ( index - count + 1 )
+      else
+        objects.unshift( nil )
+        index -= ( index - count )
+      end
+    end
+    
+    # get rid of objects already inserted
+    indexes_to_delete = [ ]
+    objects.each_with_index do |this_object, index|
+      if @unique_keys.has_key?( this_object )
+        indexes_to_delete.push( index )
+      else
+        @unique_keys[ this_object ] = true
+      end
+    end
+    indexes_to_delete.sort.reverse.each do |this_index|
+      objects.delete_at( this_index )
+    end
+
+    return nil if objects.empty?
+
+    return super
+    
+  end
+  
+  ##############
+  #  collect!  #
+  #  map!      #
+  ##############
+
+  def collect!
+    
+    return to_enum unless block_given?
+    
+    delete_indexes = [ ]
+    self.each_with_index do |this_object, index|
+      replacement_object = yield( this_object )
+      if @unique_keys.has_key?( replacement_object ) and replacement_object != this_object
+        delete_indexes.push( index )
+      else
+        self[ index ] = replacement_object
+      end
+    end
+    
+    delete_indexes.sort.reverse.each do |this_index|
+      delete_at( this_index )
+    end
+    
+    return self
+    
+  end
+  alias_method :map!, :collect!
+
+  ##################################################################################################
+      private ######################################################################################
+  ##################################################################################################
+
+  #############################
+  #  non_cascading_delete_at  #
+  #############################
+
+  def non_cascading_delete_at( index )
+    
+    object = super
+    
+    @unique_keys.delete( object )
+    
+    return object
+    
+  end
+
+  #########################  Self-as-Sub Management for Parent Updates  ############################
+	
+  ########################################
+  #  update_as_sub_array_for_parent_set  #
+  ########################################
+  
+  def update_as_sub_array_for_parent_set( index, object )
+    
+    super unless @unique_keys.has_key?( object )
+    
+  end
+
+  ###########################################
+  #  update_as_sub_array_for_parent_insert  #
+  ###########################################
+
+  def update_as_sub_array_for_parent_insert( index, *objects )
+    
+    # new parent indexes have been inserted at index in parent
+    
+    # get rid of objects already inserted
+    indexes_to_delete = [ ]
+    objects.each_with_index do |this_object, index|
+      if @unique_keys.has_key?( this_object )
+        indexes_to_delete.push( index )
+      else
+        @unique_keys[ this_object ] = true
+      end
+    end
+    indexes_to_delete.sort.reverse.each do |this_index|
+      objects.delete_at( this_index )
+    end
+    return false if objects.empty?
+
+    super
+
+  end
+  
+end