immutable-ruby 0.0.1

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

@@ -0,0 +1,18 @@
+require "spec_helper"
+
+describe Immutable::Vector do
+  describe "#first" do
+    [
+      [[], nil],
+      [["A"], "A"],
+      [%w[A B C], "A"],
+      [(1..32), 1],
+    ].each do |values, expected|
+      describe "on #{values.inspect}" do
+        it "returns #{expected.inspect}" do
+          V[*values].first.should == expected
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+require "spec_helper"
+
+describe Immutable::Vector do
+  let(:vector) { V[*values] }
+
+  describe "#flat_map" do
+    let(:block) { ->(item) { [item, item + 1, item * item] } }
+    let(:flat_map) { vector.flat_map(&block) }
+    let(:flattened_vector) { V[*flattened_values] }
+
+    shared_examples "checking flattened result" do
+      it "returns the flattened values as an Immutable::Vector" do
+        expect(flat_map).to eq(flattened_vector)
+      end
+
+      it "returns an Immutable::Vector" do
+        expect(flat_map).to be_a(Immutable::Vector)
+      end
+    end
+
+    context "with an empty vector" do
+      let(:values) { [] }
+      let(:flattened_values) { [] }
+
+      include_examples "checking flattened result"
+    end
+
+    context "with a block that returns an empty vector" do
+      let(:block) { ->(item) { [] } }
+      let(:values) { [1, 2, 3] }
+      let(:flattened_values) { [] }
+
+      include_examples "checking flattened result"
+    end
+
+    context "with a vector of one item" do
+      let(:values) { [7] }
+      let(:flattened_values) { [7, 8, 49] }
+
+      include_examples "checking flattened result"
+    end
+
+    context "with a vector of multiple items" do
+      let(:values) { [1, 2, 3] }
+      let(:flattened_values) { [1, 2, 1, 2, 3, 4, 3, 4, 9] }
+
+      include_examples "checking flattened result"
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+require "spec_helper"
+
+describe Immutable::Vector do
+  describe "#flatten" do
+    it "recursively flattens nested vectors into containing vector" do
+      V[V[1], V[2]].flatten.should eql(V[1,2])
+      V[V[V[V[V[V[1,2,3]]]]]].flatten.should eql(V[1,2,3])
+      V[V[V[1]], V[V[V[2]]]].flatten.should eql(V[1,2])
+    end
+
+    it "flattens nested arrays as well" do
+      V[[1,2,3],[[4],[5,6]]].flatten.should eql(V[1,2,3,4,5,6])
+    end
+
+    context "with an integral argument" do
+      it "only flattens down to the specified depth" do
+        V[V[V[1,2]]].flatten(1).should eql(V[V[1,2]])
+        V[V[V[V[1]], V[2], V[3]]].flatten(2).should eql(V[V[1], 2, 3])
+      end
+    end
+
+    context "with an argument of zero" do
+      it "returns self" do
+        vector = V[1,2,3]
+        vector.flatten(0).should be(vector)
+      end
+    end
+
+    context "on a subclass" do
+      it "returns an instance of the subclass" do
+        subclass = Class.new(Immutable::Vector)
+        instance = subclass.new([1,2])
+        instance.flatten.class.should be(subclass)
+      end
+    end
+
+    context "on a vector with no nested vectors" do
+      it "returns an unchanged vector" do
+        vector = V[1,2,3]
+        vector.flatten.should.eql?(V[1,2,3])
+      end
+
+      context "on a Vector larger than 32 items initialized with Vector.new" do
+        # Regression test, for problem discovered while working on GH issue #182
+        it "returns an unchanged vector" do
+          vector1,vector2 = 2.times.collect { V.new(0..33) }
+          vector1.flatten.should eql(vector2)
+        end
+      end
+    end
+
+    it "leaves the original unmodified" do
+      vector = V[1,2,3]
+      vector.flatten
+      vector.should eql(V[1,2,3])
+    end
+  end
+end

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

@@ -0,0 +1,74 @@
+require "spec_helper"
+
+describe Immutable::Vector do
+  [:get, :at].each do |method|
+    describe "##{method}" do
+      context "when empty" do
+        it "always returns nil" do
+          (-1..1).each do |i|
+            V.empty.send(method, i).should be_nil
+          end
+        end
+      end
+
+      context "when not empty" do
+        let(:vector) { V[*(1..1025)] }
+
+        context "with a positive index" do
+          context "within the absolute bounds of the vector" do
+            it "returns the value at the specified index from the head" do
+              (0..(vector.size - 1)).each do |i|
+                vector.send(method, i).should == i + 1
+              end
+            end
+          end
+
+          context "outside the absolute bounds of the vector" do
+            it "returns nil" do
+              vector.send(method, vector.size).should be_nil
+            end
+          end
+        end
+
+        context "with a negative index" do
+          context "within the absolute bounds of the vector" do
+            it "returns the value at the specified index from the tail" do
+              (-vector.size..-1).each do |i|
+                vector.send(method, i).should == vector.size + i + 1
+              end
+            end
+          end
+
+          context "outside the absolute bounds of the vector" do
+            it "returns nil" do
+              vector.send(method, -vector.size.next).should be_nil
+            end
+          end
+        end
+      end
+
+      [1, 10, 31, 32, 33, 1024, 1025, 2000].each do |size|
+        context "on a #{size}-item vector" do
+          it "works correctly, even after various addings and removings" do
+            array = size.times.map { rand(10000) }
+            vector = V.new(array)
+            100.times do
+              if rand(2) == 0
+                value, index = rand(10000), rand(size)
+                array[index] = value
+                vector = vector.set(index, value)
+              else
+                index = rand(array.size)
+                array.delete_at(index)
+                vector = vector.delete_at(index)
+              end
+            end
+            0.upto(array.size) do |i|
+              array[i].should == vector.send(method, i)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+require "spec_helper"
+
+describe Immutable::Vector do
+  describe "#group_by" do
+    context "with a block" do
+      [
+        [[], []],
+        [[1], [true => V[1]]],
+        [[1, 2, 3, 4], [true => V[1, 3], false => V[2, 4]]],
+      ].each do |values, expected|
+        context "on #{values.inspect}" do
+          let(:vector) { V[*values] }
+
+          it "returns #{expected.inspect}" do
+            vector.group_by(&:odd?).should eql(H[*expected])
+            vector.should eql(V.new(values)) # make sure it hasn't changed
+          end
+        end
+      end
+    end
+
+    context "without a block" do
+      [
+        [[], []],
+        [[1], [1 => V[1]]],
+        [[1, 2, 3, 4], [1 => V[1], 2 => V[2], 3 => V[3], 4 => V[4]]],
+      ].each do |values, expected|
+        context "on #{values.inspect}" do
+          let(:vector) { V[*values] }
+
+          it "returns #{expected.inspect}" do
+            vector.group_by.should eql(H[*expected])
+            vector.should eql(V.new(values)) # make sure it hasn't changed
+          end
+        end
+      end
+    end
+
+    context "on an empty vector" do
+      it "returns an empty hash" do
+        V.empty.group_by { |x| x }.should eql(H.empty)
+      end
+    end
+
+    it "returns a hash without default proc" do
+      V[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(Immutable::Vector)
+        instance = subclass.new([1, 'string', :symbol])
+        instance.group_by { |x| x.class }.values.each { |v| v.class.should be(subclass) }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+require "spec_helper"
+
+describe Immutable::Vector do
+  [:include?, :member?].each do |method|
+    describe "##{method}" do
+      [
+        [[], "A", false],
+        [[], nil, false],
+        [["A"], "A", true],
+        [["A"], "B", false],
+        [["A"], nil, false],
+        [["A", "B", nil], "A", true],
+        [["A", "B", nil], "B", true],
+        [["A", "B", nil], nil, true],
+        [["A", "B", nil], "C", false],
+        [["A", "B", false], false, true],
+        [[2], 2, true],
+        [[2], 2.0, true],
+        [[2.0], 2.0, true],
+        [[2.0], 2, true],
+      ].each do |values, item, expected|
+        describe "on #{values.inspect}" do
+          it "returns #{expected.inspect}" do
+            V[*values].send(method, item).should == expected
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,68 @@
+require "spec_helper"
+require 'pry'
+
+describe Immutable::Vector do
+  describe "#insert" do
+    let(:original) { V[1, 2, 3] }
+
+    it "can add items at the beginning of a vector" do
+      vector = original.insert(0, :a, :b)
+      vector.size.should be(5)
+      vector.at(0).should be(:a)
+      vector.at(2).should be(1)
+    end
+
+    it "can add items in the middle of a vector" do
+      vector = original.insert(1, :a, :b, :c)
+      vector.size.should be(6)
+      vector.to_a.should == [1, :a, :b, :c, 2, 3]
+    end
+
+    it "can add items at the end of a vector" do
+      vector = original.insert(3, :a, :b, :c)
+      vector.size.should be(6)
+      vector.to_a.should == [1, 2, 3, :a, :b, :c]
+    end
+
+    it "can add items past the end of a vector" do
+      vector = original.insert(6, :a, :b)
+      vector.size.should be(8)
+      vector.to_a.should == [1, 2, 3, nil, nil, nil, :a, :b]
+    end
+
+    it "accepts a negative index, which counts back from the end of the vector" do
+      vector = original.insert(-2, :a)
+      vector.size.should be(4)
+      vector.to_a.should == [1, :a, 2, 3]
+    end
+
+    it "raises IndexError if a negative index is too great" do
+      expect { original.insert(-4, :a) }.to raise_error(IndexError)
+    end
+
+    it "works when adding an item past boundary when vector trie needs to deepen" do
+      vector = original.insert(32, :a, :b)
+      vector.size.should == 34
+      vector.to_a.size.should == 34
+    end
+
+    it "works when adding to an empty Vector" do
+      V.empty.insert(0, :a).should eql(V[:a])
+    end
+
+    it "has the right size and contents after many insertions" do
+      array  = (1..4000).to_a # we use an Array as standard of correctness
+      vector = Immutable::Vector.new(array)
+      100.times do
+        items = rand(10).times.map { rand(10000) }
+        index = rand(vector.size)
+        vector = vector.insert(index, *items)
+        array.insert(index, *items)
+        vector.size.should == array.size
+        ary = vector.to_a
+        ary.size.should == vector.size
+        ary.should eql(array)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+require "spec_helper"
+
+describe Immutable::Vector do
+  let(:vector) { V[*values] }
+
+  describe "#inspect" do
+    let(:inspect) { vector.inspect }
+
+    shared_examples "checking output" do
+      it "returns its contents as a programmer-readable string" do
+        expect(inspect).to eq(output)
+      end
+
+      it "returns a string which can be eval'd to get back an equivalent vector" do
+        expect(eval(inspect)).to eql(vector)
+      end
+    end
+
+    context "with an empty array" do
+      let(:output) { "Immutable::Vector[]" }
+      let(:values) { [] }
+
+      include_examples "checking output"
+    end
+
+    context "with a single item array" do
+      let(:output) { "Immutable::Vector[\"A\"]" }
+      let(:values) { %w[A] }
+
+      include_examples "checking output"
+    end
+
+    context "with a multi-item array" do
+      let(:output) { "Immutable::Vector[\"A\", \"B\"]" }
+      let(:values) { %w[A B] }
+
+      include_examples "checking output"
+    end
+
+    context "from a subclass" do
+      MyVector = Class.new(Immutable::Vector)
+      let(:vector) { MyVector.new(values) }
+      let(:output) { "MyVector[1, 2]" }
+      let(:values) { [1, 2] }
+
+      include_examples "checking output"
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+require "spec_helper"
+
+describe Immutable::Vector do
+  describe "#join" do
+    context "with a separator" do
+      [
+        [[], ""],
+        [["A"], "A"],
+        [[DeterministicHash.new("A", 1), DeterministicHash.new("B", 2), DeterministicHash.new("C", 3)], "A|B|C"]
+      ].each do |values, expected|
+        describe "on #{values.inspect}" do
+          let(:vector) { V[*values] }
+
+          it "preserves the original" do
+            vector.join("|")
+            vector.should eql(V[*values])
+          end
+
+          it "returns #{expected.inspect}" do
+            vector.join("|").should == expected
+          end
+        end
+      end
+    end
+
+    context "without a separator" do
+      [
+        [[], ""],
+        [["A"], "A"],
+        [[DeterministicHash.new("A", 1), DeterministicHash.new("B", 2), DeterministicHash.new("C", 3)], "ABC"]
+      ].each do |values, expected|
+        describe "on #{values.inspect}" do
+          let(:vector) { V[*values] }
+
+          it "preserves the original" do
+            vector.join
+            vector.should eql(V[*values])
+          end
+
+          it "returns #{expected.inspect}" do
+            vector.join.should == expected
+          end
+        end
+      end
+    end
+
+    context "without a separator (with global default separator set)" do
+      before { $, = '**' }
+      after  { $, = nil }
+
+      describe 'on ["A", "B", "C"]' do
+        it 'returns "A**B**C"' do
+          V["A", "B", "C"].join.should == "A**B**C"
+        end
+      end
+    end
+  end
+end