hamster 0.1.5 → 0.1.6

data/History.rdoc

@@ -1,3 +1,7 @@
+=== 0.1.6 / 2009-11-23
+
+* First cut at finishing implementation of Hash.
+
 === 0.1.5 / 2009-11-5
 
 * Add some examples

data/lib/hamster/hash.rb

@@ -23,7 +23,10 @@ module Hamster
 
     # Retrieves the value corresponding to the given key. If not found, returns <tt>nil</tt>.
     def get(key)
-      @trie.get(key)
+      entry = @trie.get(key)
+      if entry
+        entry.value
+      end
     end
 
     # Returns a copy of <tt>self</tt> with the given value associated with the key.
@@ -34,10 +37,10 @@ module Hamster
     # Returns a copy of <tt>self</tt> with the given key/value pair removed. If not found, returns <tt>self</tt>.
     def remove(key)
       copy = @trie.remove(key)
-      if copy.equal?(@trie)
-        self
-      else
+      if !copy.equal?(@trie)
         self.class.new(copy)
+      else
+        self
       end
     end
 
@@ -45,7 +48,7 @@ module Hamster
     # Returns <tt>self</tt>
     def each
       block_given? or return enum_for(__method__)
-      @trie.each { |key, value| yield key, value }
+      @trie.each { |entry| yield entry.key, entry.value }
       self
     end
 

data/lib/hamster/set.rb

@@ -13,7 +13,7 @@ module Hamster
 
     # Returns <tt>true</tt> if the set contains no items.
     def empty?
-      @trie.size
+      @trie.empty?
     end
 
     # Returns <tt>true</tt> if the given item is present in the set.
@@ -33,10 +33,10 @@ module Hamster
     # Returns a copy of <tt>self</tt> with the given item removed. If not found, returns <tt>self</tt>.
     def remove(key)
       copy = @trie.remove(item)
-      if copy.equal?(@trie)
-        self
-      else
+      if !copy.equal?(@trie)
         self.class.new(copy)
+      else
+        self
       end
     end
 
@@ -44,7 +44,7 @@ module Hamster
     # Returns <tt>self</tt>
     def each
       block_given? or return enum_for(__method__)
-      @trie.each { |key, value| yield key }
+      @trie.each { |entry| yield entry.key }
       self
     end
 

data/lib/hamster/trie.rb

@@ -27,9 +27,9 @@ module Hamster
 
     # Calls <tt>block</tt> once for each entry in the trie, passing the key-value pair as parameters.
     def each
-      @entries.each { |entry| yield entry.key, entry.value if entry }
+      @entries.each { |entry| yield entry if entry }
       @children.each do |child|
-        child.each { |key, value| yield key, value } if child
+        child.each { |entry| yield entry } if child
       end
     end
 
@@ -37,7 +37,11 @@ module Hamster
     def put(key, value)
       index = index_for(key)
       entry = @entries[index]
-      if entry && !entry.has_key?(key)
+      if !entry || entry.key_eql?(key)
+        entries = @entries.dup
+        entries[index] = Entry.new(key, value)
+        self.class.new(@significant_bits, entries, @children)
+      else
         children = @children.dup
         child = children[index]
         children[index] = if child
@@ -46,19 +50,15 @@ module Hamster
           self.class.new(@significant_bits + 5).put!(key, value)
         end
         self.class.new(@significant_bits, @entries, children)
-      else
-        entries = @entries.dup
-        entries[index] = Entry.new(key, value)
-        self.class.new(@significant_bits, entries, @children)
       end
     end
 
-    # Retrieves the value corresponding to the given key. If not found, returns <tt>nil</tt>.
+    # Retrieves the entry corresponding to the given key. If not found, returns <tt>nil</tt>.
     def get(key)
       index = index_for(key)
       entry = @entries[index]
-      if entry && entry.has_key?(key)
-        entry.value
+      if entry && entry.key_eql?(key)
+        entry
       else
         child = @children[index]
         if child
@@ -67,44 +67,63 @@ module Hamster
       end
     end
 
-    # Returns a copy of <tt>self</tt> with the given key/value pair removed. If not found, returns <tt>self</tt>.
+    # Returns a copy of <tt>self</tt> with the given key (and associated value) removed. If not found, returns <tt>self</tt>.
     def remove(key)
-      remove!(key) || self
+      xxx(key) || Trie.new(@significant_bits)
     end
 
     # Returns <tt>true</tt> if . <tt>eql?</tt> is synonymous with <tt>==</tt>
     def eql?(other)
-      blammo!
+      false
     end
     alias :== :eql?
 
     protected
 
+    # Returns <tt>self</tt> after overwriting the element associated with the specified key.
     def put!(key, value)
       @entries[index_for(key)] = Entry.new(key, value)
       self
     end
-    
-    def remove!(key)
+
+    # Returns a replacement instance after removing the specified key.
+    # If not found, returns <tt>self</tt>.
+    # If empty, returns <tt>nil</tt>.
+    def xxx(key)
       index = index_for(key)
       entry = @entries[index]
-      if entry && entry.has_key?(key)
-        if size > 1
-          entries = @entries.dup
-          entries[index] = nil
-          self.class.new(@significant_bits, entries, @children)
-        end
+      if entry && entry.key_eql?(key)
+        return remove_at(index)
       else
         child = @children[index]
         if child
-          copy = child.remove!(key)
+          copy = child.xxx(key)
           if !copy.equal?(child)
             children = @children.dup
             children[index] = copy
-            self.class.new(@significant_bits, @entries, children)
+            return self.class.new(@significant_bits, @entries, children)
           end
         end
       end
+      self
+    end
+
+    # Returns a replacement instance after removing the specified entry. If empty, returns <tt>nil</tt>
+    def remove_at(index = @entries.index { |e| e })
+      yield @entries[index] if block_given?
+      if size > 1
+        entries = @entries.dup
+        child = @children[index]
+        if child
+          children = @children.dup
+          children[index] = child.remove_at do |entry|
+            entries[index] = entry
+          end
+        else
+          entries[index] = nil
+        end
+        self.class.new(@significant_bits, entries, children || @children)
+      end
     end
 
     private
@@ -122,7 +141,7 @@ module Hamster
         @value = value
       end
 
-      def has_key?(key)
+      def key_eql?(key)
         @key.eql?(key)
       end
 

data/lib/hamster/version.rb

@@ -1,5 +1,5 @@
 module Hamster
 
-  VERSION = "0.1.5".freeze
+  VERSION = "0.1.6".freeze
 
 end

data/spec/hamster/hash/eql_spec.rb

@@ -15,6 +15,20 @@ describe Hamster::Hash do
       end
     end
 
+    it "is true for two instances with the same key/value pairs" do
+      pending do
+        a = Hamster::Hash.new.put("a", "Aye").put("b", "Bee").put("c", "See")
+        b = Hamster::Hash.new.put("a", "Aye").put("b", "Bee").put("c", "See")
+        a.should eql(b)
+      end
+    end
+
+    it "is false for two instances with different key/value pairs" do
+      a = Hamster::Hash.new.put("a", "Aye").put("b", "Bee").put("c", "See")
+      b = Hamster::Hash.new.put("a", "Aye").put("b", "Bee")
+      a.should_not eql(b)
+    end
+
   end
 
 end

data/spec/hamster/hash/has_key_spec.rb

@@ -5,7 +5,7 @@ describe Hamster::Hash do
   describe "#has_key?" do
 
     before do
-      @hash = Hamster::Hash.new.put("A", "aye")
+      @hash = Hamster::Hash.new.put("A", "aye").put("NIL", nil)
     end
 
     it "returns true for an existing key" do
@@ -15,6 +15,10 @@ describe Hamster::Hash do
     it "returns false for a non-existing key" do
       @hash.has_key?("B").should be_false
     end
+    
+    it "returns true for a nil value" do
+      @hash.has_key?("NIL").should be_true
+    end
 
   end
 

data/spec/hamster/hash/put_spec.rb

@@ -88,6 +88,18 @@ describe Hamster::Hash do
 
     end
 
+    describe "with a nil key" do
+
+      before do
+        @hash = Hamster::Hash.new.put(nil, "NIL")
+      end
+
+      it "can locate the key/value pair" do
+        @hash.get(nil).should == "NIL"
+      end
+
+    end
+
   end
 
 end

data/spec/hamster/hash/remove_spec.rb

@@ -3,6 +3,18 @@ require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
 describe Hamster::Hash do
 
   describe "#remove" do
+    
+    describe "the last key" do
+
+      before do
+        @hash = Hamster::Hash.new.put("A", "aye").remove("A")
+      end
+
+      it "no longer provides access to the removed key" do
+        @hash.has_key?("A").should be_false
+      end
+      
+    end
 
     describe "with an existing key" do
 
@@ -79,7 +91,7 @@ describe Hamster::Hash do
 
       def instance_count
         ObjectSpace.garbage_collect
-        ObjectSpace.each_object(Hamster::Hash) {}
+        ObjectSpace.each_object(Hamster::Trie) {}
       end
 
       before do
@@ -98,14 +110,6 @@ describe Hamster::Hash do
         copy.get(@b).should == "bee"
       end
 
-      it "cleans up empty instances" do
-        pending do
-          instance_count_before = instance_count
-          # copy = @original.remove(@b)
-          instance_count.should == instance_count_before + 1
-        end
-      end
-
     end
 
   end

data/tasks/spec.rb

@@ -1,4 +1,4 @@
-require "spec/rake/spectask"
+require 'spec/rake/spectask'
 
 desc "Run specifications"
 Spec::Rake::SpecTask.new(:spec) do |t|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: hamster
 version: !ruby/object:Gem::Version 
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors: 
 - Simon Harris
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-07 00:00:00 +11:00
+date: 2009-11-23 00:00:00 +11:00
 default_executable: 
 dependencies: []