hash_digest 1.1.0 → 1.1.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ODI5OGYwMmEyMTQ1ZjMyNmNiMjcyMmIyMTU3NTBmMWFmNjgzMDVmNA==
+    NTY4NDk1MDA3Yjc5ODZhNzI3ZmRkNjEzN2U4YjAxNzg4ZTFlNGEzMA==
   data.tar.gz: !binary |-
-    ZmVlMDRkN2MxOTY4MDRiMWJjNjMyOGNmMmUwMDdlMWQyYzAyM2VlZg==
+    OGViMWNlNTE5NjA5M2VjMzg1YjBhM2IxNmY2N2U2ZjY1NTRhYmViZQ==
 SHA512:
   metadata.gz: !binary |-
-    MjllMmZlNjc3Zjg4M2Q2YzA5OTFlOTA4MWUzYjA0MDQ5YzA3MjRhNmU4ZWZk
-    NWM0Yjg4MTM3NzdjNTYwMjNmMTA0ODFiMmJjMTY5N2MyZWI0MDE2MDdkYjVm
-    MTcwNmY1Y2Y5MmUyYzAxNjIzOWM2MzY5ZDQ3ODY1MzZhZTgyOGE=
+    MDk2YzFjZjg3MmYwM2U0OTdkMjc5YjA3MjRiZTZiZDI0ZTYwZDYxNzVkZDdm
+    ZDgyOTA1YTk3ZjM5MzMzMDQ2YTU2ZTk4YmU3MTJiZjY0YzNlNGVlZjVhMDY3
+    ZTc5NWY4NTJlMGM2MGU5ZDY2NGVmYzMzM2I2OTk0OWZlMDg0OTE=
   data.tar.gz: !binary |-
-    MTk0MDNkMzk5ZTMzOTNkMGY5OTJhOWMzZDhjNGFhY2ZiY2VkYTNkZTc0OTE2
-    MWJiZTFiMzdmNTgwMGE1ZjVkNGQ1YWQ4MTdlZmRhOWNiMGYxYTM0ZTgzMjUw
-    YzlkZDNhYzFjNWFkMzIxMDQzNGIzNTFhNmMzNjVmMDg5ZDYwMzg=
+    Y2NhYzQ4M2VmZWI0Yzg5NDg5ZDJhNTNkZGRjNTgwMmQ5NzliYzE5YmNiY2Uz
+    ZGQ3M2U3NWU5MGNlNDZlZmM2ODMyOWVjOTUxOWQwOTE2MjExMGViZmNjNTAw
+    YmY4Y2Q0M2JiNmEwMTQ1OTNiYTExOGI0YWM1ZmUwYmQ4OWQwYzM=

data/.gitignore

@@ -2,3 +2,5 @@
 .bundle
 Gemfile.lock
 pkg/*
+doc/
+.yardoc/

data/CHANGELOG

@@ -1,3 +1,10 @@
+1.1.1 / 2014-01-02
+
+* Bug fixes
+
+  * Fix compatibility with JRuby - thanks @towerhe https://github.com/seamusabshere/remote_table/issues/13
+  * Corrected README to latest and greatest
+
 1.1.0 / 2014-01-01
 
 * Breaking changes

data/README.markdown

@@ -1,25 +1,62 @@
 # HashDigest
 
-Generates MD5 digests of Hashes (and Arrays) indifferent to key type and ordering.
+Generates non-cryptographic digests of Hashes (and Arrays) indifferent to key type (string or symbol) and ordering.
 
-Useful for hashing rows in a 2-dimensional table.
+Extracted from [`RemoteTable`](https://github.com/seamusabshere/remote_table).
 
-Used by the [remote_table](https://github.com/seamusabshere/remote_table) gem.
+## Note plz
+
+1. You should use `HashDigest.digest2` for new applications. `hexdigest` is legacy.
+2. `digest2`, unlike its predecessor, is CASE SENSITIVE.
 
 ## Example
 
 ### Indifferent to key type
 
-    HashDigest.hexdigest(:a => 1)  #=> '3872c9ae3f427af0be0ead09d07ae2cf'
-    HashDigest.hexdigest('a' => 1) #=> '3872c9ae3f427af0be0ead09d07ae2cf'
+    >> HashDigest.digest2(:a => 1)
+    => "1s05qdo"
+    >> HashDigest.digest2('a' => 1)
+    => "1s05qdo"
 
 ### 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
+    >> HashDigest.digest2(:a => 1, 'b' => 2)
+    => "fkqncr"
+    >> HashDigest.digest2(:b => 2, 'a' => 1)
+    => "fkqncr"
+
+## Speed
+
+If you're **not** on JRuby, having [`EscapeUtils`](https://github.com/brianmario/escape_utils) in your `Gemfile` will make things much faster.
+
+### With EscapeUtils (MRI, doesn't work on JRuby)
+
+      HashDigest.digest2      2492 i/100ms
+    HashDigest.hexdigest      2276 i/100ms
+    
+### With stdlib's CGI (JRuby)
+
+      HashDigest.digest2       645 i/100ms
+    HashDigest.hexdigest       213 i/100ms
+
+### With stdlib's CGI (MRI)
+
+      HashDigest.digest2       531 i/100ms
+    HashDigest.hexdigest       513 i/100ms
 
 ## Algorithm
 
+### digest2 (current)
+
+1. Represent the hash as a URL querystring
+2. Sort by key
+3. [MurmurHash3](http://en.wikipedia.org/wiki/MurmurHash)
+4. Convert to base 36 to save space
+
+Note: non-cryptographic and variable length. CASE SENSITIVE.
+
+### hexdigest (deprecated)
+
 Basically represent the hash as a URL querystring, ordered by key, and MD5 that.
 
 1. Stringify keys
@@ -31,10 +68,8 @@ To digest an array, just pretend it's a hash with keys like 1, 2, 3, etc.
 
 ## 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 2011 Seamus Abshere
+Copyright 2013 Seamus Abshere

data/Rakefile

@@ -8,4 +8,9 @@ Rake::TestTask.new(:test) do |test|
   test.verbose = true
 end
 
+require 'yard'
+YARD::Rake::YardocTask.new do |y|
+  y.options << '--no-private'
+end
+
 task :default => :test

data/hash_digest.gemspec

@@ -19,10 +19,14 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   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'
+  s.add_development_dependency 'yard'
+
+  if ENV['TEST_ESCAPE_UTILS'] == 'true'
+    s.add_development_dependency 'escape_utils'
+  end
 end

data/lib/hash_digest.rb

@@ -1,6 +1,6 @@
 require 'digest/md5'
 require 'murmurhash3'
-require 'escape_utils'
+# see below for requiring either cgi (on JRuby) or escape_utils (if available)
 
 require "hash_digest/version"
 
@@ -38,6 +38,22 @@ module HashDigest
   def self.hexdigest(obj)
     ::Digest::MD5.hexdigest as_digest1(obj)
   end
+
+  # CGI escaping engine
+
+  if RUBY_PLATFORM == 'java'
+    require 'cgi'
+    def self.escape_url(str);     ::CGI.escape(str) end
+  else
+    begin
+      # MUCH faster than stdlib's cgi
+      require 'escape_utils'
+      def self.escape_url(str);   ::EscapeUtils.escape_url(str) end
+    rescue LoadError
+      require 'cgi'
+      def self.escape_url(str);   ::CGI.escape(str) end
+    end
+  end
 end
 
 # EVERYTHING BELOW IS COPIED FROM ACTIVESUPPORT 4.0.2
@@ -70,7 +86,6 @@ 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)}"
+    "#{::HashDigest.escape_url(key.to_hash_digest_param)}=#{::HashDigest.escape_url(to_hash_digest_param)}"
   end
 end

data/lib/hash_digest/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hash_digest
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Seamus Abshere
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-01 00:00:00.000000000 Z
+date: 2014-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: murmurhash3
@@ -25,13 +25,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: escape_utils
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: benchmark-ips
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: benchmark-ips
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='