consistent_hash 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2bf968f60c0e1ad50c87dd3e34f83a5eba9bc49f
+  data.tar.gz: 7d48b9f7701ed9e5d9b16445f673dff011bedd7d
+SHA512:
+  metadata.gz: 2d84da0164eb8e40282923c72d6a1780247a2200961d1c8402026f0084ad37129f73649779520c55175fec845fd9eeeea4ae6dc9c6578eb9a23fbb6c1b07ed30
+  data.tar.gz: 0b3bd29a6b69dcd407c84898feccbea2b1d41cd5fc5be1ca9c9a7012cffb32e4be6ab235df26c9f80876ee86fee087dde6bd30b27526e3a078a87a240cb3fef9

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ulysse Carion
+
+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,98 @@
+# ConsistentHash
+
+A simple Ruby library that gives `String` the method `#consistent_hash`, which
+will return consistent values, even between different instances of MRI.
+
+This entire gem is basically just a dozen lines of C. The code is written as a C
+extension so that it can perform as well as `String#hash`. (See the section on
+performance.)
+
+`String#consistent_hash` and Java's `String#hashCode` methods do exactly the
+same thing, and return the same results. This library is not re-inventing the
+string hash function, it's just implementing an alternative to Ruby's built-in
+`#hash`.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'consistent_hash'
+```
+
+And then execute:
+
+```sh
+$ bundle
+```
+
+Or install it yourself as:
+
+```sh
+$ gem install consistent_hash
+```
+
+## Motivation
+
+Every time you restart Ruby, the values returned from `String#hash` are changed:
+
+```sh
+$ irb
+2.0.0p353 :001 > "hello".hash
+ => 482951767139383391
+2.0.0p353 :002 > exit
+
+$ irb
+2.0.0p353 :001 > "hello".hash
+ => 3216751850140847920
+2.0.0p353 :002 > exit
+```
+
+This means you cannot rely on the value of `String#hash` to precalculate some
+data about a string and store the value of `#hash` in a database, because if you
+restart your Ruby program, the values of `String#hash` will be completely
+changed.
+
+But with `#consistent_hash`, this is no longer the case:
+
+```sh
+$ irb
+2.0.0-p353 :001 > require 'consistent_hash'
+ => true
+2.0.0-p353 :002 > "hello".consistent_hash
+ => 99162322
+ 2.0.0-p353 :003 > exit
+
+$ irb
+2.0.0-p353 :001 > require 'consistent_hash'
+ => true
+2.0.0-p353 :002 > "hello".consistent_hash
+ => 99162322
+ 2.0.0-p353 :003 > exit
+```
+
+## Performance
+
+If you're concerned about how fast your hash function is, `#consistent_hash`
+will work for you. Because this library is written in C, it's almost as fast as
+the built-in hash function, and it's a few orders of magnitude faster than any
+Ruby code:
+
+```
+                 user     system      total        real
+naive:      35.620000   0.220000  35.840000 ( 35.841524) # this is written in Ruby
+ruby:       30.460000   0.180000  30.640000 ( 30.644228) # this is written in Ruby
+c:           0.010000   0.000000   0.010000 (  0.005697) # this is #consistent_hash
+std hash:    0.000000   0.000000   0.000000 (  0.003163) # this is String#hash
+```
+
+(See [benchmark.rb](benchmark.rb))
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rake/extensiontask'
+
+RSpec::Core::RakeTask.new(:spec)
+
+Rake::ExtensionTask.new('consistent_hash')
+
+task default: %i(compile spec)

data/benchmark.rb

@@ -0,0 +1,31 @@
+require 'benchmark'
+
+def random_string
+  length = rand(10000).to_i
+  length.times.map { (('a'..'z').to_a + ('A'..'Z').to_a).sample }.join
+end
+
+strings = 1000.times.map { random_string }
+
+def naive_hash(s)
+  s.chars.reduce(0) { |acc, char| acc * 31 + char.ord }
+end
+
+def ruby_hash(s)
+  h = 0
+  i = 0
+  while i < s.bytesize
+    h = h * 31 + s.getbyte(i)
+    i += 1
+  end
+  h
+end
+
+require 'consistent_hash'
+
+Benchmark.bm(10) do |x|
+  x.report("naive:")    { strings.each { |s| naive_hash(s) } }
+  x.report("ruby:")     { strings.each { |s| ruby_hash(s) } }
+  x.report("c:")        { strings.each { |s| s.consistent_hash } }
+  x.report("std hash:") { strings.each { |s| s.hash } }
+end

data/consistent_hash.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'consistent_hash/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "consistent_hash"
+  spec.version       = ConsistentHash::VERSION
+  spec.authors       = ["Ulysse Carion"]
+  spec.email         = ["ulyssecarion@gmail.com"]
+  spec.description   = %q{A string hash function that returns the same value each time it's called.}
+  spec.summary       = %q{A consistent hash function for strings.}
+  spec.homepage      = "https://github.com/ucarion/consistent_hash"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.14"
+  spec.add_development_dependency "rake-compiler"
+end

data/ext/consistent_hash/consistent_hash.c

@@ -0,0 +1,16 @@
+#include "ruby.h"
+
+VALUE consistent_hash(VALUE string) {
+  uint32_t h = 0;
+
+  for (int i = 0; i < RSTRING_LEN(string); i++) {
+    uint32_t c = RSTRING_PTR(string)[i];
+    h = h * 31 + c;
+  }
+
+  return INT2NUM(h);
+}
+
+void Init_consistent_hash() {
+  rb_define_method(rb_cString, "consistent_hash", consistent_hash, 0);
+}

data/ext/consistent_hash/extconf.rb

@@ -0,0 +1,3 @@
+require 'mkmf'
+
+create_makefile('consistent_hash')

data/lib/consistent_hash.rb

@@ -0,0 +1,6 @@
+require "consistent_hash/version"
+require 'consistent_hash.so'
+
+module ConsistentHash
+  # Your code goes here...
+end

data/lib/consistent_hash/version.rb

@@ -0,0 +1,3 @@
+module ConsistentHash
+  VERSION = "0.0.2"
+end

data/spec/consistent_hash_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe String do
+  it 'creates a String#consistent_hash method' do
+    expect("").to respond_to(:consistent_hash)
+  end
+
+  it 'works just like Java String#hashCode' do
+    examples = {
+      "" => 0,
+      "hello world" => 1794106052,
+      "this is a test" => -1879005787,
+      "a" * 200 => 469437568
+    }
+
+    examples.each { |k, v| expect(k.consistent_hash).to eq v }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'consistent_hash'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: consistent_hash
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Ulysse Carion
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A string hash function that returns the same value each time it's called.
+email:
+- ulyssecarion@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- benchmark.rb
+- consistent_hash.gemspec
+- ext/consistent_hash/consistent_hash.c
+- ext/consistent_hash/extconf.rb
+- lib/consistent_hash.rb
+- lib/consistent_hash/version.rb
+- spec/consistent_hash_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ucarion/consistent_hash
+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.1.11
+signing_key: 
+specification_version: 4
+summary: A consistent hash function for strings.
+test_files:
+- spec/consistent_hash_spec.rb
+- spec/spec_helper.rb