array-hooked 1.0.0

data/lib/array/namespaces.rb

@@ -0,0 +1,6 @@
+
+class ::Array::Hooked < ::Array
+end
+
+class ::HookedArray < ::Array::Hooked
+end

data/lib/array/requires.rb

@@ -0,0 +1,27 @@
+
+basepath = 'hooked'
+
+files = [
+  
+  'array_interface'
+  
+]
+
+second_basepath = '../hooked_array'
+
+second_files = [
+    
+  'array_interface'
+    
+]
+
+
+files.each do |this_file|
+  require_relative( File.join( basepath, this_file ) + '.rb' )
+end
+second_files.each do |this_file|
+  require_relative( File.join( second_basepath, this_file ) + '.rb' )
+end
+
+require_relative( basepath + '.rb' )
+require_relative( second_basepath + '.rb' )

data/lib/hooked/array.rb

@@ -0,0 +1,2 @@
+
+require_relative '../array-hooked.rb'

data/lib/hooked_array.rb

@@ -0,0 +1,6 @@
+
+class ::HookedArray < ::Array::Hooked
+
+  include ::HookedArray::Interface
+  
+end

data/lib/hooked_array/array_interface.rb

@@ -0,0 +1,29 @@
+
+module ::HookedArray::Interface
+
+  instances_identify_as!( ::HookedArray )
+  
+  ################
+  #  initialize  #
+  ################
+
+  # Initialize with reference a configuration instance.
+  # @param [Object] object Object that HookedArray instance is attached to, primarily useful for
+  #  reference from hooks.
+  # @param [Array<Object>] args Parameters passed through super to Array#initialize.
+  # @return [true,false] Whether receiver identifies as object.
+  def initialize( configuration_instance = nil, *args )
+    
+    @configuration_instance = configuration_instance
+
+    super( *args )
+        
+  end
+
+  ############################
+  #  configuration_instance  #
+  ############################
+
+  attr_accessor :configuration_instance
+  
+end

data/spec/array/hooked_spec.rb

@@ -0,0 +1,758 @@
+
+require_relative '../../lib/array-hooked.rb'
+
+describe ::Array::Hooked do
+
+  ################
+  #  initialize  #
+  ################
+
+  it 'can add initialize with an ancestor, inheriting its values and linking to it as a child' do
+  
+    hooked_array = ::Array::Hooked.new
+
+    hooked_array.instance_variable_get( :@parent_composite_object ).should == nil
+    hooked_array.should == [ ]
+    hooked_array.push( :A, :B, :C, :D )
+
+  end
+  
+  #########
+  #  []=  #
+  #########
+
+  it 'can add elements' do
+  
+    hooked_array = ::Array::Hooked.new
+
+    hooked_array[ 0 ] = :A
+    hooked_array.should == [ :A ]
+
+    hooked_array[ 1 ] = :B
+    hooked_array.should == [ :A, :B ]
+
+    hooked_array[ 0 ] = :D
+    hooked_array.should == [ :D, :B ]
+
+  end
+
+  ############
+  #  insert  #
+  ############
+
+  it 'can insert elements' do
+  
+    hooked_array = ::Array::Hooked.new
+
+    hooked_array.insert( 3, :D )
+    hooked_array.should == [ nil, nil, nil, :D ]
+
+    hooked_array.insert( 1, :B )
+    hooked_array.should == [ nil, :B, nil, nil, :D ]
+
+    hooked_array.insert( 2, :C )
+    hooked_array.should == [ nil, :B, :C, nil, nil, :D ]
+
+  end
+
+  ##########
+  #  push  #
+  #  <<    #
+  ##########
+  
+  it 'can add elements' do
+
+    hooked_array = ::Array::Hooked.new
+
+    hooked_array << :A
+    hooked_array.should == [ :A ]
+
+    hooked_array << :B
+    hooked_array.should == [ :A, :B ]
+
+  end
+  
+  ############
+  #  concat  #
+  #  +       #
+  ############
+
+  it 'can add elements' do
+
+    # NOTE: this breaks + by causing it to modify the array like +=
+    # The alternative was worse.
+
+    hooked_array = ::Array::Hooked.new
+
+    hooked_array.concat( [ :A ] )
+    hooked_array.should == [ :A ]
+
+    hooked_array += [ :B ]
+    hooked_array.should == [ :A, :B ]
+
+  end
+
+  ####################
+  #  delete_objects  #
+  ####################
+
+  it 'can delete multiple elements' do
+
+    hooked_array = ::Array::Hooked.new
+
+    hooked_array += [ :A, :B ]
+    hooked_array.should == [ :A, :B ]
+
+    hooked_array.delete_objects( :A, :B )
+    hooked_array.should == [ ]
+
+  end
+
+  #######
+  #  -  #
+  #######
+  
+  it 'can exclude elements' do
+
+    hooked_array = ::Array::Hooked.new
+
+    hooked_array.push( :A )
+    hooked_array.should == [ :A ]
+
+    hooked_array -= [ :A ]
+    hooked_array.should == [ ]
+
+    hooked_array.push( :B )
+    hooked_array.should == [ :B ]
+
+  end
+
+  ############
+  #  delete  #
+  ############
+  
+  it 'can delete elements' do
+
+    hooked_array = ::Array::Hooked.new
+
+    hooked_array.push( :A )
+    hooked_array.should == [ :A ]
+
+    hooked_array.delete( :A )
+    hooked_array.should == [ ]
+
+    hooked_array.push( :B )
+    hooked_array.should == [ :B ]
+
+  end
+
+  ###############
+  #  delete_at  #
+  ###############
+
+  it 'can delete by indexes' do
+
+    hooked_array = ::Array::Hooked.new
+
+    hooked_array.push( :A )
+    hooked_array.should == [ :A ]
+    
+    hooked_array.delete_at( 0 )
+    hooked_array.should == [ ]
+
+    hooked_array.push( :B )
+    hooked_array.should == [ :B ]
+
+  end
+
+  #######################
+  #  delete_at_indexes  #
+  #######################
+
+  it 'can delete by indexes' do
+
+    hooked_array = ::Array::Hooked.new
+
+    hooked_array.push( :A, :B, :C )
+    hooked_array.should == [ :A, :B, :C ]
+
+    hooked_array.delete_at_indexes( 0, 1 )
+    hooked_array.should == [ :C ]
+
+  end
+
+  ###############
+  #  delete_if  #
+  ###############
+
+  it 'can delete by block' do
+
+    hooked_array = ::Array::Hooked.new
+
+    hooked_array.push( :A, :B, :C )
+    hooked_array.should == [ :A, :B, :C ]
+    hooked_array.delete_if do |object|
+      object != :C
+    end
+    hooked_array.should == [ :C ]
+
+    hooked_array.delete_if.is_a?( Enumerator ).should == true
+
+  end
+
+  #############
+  #  keep_if  #
+  #############
+
+  it 'can keep by block' do
+
+    hooked_array = ::Array::Hooked.new
+
+    hooked_array.push( :A, :B, :C )
+    hooked_array.should == [ :A, :B, :C ]
+    hooked_array.keep_if do |object|
+      object == :C
+    end
+    hooked_array.should == [ :C ]
+
+  end
+
+  ##############
+  #  compact!  #
+  ##############
+
+  it 'can compact' do
+
+    hooked_array = ::Array::Hooked.new
+
+    hooked_array.push( :A, nil, :B, nil, :C, nil )
+    hooked_array.should == [ :A, nil, :B, nil, :C, nil ]
+    hooked_array.compact!
+    hooked_array.should == [ :A, :B, :C ]
+
+  end
+
+  ##############
+  #  flatten!  #
+  ##############
+
+  it 'can flatten' do
+
+    hooked_array = ::Array::Hooked.new
+
+    hooked_array.push( :A, [ :F_A, :F_B ], :B, [ :F_C ], :C, [ :F_D ], [ :F_E ] )
+    hooked_array.should == [ :A, [ :F_A, :F_B ], :B, [ :F_C ], :C, [ :F_D ], [ :F_E ] ]
+    hooked_array.flatten!
+    hooked_array.should == [ :A, :F_A, :F_B, :B, :F_C, :C, :F_D, :F_E ]
+
+  end
+
+  #############
+  #  reject!  #
+  #############
+
+  it 'can reject' do
+
+    hooked_array = ::Array::Hooked.new
+
+    hooked_array.push( :A, :B, :C )
+    hooked_array.should == [ :A, :B, :C ]
+    hooked_array.reject! do |object|
+      object != :C
+    end
+    hooked_array.should == [ :C ]
+
+  end
+
+  #############
+  #  replace  #
+  #############
+
+  it 'can replace self' do
+
+    hooked_array = ::Array::Hooked.new
+
+    hooked_array.push( :A, :B, :C )
+    hooked_array.should == [ :A, :B, :C ]
+    hooked_array.replace( [ :D, :E, :F ] )
+    hooked_array.should == [ :D, :E, :F ]
+
+  end
+
+  ##############
+  #  reverse!  #
+  ##############
+
+  it 'can reverse self' do
+
+    hooked_array = ::Array::Hooked.new
+
+    hooked_array.push( :A, :B, :C )
+    hooked_array.should == [ :A, :B, :C ]
+    hooked_array.reverse!
+    hooked_array.should == [ :C, :B, :A ]
+
+  end
+
+  #############
+  #  rotate!  #
+  #############
+
+  it 'can rotate self' do
+
+    hooked_array = ::Array::Hooked.new
+
+    hooked_array.push( :A, :B, :C )
+    hooked_array.should == [ :A, :B, :C ]
+
+    hooked_array.rotate!
+    hooked_array.should == [ :B, :C, :A ]
+
+    hooked_array.rotate!( -1 )
+    hooked_array.should == [ :A, :B, :C ]
+
+  end
+
+  #############
+  #  select!  #
+  #############
+
+  it 'can keep by select' do
+
+    hooked_array = ::Array::Hooked.new
+
+    hooked_array.push( :A, :B, :C )
+    hooked_array.should == [ :A, :B, :C ]
+    hooked_array.select! do |object|
+      object == :C
+    end
+    hooked_array.should == [ :C ]
+
+    hooked_array.select!.is_a?( Enumerator ).should == true
+
+  end
+
+  ##############
+  #  shuffle!  #
+  ##############
+
+  it 'can shuffle self' do
+
+    hooked_array = ::Array::Hooked.new
+
+    hooked_array.push( :A, :B, :C )
+    hooked_array.should == [ :A, :B, :C ]
+
+    prior_version = hooked_array.dup
+    attempts = [ ]
+    50.times do
+      hooked_array.shuffle!
+      attempts.push( hooked_array == prior_version )
+      prior_version = hooked_array.dup
+    end
+    attempts_correct = attempts.select { |member| member == false }.count
+    ( attempts_correct >= 10 ).should == true
+    first_shuffle_version = hooked_array
+
+  end
+
+  ##############
+  #  collect!  #
+  #  map!      #
+  ##############
+
+  it 'can replace by collect/map' do
+
+    hooked_array = ::Array::Hooked.new
+
+    hooked_array.push( :A, :B, :C )
+    hooked_array.should == [ :A, :B, :C ]
+    hooked_array.collect! do |object|
+      :C
+    end
+    hooked_array.should == [ :C, :C, :C ]
+
+    hooked_array.collect!.is_a?( Enumerator ).should == true
+
+  end
+
+  ###########
+  #  sort!  #
+  ###########
+
+  it 'can replace by collect/map' do
+
+    hooked_array = ::Array::Hooked.new
+
+    hooked_array.push( :A, :B, :C )
+    hooked_array.should == [ :A, :B, :C ]
+    hooked_array.sort! do |a, b|
+      if a < b
+        1
+      elsif a > b
+        -1
+      elsif a == b
+        0
+      end
+    end
+    hooked_array.should == [ :C, :B, :A ]
+
+    hooked_array.sort!
+    hooked_array.should == [ :A, :B, :C ]
+
+  end
+
+  ##############
+  #  sort_by!  #
+  ##############
+
+  it 'can replace by collect/map' do
+
+    hooked_array = ::Array::Hooked.new
+
+    hooked_array.push( :A, :B, :C )
+    hooked_array.should == [ :A, :B, :C ]
+    hooked_array.sort_by! do |object|
+      case object
+      when :A
+        :B
+      when :B
+        :A
+      when :C
+        :C
+      end
+    end
+    hooked_array.should == [ :B, :A, :C ]
+
+    hooked_array.sort_by!.is_a?( Enumerator ).should == true
+
+  end
+
+  ###########
+  #  uniq!  #
+  ###########
+
+  it 'can remove non-unique elements' do
+
+    hooked_array = ::Array::Hooked.new
+
+    hooked_array.push( :A, :B, :C, :C, :C, :B, :A )
+    hooked_array.should == [ :A, :B, :C, :C, :C, :B, :A ]
+    hooked_array.uniq!
+    hooked_array.should == [ :A, :B, :C ]
+
+  end
+
+  #############
+  #  unshift  #
+  #############
+
+  it 'can unshift onto the first element' do
+
+    hooked_array = ::Array::Hooked.new
+
+    hooked_array += :A
+    hooked_array.should == [ :A ]
+
+    hooked_array.unshift( :B )
+    hooked_array.should == [ :B, :A ]
+
+  end
+
+  #########
+  #  pop  #
+  #########
+  
+  it 'can pop the final element' do
+
+    hooked_array = ::Array::Hooked.new
+
+    hooked_array += :A
+    hooked_array.should == [ :A ]
+
+    hooked_array.pop.should == :A
+    hooked_array.should == [ ]
+
+    hooked_array += :B
+    hooked_array.should == [ :B ]
+
+  end
+
+  ###########
+  #  shift  #
+  ###########
+  
+  it 'can shift the first element' do
+
+    hooked_array = ::Array::Hooked.new
+
+    hooked_array += :A
+    hooked_array.should == [ :A ]
+
+    hooked_array.shift.should == :A
+    hooked_array.should == [ ]
+
+    hooked_array += :B
+    hooked_array.should == [ :B ]
+
+  end
+
+  ############
+  #  slice!  #
+  ############
+  
+  it 'can slice elements' do
+
+    hooked_array = ::Array::Hooked.new
+
+    hooked_array += :A
+    hooked_array.should == [ :A ]
+
+    hooked_array.slice!( 0, 1 ).should == [ :A ]
+    hooked_array.should == [ ]
+
+    hooked_array += :B
+    hooked_array.should == [ :B ]
+
+  end
+  
+  ###########
+  #  clear  #
+  ###########
+
+  it 'can clear, causing present elements to be excluded' do
+
+    hooked_array = ::Array::Hooked.new
+
+    hooked_array += :A
+    hooked_array.should == [ :A ]
+
+    hooked_array.clear
+    hooked_array.should == [ ]
+
+    hooked_array += :B
+    hooked_array.should == [ :B ]
+
+  end
+
+  ##################
+  #  pre_set_hook  #
+  ##################
+
+  it 'has a hook that is called before setting a value; return value is used in place of object' do
+    
+    class ::Array::Hooked::SubMockPreSet < ::Array::Hooked
+      
+      def pre_set_hook( index, object, is_insert = false )
+        return :some_other_value
+      end
+      
+    end
+    
+    hooked_array = ::Array::Hooked::SubMockPreSet.new
+
+    hooked_array.push( :some_value )
+    
+    hooked_array.should == [ :some_other_value ]
+    
+  end
+
+  ###################
+  #  post_set_hook  #
+  ###################
+
+  it 'has a hook that is called after setting a value' do
+
+    class ::Array::Hooked::SubMockPostSet < ::Array::Hooked
+      
+      def post_set_hook( index, object, is_insert = false )
+        return :some_other_value
+      end
+      
+    end
+    
+    hooked_array = ::Array::Hooked::SubMockPostSet.new
+
+    hooked_array.push( :some_value ).should == [ :some_other_value ]
+    
+    hooked_array.should == [ :some_value ]
+    
+  end
+
+  ##################
+  #  pre_get_hook  #
+  ##################
+
+  it 'has a hook that is called before getting a value; if return value is false, get does not occur' do
+    
+    class ::Array::Hooked::SubMockPreGet < ::Array::Hooked
+      
+      def pre_get_hook( index )
+        return false
+      end
+      
+    end
+    
+    hooked_array = ::Array::Hooked::SubMockPreGet.new
+    
+    hooked_array.push( :some_value )
+    hooked_array[ 0 ].should == nil
+    
+    hooked_array.should == [ :some_value ]
+    
+  end
+
+  ###################
+  #  post_get_hook  #
+  ###################
+
+  it 'has a hook that is called after getting a value' do
+
+    class ::Array::Hooked::SubMockPostGet < ::Array::Hooked
+      
+      def post_get_hook( index, object )
+        return :some_other_value
+      end
+      
+    end
+    
+    hooked_array = ::Array::Hooked::SubMockPostGet.new
+    
+    hooked_array.push( :some_value )
+    hooked_array[ 0 ].should == :some_other_value
+    
+    hooked_array.should == [ :some_value ]
+    
+  end
+
+  #####################
+  #  pre_delete_hook  #
+  #####################
+
+  it 'has a hook that is called before deleting an index; if return value is false, delete does not occur' do
+    
+    class ::Array::Hooked::SubMockPreDelete < ::Array::Hooked
+      
+      def pre_delete_hook( index )
+        return false
+      end
+      
+    end
+    
+    hooked_array = ::Array::Hooked::SubMockPreDelete.new
+    
+    hooked_array.push( :some_value )
+    hooked_array.delete_at( 0 )
+    
+    hooked_array.should == [ :some_value ]
+    
+  end
+
+  ######################
+  #  post_delete_hook  #
+  ######################
+
+  it 'has a hook that is called after deleting an index' do
+    
+    class ::Array::Hooked::SubMockPostDelete < ::Array::Hooked
+      
+      def post_delete_hook( index, object )
+        return :some_other_value
+      end
+      
+    end
+    
+    hooked_array = ::Array::Hooked::SubMockPostDelete.new
+    
+    hooked_array.push( :some_value )
+    hooked_array.delete_at( 0 ).should == :some_other_value
+    
+    hooked_array.should == [ ]
+    
+  end
+
+  ########################
+  #  child_pre_set_hook  #
+  ########################
+
+  it 'has a hook that is called before setting a value that has been passed by a parent; return value is used in place of object' do
+    
+    class ::Array::Hooked::SubMockChildPreSet < ::Array::Hooked
+      
+      def child_pre_set_hook( index, object, is_insert = false )
+        return :some_other_value
+      end
+      
+    end
+    
+    hooked_array = ::Array::Hooked::SubMockChildPreSet.new
+    hooked_array.push( :some_value )
+
+  end
+
+  #########################
+  #  child_post_set_hook  #
+  #########################
+
+  it 'has a hook that is called after setting a value passed by a parent' do
+
+    class ::Array::Hooked::SubMockChildPostSet < ::Array::Hooked
+      
+      def child_post_set_hook( index, object, is_insert = false )
+        push( :some_other_value )
+      end
+      
+    end
+    
+    hooked_array = ::Array::Hooked::SubMockChildPostSet.new
+    hooked_array.push( :some_value )
+
+    hooked_array.should == [ :some_value ]
+    
+  end
+
+  ###########################
+  #  child_pre_delete_hook  #
+  ###########################
+
+  it 'has a hook that is called before deleting an index that has been passed by a parent; if return value is false, delete does not occur' do
+
+    class ::Array::Hooked::SubMockChildPreDelete < ::Array::Hooked
+      
+      def child_pre_delete_hook( index )
+        false
+      end
+      
+    end
+    
+    hooked_array = ::Array::Hooked::SubMockChildPreDelete.new
+    hooked_array.push( :some_value )
+    hooked_array.delete( :some_value )
+
+    hooked_array.should == [  ]
+    
+  end
+
+  ############################
+  #  child_post_delete_hook  #
+  ############################
+
+  it 'has a hook that is called after deleting an index passed by a parent' do
+
+    class ::Array::Hooked::SubMockChildPostDelete < ::Array::Hooked
+      
+      def child_post_delete_hook( index, object )
+        delete( :some_other_value )
+      end
+      
+    end
+    
+    hooked_array = ::Array::Hooked::SubMockChildPostDelete.new
+    hooked_array.push( :some_value )
+    hooked_array.delete( :some_value )
+
+    hooked_array.should == [  ]
+    
+  end
+  
+end