immutable-ruby 0.0.1

data/spec/lib/immutable/vector/shuffle_spec.rb

@@ -0,0 +1,43 @@
+require "spec_helper"
+
+describe Immutable::Vector do
+  describe "#shuffle" do
+    let(:vector) { V[1,2,3,4] }
+
+    it "returns the same values, in a usually different order" do
+      different = false
+      10.times do
+        shuffled = vector.shuffle
+        shuffled.sort.should eql(vector)
+        different ||= (shuffled != vector)
+      end
+      different.should be(true)
+    end
+
+    it "leaves the original unchanged" do
+      vector.shuffle
+      vector.should eql(V[1,2,3,4])
+    end
+
+    context "from a subclass" do
+      it "returns an instance of the subclass" do
+        subclass = Class.new(Immutable::Vector)
+        instance = subclass.new([1,2,3])
+        instance.shuffle.class.should be(subclass)
+      end
+    end
+
+    [32, 33, 1023, 1024, 1025].each do |size|
+      context "on a #{size}-item vector" do
+        it "works correctly" do
+          vector = V.new(1..size)
+          shuffled = vector.shuffle
+          shuffled = vector.shuffle while shuffled.eql?(vector) # in case we get the same
+          vector.should eql(V.new(1..size))
+          shuffled.size.should == vector.size
+          shuffled.sort.should eql(vector)
+        end
+      end
+    end
+  end
+end

data/spec/lib/immutable/vector/slice_spec.rb

@@ -0,0 +1,240 @@
+require "spec_helper"
+
+describe Immutable::Vector do
+  let(:vector) { V[1,2,3,4] }
+  let(:big) { V.new(1..10000) }
+
+  [:slice, :[]].each do |method|
+    describe "##{method}" do
+      context "when passed a positive integral index" do
+        it "returns the element at that index" do
+          vector.send(method, 0).should be(1)
+          vector.send(method, 1).should be(2)
+          vector.send(method, 2).should be(3)
+          vector.send(method, 3).should be(4)
+          vector.send(method, 4).should be(nil)
+          vector.send(method, 10).should be(nil)
+
+          big.send(method, 0).should be(1)
+          big.send(method, 9999).should be(10000)
+        end
+
+        it "leaves the original unchanged" do
+          vector.should eql(V[1,2,3,4])
+        end
+      end
+
+      context "when passed a negative integral index" do
+        it "returns the element which is number (index.abs) counting from the end of the vector" do
+          vector.send(method, -1).should be(4)
+          vector.send(method, -2).should be(3)
+          vector.send(method, -3).should be(2)
+          vector.send(method, -4).should be(1)
+          vector.send(method, -5).should be(nil)
+          vector.send(method, -10).should be(nil)
+
+          big.send(method, -1).should be(10000)
+          big.send(method, -10000).should be(1)
+        end
+      end
+
+      context "when passed a positive integral index and count" do
+        it "returns 'count' elements starting from 'index'" do
+          vector.send(method, 0, 0).should  eql(V.empty)
+          vector.send(method, 0, 1).should  eql(V[1])
+          vector.send(method, 0, 2).should  eql(V[1,2])
+          vector.send(method, 0, 4).should  eql(V[1,2,3,4])
+          vector.send(method, 0, 6).should  eql(V[1,2,3,4])
+          vector.send(method, 0, -1).should be_nil
+          vector.send(method, 0, -2).should be_nil
+          vector.send(method, 0, -4).should be_nil
+          vector.send(method, 2, 0).should  eql(V.empty)
+          vector.send(method, 2, 1).should  eql(V[3])
+          vector.send(method, 2, 2).should  eql(V[3,4])
+          vector.send(method, 2, 4).should  eql(V[3,4])
+          vector.send(method, 2, -1).should be_nil
+          vector.send(method, 4, 0).should  eql(V.empty)
+          vector.send(method, 4, 2).should  eql(V.empty)
+          vector.send(method, 4, -1).should be_nil
+          vector.send(method, 5, 0).should  be_nil
+          vector.send(method, 5, 2).should  be_nil
+          vector.send(method, 5, -1).should be_nil
+          vector.send(method, 6, 0).should  be_nil
+          vector.send(method, 6, 2).should  be_nil
+          vector.send(method, 6, -1).should be_nil
+
+          big.send(method, 0, 3).should    eql(V[1,2,3])
+          big.send(method, 1023, 4).should eql(V[1024,1025,1026,1027])
+          big.send(method, 1024, 4).should eql(V[1025,1026,1027,1028])
+        end
+
+        it "leaves the original unchanged" do
+          vector.should eql(V[1,2,3,4])
+        end
+      end
+
+      context "when passed a negative integral index and count" do
+        it "returns 'count' elements, starting from index which is number 'index.abs' counting from the end of the array" do
+          vector.send(method, -1, 0).should  eql(V.empty)
+          vector.send(method, -1, 1).should  eql(V[4])
+          vector.send(method, -1, 2).should  eql(V[4])
+          vector.send(method, -1, -1).should be_nil
+          vector.send(method, -2, 0).should  eql(V.empty)
+          vector.send(method, -2, 1).should  eql(V[3])
+          vector.send(method, -2, 2).should  eql(V[3,4])
+          vector.send(method, -2, 4).should  eql(V[3,4])
+          vector.send(method, -2, -1).should be_nil
+          vector.send(method, -4, 0).should  eql(V.empty)
+          vector.send(method, -4, 1).should  eql(V[1])
+          vector.send(method, -4, 2).should  eql(V[1,2])
+          vector.send(method, -4, 4).should  eql(V[1,2,3,4])
+          vector.send(method, -4, 6).should  eql(V[1,2,3,4])
+          vector.send(method, -4, -1).should be_nil
+          vector.send(method, -5, 0).should  be_nil
+          vector.send(method, -5, 1).should  be_nil
+          vector.send(method, -5, 10).should be_nil
+          vector.send(method, -5, -1).should be_nil
+
+          big.send(method, -1, 1).should eql(V[10000])
+          big.send(method, -1, 2).should eql(V[10000])
+          big.send(method, -6, 2).should eql(V[9995,9996])
+        end
+      end
+
+      context "when passed a Range" do
+        it "returns the elements whose indexes are within the given Range" do
+          vector.send(method, 0..-1).should  eql(V[1,2,3,4])
+          vector.send(method, 0..-10).should eql(V.empty)
+          vector.send(method, 0..0).should   eql(V[1])
+          vector.send(method, 0..1).should   eql(V[1,2])
+          vector.send(method, 0..2).should   eql(V[1,2,3])
+          vector.send(method, 0..3).should   eql(V[1,2,3,4])
+          vector.send(method, 0..4).should   eql(V[1,2,3,4])
+          vector.send(method, 0..10).should  eql(V[1,2,3,4])
+          vector.send(method, 2..-10).should eql(V.empty)
+          vector.send(method, 2..0).should   eql(V.empty)
+          vector.send(method, 2..2).should   eql(V[3])
+          vector.send(method, 2..3).should   eql(V[3,4])
+          vector.send(method, 2..4).should   eql(V[3,4])
+          vector.send(method, 3..0).should   eql(V.empty)
+          vector.send(method, 3..3).should   eql(V[4])
+          vector.send(method, 3..4).should   eql(V[4])
+          vector.send(method, 4..0).should   eql(V.empty)
+          vector.send(method, 4..4).should   eql(V.empty)
+          vector.send(method, 4..5).should   eql(V.empty)
+          vector.send(method, 5..0).should   be_nil
+          vector.send(method, 5..5).should   be_nil
+          vector.send(method, 5..6).should   be_nil
+
+          big.send(method, 159..162).should     eql(V[160,161,162,163])
+          big.send(method, 160..162).should     eql(V[161,162,163])
+          big.send(method, 161..162).should     eql(V[162,163])
+          big.send(method, 9999..10100).should  eql(V[10000])
+          big.send(method, 10000..10100).should eql(V.empty)
+          big.send(method, 10001..10100).should be_nil
+
+          vector.send(method, 0...-1).should  eql(V[1,2,3])
+          vector.send(method, 0...-10).should eql(V.empty)
+          vector.send(method, 0...0).should   eql(V.empty)
+          vector.send(method, 0...1).should   eql(V[1])
+          vector.send(method, 0...2).should   eql(V[1,2])
+          vector.send(method, 0...3).should   eql(V[1,2,3])
+          vector.send(method, 0...4).should   eql(V[1,2,3,4])
+          vector.send(method, 0...10).should  eql(V[1,2,3,4])
+          vector.send(method, 2...-10).should eql(V.empty)
+          vector.send(method, 2...0).should   eql(V.empty)
+          vector.send(method, 2...2).should   eql(V.empty)
+          vector.send(method, 2...3).should   eql(V[3])
+          vector.send(method, 2...4).should   eql(V[3,4])
+          vector.send(method, 3...0).should   eql(V.empty)
+          vector.send(method, 3...3).should   eql(V.empty)
+          vector.send(method, 3...4).should   eql(V[4])
+          vector.send(method, 4...0).should   eql(V.empty)
+          vector.send(method, 4...4).should   eql(V.empty)
+          vector.send(method, 4...5).should   eql(V.empty)
+          vector.send(method, 5...0).should   be_nil
+          vector.send(method, 5...5).should   be_nil
+          vector.send(method, 5...6).should   be_nil
+
+          big.send(method, 159...162).should     eql(V[160,161,162])
+          big.send(method, 160...162).should     eql(V[161,162])
+          big.send(method, 161...162).should     eql(V[162])
+          big.send(method, 9999...10100).should  eql(V[10000])
+          big.send(method, 10000...10100).should eql(V.empty)
+          big.send(method, 10001...10100).should be_nil
+
+          vector.send(method, -1..-1).should  eql(V[4])
+          vector.send(method, -1...-1).should eql(V.empty)
+          vector.send(method, -1..3).should   eql(V[4])
+          vector.send(method, -1...3).should  eql(V.empty)
+          vector.send(method, -1..4).should   eql(V[4])
+          vector.send(method, -1...4).should  eql(V[4])
+          vector.send(method, -1..10).should  eql(V[4])
+          vector.send(method, -1...10).should eql(V[4])
+          vector.send(method, -1..0).should   eql(V.empty)
+          vector.send(method, -1..-4).should  eql(V.empty)
+          vector.send(method, -1...-4).should eql(V.empty)
+          vector.send(method, -1..-6).should  eql(V.empty)
+          vector.send(method, -1...-6).should eql(V.empty)
+          vector.send(method, -2..-2).should  eql(V[3])
+          vector.send(method, -2...-2).should eql(V.empty)
+          vector.send(method, -2..-1).should  eql(V[3,4])
+          vector.send(method, -2...-1).should eql(V[3])
+          vector.send(method, -2..10).should  eql(V[3,4])
+          vector.send(method, -2...10).should eql(V[3,4])
+
+          big.send(method, -1..-1).should    eql(V[10000])
+          big.send(method, -1..9999).should  eql(V[10000])
+          big.send(method, -1...9999).should eql(V.empty)
+          big.send(method, -2...9999).should eql(V[9999])
+          big.send(method, -2..-1).should    eql(V[9999,10000])
+
+          vector.send(method, -4..-4).should  eql(V[1])
+          vector.send(method, -4..-2).should  eql(V[1,2,3])
+          vector.send(method, -4...-2).should eql(V[1,2])
+          vector.send(method, -4..-1).should  eql(V[1,2,3,4])
+          vector.send(method, -4...-1).should eql(V[1,2,3])
+          vector.send(method, -4..3).should   eql(V[1,2,3,4])
+          vector.send(method, -4...3).should  eql(V[1,2,3])
+          vector.send(method, -4..4).should   eql(V[1,2,3,4])
+          vector.send(method, -4...4).should  eql(V[1,2,3,4])
+          vector.send(method, -4..0).should   eql(V[1])
+          vector.send(method, -4...0).should  eql(V.empty)
+          vector.send(method, -4..1).should   eql(V[1,2])
+          vector.send(method, -4...1).should  eql(V[1])
+
+          vector.send(method, -5..-5).should be_nil
+          vector.send(method, -5...-5).should be_nil
+          vector.send(method, -5..-4).should be_nil
+          vector.send(method, -5..-1).should be_nil
+          vector.send(method, -5..10).should be_nil
+
+          big.send(method, -10001..-1).should be_nil
+        end
+
+        it "leaves the original unchanged" do
+          vector.should eql(V[1,2,3,4])
+        end
+      end
+    end
+
+    context "when passed a subclass of Range" do
+      it "works the same as with a Range" do
+        subclass = Class.new(Range)
+        vector.send(method, subclass.new(1,2)).should eql(V[2,3])
+        vector.send(method, subclass.new(-3,-1,true)).should eql(V[2,3])
+      end
+    end
+
+    context "on a subclass of Vector" do
+      it "with index and count or a range, returns an instance of the subclass" do
+        subclass = Class.new(Immutable::Vector)
+        instance = subclass.new([1,2,3])
+        instance.send(method, 0, 0).class.should be(subclass)
+        instance.send(method, 0, 2).class.should be(subclass)
+        instance.send(method, 0..0).class.should be(subclass)
+        instance.send(method, 1..-1).class.should be(subclass)
+      end
+    end
+  end
+end

data/spec/lib/immutable/vector/sorting_spec.rb

@@ -0,0 +1,56 @@
+require "spec_helper"
+
+describe Immutable::Vector do
+  [
+    [:sort, ->(left, right) { left.length <=> right.length }],
+    [:sort_by, ->(item) { item.length }],
+  ].each do |method, comparator|
+    describe "##{method}" do
+      [
+        [[], []],
+        [["A"], ["A"]],
+        [%w[Ichi Ni San], %w[Ni San Ichi]],
+      ].each do |values, expected|
+        describe "on #{values.inspect}" do
+          let(:vector) { V[*values] }
+
+          context "with a block" do
+            it "preserves the original" do
+              vector.send(method, &comparator)
+              vector.should eql(V[*values])
+            end
+
+            it "returns #{expected.inspect}" do
+              vector.send(method, &comparator).should eql(V[*expected])
+            end
+          end
+
+          context "without a block" do
+            it "preserves the original" do
+              vector.send(method)
+              vector.should eql(V[*values])
+            end
+
+            it "returns #{expected.sort.inspect}" do
+              vector.send(method).should eql(V[*expected.sort])
+            end
+          end
+        end
+      end
+
+      [10, 31, 32, 33, 1023, 1024, 1025].each do |size|
+        context "on a #{size}-item vector" do
+          it "behaves like Array#{method}" do
+            array = size.times.map { rand(10000) }
+            vector = V.new(array)
+            if method == :sort
+              vector.sort.should == array.sort
+            else
+              vector.sort_by { |x| -x }.should == array.sort_by { |x| -x }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/immutable/vector/sum_spec.rb

@@ -0,0 +1,17 @@
+require "spec_helper"
+
+describe Immutable::Vector do
+  describe "#sum" do
+    [
+      [[], 0],
+      [[2], 2],
+      [[1, 3, 5, 7, 11], 27],
+    ].each do |values, expected|
+      describe "on #{values.inspect}" do
+        it "returns #{expected.inspect}" do
+          V[*values].sum.should == expected
+        end
+      end
+    end
+  end
+end

data/spec/lib/immutable/vector/take_spec.rb

@@ -0,0 +1,42 @@
+require "spec_helper"
+
+describe Immutable::Vector do
+  describe "#take" do
+    [
+      [[], 10, []],
+      [["A"], 10, ["A"]],
+      [%w[A B C], 0, []],
+      [%w[A B C], 2, %w[A B]],
+      [(1..32), 1, [1]],
+      [(1..33), 32, (1..32)],
+      [(1..100), 40, (1..40)]
+    ].each do |values, number, expected|
+      describe "#{number} from #{values.inspect}" do
+        let(:vector) { V[*values] }
+
+        it "preserves the original" do
+          vector.take(number)
+          vector.should eql(V[*values])
+        end
+
+        it "returns #{expected.inspect}" do
+          vector.take(number).should eql(V[*expected])
+        end
+      end
+    end
+
+    context "when number of elements specified is identical to size" do
+      let(:vector) { V[1, 2, 3, 4, 5, 6] }
+      it "returns self" do
+        vector.take(vector.size).should be(vector)
+      end
+    end
+
+    context "when number of elements specified is bigger than size" do
+      let(:vector) { V[1, 2, 3, 4, 5, 6] }
+      it "returns self" do
+        vector.take(vector.size + 1).should be(vector)
+      end
+    end
+  end
+end

data/spec/lib/immutable/vector/take_while_spec.rb

@@ -0,0 +1,34 @@
+require "spec_helper"
+
+describe Immutable::Vector do
+  describe "#take_while" do
+    [
+      [[], []],
+      [["A"], ["A"]],
+      [%w[A B C], %w[A B]]
+    ].each do |values, expected|
+      describe "on #{values.inspect}" do
+        let(:vector) { V[*values] }
+        let(:result) { vector.take_while { |item| item < "C" }}
+
+        describe "with a block" do
+          it "returns #{expected.inspect}" do
+            result.should eql(V[*expected])
+          end
+
+          it "preserves the original" do
+            result
+            vector.should eql(V[*values])
+          end
+        end
+
+        describe "without a block" do
+          it "returns an Enumerator" do
+            vector.take_while.class.should be(Enumerator)
+            vector.take_while.each { |item| item < "C" }.should eql(V[*expected])
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/immutable/vector/to_a_spec.rb

@@ -0,0 +1,41 @@
+require "spec_helper"
+
+describe Immutable::Vector do
+  let(:vector) { V[*values] }
+
+  describe "#to_a" do
+    let(:to_a) { vector.to_a }
+
+    shared_examples "checking to_a values" do
+      it "returns the values" do
+        expect(to_a).to eq(values)
+      end
+    end
+
+    context "with an empty vector" do
+      let(:values) { [] }
+
+      include_examples "checking to_a values"
+    end
+
+    context "with an single item vector" do
+      let(:values) { %w[A] }
+
+      include_examples "checking to_a values"
+    end
+
+    context "with an multi-item vector" do
+      let(:values) { %w[A B] }
+
+      include_examples "checking to_a values"
+    end
+
+    [10, 31, 32, 33, 1000, 1023, 1024, 1025].each do |size|
+      context "with a #{size}-item vector" do
+        let(:values) { (1..size).to_a }
+
+        include_examples "checking to_a values"
+      end
+    end
+  end
+end