hamster 0.2.13 → 0.3.0

data/History.rdoc

@@ -1,3 +1,9 @@
+=== 0.3.0 / 2010-03-28
+
+* Add Hamster::Immutable as general purpose module to facililate immutability.
+
+* List, Stack, Set, and Hash now all implement Hamster::Immutable.
+
 === 0.2.13 / 2010-03-25
 
 * Implement Hash#hash.

data/lib/hamster/hash.rb

@@ -1,5 +1,6 @@
 require 'forwardable'
 
+require 'hamster/immutable'
 require 'hamster/trie'
 
 module Hamster
@@ -12,8 +13,10 @@ module Hamster
 
     extend Forwardable
 
-    def initialize(trie = EmptyTrie)
-      @trie = trie
+    include Immutable
+
+    def initialize
+      @trie = EmptyTrie
     end
 
     def size
@@ -40,16 +43,12 @@ module Hamster
     def_delegator :self, :get, :[]
 
     def put(key, value)
-      self.class.new(@trie.put(key, value))
+      transform { @trie = @trie.put(key, value) }
     end
 
     def delete(key)
       trie = @trie.delete(key)
-      if trie.equal?(@trie)
-        self
-      else
-        self.class.new(trie)
-      end
+      transform_unless(trie.equal?(@trie)) { @trie = trie }
     end
 
     def each
@@ -61,7 +60,7 @@ module Hamster
     def map
       return self unless block_given?
       return self if empty?
-      self.class.new(@trie.reduce(EmptyTrie) { |trie, entry| trie.put(*yield(entry.key, entry.value)) })
+      transform { @trie = @trie.reduce(EmptyTrie) { |trie, entry| trie.put(*yield(entry.key, entry.value)) } }
     end
     def_delegator :self, :map, :collect
 
@@ -76,11 +75,7 @@ module Hamster
     def filter
       return self unless block_given?
       trie = @trie.filter { |entry| yield(entry.key, entry.value) }
-      if trie.equal?(@trie)
-        self
-      else
-        self.class.new(trie)
-      end
+      transform_unless(trie.equal?(@trie)) { @trie = trie }
     end
     def_delegator :self, :filter, :select
     def_delegator :self, :filter, :find_all
@@ -132,10 +127,6 @@ module Hamster
       reduce(0) { |h, key, value| h ^ key.hash }
     end
 
-    def dup
-      self
-    end
-    def_delegator :self, :dup, :clone
     def_delegator :self, :dup, :uniq
     def_delegator :self, :dup, :nub
     def_delegator :self, :dup, :remove_duplicates

data/lib/hamster/immutable.rb

@@ -0,0 +1,52 @@
+require 'forwardable'
+
+module Hamster
+
+  module Immutable
+
+    def self.included(klass)
+      klass.extend(ClassMethods)
+      klass.instance_eval do
+        include InstanceMethods
+      end
+    end
+
+    module ClassMethods
+
+      def new(*args)
+        super.freeze
+      end
+
+    end
+
+    module InstanceMethods
+
+      extend Forwardable
+
+      def immutable?
+        frozen?
+      end
+
+      alias_method :__copy__, :dup
+      private :__copy__
+
+      def dup
+        self
+      end
+      def_delegator :self, :dup, :clone
+
+      protected
+
+      def transform_unless(condition, &block)
+        condition ? self : transform(&block)
+      end
+
+      def transform(&block)
+        __copy__.tap { |copy| copy.instance_eval(&block) }.freeze
+      end
+
+    end
+
+  end
+
+end

data/lib/hamster/list.rb

@@ -534,29 +534,8 @@ module Hamster
     def_delegator :target, :tail
     def_delegator :target, :empty?
 
-    def head
-      target.head
-    end
-
-    def tail
-      target.tail
-    end
-
-    def empty?
-      target.empty?
-    end
-
     protected
 
-    def target
-      # vivify
-      list = vivify
-      while list.is_a?(Stream)
-        list = list.vivify
-      end
-      list
-    end
-
     def vivify
       @lock.synchronize do
         unless @block.nil?
@@ -567,6 +546,16 @@ module Hamster
       @target
     end
 
+    private
+
+    def target
+      list = vivify
+      while list.is_a?(Stream)
+        list = list.vivify
+      end
+      list
+    end
+
   end
 
   module EmptyList

data/lib/hamster/set.rb

@@ -1,5 +1,6 @@
 require 'forwardable'
 
+require 'hamster/immutable'
 require 'hamster/undefined'
 require 'hamster/tuple'
 require 'hamster/sorter'
@@ -16,8 +17,10 @@ module Hamster
 
     extend Forwardable
 
-    def initialize(trie = EmptyTrie)
-      @trie = trie
+    include Immutable
+
+    def initialize
+      @trie = EmptyTrie
     end
 
     def empty?
@@ -38,15 +41,13 @@ module Hamster
     def_delegator :self, :include?, :elem?
 
     def add(item)
-      return self if include?(item)
-      self.class.new(@trie.put(item, nil))
+      transform_unless(include?(item)) { @trie = @trie.put(item, nil) }
     end
     def_delegator :self, :add, :<<
 
     def delete(item)
       trie = @trie.delete(item)
-      return self if trie.equal?(@trie)
-      self.class.new(trie)
+      transform_unless(trie.equal?(@trie)) { @trie = trie }
     end
 
     def each
@@ -58,7 +59,7 @@ module Hamster
     def map
       return self unless block_given?
       return self if empty?
-      self.class.new(@trie.reduce(EmptyTrie) { |trie, entry| trie.put(yield(entry.key), nil) })
+      transform { @trie = @trie.reduce(EmptyTrie) { |trie, entry| trie.put(yield(entry.key), nil) } }
     end
     def_delegator :self, :map, :collect
 
@@ -78,7 +79,7 @@ module Hamster
       trie = @trie.filter { |entry| yield(entry.key) }
       return self if trie.equal?(@trie)
       return EmptySet if trie.empty?
-      self.class.new(trie)
+      transform { @trie = trie }
     end
     def_delegator :self, :filter, :select
     def_delegator :self, :filter, :find_all
@@ -186,24 +187,21 @@ module Hamster
         next trie if trie.has_key?(item)
         trie.put(item, nil)
       end
-      return self if trie.equal?(@trie)
-      self.class.new(trie)
+      transform_unless(trie.equal?(@trie)) { @trie = trie }
     end
     def_delegator :self, :union, :|
     def_delegator :self, :union, :+
 
     def intersection(other)
       trie = @trie.filter { |entry| other.include?(entry.key) }
-      return self if trie.equal?(@trie)
-      self.class.new(trie)
+      transform_unless(trie.equal?(@trie)) { @trie = trie }
     end
     def_delegator :self, :intersection, :intersect
     def_delegator :self, :intersection, :&
 
     def difference(other)
       trie = @trie.filter { |entry| !other.include?(entry.key) }
-      return self if trie.equal?(@trie)
-      self.class.new(trie)
+      transform_unless(trie.equal?(@trie)) { @trie = trie }
     end
     def_delegator :self, :difference, :diff
     def_delegator :self, :difference, :subtract
@@ -254,10 +252,6 @@ module Hamster
       reduce(0) { |h, item| h ^ item.hash }
     end
 
-    def dup
-      self
-    end
-    def_delegator :self, :dup, :clone
     def_delegator :self, :dup, :uniq
     def_delegator :self, :dup, :nub
     def_delegator :self, :dup, :to_set

data/lib/hamster/sorter.rb

@@ -1,11 +1,15 @@
 require 'forwardable'
 
+require 'hamster/immutable'
+
 module Hamster
 
   class Sorter
 
     extend Forwardable
 
+    include Immutable
+
     include Enumerable
 
     def initialize(collection)

data/lib/hamster/stack.rb

@@ -1,5 +1,6 @@
 require 'forwardable'
 
+require 'hamster/immutable'
 require 'hamster/list'
 
 module Hamster
@@ -12,8 +13,10 @@ module Hamster
 
     extend Forwardable
 
-    def initialize(list)
-      @list = list
+    include Immutable
+
+    def initialize
+      @list = EmptyList
     end
 
     def empty?
@@ -30,7 +33,7 @@ module Hamster
     end
 
     def push(item)
-      self.class.new(@list.cons(item))
+      transform { @list = @list.cons(item) }
     end
     def_delegator :self, :push, :<<
 
@@ -39,7 +42,7 @@ module Hamster
       if list.empty?
         EmptyStack
       else
-        self.class.new(list)
+        transform { @list = list }
       end
     end
 
@@ -54,11 +57,6 @@ module Hamster
     end
     def_delegator :self, :eql?, :==
 
-    def dup
-      self
-    end
-    def_delegator :self, :dup, :clone
-
     def to_a
       @list.to_a
     end
@@ -78,6 +76,6 @@ module Hamster
 
   end
 
-  EmptyStack = Stack.new(EmptyList)
+  EmptyStack = Stack.new
 
 end

data/lib/hamster/tuple.rb

@@ -1,11 +1,15 @@
 require 'forwardable'
 
+require 'hamster/immutable'
+
 module Hamster
 
   class Tuple
 
     extend Forwardable
 
+    include Immutable
+
     def initialize(*items)
       @items = items.freeze
     end
@@ -25,11 +29,6 @@ module Hamster
     end
     def_delegator :self, :eql?, :==
 
-    def dup
-      self
-    end
-    def_delegator :self, :dup, :clone
-
     def to_ary
       @items
     end

data/lib/hamster/version.rb

@@ -1,5 +1,5 @@
 module Hamster
 
-  VERSION = "0.2.13".freeze
+  VERSION = "0.3.0".freeze
 
 end

data/spec/hamster/hash/immutable_spec.rb

@@ -0,0 +1,12 @@
+require File.expand_path('../../../spec_helper', __FILE__)
+
+require 'hamster/immutable'
+require 'hamster/hash'
+
+describe Hamster::Hash do
+
+  it "includes Immutable" do
+    Hamster::Hash.should include(Hamster::Immutable)
+  end
+
+end

data/spec/hamster/immutable/copying_spec.rb

@@ -0,0 +1,28 @@
+require File.expand_path('../../../spec_helper', __FILE__)
+
+require 'hamster/immutable'
+
+describe Hamster::Immutable do
+
+  class Fixture
+    include Hamster::Immutable
+  end
+
+  [:dup, :clone].each do |method|
+
+    describe "##{method}" do
+
+      before do
+        @original = Fixture.new
+        @result = @original.send(method)
+      end
+
+      it "returns self" do
+        @result.should equal(@original)
+      end
+
+    end
+
+  end
+
+end

data/spec/hamster/immutable/immutable_spec.rb

@@ -0,0 +1,58 @@
+require File.expand_path('../../../spec_helper', __FILE__)
+
+require 'hamster/immutable'
+
+describe Hamster::Immutable do
+
+  describe "#immutable?" do
+
+    describe "object constructed after its class becomes Immutable" do
+
+      class Fixture
+        include Hamster::Immutable
+      end
+
+      before do
+        @fixture = Fixture.new
+      end
+
+      it "returns true" do
+        @fixture.should be_immutable
+      end
+
+    end
+
+    describe "object constructed before its class becomes Immutable" do
+
+      before do
+        @fixture = Class.new.new
+        @fixture.class.instance_eval do
+          include Hamster::Immutable
+        end
+      end
+
+      describe "that are not frozen" do
+
+        it "returns false" do
+          @fixture.should_not be_immutable
+        end
+
+      end
+
+      describe "that are frozen" do
+
+        before do
+          @fixture.freeze
+        end
+
+        it "returns true" do
+          @fixture.should be_immutable
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/spec/hamster/immutable/new_spec.rb

@@ -0,0 +1,28 @@
+require File.expand_path('../../../spec_helper', __FILE__)
+
+require 'hamster/immutable'
+
+describe Hamster::Immutable do
+
+  describe "#new" do
+
+    class Person < Struct.new(:first, :last)
+      include Hamster::Immutable
+    end
+
+    before do
+      @instance = Person.new("Simon", "Harris")
+    end
+
+    it "passes the constructor arguments" do
+      @instance.first.should == "Simon"
+      @instance.last.should == "Harris"
+    end
+
+    it "freezes the instance" do
+      @instance.should be_frozen
+    end
+
+  end
+
+end

data/spec/hamster/immutable/transform_spec.rb

@@ -0,0 +1,31 @@
+require File.expand_path('../../../spec_helper', __FILE__)
+
+require 'hamster/immutable'
+
+describe Hamster::Immutable do
+
+  describe "#transform" do
+
+    class Person < Struct.new(:first, :last)
+      include Hamster::Immutable
+      public :transform
+    end
+
+    before do
+      @original = Person.new("Simon", "Harris")
+      @result = @original.transform { self.first = "Sampy" }
+    end
+
+    it "preserves the original" do
+      @original.first.should == "Simon"
+      @original.last.should == "Harris"
+    end
+
+    it "returns a new instance with the updated values" do
+      @result.first.should == "Sampy"
+      @result.last.should == "Harris"
+    end
+
+  end
+
+end

data/spec/hamster/immutable/transform_unless_spec.rb

@@ -0,0 +1,55 @@
+require File.expand_path('../../../spec_helper', __FILE__)
+
+require 'hamster/immutable'
+
+describe Hamster::Immutable do
+
+  describe "#transform_unless" do
+
+    class Person < Struct.new(:first, :last)
+      include Hamster::Immutable
+      public :transform_unless
+    end
+
+    before do
+      @original = Person.new("Simon", "Harris")
+    end
+
+    describe "when the condition is false" do
+
+      before do
+        @result = @original.transform_unless(false) { self.first = "Sampy" }
+      end
+
+      it "preserves the original" do
+        @original.first.should == "Simon"
+        @original.last.should == "Harris"
+      end
+
+      it "returns a new instance with the updated values" do
+        @result.first.should == "Sampy"
+        @result.last.should == "Harris"
+      end
+
+    end
+
+    describe "when the condition is true" do
+
+      before do
+        @result = @original.transform_unless(true) { fail("Should never be called") }
+      end
+
+      it "preserves the original" do
+        @original.first.should == "Simon"
+        @original.last.should == "Harris"
+      end
+
+      it "returns the original" do
+        @result.should equal(@original)
+      end
+
+    end
+
+  end
+
+end

data/spec/hamster/set/immutable_spec.rb

@@ -0,0 +1,12 @@
+require File.expand_path('../../../spec_helper', __FILE__)
+
+require 'hamster/immutable'
+require 'hamster/set'
+
+describe Hamster::Set do
+
+  it "includes Immutable" do
+    Hamster::Set.should include(Hamster::Immutable)
+  end
+
+end

data/spec/hamster/sorter/immutable_spec.rb

@@ -0,0 +1,12 @@
+require File.expand_path('../../../spec_helper', __FILE__)
+
+require 'hamster/immutable'
+require 'hamster/sorter'
+
+describe Hamster::Sorter do
+
+  it "includes Immutable" do
+    Hamster::Sorter.should include(Hamster::Immutable)
+  end
+
+end

data/spec/hamster/stack/immutable_spec.rb

@@ -0,0 +1,12 @@
+require File.expand_path('../../../spec_helper', __FILE__)
+
+require 'hamster/immutable'
+require 'hamster/stack'
+
+describe Hamster::Stack do
+
+  it "includes Immutable" do
+    Hamster::Stack.should include(Hamster::Immutable)
+  end
+
+end

data/spec/hamster/tuple/immutable_spec.rb

@@ -0,0 +1,12 @@
+require File.expand_path('../../../spec_helper', __FILE__)
+
+require 'hamster/immutable'
+require 'hamster/tuple'
+
+describe Hamster::Tuple do
+
+  it "includes Immutable" do
+    Hamster::Tuple.should include(Hamster::Immutable)
+  end
+
+end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
-  - 13
-  version: 0.2.13
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Simon Harris
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-25 00:00:00 +11:00
+date: 2010-03-28 00:00:00 +11:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -60,6 +60,7 @@ files:
 - lib/hamster/core_ext/io.rb
 - lib/hamster/core_ext.rb
 - lib/hamster/hash.rb
+- lib/hamster/immutable.rb
 - lib/hamster/list.rb
 - lib/hamster/set.rb
 - lib/hamster/sorter.rb
@@ -86,6 +87,7 @@ files:
 - spec/hamster/hash/get_spec.rb
 - spec/hamster/hash/has_key_spec.rb
 - spec/hamster/hash/hash_spec.rb
+- spec/hamster/hash/immutable_spec.rb
 - spec/hamster/hash/inspect_spec.rb
 - spec/hamster/hash/keys_spec.rb
 - spec/hamster/hash/map_spec.rb
@@ -95,6 +97,11 @@ files:
 - spec/hamster/hash/remove_spec.rb
 - spec/hamster/hash/size_spec.rb
 - spec/hamster/hash/uniq_spec.rb
+- spec/hamster/immutable/copying_spec.rb
+- spec/hamster/immutable/immutable_spec.rb
+- spec/hamster/immutable/new_spec.rb
+- spec/hamster/immutable/transform_spec.rb
+- spec/hamster/immutable/transform_unless_spec.rb
 - spec/hamster/list/all_spec.rb
 - spec/hamster/list/any_spec.rb
 - spec/hamster/list/append_spec.rb
@@ -182,6 +189,7 @@ files:
 - spec/hamster/set/group_by_spec.rb
 - spec/hamster/set/hash_spec.rb
 - spec/hamster/set/head_spec.rb
+- spec/hamster/set/immutable_spec.rb
 - spec/hamster/set/include_spec.rb
 - spec/hamster/set/inspect_spec.rb
 - spec/hamster/set/intersection_spec.rb
@@ -205,11 +213,13 @@ files:
 - spec/hamster/set/to_set_spec.rb
 - spec/hamster/set/union_spec.rb
 - spec/hamster/set/uniq_spec.rb
+- spec/hamster/sorter/immutable_spec.rb
 - spec/hamster/stack/clear_spec.rb
 - spec/hamster/stack/construction_spec.rb
 - spec/hamster/stack/copying_spec.rb
 - spec/hamster/stack/empty_spec.rb
 - spec/hamster/stack/eql_spec.rb
+- spec/hamster/stack/immutable_spec.rb
 - spec/hamster/stack/inspect_spec.rb
 - spec/hamster/stack/pop_spec.rb
 - spec/hamster/stack/push_spec.rb
@@ -222,6 +232,7 @@ files:
 - spec/hamster/tuple/copying_spec.rb
 - spec/hamster/tuple/eql_spec.rb
 - spec/hamster/tuple/first_spec.rb
+- spec/hamster/tuple/immutable_spec.rb
 - spec/hamster/tuple/inspect_spec.rb
 - spec/hamster/tuple/last_spec.rb
 - spec/hamster/tuple/to_a_spec.rb