hamster 0.1.19 → 0.1.20

data/History.rdoc

@@ -1,3 +1,13 @@
+=== 0.1.20 / 2010-01-07
+
+* Implement Stack#clear.
+
+* Implement List#clear and Stack#clear.
+
+* Implement List#break.
+
+* Implement List#span.
+
 === 0.1.19 / 2010-01-03
 
 * Bump minimum Ruby version to 1.8.7. I mean really, c'mon!

data/README.rdoc

@@ -1,4 +1,4 @@
-= Hamster
+= Hamster - Efficient, Immutable, Thread-Safe Collection classes for Ruby
 
 Hamster started out as an implementation of Hash Array Mapped Trees (HAMT) for Ruby (see http://lamp.epfl.ch/papers/idealhashtrees.pdf) and has since expanded to include implementations of other Persistent Data Structures (see http://en.wikipedia.org/wiki/Persistent_data_structure) such as Sets, Lists, Stacks, etc.
 

data/lib/hamster/list.rb

@@ -170,7 +170,7 @@ module Hamster
 
     def partition(&block)
       return self unless block_given?
-      EmptyList.cons(reject(&block)).cons(filter(&block))
+      Stream.new(filter(&block)) { EmptyList.cons(reject(&block)) }
     end
 
     def append(other)
@@ -209,9 +209,24 @@ module Hamster
     end
 
     def split_at(number)
+      # Stream.new(take(number)) { EmptyList.cons(drop(number)) }
       EmptyList.cons(drop(number)).cons(take(number))
     end
 
+    def span(&block)
+      return EmptyList.cons(EmptyList).cons(self) unless block_given?
+      Stream.new(take_while(&block)) { EmptyList.cons(drop_while(&block)) }
+    end
+
+    def break(&block)
+      return EmptyList.cons(EmptyList).cons(self) unless block_given?
+      span { |item| !yield(item) }
+    end
+
+    def clear
+      EmptyList
+    end
+
     def eql?(other)
       return false unless other.is_a?(List)
 
@@ -276,6 +291,7 @@ module Hamster
     include List
 
     attr_reader :head, :tail
+    alias_method :first, :head
 
     def initialize(head, tail = self)
       @head = head
@@ -289,6 +305,7 @@ module Hamster
     include List
 
     attr_reader :head
+    alias_method :first, :head
 
     def initialize(head, &tail)
       @head = head
@@ -316,6 +333,7 @@ module Hamster
       def head
         nil
       end
+      alias_method :first, :head
 
       def tail
         self

data/lib/hamster/stack.rb

@@ -39,6 +39,10 @@ module Hamster
       end
     end
 
+    def clear
+      EmptyStack
+    end
+
     def eql?(other)
       return true if other.equal?(self)
       return false unless other.class.equal?(self.class)

data/lib/hamster/version.rb

@@ -1,5 +1,5 @@
 module Hamster
 
-  VERSION = "0.1.19".freeze
+  VERSION = "0.1.20".freeze
 
 end

data/spec/hamster/hash/all_spec.rb

@@ -13,11 +13,11 @@ describe Hamster::Hash do
       end
 
       it "with a block returns true" do
-        @hash.all? {}.should be_true
+        @hash.all? {}.should == true
       end
 
       it "with no block returns true" do
-        @hash.all?.should be_true
+        @hash.all?.should == true
       end
 
     end
@@ -31,11 +31,11 @@ describe Hamster::Hash do
       describe "with a block" do
 
         it "returns true if the block always returns true" do
-          @hash.all? { |key, value| true }.should be_true
+          @hash.all? { |key, value| true }.should == true
         end
 
         it "returns false if the block ever returns false" do
-          @hash.all? { |key, value| key == "D" || value == "dee" }.should be_false
+          @hash.all? { |key, value| key == "D" || value == "dee" }.should == false
         end
 
       end
@@ -43,7 +43,7 @@ describe Hamster::Hash do
       describe "with no block" do
 
         it "returns true" do
-          @hash.all?.should be_true
+          @hash.all?.should == true
         end
 
       end

data/spec/hamster/hash/any_spec.rb

@@ -15,11 +15,11 @@ describe Hamster::Hash do
         end
 
         it "with a block returns false" do
-          @hash.send(method) {}.should be_false
+          @hash.send(method) {}.should == false
         end
 
         it "with no block returns false" do
-          @hash.send(method).should be_false
+          @hash.send(method).should == false
         end
 
       end
@@ -40,11 +40,11 @@ describe Hamster::Hash do
           ].each do |pair|
 
             it "returns true if the block ever returns true (#{pair.inspect})" do
-              @hash.send(method) { |key, value| key == pair.first && value == pair.last }.should be_true
+              @hash.send(method) { |key, value| key == pair.first && value == pair.last }.should == true
             end
 
             it "returns false if the block always returns false" do
-              @hash.send(method) { |key, value| key == "D" && value == "dee" }.should be_false
+              @hash.send(method) { |key, value| key == "D" && value == "dee" }.should == false
             end
 
           end
@@ -54,7 +54,7 @@ describe Hamster::Hash do
         describe "with no block" do
 
           it "returns true" do
-            @hash.send(method).should be_true
+            @hash.send(method).should == true
           end
 
         end

data/spec/hamster/hash/eql_spec.rb

@@ -15,11 +15,11 @@ describe Hamster::Hash do
         end
 
         it "a standard hash" do
-          @hash.send(method, "A" => "aye", "B" => "bee", "C" => "see").should be_false
+          @hash.send(method, "A" => "aye", "B" => "bee", "C" => "see").should == false
         end
 
         it "an aribtrary object" do
-          @hash.send(method, Object.new).should be_false
+          @hash.send(method, Object.new).should == false
         end
 
       end

data/spec/hamster/hash/has_key_spec.rb

@@ -15,13 +15,13 @@ describe Hamster::Hash do
       ["A", "B", "C", nil].each do |key|
 
         it "returns true for an existing key (#{key.inspect})" do
-          @hash.send(method, key).should be_true
+          @hash.send(method, key).should == true
         end
 
       end
 
       it "returns false for a non-existing key" do
-        @hash.send(method, "D").should be_false
+        @hash.send(method, "D").should == false
       end
 
     end

data/spec/hamster/hash/none_spec.rb

@@ -13,11 +13,11 @@ describe Hamster::Hash do
       end
 
       it "with a block returns true" do
-        @hash.none? {}.should be_true
+        @hash.none? {}.should == true
       end
 
       it "with no block returns true" do
-        @hash.none?.should be_true
+        @hash.none?.should == true
       end
 
     end
@@ -38,11 +38,11 @@ describe Hamster::Hash do
         ].each do |pair|
 
           it "returns false if the block ever returns true (#{pair.inspect})" do
-            @hash.none? { |key, value| key == pair.first && value == pair.last }.should be_false
+            @hash.none? { |key, value| key == pair.first && value == pair.last }.should == false
           end
 
           it "returns true if the block always returns false" do
-            @hash.none? { |key, value| key == "D" && value == "dee" }.should be_true
+            @hash.none? { |key, value| key == "D" && value == "dee" }.should == true
           end
 
         end
@@ -52,7 +52,7 @@ describe Hamster::Hash do
       describe "with no block" do
 
         it "returns false" do
-          @hash.none?.should be_false
+          @hash.none?.should == false
         end
 
       end

data/spec/hamster/list/all_spec.rb

@@ -9,11 +9,11 @@ describe Hamster::List do
     describe "doesn't run out of stack space on a really big" do
 
       it "stream" do
-        @list = Hamster.interval(0, 10000)
+        @list = Hamster.interval(0, STACK_OVERFLOW_DEPTH)
       end
 
       it "list" do
-        @list = (0..10000).reduce(Hamster.list) { |list, i| list.cons(i) }
+        @list = (0...STACK_OVERFLOW_DEPTH).reduce(Hamster.list) { |list, i| list.cons(i) }
       end
 
       after do
@@ -29,11 +29,11 @@ describe Hamster::List do
       end
 
       it "with a block returns true" do
-        @list.all? {}.should be_true
+        @list.all? {}.should == true
       end
 
       it "with no block returns true" do
-        @list.all?.should be_true
+        @list.all?.should == true
       end
 
     end
@@ -46,26 +46,58 @@ describe Hamster::List do
           @list = Hamster.list("A", "B", "C")
         end
 
-        it "returns true if the block always returns true" do
-          @list.all? { |item| true }.should be_true
+        describe "if the block always returns true" do
+
+          before do
+            @result = @list.all? { |item| true }
+          end
+
+          it "returns true" do
+            @result.should == true
+          end
+
         end
 
-        it "returns false if the block ever returns false" do
-          @list.all? { |item| item == "D" }.should be_false
+        describe "if the block ever returns false" do
+
+          before do
+            @result = @list.all? { |item| item == "D" }
+          end
+
+          it "returns false" do
+            @result.should == false
+          end
+
         end
 
       end
 
       describe "with no block" do
 
-        it "returns true if all values are truthy" do
-          Hamster.list(true, "A").all?.should be_true
+        describe "if all values are truthy" do
+
+          before do
+            @result = Hamster.list(true, "A").all?
+          end
+
+          it "returns true" do
+            @result.should == true
+          end
+
         end
 
         [nil, false].each do |value|
 
-          it "returns false if any value is #{value.inspect}" do
-            Hamster.list(value, true, "A").all?.should be_false
+          describe "if any value is #{value.inspect}" do
+
+            before do
+              @result = Hamster.list(value, true, "A").all?
+            end
+
+            it "returns false" do
+              @result.should == false
+            end
+
           end
 
         end

data/spec/hamster/list/any_spec.rb

@@ -11,11 +11,11 @@ describe Hamster::List do
       describe "doesn't run out of stack space on a really big" do
 
         it "stream" do
-          @list = Hamster.interval(0, 10000)
+          @list = Hamster.interval(0, STACK_OVERFLOW_DEPTH)
         end
 
         it "list" do
-          @list = (0..10000).reduce(Hamster.list) { |list, i| list.cons(i) }
+          @list = (0...STACK_OVERFLOW_DEPTH).reduce(Hamster.list) { |list, i| list.cons(i) }
         end
 
         after do
@@ -31,11 +31,11 @@ describe Hamster::List do
         end
 
         it "with a block returns false" do
-          @list.send(method) {}.should be_false
+          @list.send(method) {}.should == false
         end
 
         it "with no block returns false" do
-          @list.send(method).should be_false
+          @list.send(method).should == false
         end
 
       end
@@ -51,13 +51,13 @@ describe Hamster::List do
           ["A", "B", "C", nil].each do |value|
 
             it "returns true if the block ever returns true (#{value.inspect})" do
-              @list.send(method) { |item| item == value }.should be_true
+              @list.send(method) { |item| item == value }.should == true
             end
 
           end
 
           it "returns false if the block always returns false" do
-            @list.send(method) { |item| item == "D" }.should be_false
+            @list.send(method) { |item| item == "D" }.should == false
           end
 
         end
@@ -65,11 +65,11 @@ describe Hamster::List do
         describe "with no block" do
 
           it "returns true if any value is truthy" do
-            Hamster.list(nil, false, true, "A").send(method).should be_true
+            Hamster.list(nil, false, "A", true).send(method).should == true
           end
 
           it "returns false if all values are falsey" do
-            Hamster.list(nil, false).send(method).should be_false
+            Hamster.list(nil, false).send(method).should == false
           end
 
         end

data/spec/hamster/list/append_spec.rb

@@ -11,11 +11,11 @@ describe Hamster::List do
       describe "doesn't run out of stack space on a really big" do
 
         it "stream" do
-          @a = @b = Hamster.interval(0, 10000)
+          @a = @b = Hamster.interval(0, STACK_OVERFLOW_DEPTH)
         end
 
         it "list" do
-          @a = @b = (0..10000).reduce(Hamster.list) { |list, i| list.cons(i) }
+          @a = @b = (0...STACK_OVERFLOW_DEPTH).reduce(Hamster.list) { |list, i| list.cons(i) }
         end
 
         after do

data/spec/hamster/list/break_spec.rb

@@ -0,0 +1,183 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+require 'hamster/list'
+
+describe Hamster::List do
+
+  shared_examples_for "#break without a block" do
+
+    describe "without a block" do
+
+      before do
+        @result = @original.break
+        @prefix = @result.car
+        @remainder = @result.cadr
+      end
+
+      it "returns a list with two items" do
+        @result.size.should == 2
+      end
+
+      it "returns self as the prefix" do
+        @prefix.should equal(@original)
+      end
+
+      it "leaves the remainder empty" do
+        @remainder.should be_empty
+      end
+
+    end
+
+  end
+
+  shared_examples_for "#break is lazy" do
+
+    it "is lazy" do
+      count = 0
+      @original.break { |item| count += 1; false }
+      count.should <= 1
+    end
+
+  end
+
+  describe "#break" do
+
+    describe "doesn't run out of stack space on a really big" do
+
+      it "stream" do
+        @list = Hamster.interval(0, STACK_OVERFLOW_DEPTH)
+      end
+
+      it "list" do
+        @list = (0...STACK_OVERFLOW_DEPTH).reduce(Hamster.list) { |list, i| list.cons(i) }
+      end
+
+      after do
+        @list.break { |item| item < 5000 }
+      end
+
+    end
+
+    describe "on a stream" do
+
+      before do
+        count = 0
+        @original = Hamster.stream { count += 1 }
+      end
+
+      describe "with a block" do
+
+        before do
+          @result = @original.break { |item| item > 5 }
+          @prefix = @result.car
+          @remainder = @result.cadr
+        end
+
+        it "returns a list with two items" do
+          @result.size.should == 2
+        end
+
+        it "correctly identifies the prefix" do
+          @prefix.should == Hamster.list(1, 2, 3, 4, 5)
+        end
+
+        it "correctly identifies the remainder" do
+          @remainder.take(5).should == Hamster.list(6, 7, 8, 9, 10)
+        end
+
+      end
+
+      it_should_behave_like "#break without a block"
+
+      it_should_behave_like "#break is lazy"
+
+    end
+
+    describe "on an interval" do
+
+      before do
+        @original = Hamster.interval(1, 10)
+      end
+
+      describe "with a block" do
+
+        before do
+          @result = @original.break { |item| item > 5 }
+          @prefix = @result.car
+          @remainder = @result.cadr
+        end
+
+        it "returns a list with two items" do
+          @result.size.should == 2
+        end
+
+        it "correctly identifies the prefix" do
+          @prefix.should == Hamster.list(1, 2, 3, 4, 5)
+        end
+
+        it "correctly identifies the remainder" do
+          @remainder.should == Hamster.list(6, 7, 8, 9, 10)
+        end
+
+      end
+
+      it_should_behave_like "#break without a block"
+
+      it_should_behave_like "#break is lazy"
+
+    end
+
+    [
+      [[], [], []],
+      [[1], [1], []],
+      [[1, 2], [1, 2], []],
+      [[1, 2, 3], [1, 2], [3]],
+      [[1, 2, 3, 4], [1, 2], [3, 4]],
+      [[2, 3, 4], [2], [3, 4]],
+      [[3, 4], [], [3, 4]],
+      [[4], [], [4]],
+    ].each do |values, expected_prefix, expected_remainder|
+
+      describe "on #{values.inspect}" do
+
+        before do
+          @original = Hamster.list(*values)
+        end
+
+        describe "with a block" do
+
+          before do
+            @result = @original.break { |item| item > 2 }
+            @prefix = @result.car
+            @remainder = @result.cadr
+          end
+
+          it "preserves the original" do
+            @original.should == Hamster.list(*values)
+          end
+
+          it "returns a list with two items" do
+            @result.size.should == 2
+          end
+
+          it "correctly identifies the prefix" do
+            @prefix.should == Hamster.list(*expected_prefix)
+          end
+
+          it "correctly identifies the remainder" do
+            @remainder.should == Hamster.list(*expected_remainder)
+          end
+
+        end
+
+        it_should_behave_like "#break without a block"
+
+        it_should_behave_like "#break is lazy"
+
+      end
+
+    end
+
+  end
+
+end