mitchellh-hash_ring 0.1 → 0.2

data/README.rdoc

@@ -12,6 +12,9 @@ http://amix.dk/blog/viewEntry/19367
 
 == Usage
 
+  require 'rubygems'
+  require 'hash_ring'
+
   memcache_servers = ['192.168.0.111:14107',
                       '192.168.0.112:14107',
                       '192.168.0.113:14108']
@@ -22,3 +25,7 @@ http://amix.dk/blog/viewEntry/19367
 
   ring = HashRing.new(memcache_servers, weights)
   server = ring.get_node('my_key')
+
+== Installation
+
+  sudo gem install mitchellh-hash_ring

data/lib/hash_ring.rb

@@ -41,7 +41,7 @@ require 'digest/md5'
 #  server = ring.get_node('my_key')
 #
 class HashRing
-  VERSION = '0.1'
+  VERSION = '0.2'
 
   #
   # Creates a HashRing instance
@@ -67,16 +67,18 @@ class HashRing
   end
 
   #
-  # Generates the circle
+  # Generates the ring.
+  #
+  # This is for internal use only.
   def _generate_circle
     total_weight = 0
     
     @nodes.each do |node|
-      total_weight += @weights[node] || 1
+      total_weight += @weights[node.to_s] || 1
     end
 
     @nodes.each do |node|
-      weight = @weights[node] || 1
+      weight = @weights[node.to_s] || 1
       factor = ((40 * @nodes.length * weight) / total_weight.to_f).floor.to_i
 
       factor.times do |j|
@@ -153,15 +155,23 @@ class HashRing
     return self._hash_val(b_key) { |x| x }
   end
 
+  #
+  # Converts a hex digest to a value based on certain parts of 
+  # the digest determined by the block. The block will be called
+  # 4 times (with paramter 3, then 2, then 1, then 0) and is 
+  # expected to return a valid index into the digest with which
+  # to pull a single character from.
+  #
+  # This function is meant for use internally.
   def _hash_val(b_key, &block)
     return ((b_key[block.call(3)] << 24) | 
             (b_key[block.call(2)] << 16) | 
             (b_key[block.call(1)] << 8) | 
             (b_key[block.call(0)])) 
- end
+  end
 
   #
-  # Returns raw MD5 digest given a key
+  # Returns raw MD5 digest of a key.
   def _hash_digest(key)
     m = Digest::MD5.new
     m.update(key)
@@ -172,7 +182,11 @@ class HashRing
   end
 
   #
-  # Bisect an array
+  # Bisects an array, returning the index where the key would
+  # need to be inserted to maintain sorted order of the array.
+  #
+  # That being said, it is assumed that the array is already
+  # in sorted order before calling this method.
   def bisect(arr, key)
     arr.each_index do |i|
       return i if key < arr[i]

data/spec/hash_ring_spec.rb

@@ -9,6 +9,12 @@ WEIGHTED_ERROR_BOUND = 0.05
 describe HashRing do
   include HashRingHelpers
 
+  it "should allow the creation of a hash ring with non-string objects" do
+    lambda do
+      ring = HashRing.new([HashRing.new('a'), HashRing.new('b')])
+    end.should_not raise_error
+  end
+
   describe "bisection" do
     before do
       @ring = HashRing.new(['a'])

data/spec/spec_base.rb

@@ -1,5 +1,6 @@
 # Include the hash_ring library
 require File.expand_path(File.dirname(__FILE__) + '/../lib/hash_ring')
+require 'digest/md5'
 
 # Helpers
 module HashRingHelpers

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mitchellh-hash_ring
 version: !ruby/object:Gem::Version 
-  version: "0.1"
+  version: "0.2"
 platform: ruby
 authors: 
 - Mitchell Hashimoto