hamster 0.4.3 → 1.0.0

data/spec/lib/hamster/set/exclusion_spec.rb

@@ -0,0 +1,48 @@
+require "spec_helper"
+require "hamster/set"
+
+describe Hamster::Set do
+  [:exclusion, :^].each do |method|
+    describe "##{method}" do
+      [
+        [[], [], []],
+        [["A"], [], ["A"]],
+        [["A"], ["A"], []],
+        [%w[A B C], ["B"], %w[A C]],
+        [%w[A B C], %w[B C D], %w[A D]],
+        [%w[A B C], %w[D E F], %w[A B C D E F]],
+      ].each do |a, b, expected|
+        context "for #{a.inspect} and #{b.inspect}" do
+          let(:set_a) { Hamster.set(*a) }
+          let(:set_b) { Hamster.set(*b) }
+          let(:result) { set_a.send(method, set_b) }
+
+          it "doesn't modify the original Sets" do
+            result
+            set_a.should eql(Hamster::Set.new(a))
+            set_b.should eql(Hamster::Set.new(b))
+          end
+
+          it "returns #{expected.inspect}"  do
+            result.should eql(Hamster.set(*expected))
+          end
+        end
+
+        context "when passed a Ruby Array" do
+          it "returns the expected Set" do
+            Hamster.set(*a).exclusion(b.freeze).should eql(Hamster.set(*expected))
+          end
+        end
+      end
+
+      it "works for a wide variety of inputs" do
+        50.times do
+          array1 = (1..400).to_a.sample(100)
+          array2 = (1..400).to_a.sample(100)
+          result = Hamster::Set.new(array1) ^ Hamster::Set.new(array2)
+          result.to_a.sort.should eql(((array1 | array2) - (array1 & array2)).sort)
+        end
+      end
+    end
+  end
+end

data/spec/{hamster → lib/hamster}/set/find_spec.rb

@@ -1,13 +1,9 @@
-require 'spec_helper'
-
-require 'hamster/set'
+require "spec_helper"
+require "hamster/set"
 
 describe Hamster::Set do
-
   [:find, :detect].each do |method|
-
     describe "##{method}" do
-
       [
         [[], "A", nil],
         [[], nil, nil],
@@ -19,35 +15,22 @@ describe Hamster::Set do
         [["A", "B", nil], nil, nil],
         [["A", "B", nil], "C", nil],
       ].each do |values, item, expected|
-
         describe "on #{values.inspect}" do
-
-          before do
-            @set = Hamster.set(*values)
-          end
-
-          describe "with a block" do
-
+          context "with a block" do
             it "returns #{expected.inspect}" do
-              @set.send(method) { |x| x == item }.should == expected
+              Hamster.set(*values).send(method) { |x| x == item }.should == expected
             end
-
           end
 
-          describe "without a block" do
-
-            it "returns nil" do
-              @set.send(method).should be_nil
+          context "without a block" do
+            it "returns an Enumerator" do
+              result = Hamster.set(*values).send(method)
+              result.class.should be(Enumerator)
+              result.each { |x| x == item}.should == expected
             end
-
           end
-
         end
-
       end
-
     end
-
   end
-
-end
+end

data/spec/lib/hamster/set/first_spec.rb

@@ -0,0 +1,29 @@
+require "spec_helper"
+require "hamster/set"
+
+describe Hamster::Set do
+  describe "#first" do
+    context "on an empty set" do
+      it "returns nil" do
+        Hamster.set.first.should be_nil
+      end
+    end
+
+    context "on a non-empty set" do
+      it "returns an arbitrary value from the set" do
+        %w[A B C].include?(Hamster.set("A", "B", "C").first).should == true
+      end
+    end
+
+    it "returns nil if only member of set is nil" do
+      Hamster.set(nil).first.should be(nil)
+    end
+
+    it "returns the first item yielded by #each" do
+      10.times do
+        set = Hamster::Set.new((rand(10)+1).times.collect { rand(10000 )})
+        set.each { |item| break item }.should be(set.first)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+require "spec_helper"
+require "hamster/set"
+
+describe Hamster do
+  describe "#flatten" do
+    [
+      [["A"], ["A"]],
+      [%w[A B C], %w[A B C]],
+      [["A", Hamster.set("B"), "C"], %w[A B C]],
+      [[Hamster.set("A"), Hamster.set("B"), Hamster.set("C")], %w[A B C]],
+    ].each do |values, expected|
+      describe "on #{values}" do
+        let(:set) { Hamster.set(*values) }
+
+        it "preserves the original" do
+          set.flatten
+          set.should eql(Hamster.set(*values))
+        end
+
+        it "returns the inlined values" do
+          set.flatten.should eql(Hamster.set(*expected))
+        end
+      end
+    end
+
+    context "on an empty set" do
+      it "returns an empty set" do
+        Hamster.set.flatten.should equal(Hamster.set)
+      end
+    end
+
+    context "on a set with multiple levels of nesting" do
+      it "inlines lower levels of nesting" do
+        set = Hamster.set(Hamster.set(Hamster.set(1)), Hamster.set(Hamster.set(2)))
+        set.flatten.should eql(Hamster.set(1, 2))
+      end
+    end
+
+    context "from a subclass" do
+      it "returns an instance of the subclass" do
+        subclass = Class.new(Hamster::Set)
+        subclass.new.flatten.class.should be(subclass)
+        subclass.new([Hamster.set(1), Hamster.set(2)]).flatten.class.should be(subclass)
+      end
+    end
+  end
+end

data/spec/lib/hamster/set/grep_spec.rb

@@ -0,0 +1,58 @@
+require "spec_helper"
+require "hamster/set"
+
+describe Hamster::Set do
+  let(:set) { Hamster.set(*values) }
+
+  describe "#grep" do
+    let(:grep) { set.grep(String, &block) }
+
+    shared_examples "check filtered values" do
+      it "returns the filtered values" do
+        expect(grep).to eq(filtered)
+      end
+    end
+
+    shared_examples "check different types of inputs" do
+      context "with an empty array" do
+        let(:values) { [] }
+        let(:filtered) { [] }
+
+        shared_examples "check filtered values"
+      end
+
+      context "with a single item array" do
+        let(:values) { ["A"] }
+        let(:filtered) { ["A"] }
+
+        shared_examples "check filtered values"
+      end
+
+      context "with a single item array that doesn't contain match" do
+        let(:values) { [1] }
+        let(:filtered) { [] }
+
+        shared_examples "check filtered values"
+      end
+
+      context "with a multi-item array where one isn't a match" do
+        let(:values) { ["A", 2, "C"] }
+        let(:filtered) { %w[A C] }
+
+        shared_examples "check filtered values"
+      end
+    end
+
+    context "without a block" do
+      let(:block) { nil }
+
+      include_examples "check different types of inputs"
+    end
+
+    describe "with a block" do
+      let(:block) { ->(item) { item.downcase }}
+
+      include_examples "check different types of inputs"
+    end
+  end
+end

data/spec/lib/hamster/set/group_by_spec.rb

@@ -0,0 +1,60 @@
+require "spec_helper"
+require "hamster/set"
+
+describe Hamster::Set do
+  [:group_by, :group, :classify].each do |method|
+    describe "##{method}" do
+      context "with a block" do
+        [
+          [[], []],
+          [[1], [true => Hamster.set(1)]],
+          [[1, 2, 3, 4], [true => Hamster.set(3, 1), false => Hamster.set(4, 2)]],
+        ].each do |values, expected|
+          context "on #{values.inspect}" do
+            let(:set) { Hamster.set(*values) }
+
+            it "returns #{expected.inspect}" do
+              set.send(method, &:odd?).should eql(Hamster.hash(*expected))
+              set.should eql(Hamster::Set.new(values)) # make sure it hasn't changed
+            end
+          end
+        end
+      end
+
+      context "without a block" do
+        [
+          [[], []],
+          [[1], [1 => Hamster.set(1)]],
+          [[1, 2, 3, 4], [1 => Hamster.set(1), 2 => Hamster.set(2), 3 => Hamster.set(3), 4 => Hamster.set(4)]],
+        ].each do |values, expected|
+          context "on #{values.inspect}" do
+            let(:set) { Hamster.set(*values) }
+
+            it "returns #{expected.inspect}" do
+              set.group_by.should eql(Hamster.hash(*expected))
+              set.should eql(Hamster::Set.new(values)) # make sure it hasn't changed
+            end
+          end
+        end
+      end
+
+      context "on an empty set" do
+        it "returns an empty hash" do
+          Hamster.set.group_by { |x| x }.should eql(Hamster.hash)
+        end
+      end
+
+      it "returns a hash without default proc" do
+        Hamster.set(1,2,3).group_by { |x| x }.default_proc.should be_nil
+      end
+
+      context "from a subclass" do
+        it "returns an Hash whose values are instances of the subclass" do
+          subclass = Class.new(Hamster::Set)
+          instance = subclass.new([1, 'string', :symbol])
+          instance.group_by { |x| x.class }.values.each { |v| v.class.should be(subclass) }
+        end
+      end
+    end
+  end
+end

data/spec/lib/hamster/set/hash_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper"
+require "hamster/set"
+
+describe Hamster::Set do
+  describe "#hash" do
+    context "on an empty set" do
+      it "returns 0" do
+        Hamster.set.hash.should == 0
+      end
+    end
+
+    it "generates the same hash value for a set regardless of the order things were added to it" do
+      item1 = DeterministicHash.new('a', 121)
+      item2 = DeterministicHash.new('b', 474)
+      item3 = DeterministicHash.new('c', 121)
+      Hamster.set.add(item1).add(item2).add(item3).hash.should == Hamster.set.add(item3).add(item2).add(item1).hash
+    end
+
+    it "values are sufficiently distributed" do
+      (1..4000).each_slice(4).map { |a, b, c, d| Hamster.set(a, b, c, d).hash }.uniq.size.should == 1000
+    end
+  end
+end

data/spec/{hamster → lib/hamster}/set/immutable_spec.rb

@@ -1,12 +1,9 @@
-require 'spec_helper'
-
-require 'hamster/immutable'
-require 'hamster/set'
+require "spec_helper"
+require "hamster/immutable"
+require "hamster/set"
 
 describe Hamster::Set do
-
   it "includes Immutable" do
     Hamster::Set.should include(Hamster::Immutable)
   end
-
-end
+end

data/spec/lib/hamster/set/include_spec.rb

@@ -0,0 +1,61 @@
+require "spec_helper"
+require "hamster/set"
+require 'set'
+
+describe Hamster::Set do
+  [:include?, :member?].each do |method|
+    describe "##{method}" do
+      let(:set) { Hamster.set("A", "B", "C", 2.0, nil) }
+
+      ["A", "B", "C", 2.0, nil].each do |value|
+        it "returns true for an existing value (#{value.inspect})" do
+          set.send(method, value).should == true
+        end
+      end
+
+      it "returns false for a non-existing value" do
+        set.send(method, "D").should == false
+      end
+
+      it "returns true even if existing value is nil" do
+        Hamster.set(nil).include?(nil).should == true
+      end
+
+      it "returns true even if existing value is false" do
+        Hamster.set(false).include?(false).should == true
+      end
+
+      it "returns false for a mutable item which is mutated after adding" do
+        item = ['mutable']
+        item = [rand(1000000)] while (item.hash.abs & 31 == [item[0], 'HOSED!'].hash.abs & 31)
+        set  = Hamster::Set[item]
+        item.push('HOSED!')
+        set.include?(item).should == false
+      end
+
+      it "uses #eql? for equality" do
+        set.send(method, 2).should == false
+      end
+
+      it "returns the right answers after a lot of addings and removings" do
+        array, set, rb_set = [], Hamster::Set.new, Set.new
+
+        1000.times do
+          if rand(2) == 0
+            array << (item = rand(10000))
+            rb_set.add(item)
+            set = set.add(item)
+            set.include?(item).should == true
+          else
+            item = array.sample
+            rb_set.delete(item)
+            set = set.delete(item)
+            set.include?(item).should == false
+          end
+        end
+
+        array.each { |item| set.include?(item).should == rb_set.include?(item) }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+require "spec_helper"
+require "hamster/set"
+
+describe Hamster::Set do
+  describe "#inspect" do
+    [
+      [[], "Hamster::Set[]"],
+      [["A"], 'Hamster::Set["A"]'],
+    ].each do |values, expected|
+      describe "on #{values.inspect}" do
+        let(:set) { Hamster.set(*values) }
+
+        it "returns #{expected.inspect}" do
+          set.inspect.should == expected
+        end
+
+        it "returns a string which can be eval'd to get an equivalent set" do
+          eval(set.inspect).should eql(set)
+        end
+      end
+    end
+
+    describe 'on ["A", "B", "C"]' do
+      let(:set) { Hamster.set("A", "B", "C") }
+
+      it "returns a programmer-readable representation of the set contents" do
+        set.inspect.should match(/^Hamster::Set\["[A-C]", "[A-C]", "[A-C]"\]$/)
+      end
+
+      it "returns a string which can be eval'd to get an equivalent set" do
+        eval(set.inspect).should eql(set)
+      end
+    end
+
+    context "from a subclass" do
+      MySet = Class.new(Hamster::Set)
+      let(:set) { MySet[1, 2] }
+
+      it "returns a programmer-readable representation of the set contents" do
+        set.inspect.should match(/^MySet\[[1-2], [1-2]\]$/)
+      end
+
+      it "returns a string which can be eval'd to get an equivalent set" do
+        eval(set.inspect).should eql(set)
+      end
+    end
+  end
+end