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

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

@@ -0,0 +1,99 @@
+require "spec_helper"
+require "hamster/hash"
+
+describe Hamster::Hash do
+  describe "#flatten" do
+    context "with flatten depth of zero" do
+      it "returns a vector of keys/value" do
+        hash = Hamster.hash(a: 1, b: 2)
+        hash.flatten(0).sort.should eql(V[[:a, 1], [:b, 2]])
+      end
+    end
+
+    context "without array keys or values" do
+      it "returns a vector of keys and values" do
+        hash = Hamster.hash(a: 1, b: 2, c: 3)
+        possibilities = [[:a, 1, :b, 2, :c, 3],
+         [:a, 1, :c, 3, :b, 2],
+         [:b, 2, :a, 1, :c, 3],
+         [:b, 2, :c, 3, :a, 1],
+         [:c, 3, :a, 1, :b, 2],
+         [:c, 3, :b, 2, :a, 1]]
+        possibilities.include?(hash.flatten).should == true
+        possibilities.include?(hash.flatten(1)).should == true
+        possibilities.include?(hash.flatten(2)).should == true
+        hash.flatten(2).class.should be(Hamster::Vector)
+        possibilities.include?(hash.flatten(10)).should == true
+      end
+
+      it "doesn't modify the receiver" do
+        hash = Hamster.hash(a: 1, b: 2, c: 3)
+        hash.flatten(1)
+        hash.flatten(2)
+        hash.should eql(Hamster.hash(a: 1, b: 2, c: 3))
+      end
+    end
+
+    context "on an empty Hash" do
+      it "returns an empty Vector" do
+        Hamster.hash.flatten.should eql(V[])
+      end
+    end
+
+    context "with array keys" do
+      it "flattens array keys into returned vector if flatten depth is sufficient" do
+        hash = Hamster.hash([1, 2] => 3, [4, 5] => 6)
+        [[[1, 2], 3, [4, 5], 6], [[4, 5], 6, [1, 2], 3]].include?(hash.flatten(1)).should == true
+        [[[1, 2], 3, [4, 5], 6], [[4, 5], 6, [1, 2], 3]].include?(hash.flatten).should == true
+        hash.flatten(1).class.should be(Hamster::Vector)
+        [[1, 2, 3, 4, 5, 6], [4, 5, 6, 1, 2, 3]].include?(hash.flatten(2)).should == true
+        [[1, 2, 3, 4, 5, 6], [4, 5, 6, 1, 2, 3]].include?(hash.flatten(3)).should == true
+      end
+
+      it "doesn't modify the receiver (or its contents)" do
+        hash = Hamster.hash([1, 2] => 3, [4, 5] => 6)
+        hash.flatten(1)
+        hash.flatten(2)
+        hash.should eql(Hamster.hash([1, 2] => 3, [4, 5] => 6))
+      end
+    end
+
+    context "with array values" do
+      it "flattens array values into returned vector if flatten depth is sufficient" do
+        hash = Hamster.hash(1 => [2, 3], 4 => [5, 6])
+        [[1, [2, 3], 4, [5, 6]], [4, [5, 6], 1, [2, 3]]].include?(hash.flatten(1)).should == true
+        [[1, [2, 3], 4, [5, 6]], [4, [5, 6], 1, [2, 3]]].include?(hash.flatten).should == true
+        [[1, 2, 3, 4, 5, 6], [4, 5, 6, 1, 2, 3]].include?(hash.flatten(2)).should == true
+        [[1, 2, 3, 4, 5, 6], [4, 5, 6, 1, 2, 3]].include?(hash.flatten(3)).should == true
+        hash.flatten(3).class.should be(Hamster::Vector)
+      end
+
+      it "doesn't modify the receiver (or its contents)" do
+        hash = Hamster.hash(1 => [2, 3], 4 => [5, 6])
+        hash.flatten(1)
+        hash.flatten(2)
+        hash.should eql(Hamster.hash(1 => [2, 3], 4 => [5, 6]))
+      end
+    end
+
+    context "with vector keys" do
+      it "flattens vector keys into returned vector if flatten depth is sufficient" do
+        hash = Hamster.hash(V[1, 2] => 3, V[4, 5] => 6)
+        [[V[1, 2], 3, V[4, 5], 6], [V[4, 5], 6, V[1, 2], 3]].include?(hash.flatten).should == true
+        [[V[1, 2], 3, V[4, 5], 6], [V[4, 5], 6, V[1, 2], 3]].include?(hash.flatten(1)).should == true
+        [[1, 2, 3, 4, 5, 6], [4, 5, 6, 1, 2, 3]].include?(hash.flatten(2)).should == true
+        [[1, 2, 3, 4, 5, 6], [4, 5, 6, 1, 2, 3]].include?(hash.flatten(3)).should == true
+      end
+    end
+
+    context "with vector values" do
+      it "flattens vector values into returned vector if flatten depth is sufficient" do
+        hash = Hamster.hash(1 => V[2, 3], 4 => V[5, 6])
+        [[1, V[2, 3], 4, V[5, 6]], [4, V[5, 6], 1, V[2, 3]]].include?(hash.flatten(1)).should == true
+        [[1, V[2, 3], 4, V[5, 6]], [4, V[5, 6], 1, V[2, 3]]].include?(hash.flatten).should == true
+        [[1, 2, 3, 4, 5, 6], [4, 5, 6, 1, 2, 3]].include?(hash.flatten(2)).should == true
+        [[1, 2, 3, 4, 5, 6], [4, 5, 6, 1, 2, 3]].include?(hash.flatten(3)).should == true
+      end
+    end
+  end
+end

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

@@ -0,0 +1,80 @@
+require "spec_helper"
+require "hamster/hash"
+
+describe Hamster::Hash do
+  [:get, :[]].each do |method|
+    describe "##{method}" do
+      context "with a default block" do
+        let(:hash) { Hamster.hash("A" => "aye") { |key| fail }}
+
+        context "when the key exists" do
+          it "returns the value associated with the key" do
+            hash.send(method, "A").should == "aye"
+          end
+
+          it "does not call the default block even if the key is 'nil'" do
+            Hamster.hash(nil => 'something') { fail }.send(method, nil)
+          end
+        end
+
+        context "when the key does not exist" do
+          let(:hash) do
+            Hamster.hash("A" => "aye") do |key|
+              expect(key).to eq("B")
+              "bee"
+            end
+          end
+
+          it "returns the value from the default block" do
+            hash.send(method, "B").should == "bee"
+          end
+        end
+      end
+
+      context "with no default block" do
+        let(:hash) { Hamster.hash("A" => "aye", "B" => "bee", "C" => "see", nil => "NIL") }
+
+        [
+          %w[A aye],
+          %w[B bee],
+          %w[C see],
+          [nil, "NIL"]
+        ].each do |key, value|
+          it "returns the value (#{value.inspect}) for an existing key (#{key.inspect})" do
+            hash.send(method, key).should == value
+          end
+        end
+
+        it "returns nil for a non-existing key" do
+          hash.send(method, "D").should be_nil
+        end
+      end
+
+      it "uses #hash to look up keys" do
+        x = double('0')
+        x.should_receive(:hash).and_return(0)
+        Hamster.hash(foo: :bar).send(method, x).should be_nil
+      end
+
+      it "uses #eql? to compare keys with the same hash code" do
+        x = double('x', hash: 42)
+        x.should_not_receive(:eql?)
+
+        y = double('y', hash: 42)
+        y.should_receive(:eql?).and_return(true)
+
+        Hamster.hash(y => 1)[x].should == 1
+      end
+
+      it "does not use #eql? to compare keys with different hash codes" do
+        x = double('x', hash: 0)
+        x.should_not_receive(:eql?)
+
+        y = double('y', hash: 1)
+        y.should_not_receive(:eql?)
+
+        Hamster.hash(y => 1)[x].should be_nil
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+require "spec_helper"
+require "hamster/hash"
+
+describe Hamster::Hash do
+  [:key?, :has_key?, :include?, :member?].each do |method|
+    describe "##{method}" do
+      let(:hash) { Hamster.hash("A" => "aye", "B" => "bee", "C" => "see", nil => "NIL", 2.0 => "two") }
+
+      ["A", "B", "C", nil, 2.0].each do |key|
+        it "returns true for an existing key (#{key.inspect})" do
+          hash.send(method, key).should == true
+        end
+      end
+
+      it "returns false for a non-existing key" do
+        hash.send(method, "D").should == false
+      end
+
+      it "uses #eql? for equality" do
+        hash.send(method, 2).should == false
+      end
+
+      it "returns true if the key is found and maps to nil" do
+        Hamster.hash("A" => nil).send(method, "A").should == true
+      end
+
+      it "returns true if the key is found and maps to false" do
+        Hamster.hash("A" => false).send(method, "A").should == true
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+require "spec_helper"
+require "hamster/hash"
+
+describe Hamster::Hash do
+  let(:hash) { Hamster.hash(toast: 'buttered', jam: 'strawberry') }
+
+  [:value?, :has_value?].each do |method|
+    describe "##{method}" do
+      it "returns true if any key/val pair in Hash has the same value" do
+        hash.send(method, 'strawberry').should == true
+      end
+
+      it "returns false if no key/val pair in Hash has the same value" do
+        hash.send(method, 'marmalade').should == false
+      end
+
+      it "uses #== to check equality" do
+        Hamster.hash(a: EqualNotEql.new).send(method, EqualNotEql.new).should == true
+        Hamster.hash(a: EqlNotEqual.new).send(method, EqlNotEqual.new).should == false
+      end
+
+      it "works on a large hash" do
+        large = Hamster::Hash.new((1..1000).zip(2..1001))
+        [2, 100, 200, 500, 900, 1000, 1001].each { |n| large.value?(n).should == true }
+      end
+    end
+  end
+end

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

@@ -3,7 +3,6 @@ require "hamster/hash"
 
 describe Hamster::Hash do
   describe "#hash" do
-
     it "values are sufficiently distributed" do
       (1..4000).each_slice(4).map { |ka, va, kb, vb| Hamster.hash(ka => va, kb => vb).hash }.uniq.size.should == 1000
     end
@@ -16,21 +15,15 @@ describe Hamster::Hash do
       Hamster.hash("ka" => "va").hash.should_not == Hamster.hash("kb" => "va").hash
     end
 
-    it "generates the same hash value for the a hash regardless of the order things were added to it" do
-      # The keys :issued_at and :expires_at happen to end up in the same
-      # bucket in the trie, so depending on which one gets added first, one
-      # of them will end up in a child trie. The hash value should be the
-      # same regardless of which is added first
-      Hamster.hash.put(:issued_at, nil).put(:expires_at, nil).hash.should == Hamster.hash.put(:expires_at, nil).put(:issued_at, nil).hash
+    it "generates the same hash value for a hash regardless of the order things were added to it" do
+      key1 = DeterministicHash.new('abc', 1)
+      key2 = DeterministicHash.new('xyz', 1)
+      Hamster.hash.put(key1, nil).put(key2, nil).hash.should == Hamster.hash.put(key2, nil).put(key1, nil).hash
     end
 
     describe "on an empty hash" do
-      before do
-        @result = Hamster.hash.hash
-      end
-
       it "returns 0" do
-        @result.should == 0
+        Hamster.hash.hash.should == 0
       end
     end
   end

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

@@ -0,0 +1,31 @@
+require "spec_helper"
+require "hamster/hash"
+
+describe Hamster::Hash do
+  describe "#inspect" do
+    [
+      [[], 'Hamster::Hash[]'],
+      [["A" => "aye"], 'Hamster::Hash["A" => "aye"]'],
+      [[DeterministicHash.new("A", 1) => "aye", DeterministicHash.new("B", 2) => "bee", DeterministicHash.new("C", 3) => "see"], 'Hamster::Hash["A" => "aye", "B" => "bee", "C" => "see"]']
+    ].each do |values, expected|
+      describe "on #{values.inspect}" do
+        it "returns #{expected.inspect}" do
+          Hamster.hash(*values).inspect.should == expected
+        end
+      end
+    end
+
+    [
+      {},
+      {"A" => "aye"},
+      {a: "aye", b: "bee", c: "see"}
+    ].each do |values|
+      describe "on #{values.inspect}" do
+        it "returns a string which can be eval'd to get an equivalent object" do
+          original = Hamster::Hash.new(values)
+          eval(original.inspect).should eql(original)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+require "spec_helper"
+require "hamster/hash"
+
+describe Hamster::Hash do
+  describe "#invert" do
+    let(:hash) { Hamster.hash(a: 3, b: 2, c: 1) }
+
+    it "uses the existing keys as values and values as keys" do
+      hash.invert.should eql(Hamster.hash(3 => :a, 2 => :b, 1 => :c))
+    end
+
+    it "will select one key/value pair among multiple which have same value" do
+      [Hamster.hash(1 => :a),
+       Hamster.hash(1 => :b),
+       Hamster.hash(1 => :c)].include?(Hamster.hash(a: 1, b: 1, c: 1).invert).should == true
+    end
+
+    it "doesn't change the original Hash" do
+      hash.invert
+      hash.should eql(Hamster.hash(a: 3, b: 2, c: 1))
+    end
+
+    context "from a subclass of Hash" do
+      it "returns an instance of the subclass" do
+        subclass = Class.new(Hamster::Hash)
+        instance = subclass.new(a: 1, b: 2)
+        instance.invert.class.should be(subclass)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+require "spec_helper"
+require "hamster/hash"
+
+describe Hamster::Hash do
+  describe "#key" do
+    let(:hash) { Hamster.hash(a: 1, b: 1, c: 2, d: 3) }
+
+    it "returns a key associated with the given value, if there is one" do
+      [:a, :b].include?(hash.key(1)).should == true
+      hash.key(2).should be(:c)
+      hash.key(3).should be(:d)
+    end
+
+    it "returns nil if there is no key associated with the given value" do
+      hash.key(5).should be_nil
+      hash.key(0).should be_nil
+    end
+
+    it "uses #== to compare values for equality" do
+      hash.key(EqualNotEql.new).should_not be_nil
+      hash.key(EqlNotEqual.new).should be_nil
+    end
+
+    it "doesn't use default block if value is not found" do
+      Hamster.hash(a: 1) { fail }.key(2).should be_nil
+    end
+  end
+end

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

@@ -4,17 +4,14 @@ require "hamster/set"
 
 describe Hamster::Hash do
   describe "#keys" do
-    before do
-      hash = Hamster.hash("A" => "aye", "B" => "bee", "C" => "see")
-      @result = hash.keys
-    end
+    let(:hash) { Hamster.hash("A" => "aye", "B" => "bee", "C" => "see") }
 
     it "returns the keys as a set" do
-      @result.should == Hamster.set("A", "B", "C")
+      hash.keys.should eql(Hamster.set("A", "B", "C"))
     end
 
     it "returns frozen String keys" do
-      @result.each { |s| s.should be_frozen }
+      hash.keys.each { |s| s.should be_frozen }
     end
   end
 end

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

@@ -0,0 +1,46 @@
+require "spec_helper"
+require "hamster/hash"
+
+describe Hamster::Hash do
+  [:map, :collect].each do |method|
+    describe "##{method}" do
+      context "when empty" do
+        it "returns self" do
+          Hamster.hash.send(method) {}.should equal(Hamster.hash)
+        end
+      end
+
+      context "when not empty" do
+        let(:hash) { Hamster.hash("A" => "aye", "B"  => "bee", "C" => "see") }
+
+        context "with a block" do
+          let(:mapped) { hash.send(method) { |key, value| [key.downcase, value.upcase] }}
+
+          it "preserves the original values" do
+            mapped
+            hash.should eql(Hamster.hash("A" => "aye", "B"  => "bee", "C" => "see"))
+          end
+
+          it "returns a new hash with the mapped values" do
+            mapped.should eql(Hamster.hash("a" => "AYE", "b"  => "BEE", "c" => "SEE"))
+          end
+        end
+
+        context "with no block" do
+          it "returns an Enumerator" do
+            hash.send(method).class.should be(Enumerator)
+            hash.send(method).each { |k,v| [k.downcase, v] }.should == hash.map { |k,v| [k.downcase, v] }
+          end
+        end
+      end
+
+      context "from a subclass" do
+        it "returns an instance of the subclass" do
+          subclass = Class.new(Hamster::Hash)
+          instance = subclass.new('a' => 'aye', 'b' => 'bee')
+          instance.map { |k,v| [k, v.upcase] }.class.should be(subclass)
+        end
+      end
+    end
+  end
+end

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

@@ -18,11 +18,11 @@ describe Hamster::Hash do
       end
     end
 
-    it "should survive dumping and loading into a new process" do
-      expect(reloaded_hash).to eq(Hamster.hash(existing_key: 42, other_thing: "data"))
+    it "can survive dumping and loading into a new process" do
+      expect(reloaded_hash).to eql(Hamster.hash(existing_key: 42, other_thing: "data"))
     end
 
-    it "should still be possible to find items by key" do
+    it "is still possible to find items by key after loading" do
       expect(reloaded_hash[:existing_key]).to eq(42)
     end
   end