hamster 1.0.1.pre.rc2 → 1.0.1.pre.rc3

data/spec/lib/hamster/hash/merge_spec.rb

@@ -0,0 +1,77 @@
+require "spec_helper"
+require "hamster/hash"
+
+describe Hamster::Hash do
+  [:merge, :+].each do |method|
+    describe "##{method}" do
+      [
+        [{}, {}, {}],
+        [{"A" => "aye"}, {}, {"A" => "aye"}],
+        [{"A" => "aye"}, {"A" => "bee"}, {"A" => "bee"}],
+        [{"A" => "aye"}, {"B" => "bee"}, {"A" => "aye", "B" => "bee"}],
+        [(1..300).zip(1..300), (150..450).zip(150..450), (1..450).zip(1..450)]
+      ].each do |a, b, expected|
+        context "for #{a.inspect} and #{b.inspect}" do
+          let(:hash_a) { Hamster.hash(a) }
+          let(:hash_b) { Hamster.hash(b) }
+          let(:result) { hash_a.send(method, hash_b) }
+
+          it "returns #{expected.inspect} when passed a Hamster::Hash"  do
+            result.should eql(Hamster.hash(expected))
+          end
+
+          it "returns #{expected.inspect} when passed a Ruby Hash" do
+            Hamster.hash(a).send(method, ::Hash[b]).should eql(Hamster.hash(expected))
+          end
+
+          it "doesn't change the original Hashes" do
+            result
+            hash_a.should eql(Hamster.hash(a))
+            hash_b.should eql(Hamster.hash(b))
+          end
+        end
+      end
+
+      context "when merging with an empty Hash" do
+        it "returns self" do
+          hash = Hamster.hash(a: 1, b: 2)
+          hash.send(method, Hamster.hash).should be(hash)
+        end
+      end
+
+      context "when called on a subclass" do
+        it "returns an instance of the subclass" do
+          subclass = Class.new(Hamster::Hash)
+          instance = subclass.new(a: 1, b: 2)
+          instance.merge(c: 3, d: 4).class.should be(subclass)
+        end
+      end
+
+      it "sets any duplicate key to the value of block if passed a block" do
+        h1 = Hamster.hash(:a => 2, :b => 1, :d => 5)
+        h2 = Hamster.hash(:a => -2, :b => 4, :c => -3)
+        r = h1.merge(h2) { |k,x,y| nil }
+        r.should eql(Hamster.hash(:a => nil, :b => nil, :c => -3, :d => 5))
+
+        r = h1.merge(h2) { |k,x,y| "#{k}:#{x+2*y}" }
+        r.should eql(Hamster.hash(:a => "a:-2", :b => "b:9", :c => -3, :d => 5))
+
+        lambda {
+          h1.merge(h2) { |k, x, y| raise(IndexError) }
+        }.should raise_error(IndexError)
+
+        r = h1.merge(h1) { |k,x,y| :x }
+        r.should eql(Hamster.hash(:a => :x, :b => :x, :d => :x))
+      end
+
+      it "yields key/value pairs in the same order as #each" do
+        hash = Hamster.hash(a: 1, b: 2, c: 3)
+        each_pairs = []
+        merge_pairs = []
+        hash.each { |k, v| each_pairs << [k, v] }
+        hash.merge(hash) { |k, v1, v2| merge_pairs << [k, v1] }
+        each_pairs.should == merge_pairs
+      end
+    end
+  end
+end

data/spec/lib/hamster/hash/min_max_spec.rb

@@ -0,0 +1,50 @@
+require "spec_helper"
+require "hamster/hash"
+
+describe Hamster::Hash do
+  let(:hash) { Hamster.hash("a" => 3, "b" => 2, "c" => 1) }
+
+  [:min, :minimum].each do |method|
+    describe "##{method}" do
+      it "returns the smallest key/val pair" do
+        hash.send(method).should == ["a", 3]
+      end
+    end
+  end
+
+  [:max, :maximum].each do |method|
+    describe "##{method}" do
+      it "returns the largest key/val pair" do
+        hash.send(method).should == ["c", 1]
+      end
+    end
+  end
+
+  describe "#min_by" do
+    it "returns the smallest key/val pair (after passing it through a key function)" do
+      hash.min_by { |k,v| v }.should == ["c", 1]
+    end
+
+    it "returns the first key/val pair yielded by #each in case of a tie" do
+      hash.min_by { 0 }.should == hash.each.first
+    end
+
+    it "returns nil if the hash is empty" do
+      Hamster.hash.min_by { |k,v| v }.should be_nil
+    end
+  end
+
+  describe "#max_by" do
+    it "returns the largest key/val pair (after passing it through a key function)" do
+      hash.max_by { |k,v| v }.should == ["a", 3]
+    end
+
+    it "returns the first key/val pair yielded by #each in case of a tie" do
+      hash.max_by { 0 }.should == hash.each.first
+    end
+
+    it "returns nil if the hash is empty" do
+      Hamster.hash.max_by { |k,v| v }.should be_nil
+    end
+  end
+end

data/spec/lib/hamster/hash/new_spec.rb

@@ -0,0 +1,71 @@
+require "spec_helper"
+require "hamster/hash"
+
+describe Hamster::Hash do
+  describe ".new" do
+    it "is amenable to overriding of #initialize" do
+      class SnazzyHash < Hamster::Hash
+        def initialize
+          super({'snazzy?' => 'oh yeah'})
+        end
+      end
+
+      SnazzyHash.new['snazzy?'].should == 'oh yeah'
+    end
+
+    context "from a subclass" do
+      it "returns a frozen instance of the subclass" do
+        subclass = Class.new(Hamster::Hash)
+        instance = subclass.new("some" => "values")
+        instance.class.should be(subclass)
+        instance.frozen?.should be true
+      end
+    end
+
+    it "accepts an array as initializer" do
+      Hamster::Hash.new([['a', 'b'], ['c', 'd']]).should eql(Hamster.hash('a' => 'b', 'c' => 'd'))
+    end
+
+    it "returns a Hash which doesn't change even if initializer is mutated" do
+      rbhash = {a: 1, b: 2}
+      hash = Hamster::Hash.new(rbhash)
+      rbhash[:a] = 'BAD'
+      hash.should eql(Hamster.hash(a: 1, b: 2))
+    end
+  end
+
+  describe ".[]" do
+    it "accepts a Ruby Hash as initializer" do
+      hash = Hamster::Hash[a: 1, b: 2]
+      hash.class.should be(Hamster::Hash)
+      hash.size.should == 2
+      hash.key?(:a).should == true
+      hash.key?(:b).should == true
+    end
+
+    it "accepts a Hamster::Hash as initializer" do
+      hash = Hamster::Hash[Hamster.hash(a: 1, b: 2)]
+      hash.class.should be(Hamster::Hash)
+      hash.size.should == 2
+      hash.key?(:a).should == true
+      hash.key?(:b).should == true
+    end
+
+    it "accepts an array as initializer" do
+      hash = Hamster::Hash[[[:a, 1], [:b, 2]]]
+      hash.class.should be(Hamster::Hash)
+      hash.size.should == 2
+      hash.key?(:a).should == true
+      hash.key?(:b).should == true
+    end
+
+    it "can be used with a subclass of Hamster::Hash" do
+      subclass = Class.new(Hamster::Hash)
+      instance = subclass[a: 1, b: 2]
+      instance.class.should be(subclass)
+      instance.size.should == 2
+      instance.key?(:a).should == true
+      instance.key?(:b).should == true
+    end
+  end
+end

data/spec/{hamster → lib/hamster}/hash/none_spec.rb

@@ -4,46 +4,44 @@ require "hamster/hash"
 describe Hamster::Hash do
   describe "#none?" do
     context "when empty" do
-      before do
-        @hash = Hamster.hash
-      end
-
       it "with a block returns true" do
-        @hash.none? {}.should == true
+        Hamster.hash.none? {}.should == true
       end
 
       it "with no block returns true" do
-        @hash.none?.should == true
+        Hamster.hash.none?.should == true
       end
     end
 
     context "when not empty" do
-      before do
-        @hash = Hamster.hash("A" => "aye", "B" => "bee", "C" => "see", nil => "NIL")
-      end
+      let(:hash) { Hamster.hash("A" => "aye", "B" => "bee", "C" => "see", nil => "NIL") }
 
       context "with a block" do
-
         [
           %w[A aye],
           %w[B bee],
           %w[C see],
           [nil, "NIL"],
         ].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 == 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 == true
+            hash.none? { |key, value| key == "D" && value == "dee" }.should == true
+          end
+
+          it "stops iterating as soon as the block returns true" do
+            yielded = []
+            hash.none? { |k,v| yielded << k; true }
+            yielded.size.should == 1
           end
         end
       end
 
       context "with no block" do
         it "returns false" do
-          @hash.none?.should == false
+          hash.none?.should == false
         end
       end
     end

data/spec/lib/hamster/hash/partition_spec.rb

@@ -0,0 +1,36 @@
+require "spec_helper"
+require "hamster/hash"
+
+describe Hamster::Hash do
+  let(:hash) { Hamster.hash("a" => 1, "b" => 2, "c" => 3, "d" => 4) }
+  let(:partition) { hash.partition { |k,v| v % 2 == 0 }}
+
+  describe "#partition" do
+    it "returns a pair of Hamster::Hashes" do
+      partition.each { |h| h.class.should be(Hamster::Hash) }
+      partition.should be_frozen
+    end
+
+    it "returns key/val pairs for which predicate is true in first Hash" do
+      partition[0].should == {"b" => 2, "d" => 4}
+    end
+
+    it "returns key/val pairs for which predicate is false in second Hash" do
+      partition[1].should == {"a" => 1, "c" => 3}
+    end
+
+    it "doesn't modify the original Hash" do
+      partition
+      hash.should eql(Hamster.hash("a" => 1, "b" => 2, "c" => 3, "d" => 4))
+    end
+
+    context "from a subclass" do
+      it "should return instances of the subclass" do
+        subclass  = Class.new(Hamster::Hash)
+        instance  = subclass.new("a" => 1, "b" => 2, "c" => 3, "d" => 4)
+        partition = instance.partition { |k,v| v % 2 == 0 }
+        partition.each { |h| h.class.should be(subclass) }
+      end
+    end
+  end
+end

data/spec/lib/hamster/hash/pretty_print_spec.rb

@@ -0,0 +1,35 @@
+require "spec_helper"
+require "hamster/hash"
+require "pp"
+require "stringio"
+
+describe Hamster::Hash do
+  describe "#pretty_print" do
+    let(:hash) { Hamster::Hash.new(DeterministicHash.new(1,1) => "tin", DeterministicHash.new(2,2) => "earwax", DeterministicHash.new(3,3) => "neanderthal") }
+    let(:stringio) { StringIO.new }
+
+
+    it "prints the whole Hash on one line if it fits" do
+      PP.pp(hash, stringio, 80)
+      stringio.string.chomp.should == 'Hamster::Hash[1 => "tin", 2 => "earwax", 3 => "neanderthal"]'
+    end
+
+    it "prints each key/val pair on its own line, if not" do
+      PP.pp(hash, stringio, 20)
+      stringio.string.chomp.should == 'Hamster::Hash[
+ 1 => "tin",
+ 2 => "earwax",
+ 3 => "neanderthal"]'
+    end
+
+    it "prints keys and vals on separate lines, if space is very tight" do
+      PP.pp(hash, stringio, 15)
+      # the trailing space after "3 =>" below is needed, don't remove it
+      stringio.string.chomp.should == 'Hamster::Hash[
+ 1 => "tin",
+ 2 => "earwax",
+ 3 => 
+  "neanderthal"]'
+    end
+  end
+end

data/spec/lib/hamster/hash/put_spec.rb

@@ -0,0 +1,81 @@
+require "spec_helper"
+require "hamster/hash"
+
+describe Hamster::Hash do
+  describe "#put" do
+    let(:hash) { Hamster.hash("A" => "aye", "B" => "bee", "C" => "see") }
+
+    context "with a block" do
+      it "passes the value to the block" do
+        hash.put("A") { |value| value.should == "aye" }
+      end
+
+      it "replaces the value with the result of the block" do
+        result = hash.put("A") { |value| "FLIBBLE" }
+        result.get("A").should == "FLIBBLE"
+      end
+
+      it "supports to_proc methods" do
+        result = hash.put("A", &:upcase)
+        result.get("A").should == "AYE"
+      end
+
+      context "if there is no existing association" do
+        it "passes nil to the block" do
+          hash.put("D") { |value| value.should be_nil }
+        end
+
+        it "stores the result of the block as the new value" do
+          result = hash.put("D") { |value| "FLIBBLE" }
+          result.get("D").should == "FLIBBLE"
+        end
+      end
+    end
+
+    context "with a unique key" do
+      let(:result) { hash.put("D", "dee") }
+
+      it "preserves the original" do
+        result
+        hash.should eql(Hamster.hash("A" => "aye", "B" => "bee", "C" => "see"))
+      end
+
+      it "returns a copy with the superset of key/value pairs" do
+        result.should eql(Hamster.hash("A" => "aye", "B" => "bee", "C" => "see", "D" => "dee"))
+      end
+    end
+
+    context "with a duplicate key" do
+      let(:result) { hash.put("C", "sea") }
+
+      it "preserves the original" do
+        result
+        hash.should eql(Hamster.hash("A" => "aye", "B" => "bee", "C" => "see"))
+      end
+
+      it "returns a copy with the superset of key/value pairs" do
+        result.should eql(Hamster.hash("A" => "aye", "B" => "bee", "C" => "sea"))
+      end
+    end
+
+    context "with unequal keys which hash to the same value" do
+      let(:hash) { Hamster.hash(DeterministicHash.new('a', 1) => 'aye') }
+
+      it "stores and can retrieve both" do
+        result = hash.put(DeterministicHash.new('b', 1), 'bee')
+        result.get(DeterministicHash.new('a', 1)).should eql('aye')
+        result.get(DeterministicHash.new('b', 1)).should eql('bee')
+      end
+    end
+
+    context "when a String is inserted as key and then mutated" do
+      it "is not affected" do
+        string = "a string!"
+        hash = Hamster.hash.put(string, 'a value!')
+        string.upcase!
+        hash['a string!'].should == 'a value!'
+        hash['A STRING!'].should be_nil
+      end
+    end
+  end
+end

data/spec/lib/hamster/hash/reduce_spec.rb

@@ -0,0 +1,36 @@
+require "spec_helper"
+require "hamster/hash"
+
+describe Hamster::Hash do
+  [:reduce, :inject, :fold, :foldr].each do |method|
+    describe "##{method}" do
+      context "when empty" do
+        it "returns the memo" do
+          Hamster.hash.send(method, "ABC") {}.should == "ABC"
+        end
+      end
+
+      context "when not empty" do
+        let(:hash) { Hamster.hash("A" => "aye", "B" => "bee", "C" => "see") }
+
+        context "with a block" do
+          it "returns the final memo" do
+            hash.send(method, 0) { |memo, key, value| memo + 1 }.should == 3
+          end
+        end
+
+        context "with no block" do
+          let(:hash) { Hamster.hash(a: 1, b: 2) }
+
+          it "uses a passed string as the name of a method to use instead" do
+            [[:a, 1, :b, 2], [:b, 2, :a, 1]].include?(hash.send(method, "+")).should == true
+          end
+
+          it "uses a passed symbol as the name of a method to use instead" do
+            [[:a, 1, :b, 2], [:b, 2, :a, 1]].include?(hash.send(method, :+)).should == true
+          end
+        end
+      end
+    end
+  end
+end