rlrw 0.0.1

data/.gitignore

@@ -0,0 +1,34 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rlrw.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,21 @@
+PATH
+  remote: .
+  specs:
+    rlrw (0.0.1)
+      murmurhash3 (= 0.1.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.4.3)
+    murmurhash3 (0.1.4)
+    rake (10.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.7)
+  minitest (= 5.4.3)
+  rake (~> 10.0)
+  rlrw!

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Omar Yasin
+
+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,46 @@
+# Rendezvous or Lowest Random Weight (LRW) hashing
+
+This is a Ruby implementation of LRW. It is a port of Ferd's
+[LRW](https://github.com/ferd/lrw). Even if it is a port, it cannot be used with
+the original implementation as it uses another hash function.
+
+This hashing mechanism allows you to consistently hash to a specific node
+without needing to do bucketing first a'la Consistent Hashing. It also
+guarantees as little key redistribution as possible.
+
+## Interface
+
+The `all/2` function gives an ordering of all nodes:
+
+```
+<= Rlrw::LRW.all("my_item", ["127.0.0.1", "255.0.0.1", "192.2.1.2", "192.198.2.1"])
+=> ["255.0.0.1", "192.2.1.2", "127.0.0.1", "192.198.2.1"]
+<= Rlrw::LRW.all("my_item", ["127.0.0.1","198.2.1.2","192.198.2.1","10.10.100.10"])
+=> ["198.2.1.2", "10.10.100.10", "127.0.0.1", "192.198.2.1"]
+<= Rlrw::LRW.all("my_item", ["127.0.0.1","192.198.2.1"])
+=> ["127.0.0.1", "192.198.2.1"]
+<= Rlrw::LRW.all("my_item", ["127.0.0.1","192.18.211.12","23.66.77.88","252.11.11.11"])
+=> ["192.18.211.12", "23.66.77.88", "127.0.0.1", "252.11.11.11"]
+<= Rlrw::LRW.all("my_other_item", ["127.0.0.1","192.18.211.12","23.66.77.88","252.11.11.11"])
+=> ["252.11.11.11", "23.66.77.88", "192.18.211.12", "127.0.0.1"]
+<= Rlrw::LRW.all("my_other_item", ["127.0.0.1","192.18.211.12","23.66.77.88","252.11.11.11"])
+=> ["252.11.11.11", "23.66.77.88", "192.18.211.12", "127.0.0.1"]
+```
+
+The `top/3` function returns a subset. It is using `all/2` in its implementation
+
+```
+<= Rlrw::LRW.top("12123", ["127.0.0.1","255.0.0.1","198.2.1.2","192.198.2.1"], 2)
+=> ["127.0.0.1", "198.2.1.2"]
+```
+
+Custom hashing functions can be passed by calling `all/3` and `top/3`, where the
+argument of each function must be a lambda that accepts two arguments, `key`, and
+`node` and returns a number.
+
+## Test
+
+```
+$ bundle install
+$ bundle exec rake
+```

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+task :default => :test
+
+task :test do
+  Rake::TestTask.new do |t|
+    t.pattern = "test/*.rb"
+  end
+end

data/lib/rlrw.rb

@@ -0,0 +1,34 @@
+require "rlrw/version"
+require "murmurhash3"
+
+module Rlrw
+  module LRW
+    MOD = 2147483648
+
+    PHASH = lambda { |key, node| MurmurHash3::V32.str_hash("#{node}#{key}", MOD) }
+
+    def self.all(key, nodes, phash=PHASH)
+      self.all_weights(key, nodes, phash).map do | node |
+        node[:node]
+      end
+    end
+
+    def self.top(key, nodes, len, phash=PHASH)
+      self.top_weights(key, nodes, len, phash).map do | node |
+        node[:node]
+      end
+    end
+
+    def self.all_weights(key, nodes, phash=PHASH)
+      res = nodes.map do |node|
+        { node: node, weight: phash.call(key, node) }
+      end
+      res.sort_by { |res| res[:weight] }
+    end
+
+    def self.top_weights(key, nodes, len, phash=PHASH)
+      self.all_weights(key, nodes, phash).take(len)
+    end
+
+  end
+end

data/lib/rlrw/version.rb

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

data/rlrw.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rlrw/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rlrw"
+  spec.version       = Rlrw::VERSION
+  spec.authors       = ["omarkj"]
+  spec.email         = ["omarkj@gmail.com"]
+  spec.summary       = "Lowest Random Weight hashing"
+  spec.description   = %q{This hashing mechanism allows you to consistently hash to a specific node without needing to do bucketing first a'la Consistent Hashing. It also guarantees as little key redistribution as possible.}
+  spec.homepage      = ""
+  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_runtime_dependency "murmurhash3", "= 0.1.4"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "= 5.4.3"
+end

data/test/rlrw.rb

@@ -0,0 +1,50 @@
+require 'minitest/autorun'
+require 'digest/sha1'
+require 'rlrw'
+
+describe Rlrw::LRW, "LRW" do
+
+  it "calculates all" do
+    Rlrw::LRW.all("my_item", ["b","c","d"]).must_equal(["d", "b", "c"])
+  end
+
+  it "calculates top" do
+    Rlrw::LRW.top("my_item", ["b","c","d"], 2).must_equal(["d", "b"])
+  end
+
+  it "calculates all and returns weights" do
+    Rlrw::LRW.all_weights("my_item", ["b","c","d"]).must_equal([{:node=>"d", :weight=>815949913},
+                                                                {:node=>"b", :weight=>3970763645},
+                                                                {:node=>"c", :weight=>4112589638}])
+  end
+
+  it "calculates top and returns weights" do
+    Rlrw::LRW.top_weights("my_item", ["b","c","d"], 2).must_equal([{:node=>"d", :weight=>815949913},
+                                                                   {:node=>"b", :weight=>3970763645}])
+  end
+
+  it "calculates all with another hash function" do
+    f = lambda { |key, node| Digest::SHA1.hexdigest("#{node}#{key}").to_i(16) }
+    Rlrw::LRW.all("my_item", ["b","c","d"], f).must_equal(["b", "c", "d"])
+  end
+
+  it "calculates top with another hash function" do
+    require 'digest/sha1'
+    f = lambda { |key, node| Digest::SHA1.hexdigest("#{node}#{key}").to_i(16) }
+    Rlrw::LRW.top("my_item", ["b","c","d"], 2, f).must_equal(["b", "c"])
+  end
+
+  it "calculates all and returns weights with another hash function" do
+    f = lambda { |key, node| Digest::SHA1.hexdigest("#{node}#{key}").to_i(16) }
+    Rlrw::LRW.all_weights("my_item", ["b","c","d"], f).must_equal([{:node=>"b", :weight=>12535624296688143233642322168769247078306177530},
+                                                                   {:node=>"c", :weight=>437434023516257654645300587808082606734576988647},
+                                                                   {:node=>"d", :weight=>1257752084205904020026775133107610541280950115641}])
+  end
+
+  it "calculates top and returns weights with another hash function" do
+    f = lambda { |key, node| Digest::SHA1.hexdigest("#{node}#{key}").to_i(16) }
+    Rlrw::LRW.top_weights("my_item", ["b","c","d"], 2, f).must_equal([{:node=>"b", :weight=>12535624296688143233642322168769247078306177530},
+                                                                      {:node=>"c", :weight=>437434023516257654645300587808082606734576988647}])
+  end
+
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: rlrw
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- omarkj
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: murmurhash3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.4.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.4.3
+description: This hashing mechanism allows you to consistently hash to a specific
+  node without needing to do bucketing first a'la Consistent Hashing. It also guarantees
+  as little key redistribution as possible.
+email:
+- omarkj@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/rlrw.rb
+- lib/rlrw/version.rb
+- rlrw.gemspec
+- test/rlrw.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4168146116181610619
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4168146116181610619
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23.2
+signing_key: 
+specification_version: 3
+summary: Lowest Random Weight hashing
+test_files:
+- test/rlrw.rb