array-unique 1.0.0

data/CHANGELOG.rdoc

@@ -0,0 +1,13 @@
+
+== 6/14/2012
+
+Initial release - split from compositing-unique-array.
+Fixed require path for hooked_array to gem.
+ 
+== 6/15/2012
+
+Fixed UniqueArray::Interface to include Array::Unique::Interface.
+
+== 6/30/2012
+
+Renamed from unique-array to array-unique. File schema updated to reflect gem name.

data/README.md

@@ -0,0 +1,44 @@
+# Unique Array #
+
+http://rubygems.org/gems/array-unique
+
+# Description #
+
+Provides ::Array::Unique and ::UniqueArray.
+
+# Summary #
+
+A subclass of Array::Hooked that also keeps array unique.
+
+# Install #
+
+* sudo gem install array-unique
+
+# Usage #
+
+Just like Array or Array::Hooked (provided by hooked_array)! Automatically keeps array unique.
+
+# License #
+
+  (The MIT License)
+
+  Copyright (c) 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/array-unique.rb

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

data/lib/array/hooked/unique.rb

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

data/lib/array/namespaces.rb

@@ -0,0 +1,7 @@
+
+class ::Array::Unique < ::Array::Hooked
+end
+
+class ::UniqueArray < ::Array::Unique
+end
+

data/lib/array/requires.rb

@@ -0,0 +1,26 @@
+
+basepath = 'unique'
+
+files = [
+  
+  'array_interface'
+  
+]
+
+second_basepath = '../unique_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/array/unique.rb

@@ -0,0 +1,14 @@
+
+require 'array/hooked'
+
+# namespaces that have to be declared ahead of time for proper load order
+require_relative './namespaces'
+
+# source file requires
+require_relative './requires.rb'
+
+class ::Array::Unique < ::Array::Hooked
+  
+  include ::Array::Unique::Interface
+    
+end

data/lib/array/unique/array_interface.rb

@@ -0,0 +1,155 @@
+
+module ::Array::Unique::Interface
+
+  include ::Array::Hooked::ArrayInterface
+
+  instances_identify_as!( ::Array::Unique )
+
+  ################
+  #  initialize  #
+  ################
+  
+  def initialize( *args )
+
+    @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
+
+  ##################################
+  #  perform_delete_between_hooks  #
+  ##################################
+  
+  def perform_delete_between_hooks( index )
+    
+    @unique_keys.delete( self[ index ] )
+    
+    return super
+    
+  end
+  
+  ##############
+  #  include?  #
+  ##############
+  
+  def include?( object )
+    
+    return @unique_keys.has_key?( object )
+    
+  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!
+
+  ##########
+  #  uniq  #
+  ##########
+
+  def uniq
+  
+    return self
+  
+  end
+
+  ###########
+  #  uniq!  #
+  ###########
+
+  def uniq!
+  
+    return self
+  
+  end
+  
+end

data/lib/unique_array.rb

@@ -0,0 +1,6 @@
+
+class ::UniqueArray < ::Array::Unique
+  
+  include ::UniqueArray::Interface
+    
+end

data/lib/unique_array/array_interface.rb

@@ -0,0 +1,9 @@
+
+module ::UniqueArray::Interface
+
+  include ::Array::Unique::Interface
+  include ::HookedArray::Interface
+  
+  instances_identify_as!( ::UniqueArray )
+
+end

data/spec/array/unique_spec.rb

@@ -0,0 +1,676 @@
+
+require_relative '../../lib/array-unique.rb'
+
+describe ::Array::Unique do
+
+  ################
+  #  initialize  #
+  ################
+
+  it 'can add initialize with an ancestor, inheriting its values and linking to it as a child' do
+  
+    unique_array = ::Array::Unique.new
+
+    unique_array.instance_variable_get( :@parent_composite_object ).should == nil
+    unique_array.should == []
+    unique_array.push( :A, :B, :C, :D )
+    
+  end
+
+  #########
+  #  []=  #
+  #########
+
+  it 'can add elements' do
+  
+    unique_array = ::Array::Unique.new
+
+    unique_array[ 0 ] = :A
+    unique_array.should == [ :A ]
+
+    unique_array[ 1 ] = :B
+    unique_array.should == [ :A, :B ]
+
+    unique_array[ 2 ] = :D
+    unique_array.should == [ :A, :B, :D ]
+
+  end
+  
+  ############
+  #  insert  #
+  ############
+
+  it 'can insert elements' do
+  
+    unique_array = ::Array::Unique.new
+
+    unique_array.insert( 3, :D )
+    unique_array.should == [ nil, :D ]
+
+    unique_array.insert( 1, :B )
+    unique_array.should == [ nil, :B, :D ]
+
+    unique_array.insert( 2, :C )
+    unique_array.should == [ nil, :B, :C, :D ]
+
+  end
+  
+  ##########
+  #  push  #
+  #  <<    #
+  ##########
+  
+  it 'can add elements' do
+
+    unique_array = ::Array::Unique.new
+
+    unique_array << :A
+    unique_array.should == [ :A ]
+
+    unique_array << :B
+    unique_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.
+
+    unique_array = ::Array::Unique.new
+
+    unique_array.concat( [ :A ] )
+    unique_array.should == [ :A ]
+
+    unique_array += [ :B ]
+    unique_array.should == [ :A, :B ]
+
+  end
+
+  ####################
+  #  delete_objects  #
+  ####################
+
+  it 'can delete multiple elements' do
+
+    unique_array = ::Array::Unique.new
+
+    unique_array += [ :A, :B ]
+    unique_array.should == [ :A, :B ]
+
+    unique_array.delete_objects( :A, :B )
+    unique_array.should == [ ]
+
+  end
+
+  #######
+  #  -  #
+  #######
+  
+  it 'can exclude elements' do
+
+    unique_array = ::Array::Unique.new
+
+    unique_array.push( :A )
+    unique_array.should == [ :A ]
+
+    unique_array -= [ :A ]
+    unique_array.should == [ ]
+
+    unique_array.push( :B )
+    unique_array.should == [ :B ]
+
+  end
+
+  ############
+  #  delete  #
+  ############
+  
+  it 'can delete elements' do
+
+    unique_array = ::Array::Unique.new
+
+    unique_array.push( :A )
+    unique_array.should == [ :A ]
+
+    unique_array.delete( :A )
+    unique_array.should == [ ]
+
+    unique_array.push( :B )
+    unique_array.should == [ :B ]
+
+  end
+
+  ###############
+  #  delete_at  #
+  ###############
+
+  it 'can delete by indexes' do
+
+    unique_array = ::Array::Unique.new
+
+    unique_array.push( :A )
+    unique_array.should == [ :A ]
+    
+    unique_array.delete_at( 0 )
+    unique_array.should == [ ]
+
+    unique_array.push( :B )
+    unique_array.should == [ :B ]
+
+  end
+
+  #######################
+  #  delete_at_indexes  #
+  #######################
+
+  it 'can delete by indexes' do
+
+    unique_array = ::Array::Unique.new
+
+    unique_array.push( :A, :B, :C )
+    unique_array.should == [ :A, :B, :C ]
+
+    unique_array.delete_at_indexes( 0, 1 )
+    unique_array.should == [ :C ]
+
+  end
+
+  ###############
+  #  delete_if  #
+  ###############
+
+  it 'can delete by block' do
+
+    unique_array = ::Array::Unique.new
+
+    unique_array.push( :A, :B, :C )
+    unique_array.should == [ :A, :B, :C ]
+    unique_array.delete_if do |object|
+      object != :C
+    end
+    unique_array.should == [ :C ]
+
+    unique_array.delete_if.is_a?( Enumerator ).should == true
+
+  end
+
+  #############
+  #  keep_if  #
+  #############
+
+  it 'can keep by block' do
+
+    unique_array = ::Array::Unique.new
+
+    unique_array.push( :A, :B, :C )
+    unique_array.should == [ :A, :B, :C ]
+    unique_array.keep_if do |object|
+      object == :C
+    end
+    unique_array.should == [ :C ]
+
+  end
+
+  ##############
+  #  compact!  #
+  ##############
+
+  it 'can compact' do
+
+    unique_array = ::Array::Unique.new
+
+    unique_array.push( :A, nil, :B, nil, :C, nil )
+    unique_array.should == [ :A, nil, :B, :C ]
+    unique_array.compact!
+    unique_array.should == [ :A, :B, :C ]
+
+  end
+
+  ##############
+  #  flatten!  #
+  ##############
+
+  it 'can flatten' do
+
+    unique_array = ::Array::Unique.new
+
+    unique_array.push( :A, [ :F_A, :F_B ], :B, [ :F_C ], :C, [ :F_D ], [ :F_E ] )
+    unique_array.should == [ :A, [ :F_A, :F_B ], :B, [ :F_C ], :C, [ :F_D ], [ :F_E ] ]
+    unique_array.flatten!
+    unique_array.should == [ :A, :F_A, :F_B, :B, :F_C, :C, :F_D, :F_E ]
+
+  end
+
+  #############
+  #  reject!  #
+  #############
+
+  it 'can reject' do
+
+    unique_array = ::Array::Unique.new
+
+    unique_array.push( :A, :B, :C )
+    unique_array.should == [ :A, :B, :C ]
+    unique_array.reject! do |object|
+      object != :C
+    end
+    unique_array.should == [ :C ]
+
+    unique_array.reject!.is_a?( Enumerator ).should == true
+
+  end
+
+  #############
+  #  replace  #
+  #############
+
+  it 'can replace self' do
+
+    unique_array = ::Array::Unique.new
+
+    unique_array.push( :A, :B, :C )
+    unique_array.should == [ :A, :B, :C ]
+    unique_array.replace( [ :D, :E, :F ] )
+    unique_array.should == [ :D, :E, :F ]
+
+  end
+
+  ##############
+  #  reverse!  #
+  ##############
+
+  it 'can reverse self' do
+
+    unique_array = ::Array::Unique.new
+
+    unique_array.push( :A, :B, :C )
+    unique_array.should == [ :A, :B, :C ]
+    unique_array.reverse!
+    unique_array.should == [ :C, :B, :A ]
+
+  end
+
+  #############
+  #  rotate!  #
+  #############
+
+  it 'can rotate self' do
+
+    unique_array = ::Array::Unique.new
+
+    unique_array.push( :A, :B, :C )
+    unique_array.should == [ :A, :B, :C ]
+
+    unique_array.rotate!
+    unique_array.should == [ :B, :C, :A ]
+
+    unique_array.rotate!( -1 )
+    unique_array.should == [ :A, :B, :C ]
+
+  end
+
+  #############
+  #  select!  #
+  #############
+
+  it 'can keep by select' do
+
+    unique_array = ::Array::Unique.new
+
+    unique_array.push( :A, :B, :C )
+    unique_array.should == [ :A, :B, :C ]
+    unique_array.select! do |object|
+      object == :C
+    end
+    unique_array.should == [ :C ]
+
+    unique_array.select!.is_a?( Enumerator ).should == true
+
+  end
+
+  ##############
+  #  shuffle!  #
+  ##############
+
+  it 'can shuffle self' do
+
+    unique_array = ::Array::Unique.new
+
+    unique_array.push( :A, :B, :C )
+    unique_array.should == [ :A, :B, :C ]
+
+    prior_version = unique_array.dup
+    attempts = [ ]
+    50.times do
+      unique_array.shuffle!
+      attempts.push( unique_array == prior_version )
+      prior_version = unique_array.dup
+    end
+    attempts_correct = attempts.select { |member| member == false }.count
+    ( attempts_correct >= 10 ).should == true
+    first_shuffle_version = unique_array
+
+  end
+
+  ##############
+  #  collect!  #
+  #  map!      #
+  ##############
+
+  it 'can replace by collect/map' do
+
+    unique_array = ::Array::Unique.new
+
+    unique_array.push( :A, :B, :C )
+    unique_array.should == [ :A, :B, :C ]
+    unique_array.collect! do |object|
+      :C
+    end
+    unique_array.should == [ :C ]
+
+    unique_array.collect!.is_a?( Enumerator ).should == true
+
+  end
+
+  ###########
+  #  sort!  #
+  ###########
+
+  it 'can replace by collect/map' do
+
+    unique_array = ::Array::Unique.new
+
+    unique_array.push( :A, :B, :C )
+    unique_array.should == [ :A, :B, :C ]
+    unique_array.sort! do |a, b|
+      if a < b
+        1
+      elsif a > b
+        -1
+      elsif a == b
+        0
+      end
+    end
+    unique_array.should == [ :C, :B, :A ]
+
+    unique_array.sort!
+    unique_array.should == [ :A, :B, :C ]
+
+  end
+
+  ##############
+  #  sort_by!  #
+  ##############
+
+  it 'can replace by collect/map' do
+
+    unique_array = ::Array::Unique.new
+
+    unique_array.push( :A, :B, :C )
+    unique_array.should == [ :A, :B, :C ]
+    unique_array.sort_by! do |object|
+      case object
+      when :A
+        :B
+      when :B
+        :A
+      when :C
+        :C
+      end
+    end
+    unique_array.should == [ :B, :A, :C ]
+
+    unique_array.sort_by!.is_a?( Enumerator ).should == true
+
+  end
+
+  ###########
+  #  uniq!  #
+  ###########
+
+  it 'can remove non-unique elements' do
+
+    unique_array = ::Array::Unique.new
+
+    unique_array.push( :A, :B, :C, :C, :C, :B, :A )
+    unique_array.should == [ :A, :B, :C ]
+    unique_array.uniq!
+    unique_array.should == [ :A, :B, :C ]
+
+  end
+
+  #############
+  #  unshift  #
+  #############
+
+  it 'can unshift onto the first element' do
+
+    unique_array = ::Array::Unique.new
+
+    unique_array += :A
+    unique_array.should == [ :A ]
+
+    unique_array.unshift( :B )
+    unique_array.should == [ :B, :A ]
+
+  end
+
+  #########
+  #  pop  #
+  #########
+  
+  it 'can pop the final element' do
+
+    unique_array = ::Array::Unique.new
+
+    unique_array += :A
+    unique_array.should == [ :A ]
+
+    unique_array.pop.should == :A
+    unique_array.should == [ ]
+
+    unique_array += :B
+    unique_array.should == [ :B ]
+
+  end
+
+  ###########
+  #  shift  #
+  ###########
+  
+  it 'can shift the first element' do
+
+    unique_array = ::Array::Unique.new
+
+    unique_array += :A
+    unique_array.should == [ :A ]
+
+    unique_array.shift.should == :A
+    unique_array.should == [ ]
+
+    unique_array += :B
+    unique_array.should == [ :B ]
+
+  end
+
+  ############
+  #  slice!  #
+  ############
+  
+  it 'can slice elements' do
+
+    unique_array = ::Array::Unique.new
+
+    unique_array += :A
+    unique_array.should == [ :A ]
+
+    unique_array.slice!( 0, 1 ).should == [ :A ]
+    unique_array.should == [ ]
+
+    unique_array += :B
+    unique_array.should == [ :B ]
+
+  end
+  
+  ###########
+  #  clear  #
+  ###########
+
+  it 'can clear, causing present elements to be excluded' do
+
+    unique_array = ::Array::Unique.new
+
+    unique_array += :A
+    unique_array.should == [ :A ]
+
+    unique_array.clear
+    unique_array.should == [ ]
+
+    unique_array += :B
+    unique_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::Unique::SubMockPreSet < ::Array::Hooked
+      
+      def pre_set_hook( index, object, is_insert = false )
+        return :some_other_value
+      end
+      
+    end
+    
+    unique_array = ::Array::Unique::SubMockPreSet.new
+
+    unique_array.push( :some_value )
+    
+    unique_array.should == [ :some_other_value ]
+    
+  end
+
+  ###################
+  #  post_set_hook  #
+  ###################
+
+  it 'has a hook that is called after setting a value' do
+
+    class ::Array::Unique::SubMockPostSet < ::Array::Hooked
+      
+      def post_set_hook( index, object, is_insert = false )
+        return :some_other_value
+      end
+      
+    end
+    
+    unique_array = ::Array::Unique::SubMockPostSet.new
+
+    unique_array.push( :some_value ).should == [ :some_other_value ]
+    
+    unique_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::Unique::SubMockPreGet < ::Array::Hooked
+      
+      def pre_get_hook( index )
+        return false
+      end
+      
+    end
+    
+    unique_array = ::Array::Unique::SubMockPreGet.new
+    
+    unique_array.push( :some_value )
+    unique_array[ 0 ].should == nil
+    
+    unique_array.should == [ :some_value ]
+    
+  end
+
+  ###################
+  #  post_get_hook  #
+  ###################
+
+  it 'has a hook that is called after getting a value' do
+
+    class ::Array::Unique::SubMockPostGet < ::Array::Hooked
+      
+      def post_get_hook( index, object )
+        return :some_other_value
+      end
+      
+    end
+    
+    unique_array = ::Array::Unique::SubMockPostGet.new
+    
+    unique_array.push( :some_value )
+    unique_array[ 0 ].should == :some_other_value
+    
+    unique_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::Unique::SubMockPreDelete < ::Array::Hooked
+      
+      def pre_delete_hook( index )
+        return false
+      end
+      
+    end
+    
+    unique_array = ::Array::Unique::SubMockPreDelete.new
+    
+    unique_array.push( :some_value )
+    unique_array.delete_at( 0 )
+    
+    unique_array.should == [ :some_value ]
+    
+  end
+
+  ######################
+  #  post_delete_hook  #
+  ######################
+
+  it 'has a hook that is called after deleting an index' do
+    
+    class ::Array::Unique::SubMockPostDelete < ::Array::Hooked
+      
+      def post_delete_hook( index, object )
+        return :some_other_value
+      end
+      
+    end
+    
+    unique_array = ::Array::Unique::SubMockPostDelete.new
+    
+    unique_array.push( :some_value )
+    unique_array.delete_at( 0 ).should == :some_other_value
+    
+    unique_array.should == [ ]
+    
+  end
+  
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: array-unique
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Asher
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: array-hooked
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A subclass of Array::Hooked that also keeps array unique.
+email: asher@ridiculouspower.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/array/hooked/unique.rb
+- lib/array/namespaces.rb
+- lib/array/requires.rb
+- lib/array/unique/array_interface.rb
+- lib/array/unique.rb
+- lib/array-unique.rb
+- lib/unique_array/array_interface.rb
+- lib/unique_array.rb
+- spec/array/unique_spec.rb
+- README.md
+- CHANGELOG.rdoc
+homepage: http://rubygems.org/gems/array-unique
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: array-unique
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Provides Array::Unique and UniqueArray.
+test_files: []
+has_rdoc: