ninjudd-ordered_set 0.1.0

data/README.rdoc

@@ -0,0 +1,35 @@
+= OrderedSet
+
+OrderSet is an class for storing sets of objects. Unlike a Set, it maintains the order of
+the objects, but unlike an Array, each object can only exist once, and checking for
+inclusion takes constant time.
+
+== Usage:
+
+  s = [1,3,2,3,4,3].to_ordered_set
+  s.to_a
+  # => [1,3,2,4]
+
+  t = OrderedSet.new([6,7,5,6,5])
+  t.to_a
+  # => [6,7,5]
+
+  (s + t).to_a
+  # => [1,3,2,4,6,7,5]
+
+  s << 5
+  s.to_a
+  # => [1,3,2,4,5]
+
+  s.delete(1)
+  s.to_a
+  # => [3,2,4,5]
+
+== Install:
+
+  sudo gem install ninjudd-deep_clonable -s http://gems.github.com
+  sudo gem install ninjudd-ordered_set -s http://gems.github.com
+
+== License:
+
+Copyright (c) 2008 Justin Balthrop, Geni.com; Published under The MIT License, see LICENSE

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:patch: 0
+:major: 0
+:minor: 1

data/lib/ordered_set.rb

@@ -0,0 +1,157 @@
+require 'rubygems'
+require 'deep_clonable'
+require 'forwardable'
+
+class OrderedSet
+  include Enumerable
+  extend  Forwardable
+
+  deep_clonable
+
+  def initialize(items = [])
+    @order    = []
+    @position = {}
+    replace(items)
+  end
+
+  def_delegators :@order, :each, :join, :[], :first, :last, :slice, :size, :length, :empty?
+  alias limit slice
+  
+  def replace(items)
+    clear
+    items.each do |item|
+      self << item
+    end
+    self
+  end
+  
+  def clear
+    @order.clear
+    @position.clear
+  end
+
+  def include?(item)
+    @position.has_key?(item)
+  end
+    
+  def <<(item)
+    return if include?(item)
+    @position[item] = @order.size
+    @order << item
+  end
+
+  clone_method :+, :add!
+  def add!(items)
+    items.each do |item|
+      self << item
+    end
+    self
+  end
+  alias concat add!
+
+  def unshift!(items)
+    need_reindex = false
+    items.each do |item|
+      next if include?(item)
+      @order.unshift(item)
+      need_reindex = true # Need to recalculate the positions.
+    end
+    reindex if need_reindex
+    self
+  end
+  
+  def unshift(item)
+    unshift!([item])
+  end
+
+  clone_method :-, :subtract!
+  def subtract!(items)
+    @order.replace(self.to_a - items.to_a)
+    reindex
+    self
+  end
+
+  clone_method :&, :intersect!
+  def intersect!(items)
+    @order.replace(self.to_a & items.to_a)
+    reindex
+    self
+  end
+
+  def reorder!(items)
+    new_order = (items.to_a & self.to_a) + self.to_a
+    @order.replace(new_order.uniq)
+    reindex
+    self
+  end
+
+  def reverse_reorder!(items)
+    return self if items.empty?
+    reverse!.reorder!(items).reverse!
+  end
+  
+  def to_ary
+    @order.dup
+  end
+  
+  def index(item)
+    @position[item]
+  end
+  
+  def delete(item)
+    @order.delete(item) do
+      return block_given? ? yield : nil
+    end
+    reindex 
+    item
+  end
+
+  def delete_at(index, &block)
+    delete(self[index], &block)
+  end
+
+  [:sort_by, :sort, :reverse, :collect, :map, :compact, :reject].each do |method_name|
+    eval %{
+      def #{method_name}!(*args, &block)
+        new_order = @order.send(:#{method_name}, *args, &block)
+        replace(new_order)
+        self
+      end
+    }
+  end
+  
+  def select!
+    reject! {|item| not yield(item)}
+  end
+
+  # Array#slice! is somewhat inconsistent with the other bang methods, 
+  # and this emulates that. For the more consistent behavior use limit!
+  def slice!(*args)
+    removed_slice = @order.slice!(*args)
+    reindex
+    removed_slice
+  end
+
+  clone_method :limit
+  def limit!(limit, offset = 0)
+    new_order = @order.slice(offset, limit) || []
+    replace(new_order)
+    self
+  end
+
+private
+
+  def reindex
+    @position.clear
+    @order.each_with_index do |item, index|
+      @position[item] = index
+    end
+  end
+  
+end
+
+module Enumerable
+  def to_ordered_set
+    self.kind_of?(OrderedSet) ? self : OrderedSet.new(self)
+  end
+end

data/test/ordered_set_test.rb

@@ -0,0 +1,300 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class OrderedSetTest < Test::Unit::TestCase
+  
+  should 'create an ordered_set' do
+    assert [1,3,2,3,1,:foo].to_ordered_set.is_a?(OrderedSet)
+    assert OrderedSet.new([1,3,2,3,1,:foo]).is_a?(OrderedSet)
+  end
+  
+  should 'be enumerable' do
+    assert_equal [nil,1], [nil,1,1,nil].to_ordered_set.collect {|i| i}
+    assert_equal [1,3,2,:foo], [1,3,2,3,1,:foo].to_ordered_set.collect {|i| i}
+    assert_equal [-1,-3,-12], [1,3,12,3,1].to_ordered_set.collect {|i| -i}
+    assert_equal [1], [1,1,0,1,0,0,0,1].to_ordered_set.select {|i| i != 0}
+  end
+  
+  should 'replace the set contents' do
+    set = [].to_ordered_set
+    set.replace([5,0,5])
+    
+    assert_equal [5,0], set.to_a
+    assert_consistent set  
+  end
+  
+  should 'join elements in set' do
+    set = ["five","O","five"].to_ordered_set
+    assert_equal 'five-O', set.join('-')
+    set << 5
+    assert_equal 'five-O-5', set.join('-')
+    assert_consistent set
+  end
+  
+  should 'add sets' do
+    set = [1,3,4].to_ordered_set + [2,3,5].to_ordered_set
+    
+    assert_equal [1,3,4,2,5], set.to_a
+    assert_consistent set
+  end
+
+  should 'subtract sets' do
+    set = [5,1,3,4].to_ordered_set - [2,3,5].to_ordered_set
+    
+    assert_equal [1,4], set.to_a
+    assert_consistent set
+  end
+
+  should 'intersect sets' do
+    set = [5,1,3,4].to_ordered_set & [2,3,5].to_ordered_set
+    
+    assert_equal [5,3], set.to_a
+    assert_consistent set
+  end
+
+  should 'reorder set' do
+    set = [5,1,3,4].to_ordered_set
+    set.reorder!([2,3,5].to_ordered_set)
+    
+    assert_equal [3,5,1,4], set.to_a
+    assert_consistent set
+  end
+
+  should 'clear set' do
+    set  = [1,2,3].to_ordered_set
+    
+    set.clear
+    assert set.empty?
+  end
+
+  should 'clone set' do
+    set  = [1,2,3].to_ordered_set
+    copy = set.clone
+    
+    copy.clear
+    assert_equal [],      copy.to_a
+    assert_equal [1,2,3], set.to_a
+  end
+  
+  should 'include? all elements' do
+    set = [1,3,2,3,1,:foo,nil].to_ordered_set
+    
+    assert set.include?(1)
+    assert set.include?(3)
+    assert set.include?(:foo)
+    assert set.include?(nil)
+    assert_consistent set
+  end
+  
+  should 'have the correct size and length' do
+    set = [1,1,1,1,2,2,1,2,3,4,2,1,0].to_ordered_set
+    assert_equal 5, set.size
+    assert_equal 5, set.length
+    assert_consistent set
+  end
+  
+  should 'be empty' do
+    set = [].to_ordered_set
+    assert set.empty?
+
+    set = [1].to_ordered_set
+    assert !set.empty?
+  end
+
+  should 'check for any elements' do
+    set = [].to_ordered_set
+    assert !set.any?
+
+    set = [1].to_ordered_set
+    assert set.any?
+  end
+  
+  should 'support index operator' do
+    set = [1,2,2,3,4,1,0].to_ordered_set
+    
+    assert_equal 1, set[0]
+    assert_equal 4, set[3]
+    assert_equal nil, set[100]
+    assert_equal [2,3], set[1,2]
+    assert_equal [3,4,0], set[2..4]
+    assert_consistent set
+  end
+
+  should 'get a slice from a set' do
+    set = [1,2,2,3,4,1,0].to_ordered_set
+    
+    assert_equal 1, set.slice(0)
+    assert_equal 4, set.slice(3)
+    assert_equal nil, set.slice(100)
+    assert_equal [2,3], set.slice(1,2)
+    assert_equal [3,4,0], set.slice(2..4)
+    assert_consistent set
+  end
+
+  should 'lookup index of element' do
+    set = [1,2,2,3,4,1,0].to_ordered_set
+
+    assert_equal 1, set.index(2)
+    assert_equal 4, set.index(0)
+    assert_consistent set
+  end
+  
+  should 'append elements' do
+    set = [1,2,2,3,4,1,0].to_ordered_set
+    
+    set << 1
+    assert_equal 5, set.size
+    assert set.include?(1)
+    assert_equal [1,2,3,4,0], set.to_a
+    assert_consistent set
+    
+    set << 100
+    assert_equal 6, set.size
+    assert set.include?(100)
+    assert_equal [1,2,3,4,0,100], set.to_a
+    assert_consistent set
+  end
+
+  should 'unshift elements' do
+    set = [1,2,2,3,4,1,0].to_ordered_set
+    
+    set.unshift(1)
+    assert_equal 5, set.size
+    assert set.include?(1)
+    assert_equal [1,2,3,4,0], set.to_a
+    assert_consistent set
+    
+    set.unshift(100)
+    assert_equal 6, set.size
+    assert set.include?(100)
+    assert_equal [100,1,2,3,4,0], set.to_a
+    assert_consistent set
+  end
+
+  
+  should 'delete elements' do
+    set = [1,2,2,3,4,1,nil].to_ordered_set
+    
+    assert_equal 1, set.delete(1)
+    assert_equal [2,3,4,nil], set.to_a
+    assert_equal 4, set.size
+    assert !set.include?(1)
+    assert_consistent set
+
+    assert_equal nil, set.delete(nil)
+    assert_equal [2,3,4], set.to_a
+    assert_equal 3, set.size
+    assert !set.include?(nil)
+    assert_consistent set
+    
+    assert_equal false, set.delete(100) { false }
+    assert_equal [2,3,4], set.to_a
+    assert_equal 3, set.size
+    assert !set.include?(100)
+    assert_consistent set
+  end
+  
+  should 'delete elements at specified position'  do
+    set = [1,2,2,3,4,1,nil].to_ordered_set
+    
+    assert_equal 1, set.delete_at(0)
+    assert_equal [2,3,4,nil], set.to_a
+    assert_equal 4, set.size
+    assert !set.include?(1)
+    assert_consistent set
+
+    assert_equal nil, set.delete_at(3)
+    assert_equal [2,3,4], set.to_a
+    assert_equal 3, set.size
+    assert !set.include?(nil)
+    assert_consistent set
+    
+    assert_equal false, set.delete(100) { false }
+    assert_equal [2,3,4], set.to_a
+    assert_equal 3, set.size
+    assert !set.include?(100)
+    assert_consistent set
+  end
+  
+  should 'sort set' do
+    set = [1,2,2,3,4,1,0].to_ordered_set
+    
+    set.sort!
+    assert_equal [0,1,2,3,4], set.to_a
+    assert_consistent set
+  end
+  
+  should 'reverse set' do
+    set = [0,1,2,2,3,4,1,0].to_ordered_set
+    
+    set.reverse!
+    assert_equal [4,3,2,1,0], set.to_a
+    assert_consistent set
+  end
+  
+  should 'modify using collect!' do
+    set = [0,1,2,2,3,4,1,0,5,6,8,9,11,32424].to_ordered_set
+    
+    set.collect! {|i| i % 3}
+    assert_equal [0,1,2], set.to_a
+    assert_consistent set
+  end
+  
+  should 'modify using map!' do
+    set = [0,1,2,2,3,4,1,0].to_ordered_set
+    
+    set.collect! {|i| i * 10}
+    assert_equal [0,10,20,30,40], set.to_a
+    assert_consistent set
+  end
+
+  should 'compact set' do
+    set = [0,1,2,2,nil,3,nil,4,1,0].to_ordered_set
+    
+    set.compact!
+    assert_equal [0,1,2,3,4], set.to_a
+    assert_consistent set
+  end
+  
+  should 'select elements from set' do
+    set = [0,1,2,2,3,4,1,0].to_ordered_set
+    
+    set.select! {|i| i % 2 == 0}
+    assert_equal [0,2,4], set.to_a
+    assert_consistent set
+  end
+
+  should 'reject elements from set' do
+    set = [0,1,2,2,3,4,1,0].to_ordered_set
+    
+    set.reject! {|i| i % 2 == 0}
+    assert_equal [1,3], set.to_a
+    assert_consistent set
+  end
+
+  should 'modify set with slice!' do
+    set = [0,1,2,2,3,4,1,0].to_ordered_set
+    
+    assert_equal [1,2,3], set.slice!(1..3)
+    assert_equal [0,4], set.to_a
+    assert_consistent set
+  end
+
+  should 'limit set' do
+    set = [0,1,2,2,3,4,1,0].to_ordered_set.limit!(3, 1)
+    
+    assert_equal [1,2,3], set.to_a
+    assert_consistent set
+
+    set = [0,1,2,2,3,4,1,0].to_ordered_set.limit!(2)
+    
+    assert_equal [0,1], set.to_a
+    assert_consistent set
+  end
+  
+  def assert_consistent(set)
+    set.each do |item|
+      assert set.include?(item)
+    end
+  end
+    
+end

data/test/test_helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+
+$LOAD_PATH.unshift File.dirname(__FILE__) + "/../lib"
+$LOAD_PATH.unshift File.dirname(__FILE__) + "/../../deep_clonable/lib"
+require 'ordered_set'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification 
+name: ninjudd-ordered_set
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Justin Balthrop
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-13 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Like Set except it maintains the order of objects
+email: code@justinbalthrop.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.rdoc
+- VERSION.yml
+- lib/ordered_set.rb
+- test/ordered_set_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/ninjudd/ordered_set
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Like Set except it maintains the order of objects
+test_files: []
+