immutable-ruby 0.0.1

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

@@ -0,0 +1,34 @@
+require "spec_helper"
+
+describe Immutable::Vector do
+  let(:vector) { V[*values] }
+
+  describe "#to_ary" do
+    let(:values) { %w[A B C D] }
+
+    it "converts using block parameters" do
+      def expectations(&block)
+        yield(vector)
+      end
+      expectations do |a, b, *c|
+        expect(a).to eq("A")
+        expect(b).to eq("B")
+        expect(c).to eq(%w[C D])
+      end
+    end
+
+    it "converts using method arguments" do
+      def expectations(a, b, *c)
+        expect(a).to eq("A")
+        expect(b).to eq("B")
+        expect(c).to eq(%w[C D])
+      end
+      expectations(*vector)
+    end
+
+    it "converts using splat" do
+      array = *vector
+      expect(array).to eq(%w[A B C D])
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+require "spec_helper"
+
+describe Immutable::Vector do
+  describe "#to_list" do
+    [
+      [],
+      ["A"],
+      %w[A B C],
+    ].each do |values|
+      describe "on #{values.inspect}" do
+        let(:vector) { V.new(values) }
+        let(:list) { vector.to_list }
+
+        it "returns a list" do
+          list.is_a?(Immutable::List).should == true
+        end
+
+        describe "the returned list" do
+          it "has the correct length" do
+            list.size.should == values.size
+          end
+
+          it "contains all values" do
+            list.to_a.should == values
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+require "spec_helper"
+
+describe Immutable::Vector do
+  describe "#to_set" do
+    [
+      [],
+      ["A"],
+      %w[A B C],
+      (1..10),
+      (1..32),
+      (1..33),
+      (1..1000)
+    ].each do |values|
+      describe "on #{values.inspect}" do
+        it "returns a set with the same values" do
+          V[*values].to_set.should eql(S[*values])
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+require "spec_helper"
+
+describe Immutable::Vector do
+  describe "#transpose" do
+    it "takes a vector of vectors and transposes rows and columns" do
+      V[V[1, 'a'], V[2, 'b'], V[3, 'c']].transpose.should eql(V[V[1, 2, 3], V["a", "b", "c"]])
+      V[V[1, 2, 3], V["a", "b", "c"]].transpose.should eql(V[V[1, 'a'], V[2, 'b'], V[3, 'c']])
+      V[].transpose.should eql(V[])
+      V[V[]].transpose.should eql(V[])
+      V[V[], V[]].transpose.should eql(V[])
+      V[V[0]].transpose.should eql(V[V[0]])
+      V[V[0], V[1]].transpose.should eql(V[V[0, 1]])
+    end
+
+    it "raises an IndexError if the vectors are not of the same length" do
+      -> { V[V[1,2], V[:a]].transpose }.should raise_error(IndexError)
+    end
+
+    it "also works on Vectors of Arrays" do
+      V[[1,2,3], [4,5,6]].transpose.should eql(V[V[1,4], V[2,5], V[3,6]])
+    end
+
+    [10, 31, 32, 33, 1000, 1023, 1024, 1025, 2000].each do |size|
+      context "on #{size}-item vectors" do
+        it "behaves like Array#transpose" do
+          array = rand(10).times.map { size.times.map { rand(10000) }}
+          vector = V.new(array)
+          result = vector.transpose
+          # Array#== uses Object#== to compare corresponding elements,
+          #   so although Vector#== does type coercion, it does not consider
+          #   nested Arrays and corresponding nested Vectors to be equal
+          # That is why the following ".map { |a| V.new(a) }" is needed
+          result.should == array.transpose.map { |a| V.new(a) }
+          result.each { |v| v.class.should be(Immutable::Vector) }
+        end
+      end
+    end
+
+    context "on a subclass of Vector" do
+      it "returns instances of the subclass" do
+        subclass = Class.new(V)
+        instance = subclass.new([[1,2,3], [4,5,6]])
+        instance.transpose.class.should be(subclass)
+        instance.transpose.each { |v| v.class.should be(subclass) }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,76 @@
+require "spec_helper"
+
+describe Immutable::Vector do
+  describe "#uniq" do
+    let(:vector) { V['a', 'b', 'a', 'a', 'c', 'b'] }
+
+    it "returns a vector with no duplicates" do
+      vector.uniq.should eql(V['a', 'b', 'c'])
+    end
+
+    it "leaves the original unmodified" do
+      vector.uniq
+      vector.should eql(V['a', 'b', 'a', 'a', 'c', 'b'])
+    end
+
+    it "uses #eql? semantics" do
+      V[1.0, 1].uniq.should eql(V[1.0, 1])
+    end
+
+    it "also uses #hash when determining which values are duplicates" do
+      x = double(1)
+      x.should_receive(:hash).at_least(1).times.and_return(1)
+      y = double(2)
+      y.should_receive(:hash).at_least(1).times.and_return(2)
+      V[x, y].uniq
+    end
+
+    it "keeps the first of each group of duplicate values" do
+      x, y, z = 'a', 'a', 'a'
+      result = V[x, y, z].uniq
+      result.size.should == 1
+      result[0].should be(x)
+    end
+
+    context "when passed a block" do
+      it "uses the return value of the block to determine which items are duplicate" do
+        v = V['a', 'A', 'B', 'b']
+        v.uniq(&:upcase).should == V['a', 'B']
+      end
+    end
+
+    context "on a vector with no duplicates" do
+      it "returns an unchanged vector" do
+        V[1, 2, 3].uniq.should eql(V[1, 2, 3])
+      end
+
+      context "if the vector has more than 32 elements and is initialized with Vector.new" do
+        # Regression test for GitHub issue #182
+        it "returns an unchanged vector" do
+          vector1,vector2 = 2.times.collect { V.new(0..36) }
+          vector1.uniq.should eql(vector2)
+        end
+      end
+    end
+
+    [10, 31, 32, 33, 1000, 1023, 1024, 1025, 2000].each do |size|
+      context "on a #{size}-item vector" do
+        it "behaves like Array#uniq" do
+          array = size.times.map { rand(size*2) }
+          vector = V.new(array)
+          result = vector.uniq
+          result.should == array.uniq
+          result.class.should be(Immutable::Vector)
+        end
+      end
+    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.uniq.class.should be(subclass)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+require "spec_helper"
+
+describe Immutable::Vector do
+  describe "#unshift" do
+    [
+      [[], "A", ["A"]],
+      [["A"], "B", %w[B A]],
+      [["A"], "A", %w[A A]],
+      [%w[A B C], "D", %w[D A B C]],
+      [1..31, 0, 0..31],
+      [1..32, 0, 0..32],
+      [1..33, 0, 0..33]
+    ].each do |values, new_value, expected|
+      context "on #{values.inspect} with #{new_value.inspect}" do
+        let(:vector) { V[*values] }
+
+        it "preserves the original" do
+          vector.unshift(new_value)
+          vector.should eql(V[*values])
+        end
+
+        it "returns #{expected.inspect}" do
+          vector.unshift(new_value).should eql(V[*expected])
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,82 @@
+require "spec_helper"
+
+describe Immutable::Vector do
+  describe "#update_in" do
+    let(:vector) {
+      Immutable::Vector[
+        100,
+        101,
+        102,
+        Immutable::Vector[200, 201, Immutable::Vector[300, 301, 302]],
+        Immutable::Hash["A" => "alpha", "B" => "bravo"],
+        [400, 401, 402]
+      ]
+    }
+
+    context "with one level on existing key" do
+      it "passes the value to the block" do
+        vector.update_in(1) { |value| value.should == 101 }
+      end
+
+      it "replaces the value with the result of the block" do
+        result = vector.update_in(1) { |value| "FLIBBLE" }
+        result.get(1).should == "FLIBBLE"
+      end
+
+      it "should preserve the original" do
+        result = vector.update_in(1) { |value| "FLIBBLE" }
+        vector.get(1).should == 101
+      end
+    end
+
+    context "with multi-level vectors on existing keys" do
+      it "passes the value to the block" do
+        vector.update_in(3, 2, 0) { |value| value.should == 300 }
+      end
+
+      it "replaces the value with the result of the block" do
+        result = vector.update_in(3, 2, 0) { |value| "FLIBBLE" }
+        result[3][2][0].should == "FLIBBLE"
+      end
+
+      it "should preserve the original" do
+        result = vector.update_in(3, 2, 0) { |value| "FLIBBLE" }
+        vector[3][2][0].should == 300
+      end
+    end
+
+    context "with multi-level creating sub-hashes when keys don't exist" do
+      it "passes nil to the block" do
+        vector.update_in(3, 3, "X", "Y") { |value| value.should be_nil }
+      end
+
+      it "creates subhashes on the way to set the value" do
+        result = vector.update_in(3, 3, "X", "Y") { |value| "NEWVALUE" }
+        result[3][3]["X"]["Y"].should == "NEWVALUE"
+        result[3][2][0].should == 300
+      end
+    end
+
+    context "with multi-level including hash with existing keys" do
+      it "passes the value to the block" do
+        vector.update_in(4, "B") { |value| value.should == "bravo" }
+      end
+
+      it "replaces the value with the result of the block" do
+        result = vector.update_in(4, "B") { |value| "FLIBBLE" }
+        result[4]["B"].should == "FLIBBLE"
+      end
+
+      it "should preserve the original" do
+        result = vector.update_in(4, "B") { |value| "FLIBBLE" }
+        vector[4]["B"].should == "bravo"
+      end
+    end
+
+    context "with empty key_path" do
+      it "raises ArguemntError" do
+        expect { vector.update_in() { |v| 42 } }.to raise_error(ArgumentError)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+require "spec_helper"
+
+describe Immutable::Vector do
+  describe "#values_at" do
+    let(:vector) { V['a', 'b', 'c'] }
+
+    it "accepts any number of indices, and returns a vector of items at those indices" do
+      vector.values_at(0).should eql(V['a'])
+      vector.values_at(1,2).should eql(V['b', 'c'])
+    end
+
+    context "when passed invalid indices" do
+      it "fills in with nils" do
+        vector.values_at(1,2,3).should  eql(V['b', 'c', nil])
+        vector.values_at(-10,10).should eql(V[nil, nil])
+      end
+    end
+
+    context "when passed no arguments" do
+      it "returns an empty vector" do
+        vector.values_at.should eql(V.empty)
+      end
+    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.values_at(1,2).class.should be(subclass)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+require "spec_helper"
+
+describe Immutable::Vector do
+  describe "#zip" do
+    let(:vector) { V[1,2,3,4] }
+
+    context "with a block" do
+      it "yields arrays of one corresponding element from each input sequence" do
+        result = []
+        vector.zip(['a', 'b', 'c', 'd']) { |obj| result << obj }
+        result.should eql([[1,'a'], [2,'b'], [3,'c'], [4,'d']])
+      end
+
+      it "fills in the missing values with nils" do
+        result = []
+        vector.zip(['a', 'b']) { |obj| result << obj }
+        result.should eql([[1,'a'], [2,'b'], [3,nil], [4,nil]])
+      end
+
+      it "returns nil" do
+        vector.zip([2,3,4]) {}.should be_nil
+      end
+
+      it "can handle multiple inputs, of different classes" do
+        result = []
+        vector.zip(V[2,3,4,5], [5,6,7,8]) { |obj| result << obj }
+        result.should eql([[1,2,5], [2,3,6], [3,4,7], [4,5,8]])
+      end
+    end
+
+    context "without a block" do
+      it "returns a vector of arrays (one corresponding element from each input sequence)" do
+        vector.zip([2,3,4,5]).should eql(V[[1,2], [2,3], [3,4], [4,5]])
+      end
+    end
+
+    [10, 31, 32, 33, 1000, 1023, 1024, 1025].each do |size|
+      context "on #{size}-item vectors" do
+        it "behaves like Array#zip" do
+          array   = (rand(9)+1).times.map { size.times.map { rand(10000) }}
+          vectors = array.map { |a| V.new(a) }
+          result  = vectors.first.zip(*vectors.drop(1))
+          result.class.should be(Immutable::Vector)
+          result.should == array[0].zip(*array.drop(1))
+        end
+      end
+    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.zip([4,5,6]).class.should be(subclass)
+      end
+    end
+  end
+end

data/spec/lib/load_spec.rb

@@ -0,0 +1,42 @@
+# It should be possible to require any one Immutable structure,
+# without loading all the others
+
+immutable_lib_dir = File.join(File.dirname(__FILE__), "..", "..", 'lib')
+
+describe :Immutable do
+  describe :Hash do
+    it "can be loaded separately" do
+      system(%{ruby -e "$:.unshift('#{immutable_lib_dir}'); require 'immutable/hash'; Immutable::Hash.new"}).should be(true)
+    end
+  end
+
+  describe :Set do
+    it "can be loaded separately" do
+      system(%{ruby -e "$:.unshift('#{immutable_lib_dir}'); require 'immutable/set'; Immutable::Set.new"}).should be(true)
+    end
+  end
+
+  describe :Vector do
+    it "can be loaded separately" do
+      system(%{ruby -e "$:.unshift('#{immutable_lib_dir}'); require 'immutable/vector'; Immutable::Vector.new"}).should be(true)
+    end
+  end
+
+  describe :List do
+    it "can be loaded separately" do
+      system(%{ruby -e "$:.unshift('#{immutable_lib_dir}'); require 'immutable/list'; Immutable::List[]"}).should be(true)
+    end
+  end
+
+  describe :SortedSet do
+    it "can be loaded separately" do
+      system(%{ruby -e "$:.unshift('#{immutable_lib_dir}'); require 'immutable/sorted_set'; Immutable::SortedSet.new"}).should be(true)
+    end
+  end
+
+  describe :Deque do
+    it "can be loaded separately" do
+      system(%{ruby -e "$:.unshift('#{immutable_lib_dir}'); require 'immutable/deque'; Immutable::Deque.new"}).should be(true)
+    end
+  end
+end