immutable-ruby 0.0.1

data/spec/lib/immutable/list/rotate_spec.rb

@@ -0,0 +1,36 @@
+require "spec_helper"
+
+describe Immutable::List do
+  describe "#rotate" do
+    let(:list) { L[1,2,3,4,5] }
+
+    context "when passed no argument" do
+      it "returns a new list with the first element moved to the end" do
+        list.rotate.should eql(L[2,3,4,5,1])
+      end
+    end
+
+    context "with an integral argument n" do
+      it "returns a new list with the first (n % size) elements moved to the end" do
+        list.rotate(2).should eql(L[3,4,5,1,2])
+        list.rotate(3).should eql(L[4,5,1,2,3])
+        list.rotate(4).should eql(L[5,1,2,3,4])
+        list.rotate(5).should eql(L[1,2,3,4,5])
+        list.rotate(-1).should eql(L[5,1,2,3,4])
+      end
+    end
+
+    context "with a non-numeric argument" do
+      it "raises a TypeError" do
+        -> { list.rotate('hello') }.should raise_error(TypeError)
+      end
+    end
+
+    context "with an argument of zero (or one evenly divisible by list length)" do
+      it "it returns self" do
+        list.rotate(0).should be(list)
+        list.rotate(5).should be(list)
+      end
+    end
+  end
+end

data/spec/lib/immutable/list/sample_spec.rb

@@ -0,0 +1,13 @@
+require "spec_helper"
+
+describe Immutable::List do
+  describe "#sample" do
+    let(:list) { (1..10).to_list }
+
+    it "returns a randomly chosen item" do
+      chosen = 100.times.map { list.sample }
+      chosen.each { |item| list.include?(item).should == true }
+      list.each { |item| chosen.include?(item).should == true }
+    end
+  end
+end

data/spec/lib/immutable/list/select_spec.rb

@@ -0,0 +1,70 @@
+require "spec_helper"
+
+describe Immutable::List do
+  let(:list) { L[*values] }
+  let(:selected_list) { L[*selected_values] }
+
+  describe "#select" do
+    it "is lazy" do
+      expect { Immutable.stream { fail }.select { |item| false } }.to_not raise_error
+    end
+
+    shared_examples "checking values" do
+      context "with a block" do
+        let(:select) { list.select { |item| item == item.upcase } }
+
+        it "preserves the original" do
+          expect(list).to eq(L[*values])
+        end
+
+        it "returns the selected list" do
+          expect(select).to eq(selected_list)
+        end
+      end
+
+      context "without a block" do
+        let(:select) { list.select }
+
+        it "returns an Enumerator" do
+          expect(select.class).to be(Enumerator)
+          expect(select.each { |item| item == item.upcase }).to eq(selected_list)
+        end
+      end
+    end
+
+    context "with an empty array" do
+      let(:values) { [] }
+      let(:selected_values) { [] }
+
+      include_examples "checking values"
+    end
+
+    context "with a single item array" do
+      let(:values) { ["A"] }
+      let(:selected_values) { ["A"] }
+
+      include_examples "checking values"
+    end
+
+    context "with a multi-item array" do
+      let(:values) { %w[A B] }
+      let(:selected_values) { %w[A B] }
+
+      include_examples "checking values"
+    end
+
+    context "with a multi-item single selectable array" do
+      let(:values) { %w[A b] }
+      let(:selected_values) { ["A"] }
+
+      include_examples "checking values"
+    end
+
+    context "with a multi-item multi-selectable array" do
+      let(:values) { %w[a b] }
+      let(:selected_values) { [] }
+
+      include_examples "checking values"
+    end
+  end
+end

data/spec/lib/immutable/list/size_spec.rb

@@ -0,0 +1,25 @@
+require "spec_helper"
+
+describe Immutable::List do
+  [:size, :length].each do |method|
+    describe "##{method}" do
+      context "on a really big list" do
+        it "doesn't run out of stack" do
+          -> { Immutable.interval(0, STACK_OVERFLOW_DEPTH).size }.should_not raise_error
+        end
+      end
+
+      [
+        [[], 0],
+        [["A"], 1],
+        [%w[A B C], 3],
+      ].each do |values, expected|
+        context "on #{values.inspect}" do
+          it "returns #{expected.inspect}" do
+            L[*values].send(method).should == expected
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,229 @@
+require "spec_helper"
+
+describe Immutable::List do
+  let(:list) { L[1,2,3,4] }
+  let(:big)  { (1..10000).to_list }
+
+  [:slice, :[]].each do |method|
+    describe "##{method}" do
+      context "when passed a positive integral index" do
+        it "returns the element at that index" do
+          list.send(method, 0).should be(1)
+          list.send(method, 1).should be(2)
+          list.send(method, 2).should be(3)
+          list.send(method, 3).should be(4)
+          list.send(method, 4).should be(nil)
+          list.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
+          list.should eql(L[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 list" do
+          list.send(method, -1).should be(4)
+          list.send(method, -2).should be(3)
+          list.send(method, -3).should be(2)
+          list.send(method, -4).should be(1)
+          list.send(method, -5).should be(nil)
+          list.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
+          list.send(method, 0, 0).should eql(L.empty)
+          list.send(method, 0, 1).should eql(L[1])
+          list.send(method, 0, 2).should eql(L[1,2])
+          list.send(method, 0, 4).should eql(L[1,2,3,4])
+          list.send(method, 0, 6).should eql(L[1,2,3,4])
+          list.send(method, 0, -1).should be_nil
+          list.send(method, 0, -2).should be_nil
+          list.send(method, 0, -4).should be_nil
+          list.send(method, 2, 0).should eql(L.empty)
+          list.send(method, 2, 1).should eql(L[3])
+          list.send(method, 2, 2).should eql(L[3,4])
+          list.send(method, 2, 4).should eql(L[3,4])
+          list.send(method, 2, -1).should be_nil
+          list.send(method, 4, 0).should eql(L.empty)
+          list.send(method, 4, 2).should eql(L.empty)
+          list.send(method, 4, -1).should be_nil
+          list.send(method, 5, 0).should be_nil
+          list.send(method, 5, 2).should be_nil
+          list.send(method, 5, -1).should be_nil
+          list.send(method, 6, 0).should be_nil
+          list.send(method, 6, 2).should be_nil
+          list.send(method, 6, -1).should be_nil
+
+          big.send(method, 0, 3).should eql(L[1,2,3])
+          big.send(method, 1023, 4).should eql(L[1024,1025,1026,1027])
+          big.send(method, 1024, 4).should eql(L[1025,1026,1027,1028])
+        end
+
+        it "leaves the original unchanged" do
+          list.should eql(L[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
+          list.send(method, -1, 0).should eql(L.empty)
+          list.send(method, -1, 1).should eql(L[4])
+          list.send(method, -1, 2).should eql(L[4])
+          list.send(method, -1, -1).should be_nil
+          list.send(method, -2, 0).should eql(L.empty)
+          list.send(method, -2, 1).should eql(L[3])
+          list.send(method, -2, 2).should eql(L[3,4])
+          list.send(method, -2, 4).should eql(L[3,4])
+          list.send(method, -2, -1).should be_nil
+          list.send(method, -4, 0).should eql(L.empty)
+          list.send(method, -4, 1).should eql(L[1])
+          list.send(method, -4, 2).should eql(L[1,2])
+          list.send(method, -4, 4).should eql(L[1,2,3,4])
+          list.send(method, -4, 6).should eql(L[1,2,3,4])
+          list.send(method, -4, -1).should be_nil
+          list.send(method, -5, 0).should be_nil
+          list.send(method, -5, 1).should be_nil
+          list.send(method, -5, 10).should be_nil
+          list.send(method, -5, -1).should be_nil
+
+          big.send(method, -1, 1).should eql(L[10000])
+          big.send(method, -1, 2).should eql(L[10000])
+          big.send(method, -6, 2).should eql(L[9995,9996])
+        end
+      end
+
+      context "when passed a Range" do
+        it "returns the elements whose indexes are within the given Range" do
+          list.send(method, 0..-1).should eql(L[1,2,3,4])
+          list.send(method, 0..-10).should eql(L.empty)
+          list.send(method, 0..0).should eql(L[1])
+          list.send(method, 0..1).should eql(L[1,2])
+          list.send(method, 0..2).should eql(L[1,2,3])
+          list.send(method, 0..3).should eql(L[1,2,3,4])
+          list.send(method, 0..4).should eql(L[1,2,3,4])
+          list.send(method, 0..10).should eql(L[1,2,3,4])
+          list.send(method, 2..-10).should eql(L.empty)
+          list.send(method, 2..0).should eql(L.empty)
+          list.send(method, 2..2).should eql(L[3])
+          list.send(method, 2..3).should eql(L[3,4])
+          list.send(method, 2..4).should eql(L[3,4])
+          list.send(method, 3..0).should eql(L.empty)
+          list.send(method, 3..3).should eql(L[4])
+          list.send(method, 3..4).should eql(L[4])
+          list.send(method, 4..0).should eql(L.empty)
+          list.send(method, 4..4).should eql(L.empty)
+          list.send(method, 4..5).should eql(L.empty)
+          list.send(method, 5..0).should be_nil
+          list.send(method, 5..5).should be_nil
+          list.send(method, 5..6).should be_nil
+
+          big.send(method, 159..162).should eql(L[160,161,162,163])
+          big.send(method, 160..162).should eql(L[161,162,163])
+          big.send(method, 161..162).should eql(L[162,163])
+          big.send(method, 9999..10100).should eql(L[10000])
+          big.send(method, 10000..10100).should eql(L.empty)
+          big.send(method, 10001..10100).should be_nil
+
+          list.send(method, 0...-1).should eql(L[1,2,3])
+          list.send(method, 0...-10).should eql(L.empty)
+          list.send(method, 0...0).should eql(L.empty)
+          list.send(method, 0...1).should eql(L[1])
+          list.send(method, 0...2).should eql(L[1,2])
+          list.send(method, 0...3).should eql(L[1,2,3])
+          list.send(method, 0...4).should eql(L[1,2,3,4])
+          list.send(method, 0...10).should eql(L[1,2,3,4])
+          list.send(method, 2...-10).should eql(L.empty)
+          list.send(method, 2...0).should eql(L.empty)
+          list.send(method, 2...2).should eql(L.empty)
+          list.send(method, 2...3).should eql(L[3])
+          list.send(method, 2...4).should eql(L[3,4])
+          list.send(method, 3...0).should eql(L.empty)
+          list.send(method, 3...3).should eql(L.empty)
+          list.send(method, 3...4).should eql(L[4])
+          list.send(method, 4...0).should eql(L.empty)
+          list.send(method, 4...4).should eql(L.empty)
+          list.send(method, 4...5).should eql(L.empty)
+          list.send(method, 5...0).should be_nil
+          list.send(method, 5...5).should be_nil
+          list.send(method, 5...6).should be_nil
+
+          big.send(method, 159...162).should eql(L[160,161,162])
+          big.send(method, 160...162).should eql(L[161,162])
+          big.send(method, 161...162).should eql(L[162])
+          big.send(method, 9999...10100).should eql(L[10000])
+          big.send(method, 10000...10100).should eql(L.empty)
+          big.send(method, 10001...10100).should be_nil
+
+          list.send(method, -1..-1).should eql(L[4])
+          list.send(method, -1...-1).should eql(L.empty)
+          list.send(method, -1..3).should eql(L[4])
+          list.send(method, -1...3).should eql(L.empty)
+          list.send(method, -1..4).should eql(L[4])
+          list.send(method, -1...4).should eql(L[4])
+          list.send(method, -1..10).should eql(L[4])
+          list.send(method, -1...10).should eql(L[4])
+          list.send(method, -1..0).should eql(L.empty)
+          list.send(method, -1..-4).should eql(L.empty)
+          list.send(method, -1...-4).should eql(L.empty)
+          list.send(method, -1..-6).should eql(L.empty)
+          list.send(method, -1...-6).should eql(L.empty)
+          list.send(method, -2..-2).should eql(L[3])
+          list.send(method, -2...-2).should eql(L.empty)
+          list.send(method, -2..-1).should eql(L[3,4])
+          list.send(method, -2...-1).should eql(L[3])
+          list.send(method, -2..10).should eql(L[3,4])
+          list.send(method, -2...10).should eql(L[3,4])
+
+          big.send(method, -1..-1).should eql(L[10000])
+          big.send(method, -1..9999).should eql(L[10000])
+          big.send(method, -1...9999).should eql(L.empty)
+          big.send(method, -2...9999).should eql(L[9999])
+          big.send(method, -2..-1).should eql(L[9999,10000])
+
+          list.send(method, -4..-4).should eql(L[1])
+          list.send(method, -4..-2).should eql(L[1,2,3])
+          list.send(method, -4...-2).should eql(L[1,2])
+          list.send(method, -4..-1).should eql(L[1,2,3,4])
+          list.send(method, -4...-1).should eql(L[1,2,3])
+          list.send(method, -4..3).should eql(L[1,2,3,4])
+          list.send(method, -4...3).should eql(L[1,2,3])
+          list.send(method, -4..4).should eql(L[1,2,3,4])
+          list.send(method, -4...4).should eql(L[1,2,3,4])
+          list.send(method, -4..0).should eql(L[1])
+          list.send(method, -4...0).should eql(L.empty)
+          list.send(method, -4..1).should eql(L[1,2])
+          list.send(method, -4...1).should eql(L[1])
+
+          list.send(method, -5..-5).should be_nil
+          list.send(method, -5...-5).should be_nil
+          list.send(method, -5..-4).should be_nil
+          list.send(method, -5..-1).should be_nil
+          list.send(method, -5..10).should be_nil
+
+          big.send(method, -10001..-1).should be_nil
+        end
+
+        it "leaves the original unchanged" do
+          list.should eql(L[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)
+        list.send(method, subclass.new(1,2)).should eql(L[2,3])
+        list.send(method, subclass.new(-3,-1,true)).should eql(L[2,3])
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+require "spec_helper"
+
+describe Immutable::List do
+  [
+    [:sort, ->(left, right) { left.length <=> right.length }],
+    [:sort_by, ->(item) { item.length }],
+  ].each do |method, comparator|
+    describe "##{method}" do
+      it "is lazy" do
+        -> { Immutable.stream { fail }.send(method, &comparator) }.should_not raise_error
+      end
+
+      [
+        [[], []],
+        [["A"], ["A"]],
+        [%w[Ichi Ni San], %w[Ni San Ichi]],
+      ].each do |values, expected|
+        context "on #{values.inspect}" do
+          let(:list) { L[*values] }
+
+          context "with a block" do
+            it "preserves the original" do
+              list.send(method, &comparator)
+              list.should == L[*values]
+            end
+
+            it "returns #{expected.inspect}" do
+              list.send(method, &comparator).should == L[*expected]
+            end
+          end
+
+          context "without a block" do
+            it "preserves the original" do
+              list.send(method)
+              list.should eql(L[*values])
+            end
+
+            it "returns #{expected.sort.inspect}" do
+              list.send(method).should == L[*expected.sort]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/immutable/list/span_spec.rb

@@ -0,0 +1,76 @@
+require "spec_helper"
+
+describe "List#span" do
+  it "is lazy" do
+    -> { Immutable.stream { |item| fail }.span { true } }.should_not raise_error
+  end
+
+  describe <<-DESC do
+given a predicate (in the form of a block), splits the list into two lists
+  (returned as an array) such that elements in the first list (the prefix) are
+  taken from the head of the list while the predicate is satisfied, and elements
+  in the second list (the remainder) are the remaining elements from the list
+  once the predicate is not satisfied. For example:
+DESC
+
+    [
+      [[], [], []],
+      [[1], [1], []],
+      [[1, 2], [1, 2], []],
+      [[1, 2, 3], [1, 2], [3]],
+      [[1, 2, 3, 4], [1, 2], [3, 4]],
+      [[2, 3, 4], [2], [3, 4]],
+      [[3, 4], [], [3, 4]],
+      [[4], [], [4]],
+    ].each do |values, expected_prefix, expected_remainder|
+      context "given the list #{values.inspect}" do
+        let(:list) { L[*values] }
+
+        context "and a predicate that returns true for values <= 2" do
+          let(:result) { list.span { |item| item <= 2 }}
+          let(:prefix) { result.first }
+          let(:remainder) { result.last }
+
+          it "preserves the original" do
+            result
+            list.should eql(L[*values])
+          end
+
+          it "returns the prefix as #{expected_prefix.inspect}" do
+            prefix.should eql(L[*expected_prefix])
+          end
+
+          it "returns the remainder as #{expected_remainder.inspect}" do
+            remainder.should eql(L[*expected_remainder])
+          end
+
+          it "calls the block only once for each element" do
+            count = 0
+            result = list.span { |item| count += 1; item <= 2 }
+            # force realization of lazy lists
+            result.first.size.should == expected_prefix.size
+            result.last.size.should == expected_remainder.size
+            # it may not need to call the block on every element, just up to the
+            # point where the block first returns a false value
+            count.should <= values.size
+          end
+        end
+
+        context "without a predicate" do
+          it "returns a frozen array" do
+            list.span.class.should be(Array)
+            list.span.should be_frozen
+          end
+
+          it "returns self as the prefix" do
+            list.span.first.should equal(list)
+          end
+
+          it "returns an empty list as the remainder" do
+            list.span.last.should be_empty
+          end
+        end
+      end
+    end
+  end
+end