hamster 0.2.2 → 0.2.3

data/History.rdoc

@@ -1,3 +1,16 @@
+=== 0.2.3 / 2010-01-18
+
+* Implement Set#group_by.
+
+* Implement List#group_by.
+
+* Implement Hash#inspect.
+
+* Tuples can now be implicitly converted to args and variables via #to_ary, meaning you can do:
+
+   integers = Hamster.iterate(1, &:succ)
+   odds, evens = integers.partition(&:odd?)
+
 === 0.2.2 / 2010-01-15
 
 * Implement List#flatten.

data/README.rdoc

@@ -128,13 +128,18 @@ Besides <tt>Hamster.list</tt> there are other ways to construct lists:
 
 <tt>Hamster.interval(from, to)</tt> (aliased as <tt>.range</tt>) creates a lazy list equivalent to a list containing all the values between <tt>from</tt> and <tt>to</tt> without actually creating a list that big.
 
-<tt>Hamster.stream { ... }</tt> allows you to creates infinite lists. Each time a new value is required, the supplied block is called.
+<tt>Hamster.stream { ... }</tt> allows you to creates infinite lists. Each time a new value is required, the supplied block is called. For example, to generate a list of integers you could do:
+
+  count = 1
+  integers = Hamster.stream { count += 1 }
 
 <tt>Hamster.repeat(x)</tt> creates an infinite list with x the value for every element.
 
 <tt>Hamster.replicate(n, x)</tt> creates a list of size n with x the value for every element.
 
-<tt>Hamster.iterate(x) { ... }</tt> creates an infinite list where the first item is calculated by applying the block on the initial argument, the second item by applying the function on the previous result and so on.
+<tt>Hamster.iterate(x) { ... }</tt> creates an infinite list where the first item is calculated by applying the block on the initial argument, the second item by applying the function on the previous result and so on. For example, a simpler way to generate a list of integers would be:
+
+  integers = Hamster.iterate(1, &:succ)
 
 You also get <tt>Enumerable#to_list</tt> so you can slowly transition from built-in collection classes to Hamster.
 

data/lib/hamster/hash.rb

@@ -132,6 +132,10 @@ module Hamster
     def_delegator :self, :dup, :nub
     def_delegator :self, :dup, :remove_duplicates
 
+    def inspect
+      "{#{reduce([]) { |memo, key, value| memo << "#{key.inspect} => #{value.inspect}"}.join(", ")}}"
+    end
+
   end
 
 end

data/lib/hamster/list.rb

@@ -2,6 +2,7 @@ require 'forwardable'
 require 'monitor'
 
 require 'hamster/tuple'
+require 'hamster/hash'
 require 'hamster/set'
 
 module Hamster
@@ -43,6 +44,10 @@ module Hamster
 
     extend Forwardable
 
+    Undefined = Object.new
+
+    CADR = /^c([ad]+)r$/
+
     def_delegator :self, :head, :first
 
     def_delegator :self, :empty?, :null?
@@ -440,6 +445,14 @@ module Hamster
       end
     end
 
+    def group_by(&block)
+      return group_by { |item| item } unless block_given?
+      reduce(Hamster::Hash.new) do |hash, item|
+        key = yield(item)
+        hash.put(key, (hash.get(key) || EmptyList).cons(item))
+      end
+    end
+
     def eql?(other)
       # return true if other.equal?(self)
       # return false unless other.is_a?(List)
@@ -484,10 +497,6 @@ module Hamster
 
     private
 
-    Undefined = Object.new
-
-    CADR = /^c([ad]+)r$/
-
     def method_missing(name, *args, &block)
       if CADR === name
         accessor($1)

data/lib/hamster/set.rb

@@ -7,7 +7,7 @@ require 'hamster/list'
 module Hamster
 
   def self.set(*items)
-    items.reduce(Set.new) { |set, item| set.add(item) }
+    items.reduce(EmptySet) { |set, item| set.add(item) }
   end
 
   class Set
@@ -116,6 +116,10 @@ module Hamster
       true
     end
 
+    def one?
+      return one? { |item| item } unless block_given?
+    end
+
     def find
       return nil unless block_given?
       each { |item| return item if yield(item) }
@@ -165,6 +169,14 @@ module Hamster
       remove(&:nil?)
     end
 
+    def group_by(&block)
+      return group_by { |item| item } unless block_given?
+      reduce(Hamster::Hash.new) do |hash, item|
+        key = yield(item)
+        hash.put(key, (hash.get(key) || EmptySet).add(item))
+      end
+    end
+
     def eql?(other)
       other.is_a?(self.class) && @trie.eql?(other.instance_eval{@trie})
     end
@@ -194,4 +206,6 @@ module Hamster
 
   end
 
+  EmptySet = Set.new
+
 end

data/lib/hamster/trie.rb

@@ -91,7 +91,7 @@ module Hamster
 
     # Returns <tt>true</tt> if . <tt>eql?</tt> is synonymous with <tt>==</tt>
     def eql?(other)
-      return true if other.equal?(self)
+      # return true if other.equal?(self)
       return false unless other.is_a?(self.class) && other.size == size
       each do |entry|
         return false unless other.include?(entry.key, entry.value)

data/lib/hamster/version.rb

@@ -1,5 +1,5 @@
 module Hamster
 
-  VERSION = "0.2.2".freeze
+  VERSION = "0.2.3".freeze
 
 end

data/spec/hamster/hash/inspect_spec.rb

@@ -0,0 +1,32 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+require 'hamster/hash'
+
+describe Hamster::Hash do
+
+  describe "#inspect" do
+
+    [
+      [[], "{}"],
+      [["A" => "aye"], "{\"A\" => \"aye\"}"],
+      [[1 => :one, 2 => :two, 3 => :three], "{1 => :one, 2 => :two, 3 => :three}"]
+    ].each do |values, expected|
+
+      describe "on #{values.inspect}" do
+
+        before do
+          original = Hamster.hash(*values)
+          @result = original.inspect
+        end
+
+        it "returns #{expected.inspect}" do
+          @result.should == expected
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/spec/hamster/list/group_by_spec.rb

@@ -0,0 +1,73 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+require 'hamster/list'
+
+describe Hamster::List do
+
+  describe "#group_by" do
+
+    describe "on a really big list" do
+
+      before do
+        @list = Hamster.interval(0, STACK_OVERFLOW_DEPTH)
+      end
+
+      it "doesn't run out of stack" do
+        lambda { @list.group_by }.should_not raise_error
+      end
+
+    end
+
+    describe "with a block" do
+
+      [
+        [[], []],
+        [[1], [true => Hamster.list(1)]],
+        [[1, 2, 3, 4], [true => Hamster.list(3, 1), false => Hamster.list(4, 2)]],
+      ].each do |values, expected|
+
+        describe "on #{values.inspect}" do
+
+          before do
+            original = Hamster.list(*values)
+            @result = original.group_by(&:odd?)
+          end
+
+          it "returns #{expected.inspect}" do
+            @result.should == Hamster.hash(*expected)
+          end
+
+        end
+
+      end
+
+    end
+
+    describe "without a block" do
+
+      [
+        [[], []],
+        [[1], [1 => Hamster.list(1)]],
+        [[1, 2, 3, 4], [1 => Hamster.list(1), 2 => Hamster.list(2), 3 => Hamster.list(3), 4 => Hamster.list(4)]],
+      ].each do |values, expected|
+
+        describe "on #{values.inspect}" do
+
+          before do
+            original = Hamster.list(*values)
+            @result = original.group_by
+          end
+
+          it "returns #{expected.inspect}" do
+            @result.should == Hamster.hash(*expected)
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/spec/hamster/list/to_ary_spec.rb

@@ -21,20 +21,27 @@ describe Hamster::List do
     describe "enables implicit conversion to" do
 
       before do
-        @list = Hamster.list("A", "B", "C")
+        @list = Hamster.list("A", "B", "C", "D")
       end
 
-      it "arrays" do
-        array = *@list
-        array.should == ["A", "B", "C"]
+      it "block parameters" do
+        def func(&block)
+          yield(@list)
+        end
+        func do |a, b, *c|
+          a.should == "A"
+          b.should == "B"
+          c.should == ["C", "D"]
+        end
       end
 
-      it "call parameters" do
-        [@list].each do |a, b, c|
+      it "method arguments" do
+        def func(a, b, *c)
           a.should == "A"
           b.should == "B"
-          c.should == "C"
+          c.should == ["C", "D"]
         end
+        func(*@list)
       end
 
     end

data/spec/hamster/set/group_by_spec.rb

@@ -0,0 +1,61 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+require 'hamster/set'
+
+describe Hamster::Set do
+
+  describe "#group_by" do
+
+    describe "with a block" do
+
+      [
+        [[], []],
+        [[1], [true => Hamster.set(1)]],
+        [[1, 2, 3, 4], [true => Hamster.set(3, 1), false => Hamster.set(4, 2)]],
+      ].each do |values, expected|
+
+        describe "on #{values.inspect}" do
+
+          before do
+            original = Hamster.set(*values)
+            @result = original.group_by(&:odd?)
+          end
+
+          it "returns #{expected.inspect}" do
+            @result.should == Hamster.hash(*expected)
+          end
+
+        end
+
+      end
+
+    end
+
+    describe "without a block" do
+
+      [
+        [[], []],
+        [[1], [1 => Hamster.set(1)]],
+        [[1, 2, 3, 4], [1 => Hamster.set(1), 2 => Hamster.set(2), 3 => Hamster.set(3), 4 => Hamster.set(4)]],
+      ].each do |values, expected|
+
+        describe "on #{values.inspect}" do
+
+          before do
+            original = Hamster.set(*values)
+            @result = original.group_by
+          end
+
+          it "returns #{expected.inspect}" do
+            @result.should == Hamster.hash(*expected)
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/spec/hamster/set/inspect_spec.rb

@@ -2,26 +2,10 @@ require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
 
 require 'hamster/set'
 
-describe Hamster::List do
+describe Hamster::Set do
 
   describe "#inspect" do
 
-    describe "doesn't run out of stack space on a really big" do
-
-      it "stream" do
-        @list = Hamster.interval(0, STACK_OVERFLOW_DEPTH)
-      end
-
-      it "list" do
-        @list = (0...STACK_OVERFLOW_DEPTH).reduce(Hamster.list) { |list, i| list.cons(i) }
-      end
-
-      after do
-        @list.inspect
-      end
-
-    end
-
     [
       [[], "{}"],
       [["A"], "{\"A\"}"],

data/spec/hamster/set/one_spec.rb

@@ -0,0 +1,77 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+require 'hamster/set'
+
+describe Hamster::Set do
+
+  describe "#one?" do
+
+    describe "when empty" do
+
+      before do
+        @set = Hamster.set
+      end
+
+      it "with a block returns false" do
+        pending do
+          @set.one? {}.should == false
+        end
+      end
+
+      it "with no block returns false" do
+        pending do
+          @set.one?.should == false
+        end
+      end
+
+    end
+
+    describe "when not empty" do
+
+      describe "with a block" do
+
+        before do
+          @set = Hamster.set("A", "B", "C")
+        end
+
+        it "returns false if the block returns true more than once" do
+          pending do
+            @set.one? { |item| true }.should == false
+          end
+        end
+
+        it "returns fale if the block never returns true" do
+          pending do
+            @set.one? { |item| false }.should == false
+          end
+        end
+
+        it "returns true if the block only returns true once" do
+          pending do
+            @set.one? { |item| item == "A" }.should == true
+          end
+        end
+
+      end
+
+      describe "with no block" do
+
+        it "returns false if more than one value is truthy" do
+          pending do
+            Hamster.set(nil, true, "A").one?.should == false
+          end
+        end
+
+        it "returns true if only one value is truthy" do
+          pending do
+            Hamster.set(nil, true, false).one?.should == true
+          end
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/spec/hamster/tuple/to_ary_spec.rb

@@ -9,14 +9,27 @@ describe Hamster::Tuple do
     describe "enables implicit conversion to" do
 
       before do
-        @tuple = Hamster::Tuple.new("A", "B")
+        @tuple = Hamster::Tuple.new("A", "B", "C", "D")
       end
 
-      it "call parameters" do
-        [@tuple].each do |a, b|
+      it "block parameters" do
+        def func(&block)
+          yield(@tuple)
+        end
+        func do |a, b, *c|
+          a.should == "A"
+          b.should == "B"
+          c.should == ["C", "D"]
+        end
+      end
+
+      it "method arguments" do
+        def func(a, b, *c)
           a.should == "A"
           b.should == "B"
+          c.should == ["C", "D"]
         end
+        func(*@tuple)
       end
 
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: hamster
 version: !ruby/object:Gem::Version 
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors: 
 - Simon Harris
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-16 00:00:00 +11:00
+date: 2010-01-18 00:00:00 +11:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -58,6 +58,7 @@ files:
 - spec/hamster/hash/filter_spec.rb
 - spec/hamster/hash/get_spec.rb
 - spec/hamster/hash/has_key_spec.rb
+- spec/hamster/hash/inspect_spec.rb
 - spec/hamster/hash/map_spec.rb
 - spec/hamster/hash/none_spec.rb
 - spec/hamster/hash/put_spec.rb
@@ -89,6 +90,7 @@ files:
 - spec/hamster/list/find_spec.rb
 - spec/hamster/list/flatten_spec.rb
 - spec/hamster/list/grep_spec.rb
+- spec/hamster/list/group_by_spec.rb
 - spec/hamster/list/head_spec.rb
 - spec/hamster/list/include_spec.rb
 - spec/hamster/list/init_spec.rb
@@ -136,6 +138,7 @@ files:
 - spec/hamster/set/filter_spec.rb
 - spec/hamster/set/find_spec.rb
 - spec/hamster/set/grep_spec.rb
+- spec/hamster/set/group_by_spec.rb
 - spec/hamster/set/head_spec.rb
 - spec/hamster/set/include_spec.rb
 - spec/hamster/set/inspect_spec.rb
@@ -144,6 +147,7 @@ files:
 - spec/hamster/set/maximum_spec.rb
 - spec/hamster/set/minimum_spec.rb
 - spec/hamster/set/none_spec.rb
+- spec/hamster/set/one_spec.rb
 - spec/hamster/set/partition_spec.rb
 - spec/hamster/set/product_spec.rb
 - spec/hamster/set/reduce_spec.rb