ch 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1eae3db0f2ca5c86f6a00459af2765dbe0663cc6
+  data.tar.gz: 43915f85e350d3af504c1ab7d65f542d40df5e84
+SHA512:
+  metadata.gz: 2a9a5db6026a3b10a7446ff0f75cefc00ad134e12e2ce44b72a5447e3dfba2e1ea3d90c2843107f6560e22354cde0b9599fa327edc907f7a2e780d6d7fe65a9b
+  data.tar.gz: 19d53368cfd2c2b77806317610d0c2a7462ec00763a0688883730b5dabed6e69e21afd0f7a3d83ad00c58c700dc716bed6e53daba6130bde1569e4640641d5ea

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://ruby.taobao.org'
+
+group :development, :test do
+  # rspec and guard
+  gem 'rspec', '~> 2.12.0'
+  gem 'guard', '~> 2.8.2'
+  gem 'guard-rspec'
+end
+
+gemspec

data/Guardfile

@@ -0,0 +1,7 @@
+ENV['GUARD_GEM_SILENCE_DEPRECATIONS'] = '1'
+
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Forrest Ye
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,62 @@
+# ch gem
+
+yet another consistent hashing library
+
+Implemented using AVLTree.
+
+Allow nodes to be inserted into multiple positions.
+
+Allow nodes to be inserted into specific positions for more granular control.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ch'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ch
+
+## Usage
+
+```ruby
+require 'ch'
+ring = ConsistentHashing::Ring.new
+
+# add nodes
+ring.add_node('127.0.0.1:6379')                 # key 102336333644841978549106395032298540172546507605
+ring.add_node('127.0.0.1:6380')                 # key 455838294994277962587720662485947692006035699684
+
+# between nodes
+ring.node_for_key(1).should == '127.0.0.1:6380' # key 304942582444936629325699363757435820077590259883
+
+# larger than both nodes
+ring.node_for_key(2).should == '127.0.0.1:6379' # key 1246245281287062843477446394631337292330716631216
+
+# pin point!
+ring.add_node('127.0.0.1:6381', 304942582444936629325699363757435820077590259883 + 1)
+ring.node_for_key(1).should == '127.0.0.1:6381'
+
+
+# key is simply computed with:
+Digest::SHA1.hexdigest(key.to_s).hex
+```
+
+## Credits
+
+- [https://github.com/domnikl/consistent-hashing](https://github.com/domnikl/consistent-hashing)
+
+## Contributing
+
+1. Fork it ( https://github.com/forresty/ch/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/ch.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ch/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ch"
+  spec.version       = ConsistentHashing::VERSION
+  spec.authors       = ["Forrest Ye"]
+  spec.email         = ["afu@forresty.com"]
+  spec.summary       = %q{ yet another consistent hashing library }
+  spec.homepage      = "https://github.com/forresty/ch"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_runtime_dependency 'avl_tree', '1.1.3'
+end

data/lib/ch.rb

@@ -0,0 +1,2 @@
+require_relative "ch/version"
+require_relative "ch/ring"

data/lib/ch/avl_tree.rb

@@ -0,0 +1,50 @@
+# originally from https://github.com/domnikl/consistent-hashing
+
+require 'avl_tree'
+
+module ConsistentHashing
+  class AVLTree < ::AVLTree
+    def minimum_pair()
+      # Return the key with the smallest key value.
+      return nil if @root.empty?
+
+      current_node = @root
+      while not current_node.left.empty?
+        current_node = current_node.left
+      end
+
+      [current_node.key, current_node.value]
+    end
+
+    def next_gte_pair(key)
+      # Returns the key/value pair with a key that follows the provided key in
+      # sorted order.
+      node = next_gte_node(@root, key)
+      [node.key, node.value] if not node.empty?
+    end
+
+    protected
+
+    def next_gte_node(node, key)
+      return AVLTree::Node::EMPTY if node.empty?
+
+      if key < node.key
+        # The current key qualifies as after the provided key. However, we need
+        # to check the tree on the left to see if there's a key in there also
+        # greater than the provided key but less than the current key.
+        after = next_gte_node(node.left, key)
+        after = node if after.empty?
+      elsif key > node.key
+        # The current key will not be after the provided key, but something
+        # in the right branch maybe. Check the right branch for the first key
+        # larger than our value.
+        after = next_gte_node(node.right, key)
+      elsif node.key == key
+        # An exact match qualifies as the next largest node.
+        after = node
+      end
+
+      return after
+    end
+  end
+end

data/lib/ch/ring.rb

@@ -0,0 +1,45 @@
+require "digest/sha1"
+require_relative 'avl_tree'
+
+module ConsistentHashing
+  class Ring
+    def initialize
+      @tree = AVLTree.new
+    end
+
+    # a node can be inserted into multiple positions
+    def add_node(node, position=nil)
+      position ||= hash_for_key(node)
+
+      @tree[position] = node
+    end
+
+    def delete_node_at_position(position)
+      @tree.delete(position)
+    end
+
+    def delete_node(node)
+      @tree.each_key { |key| @tree.delete(key) if @tree[key] == node }
+    end
+
+    def node_for_key(key)
+      return nil if @tree.empty?
+      key = hash_for_key(key)
+      _, value = @tree.next_gte_pair(key)
+      _, value = @tree.minimum_pair unless value
+      value
+    end
+
+    def nodes
+      @tree.values.uniq
+    end
+
+    def positions
+      @tree.keys
+    end
+
+    def hash_for_key(key)
+      Digest::SHA1.hexdigest(key.to_s).hex
+    end
+  end
+end

data/lib/ch/version.rb

@@ -0,0 +1,3 @@
+module ConsistentHashing
+  VERSION = "0.0.1"
+end

data/spec/ch/ring_spec.rb

@@ -0,0 +1,86 @@
+require "spec_helper"
+
+module ConsistentHashing
+  describe Ring do
+    it { should respond_to :add_node }
+    it { should respond_to :nodes }
+    it { should respond_to :hash_for_key }
+    it { should respond_to :node_for_key }
+    it { should respond_to :delete_node_at_position }
+    it { should respond_to :delete_node }
+
+    describe '#add_node' do
+      it 'adds' do
+        subject.add_node('127.0.0.1:6379')
+
+        subject.nodes.should == %w{ 127.0.0.1:6379 }
+
+        subject.add_node('127.0.0.1:6379')
+        subject.add_node('127.0.0.1:6380')
+
+        subject.nodes.should == %w{ 127.0.0.1:6379 127.0.0.1:6380 }
+      end
+    end
+
+    describe '#node_for_key' do
+      it 'finds' do
+        # show hash keys
+        subject.hash_for_key('127.0.0.1:6379').should == 102336333644841978549106395032298540172546507605
+        subject.hash_for_key('127.0.0.1:6380').should == 455838294994277962587720662485947692006035699684
+
+        subject.hash_for_key(1).should                == 304942582444936629325699363757435820077590259883
+        subject.hash_for_key(2).should                == 1246245281287062843477446394631337292330716631216
+        subject.hash_for_key(3).should                == 684329801336223661356952546078269889038938702779
+        subject.hash_for_key(4).should                == 156380102318965990264666286018191900590658905210
+
+
+        # add nodes
+        subject.add_node('127.0.0.1:6379')
+        subject.add_node('127.0.0.1:6380')
+
+        # between nodes
+        subject.node_for_key(1).should == '127.0.0.1:6380'
+
+        # larger than both nodes
+        subject.node_for_key(2).should == '127.0.0.1:6379'
+
+        # pin point!
+        subject.add_node('127.0.0.1:6381', 304942582444936629325699363757435820077590259883 + 1)
+        subject.node_for_key(1).should == '127.0.0.1:6381'
+
+        # same point works as well
+        subject.add_node('127.0.0.1:6382', 1246245281287062843477446394631337292330716631216)
+        subject.node_for_key(2).should == '127.0.0.1:6382'
+
+        # same point can be inserted into multiple positions
+        subject.node_for_key(4).should == '127.0.0.1:6381'
+        subject.add_node('127.0.0.1:6379', 156380102318965990264666286018191900590658905210)
+        subject.node_for_key(4).should == '127.0.0.1:6379'
+        # remove pinned point
+        subject.delete_node_at_position(1246245281287062843477446394631337292330716631216)
+        subject.node_for_key(2).should == '127.0.0.1:6379'
+      end
+    end
+
+    describe '#delete_node' do
+      it 'deletes all positions' do
+        subject.add_node('127.0.0.1:6379', 1)
+        subject.add_node('127.0.0.1:6379', 2)
+
+        subject.positions.should == [1, 2]
+        subject.nodes.count.should == 1
+
+        subject.delete_node('127.0.0.1:6379')
+
+        subject.positions.should == []
+        subject.nodes.count.should == 0
+      end
+    end
+
+    describe '#hash_for_key' do
+      it 'generates different hash' do
+        subject.hash_for_key(1).should_not == subject.hash_for_key(2)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require "ch"

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: ch
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Forrest Ye
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: avl_tree
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.3
+description: 
+email:
+- afu@forresty.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ch.gemspec
+- lib/ch.rb
+- lib/ch/avl_tree.rb
+- lib/ch/ring.rb
+- lib/ch/version.rb
+- spec/ch/ring_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/forresty/ch
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.4
+signing_key: 
+specification_version: 4
+summary: yet another consistent hashing library
+test_files:
+- spec/ch/ring_spec.rb
+- spec/spec_helper.rb