hash_digest 1.0.0 → 1.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ODI5OGYwMmEyMTQ1ZjMyNmNiMjcyMmIyMTU3NTBmMWFmNjgzMDVmNA==
+  data.tar.gz: !binary |-
+    ZmVlMDRkN2MxOTY4MDRiMWJjNjMyOGNmMmUwMDdlMWQyYzAyM2VlZg==
+SHA512:
+  metadata.gz: !binary |-
+    MjllMmZlNjc3Zjg4M2Q2YzA5OTFlOTA4MWUzYjA0MDQ5YzA3MjRhNmU4ZWZk
+    NWM0Yjg4MTM3NzdjNTYwMjNmMTA0ODFiMmJjMTY5N2MyZWI0MDE2MDdkYjVm
+    MTcwNmY1Y2Y5MmUyYzAxNjIzOWM2MzY5ZDQ3ODY1MzZhZTgyOGE=
+  data.tar.gz: !binary |-
+    MTk0MDNkMzk5ZTMzOTNkMGY5OTJhOWMzZDhjNGFhY2ZiY2VkYTNkZTc0OTE2
+    MWJiZTFiMzdmNTgwMGE1ZjVkNGQ1YWQ4MTdlZmRhOWNiMGYxYTM0ZTgzMjUw
+    YzlkZDNhYzFjNWFkMzIxMDQzNGIzNTFhNmMzNjVmMDg5ZDYwMzg=

data/CHANGELOG

@@ -0,0 +1,12 @@
+1.1.0 / 2014-01-01
+
+* Breaking changes
+
+  * UTF-8 strings only because of EscapeUtils "limitations"
+
+* Enhancements
+
+  * a changelog!
+  * replace CGI.escape with EscapeUtils.escape_url, which is 2x faster or so
+  * add HashDigest.digest2, which uses murmurhash3 instead of md5
+  * remove runtime dependency on activesupport

data/README.markdown

@@ -1,4 +1,4 @@
-= HashHash
+# HashDigest
 
 Generates MD5 digests of Hashes (and Arrays) indifferent to key type and ordering.
 
@@ -6,19 +6,19 @@ Useful for hashing rows in a 2-dimensional table.
 
 Used by the [remote_table](https://github.com/seamusabshere/remote_table) gem.
 
-== Example
+## Example
 
-=== Indifferent to key type
+### Indifferent to key type
 
     HashDigest.hexdigest(:a => 1)  #=> '3872c9ae3f427af0be0ead09d07ae2cf'
     HashDigest.hexdigest('a' => 1) #=> '3872c9ae3f427af0be0ead09d07ae2cf'
 
-=== Indifferent to key order
+### Indifferent to key order
 
     HashDigest.hexdigest(:a => 1, 'b' => 2) == HashDigest.hexdigest('a' => 1, :b => 2) # true
     HashDigest.hexdigest(:a => 1, 'b' => 2) == HashDigest.hexdigest(:b => 2, 'a' => 1) # true
 
-== Algorithm
+## Algorithm
 
 Basically represent the hash as a URL querystring, ordered by key, and MD5 that.
 
@@ -29,12 +29,12 @@ Basically represent the hash as a URL querystring, ordered by key, and MD5 that.
 
 To digest an array, just pretend it's a hash with keys like 1, 2, 3, etc.
 
-== Potential issues
+## Potential issues
 
 * Uses MD5 (not cryptographically awesome)
 * Uses ActiveSupport's <tt>#to_query</tt> method to create a digestible string like "foo=bar&baz=bam" (slow)
 * Meant for flat hashes, e.g. { :a => 1, :b => 2 } and not { :x => { :y => :z } }
 
-== Copyright
+## Copyright
 
 Copyright 2011 Seamus Abshere

data/hash_digest.gemspec

@@ -18,11 +18,11 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  # specify any dependencies here; for example:
-  # s.add_development_dependency "rspec"
-  # s.add_runtime_dependency "rest-client"
-  s.add_runtime_dependency 'activesupport'
-  
+  s.add_runtime_dependency 'murmurhash3'
+  s.add_runtime_dependency 'escape_utils'
+
   s.add_development_dependency 'minitest'
   s.add_development_dependency 'rake'
+  s.add_development_dependency 'activesupport'
+  s.add_development_dependency 'benchmark-ips'
 end

data/lib/hash_digest/version.rb

@@ -1,3 +1,3 @@
 module HashDigest
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/lib/hash_digest.rb

@@ -1,27 +1,76 @@
 require 'digest/md5'
-require 'active_support'
-require 'active_support/version'
-%w{
-  active_support/core_ext/hash/keys
-  active_support/core_ext/object/to_query
-}.each do |active_support_3_requirement|
-  require active_support_3_requirement
-end if ::ActiveSupport::VERSION::MAJOR >= 3
+require 'murmurhash3'
+require 'escape_utils'
 
 require "hash_digest/version"
 
 module HashDigest
-  def self.hexdigest(hsh)
-    ordered_list = if hsh.is_a?(::Hash)
-      hsh = hsh.stringify_keys
-      hsh.keys.sort.map { |k| hsh[k].to_query k }
-    elsif hsh.is_a?(::Array)
+  # CURRENT
+
+  def self.as_digest2(obj)
+    obj.to_hash_digest_query
+  end
+
+  def self.digest2(obj)
+    ::MurmurHash3::V32.str_hash(as_digest2(obj)).to_s 36
+  end
+
+  # LEGACY
+
+  def self.as_digest1(obj)
+    ordered_list = case obj
+    when ::Hash
+      obj.map do |k, v|
+        obj[k].to_hash_digest_query k
+      end.sort
+    when ::Array
       ary = []
-      hsh.each_with_index { |v, i| ary.push v.to_query(i.to_s) }
+      obj.each_with_index do |v, i|
+        ary << v.to_hash_digest_query(i)
+      end
       ary
     else
-      raise ::ArgumentError, "[hash_digest gem] Can only digest Hashes and Arrays, not #{hsh.class}"
+      raise ::ArgumentError, "[hash_digest gem] Can only digest Hashes and Arrays, not #{obj.class}"
     end
-    ::Digest::MD5.hexdigest ordered_list.join('&')
+    ordered_list.join '&'
+  end
+
+  def self.hexdigest(obj)
+    ::Digest::MD5.hexdigest as_digest1(obj)
+  end
+end
+
+# EVERYTHING BELOW IS COPIED FROM ACTIVESUPPORT 4.0.2
+
+class Object
+  def to_hash_digest_param
+    to_s
+  end
+end
+
+class Array
+  def to_hash_digest_param
+    map { |e| e.to_hash_digest_param }.join '/'
+  end
+
+  def to_hash_digest_query(key)
+    prefix = "#{key}[]"
+    map { |value| value.to_hash_digest_query(prefix) }.join '&'
+  end
+end
+
+class Hash
+  def to_hash_digest_param(namespace = nil)
+    map do |key, value|
+      value.to_hash_digest_query(namespace ? "#{namespace}[#{key}]" : key)
+    end.sort.join '&'
+  end
+  alias_method :to_hash_digest_query, :to_hash_digest_param
+end
+
+class Object
+  def to_hash_digest_query(key)
+    # "#{::CGI.escape(key.to_hash_digest_param)}=#{::CGI.escape(to_hash_digest_param)}"
+    "#{::EscapeUtils.escape_url(key.to_hash_digest_param)}=#{::EscapeUtils.escape_url(to_hash_digest_param)}"
   end
 end

data/test/helper.rb

@@ -1,10 +1,31 @@
 require 'bundler/setup'
-require 'minitest/spec'
 require 'minitest/autorun'
 
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'hash_digest'
 
-class MiniTest::Unit::TestCase
+require 'benchmark/ips'
+require 'active_support/core_ext'
+
+module TestHelper
+  def as_digest1(hsh)
+    ordered_list = if hsh.is_a?(::Hash)
+      hsh = hsh.stringify_keys
+      hsh.keys.sort.map { |k| hsh[k].to_query k }
+    elsif hsh.is_a?(::Array)
+      ary = []
+      hsh.each_with_index { |v, i| ary.push v.to_query(i.to_s) }
+      ary
+    else
+      raise ::ArgumentError, "[hash_digest gem] Can only digest Hashes and Arrays, not #{hsh.class}"
+    end
+    ordered_list.join('&')
+  end
+
+  def assert_same_as_old(a)
+    expected = as_digest1(a)
+    got = HashDigest.as_digest1(a)
+    got.must_equal expected
+  end
 end

data/test/test_hash_digest.rb

@@ -1,24 +1,82 @@
 # -*- encoding: utf-8 -*-
 require 'helper'
+require 'stringio'
 
 describe HashDigest do
-  it 'generates a hash of a hash' do
-    HashDigest.hexdigest(:a => 1).must_equal '3872c9ae3f427af0be0ead09d07ae2cf'
-  end
-  
-  it 'is indifferent to key type' do
-    HashDigest.hexdigest(:a => 1, 'b' => 2).must_equal(HashDigest.hexdigest('a' => 1, :b => 2))
+  include TestHelper
+
+  describe '.digest2' do
+    it "is much faster than .hexdigest" do
+      hsh = { 'a' => 1, :b => { foo: :bar, zoo: 'animal' }, ";b\n`&" => { foo: :bar, zoo: "==&ani!!.;&mal\n" } }
+      begin
+        old_stdout = $stdout
+        $stdout = StringIO.new
+        Benchmark.ips do |x|
+          x.report("HashDigest.hexdigest")  { HashDigest.hexdigest(hsh) }
+          x.report("HashDigest.digest2")    { HashDigest.digest2(hsh)   }
+        end
+        $stdout.rewind
+        result = $stdout.read
+      ensure
+        $stdout = old_stdout
+      end
+      result.must_equal ''
+    end
   end
-  
-  it 'is indifferent to key order' do
-    HashDigest.hexdigest(:a => 1, 'b' => 2).must_equal(HashDigest.hexdigest(:b => 2, 'a' => 1))
+
+  describe 'backwards compatibility' do
+    it 'for hashes' do
+      HashDigest.hexdigest(:a => 1).must_equal '3872c9ae3f427af0be0ead09d07ae2cf'
+    end
+    
+    it 'for arrays' do
+      HashDigest.hexdigest([:a, 1]).must_equal '8ce19b95077ec34a4fd06b089f368678'
+    end
+
+    [
+      { :a => 1 },
+      { 'b' => 99.9 },
+      { 'b`&' => 99.9 },
+      { ';b`&' => '99.9!!.;&' },
+      { ";b\n`&" => "99.9!\n!.;&" },
+      { :b => { foo: :bar, zoo: 'animal' } },
+      { :b => { foo: :bar, zoo: '==&ani!!.;&mal' } },
+      { :b => { foo: :bar, zoo: "==&ani!!.;&mal\n" } },
+      { :a => 1, 'b' => 2 },
+      { 'a' => 1, :b => 2 },
+      { 'a' => 1, :b => [1, 2] },
+      { 'a' => 1, :b => { foo: :bar, zoo: 'animal' } },
+    ].each do |hsh|
+      it "treats #{hsh} same as old" do
+        assert_same_as_old hsh
+      end
+    end
+
   end
-  
-  it 'just as a bonus, works on arrays' do
-    HashDigest.hexdigest([:a, 1]).must_equal '8ce19b95077ec34a4fd06b089f368678'
+
+  describe 'indifference to' do
+    it 'key type' do
+      HashDigest.as_digest2(:a => 1, 'b' => 2).must_equal(HashDigest.as_digest2('a' => 1, :b => 2))
+    end
+    
+    it 'key order' do
+      HashDigest.as_digest2(:a => 1, 'b' => 2).must_equal(HashDigest.as_digest2(:b => 2, 'a' => 1))
+    end
+
+    [
+      [{:a => 1, 'b' => 2},             {'a' => 1, :b => 2}],
+      [{:a => 1, 'b' => [1, 2]},        {'a' => 1, :b => ['1', 2]}],
+      [{:a => 1, 'b' => { foo: :bar }}, {'a' => 1, :b => { 'foo' => 'bar' }}],
+    ].each do |a, b|
+      it "trivial difference between #{a} and #{b}" do
+        assert_same_as_old a
+        assert_same_as_old b
+        HashDigest.as_digest2(b).must_equal(HashDigest.as_digest2(b))
+      end
+    end
   end
   
-  it "raises an exception if you try to digest something it doesn't handle" do
+  it "raises an exception if you try to digest anything other than a Hash or Array" do
     lambda { HashDigest.hexdigest('foobar') }.must_raise(::ArgumentError)
   end
 end

metadata

@@ -1,49 +1,99 @@
 --- !ruby/object:Gem::Specification
 name: hash_digest
 version: !ruby/object:Gem::Version
-  version: 1.0.0
-  prerelease: 
+  version: 1.1.0
 platform: ruby
 authors:
 - Seamus Abshere
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-23 00:00:00.000000000Z
+date: 2014-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: &2154254960 !ruby/object:Gem::Requirement
-    none: false
+  name: murmurhash3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: escape_utils
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2154254960
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &2154254540 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2154254540
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2154254120 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2154254120
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: benchmark-ips
+  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: Make consistent hashcodes from flat Hashes, regardless of key ordering.
   Useful for hashing rows in a table.
 email:
@@ -53,6 +103,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CHANGELOG
 - Gemfile
 - README.markdown
 - Rakefile
@@ -63,28 +114,28 @@ files:
 - test/test_hash_digest.rb
 homepage: https://github.com/seamusabshere/hash_digest
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: hash_digest
-rubygems_version: 1.8.6
+rubygems_version: 2.1.11
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Make consistent hashcodes from flat Hashes, regardless of key ordering
 test_files:
 - test/helper.rb
 - test/test_hash_digest.rb
+has_rdoc: