hamster 0.4.3 → 1.0.0

data/spec/lib/hamster/sorted_set/eql_spec.rb

@@ -0,0 +1,121 @@
+require "spec_helper"
+require "set"
+require "hamster/set"
+
+describe Hamster::SortedSet do
+  let(:set) { Hamster.sorted_set(*values) }
+  let(:comparison) { Hamster.sorted_set(*comparison_values) }
+
+  describe "#eql?" do
+    let(:eql?) { set.eql?(comparison) }
+
+    shared_examples "comparing something which is not a sorted set" do
+      let(:values) { %w[A B C] }
+
+      it "returns false" do
+        expect(eql?).to eq(false)
+      end
+    end
+
+    context "when comparing to a standard set" do
+      let(:comparison) { Set.new(%w[A B C]) }
+      include_examples "comparing something which is not a sorted set"
+    end
+
+    context "when comparing to a arbitrary object" do
+      let(:comparison) { Object.new }
+      include_examples "comparing something which is not a sorted set"
+    end
+
+    context "when comparing to a Hamster::Set" do
+      let(:comparison) { Hamster::Set.new(%w[A B C]) }
+      include_examples "comparing something which is not a sorted set"
+    end
+
+    context "when comparing with a subclass of Hamster::SortedSet" do
+      let(:comparison) { Class.new(Hamster::SortedSet).new(%w[A B C]) }
+      include_examples "comparing something which is not a sorted set"
+    end
+
+    context "with an empty set for each comparison" do
+      let(:values) { [] }
+      let(:comparison_values) { [] }
+
+      it "returns true" do
+        expect(eql?).to eq(true)
+      end
+    end
+
+    context "with an empty set and a set with nil" do
+      let(:values) { [] }
+      let(:comparison_values) { [nil] }
+
+      it "returns false" do
+        expect(eql?).to eq(false)
+      end
+    end
+
+    context "with a single item array and empty array" do
+      let(:values) { ["A"] }
+      let(:comparison_values) { [] }
+
+      it "returns false" do
+        expect(eql?).to eq(false)
+      end
+    end
+
+    context "with matching single item array" do
+      let(:values) { ["A"] }
+      let(:comparison_values) { ["A"] }
+
+      it "returns true" do
+        expect(eql?).to eq(true)
+      end
+    end
+
+    context "with mismatching single item array" do
+      let(:values) { ["A"] }
+      let(:comparison_values) { ["B"] }
+
+      it "returns false" do
+        expect(eql?).to eq(false)
+      end
+    end
+
+    context "with a multi-item array and single item array" do
+      let(:values) { %w[A B] }
+      let(:comparison_values) { ["A"] }
+
+      it "returns false" do
+        expect(eql?).to eq(false)
+      end
+    end
+
+    context "with matching multi-item array" do
+      let(:values) { %w[A B] }
+      let(:comparison_values) { %w[A B] }
+
+      it "returns true" do
+        expect(eql?).to eq(true)
+      end
+    end
+
+    context "with a mismatching multi-item array" do
+      let(:values) { %w[A B] }
+      let(:comparison_values) { %w[B A] }
+
+      it "returns true" do
+        expect(eql?).to eq(true)
+      end
+    end
+
+    context "with the same values, but a different sort order" do
+      let(:set) { Hamster.sorted_set(1, 2, 3) }
+      let(:comparison) { Hamster.sorted_set(1, 2, 3) { |n| -n }}
+
+      it "returns false" do
+        expect(eql?).to eq(false)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+require "spec_helper"
+require "hamster/sorted_set"
+
+describe Hamster::SortedSet 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
+          it "returns #{expected.inspect}"  do
+            Hamster.sorted_set(*a).send(method, Hamster.sorted_set(*b)).should eql(Hamster.sorted_set(*expected))
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/hamster/sorted_set/fetch_spec.rb

@@ -0,0 +1,65 @@
+require "spec_helper"
+require "hamster/sorted_set"
+
+describe Hamster::SortedSet do
+  describe "#fetch" do
+    let(:sorted_set) { Hamster.sorted_set('a', 'b', 'c') }
+
+    context "with no default provided" do
+      context "when the index exists" do
+        it "returns the value at the index" do
+          sorted_set.fetch(0).should == "a"
+          sorted_set.fetch(1).should == "b"
+          sorted_set.fetch(2).should == "c"
+        end
+      end
+
+      context "when the key does not exist" do
+        it "raises an IndexError" do
+          -> { sorted_set.fetch(3) }.should raise_error(IndexError)
+          -> { sorted_set.fetch(-4) }.should raise_error(IndexError)
+        end
+      end
+    end
+
+    context "with a default value" do
+      context "when the index exists" do
+        it "returns the value at the index" do
+          sorted_set.fetch(0, "default").should == "a"
+          sorted_set.fetch(1, "default").should == "b"
+          sorted_set.fetch(2, "default").should == "c"
+        end
+      end
+
+      context "when the index does not exist" do
+        it "returns the default value" do
+          sorted_set.fetch(3, "default").should == "default"
+          sorted_set.fetch(-4, "default").should == "default"
+        end
+      end
+    end
+
+    context "with a default block" do
+      context "when the index exists" do
+        it "returns the value at the index" do
+          sorted_set.fetch(0) { "default".upcase }.should == "a"
+          sorted_set.fetch(1) { "default".upcase }.should == "b"
+          sorted_set.fetch(2) { "default".upcase }.should == "c"
+        end
+      end
+
+      context "when the index does not exist" do
+        it "invokes the block with the missing index as parameter" do
+          sorted_set.fetch(3) { |index| index.should == 3 }
+          sorted_set.fetch(-4) { |index| index.should == -4 }
+          sorted_set.fetch(3) { "default".upcase }.should == "DEFAULT"
+          sorted_set.fetch(-4) { "default".upcase }.should == "DEFAULT"
+        end
+      end
+    end
+
+    it "gives precedence to default block over default argument if passed both" do
+      sorted_set.fetch(3, 'one') { 'two' }.should == 'two'
+    end
+  end
+end

data/spec/lib/hamster/sorted_set/find_index_spec.rb

@@ -0,0 +1,41 @@
+require "spec_helper"
+require "hamster/sorted_set"
+
+describe Hamster::SortedSet do
+  [:find_index, :index].each do |method|
+    describe "##{method}" do
+      [
+        [[], "A", nil],
+        [[], nil, nil],
+        [["A"], "A", 0],
+        [["A"], "B", nil],
+        [["A"], nil, nil],
+        [["A", "B", "C"], "A", 0],
+        [["A", "B", "C"], "B", 1],
+        [["A", "B", "C"], "C", 2],
+        [["A", "B", "C"], "D", nil],
+        [0..1, 1, 1],
+        [0..10, 5, 5],
+        [0..10, 10, 10],
+        [[2], 2, 0],
+        [[2], 2.0, 0],
+        [[2.0], 2.0, 0],
+        [[2.0], 2, 0],
+      ].each do |values, item, expected|
+        unless item.nil? # test breaks otherwise
+          context "looking for #{item.inspect} in #{values.inspect} without block" do
+            it "returns #{expected.inspect}" do
+              Hamster.sorted_set(*values).send(method, item).should == expected
+            end
+          end
+        end
+
+        context "looking for #{item.inspect} in #{values.inspect} with block" do
+          it "returns #{expected.inspect}" do
+            Hamster.sorted_set(*values).send(method) { |x| x == item }.should == expected
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+require "spec_helper"
+require "hamster/sorted_set"
+
+describe Hamster::SortedSet do
+  describe "#first" do
+    [
+      [[], nil],
+      [["A"], "A"],
+      [%w[A B C], "A"],
+      [%w[Z Y X], "X"]
+    ].each do |values, expected|
+      context "on #{values.inspect}" do
+        it "returns #{expected.inspect}" do
+          Hamster.sorted_set(*values).first.should eql(expected)
+        end
+      end
+    end
+  end
+end

data/spec/lib/hamster/sorted_set/from_spec.rb

@@ -0,0 +1,52 @@
+require "spec_helper"
+require "hamster/sorted_set"
+
+describe Hamster::SortedSet do
+  describe "#from" do
+    context "when called without a block" do
+      it "returns a sorted set of all items equal to or greater than the argument" do
+        100.times do
+          items = rand(100).times.collect { rand(1000) }
+          set   = Hamster::SortedSet.new(items)
+          threshold = rand(1000)
+          result = set.from(threshold)
+          array  = items.select { |x| x >= threshold }.sort
+          result.class.should be(Hamster::SortedSet)
+          result.size.should == array.size
+          result.to_a.should == array
+        end
+      end
+    end
+
+    context "when called with a block" do
+      it "yields all the items equal to or greater than than the argument" do
+        100.times do
+          items = rand(100).times.collect { rand(1000) }
+          set   = Hamster::SortedSet.new(items)
+          threshold = rand(1000)
+          result = []
+          set.from(threshold) { |x| result << x }
+          array  = items.select { |x| x >= threshold }.sort
+          result.size.should == array.size
+          result.should == array
+        end
+      end
+    end
+
+    context "on an empty set" do
+      it "returns an empty set" do
+        Hamster::SortedSet.empty.from(1).should be_empty
+        Hamster::SortedSet.empty.from('abc').should be_empty
+        Hamster::SortedSet.empty.from(:symbol).should be_empty
+      end
+    end
+
+    context "with an argument higher than all the values in the set" do
+      it "returns an empty set" do
+        result = Hamster.sorted_set(*(1..100)).from(101)
+        result.class.should be(Hamster::SortedSet)
+        result.should be_empty
+      end
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+require "spec_helper"
+require "hamster/sorted_set"
+
+describe Hamster::SortedSet do
+  [:group_by, :group, :classify].each do |method|
+    describe "##{method}" do
+      context "with a block" do
+        [
+          [[], []],
+          [[1], [true => Hamster.sorted_set(1)]],
+          [[1, 2, 3, 4], [true => Hamster.sorted_set(3, 1), false => Hamster.sorted_set(4, 2)]],
+        ].each do |values, expected|
+          context "on #{values.inspect}" do
+            let(:sorted_set) { Hamster.sorted_set(*values) }
+
+            it "preserves the original" do
+              sorted_set.send(method, &:odd?)
+              sorted_set.should eql(Hamster.sorted_set(*values))
+            end
+
+            it "returns #{expected.inspect}" do
+              sorted_set.send(method, &:odd?).should eql(Hamster.hash(*expected))
+            end
+          end
+        end
+      end
+
+      context "without a block" do
+        [
+          [[], []],
+          [[1], [1 => Hamster.sorted_set(1)]],
+          [[1, 2, 3, 4], [1 => Hamster.sorted_set(1), 2 => Hamster.sorted_set(2), 3 => Hamster.sorted_set(3), 4 => Hamster.sorted_set(4)]],
+        ].each do |values, expected|
+          context "on #{values.inspect}" do
+            let(:sorted_set) { Hamster.sorted_set(*values) }
+
+            it "preserves the original" do
+              sorted_set.group_by
+              sorted_set.should eql(Hamster.sorted_set(*values))
+            end
+
+            it "returns #{expected.inspect}" do
+              sorted_set.group_by.should eql(Hamster.hash(*expected))
+            end
+          end
+        end
+      end
+
+      context "from a subclass" do
+        it "returns an Hash whose values are instances of the subclass" do
+          subclass = Class.new(Hamster::SortedSet)
+          instance = subclass.new(['some', 'strings', 'here'])
+          instance.group_by { |x| x }.values.each { |v| v.class.should be(subclass) }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+require "spec_helper"
+require "hamster/sorted_set"
+
+describe Hamster::SortedSet do
+  [:include?, :member?].each do |method|
+    describe "##{method}" do
+      let(:sorted_set) { Hamster.sorted_set(1, 2, 3, 4.0) }
+
+      [1, 2, 3, 4.0].each do |value|
+        it "returns true for an existing value (#{value.inspect})" do
+          sorted_set.send(method, value).should == true
+        end
+      end
+
+      it "returns false for a non-existing value" do
+        sorted_set.send(method, 5).should == false
+      end
+
+      it "uses #<=> for equality" do
+        sorted_set.send(method, 4).should == true
+      end
+    end
+  end
+end

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

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