hash_digest 1.0.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

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

data/README.markdown

@@ -0,0 +1,40 @@
+= HashHash
+
+Generates MD5 digests of Hashes (and Arrays) indifferent to key type and ordering.
+
+Useful for hashing rows in a 2-dimensional table.
+
+Used by the [remote_table](https://github.com/seamusabshere/remote_table) gem.
+
+== Example
+
+=== Indifferent to key type
+
+    HashDigest.hexdigest(:a => 1)  #=> '3872c9ae3f427af0be0ead09d07ae2cf'
+    HashDigest.hexdigest('a' => 1) #=> '3872c9ae3f427af0be0ead09d07ae2cf'
+
+=== 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
+
+Basically represent the hash as a URL querystring, ordered by key, and MD5 that.
+
+1. Stringify keys
+2. Create an array of strings like "url_encode(key)=url_encode(value)" by going through each key in alphabetical order
+3. Join the array together with "&"
+4. MD5 hexdigest the joined string
+
+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

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+
+require 'rake'
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test

data/hash_digest.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "hash_digest/version"
+
+Gem::Specification.new do |s|
+  s.name        = "hash_digest"
+  s.version     = HashDigest::VERSION
+  s.authors     = ["Seamus Abshere"]
+  s.email       = ["seamus@abshere.net"]
+  s.homepage    = "https://github.com/seamusabshere/hash_digest"
+  s.summary     = %q{Make consistent hashcodes from flat Hashes, regardless of key ordering}
+  s.description = %q{Make consistent hashcodes from flat Hashes, regardless of key ordering. Useful for hashing rows in a table.}
+
+  s.rubyforge_project = "hash_digest"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  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_development_dependency 'minitest'
+  s.add_development_dependency 'rake'
+end

data/lib/hash_digest.rb

@@ -0,0 +1,27 @@
+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 "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)
+      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
+    ::Digest::MD5.hexdigest ordered_list.join('&')
+  end
+end

data/lib/hash_digest/version.rb

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

data/test/helper.rb

@@ -0,0 +1,10 @@
+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
+end

data/test/test_hash_digest.rb

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require 'helper'
+
+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))
+  end
+  
+  it 'is indifferent to key order' do
+    HashDigest.hexdigest(:a => 1, 'b' => 2).must_equal(HashDigest.hexdigest(:b => 2, 'a' => 1))
+  end
+  
+  it 'just as a bonus, works on arrays' do
+    HashDigest.hexdigest([:a, 1]).must_equal '8ce19b95077ec34a4fd06b089f368678'
+  end
+  
+  it "raises an exception if you try to digest something it doesn't handle" do
+    lambda { HashDigest.hexdigest('foobar') }.must_raise(::ArgumentError)
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: hash_digest
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Seamus Abshere
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-23 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &2154254960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2154254960
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &2154254540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2154254540
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2154254120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2154254120
+description: Make consistent hashcodes from flat Hashes, regardless of key ordering.
+  Useful for hashing rows in a table.
+email:
+- seamus@abshere.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.markdown
+- Rakefile
+- hash_digest.gemspec
+- lib/hash_digest.rb
+- lib/hash_digest/version.rb
+- test/helper.rb
+- test/test_hash_digest.rb
+homepage: https://github.com/seamusabshere/hash_digest
+licenses: []
+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
+signing_key: 
+specification_version: 3
+summary: Make consistent hashcodes from flat Hashes, regardless of key ordering
+test_files:
+- test/helper.rb
+- test/test_hash_digest.rb