digester 1.0.0

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Simeon Simeonov
+
+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,48 @@
+# Digester
+
+Use `Digester` anytime you want to use a complex data structure as a primary key
+in a database or a lookup key in a `Hash` or a key-value store.
+
+`Digester` creates an [MD5 digest](http://en.wikipedia.org/wiki/MD5) for Ruby
+data structures in a consistent algorithmic manner such that two identical
+data structures generate the same digests regardless of how they were
+created. 
+
+This way it is also possible to compare data structures and digests
+across different programming languages. At [Swoop](http://swoop.com),
+we use consistent data structure digests to implement variations of 
+[content addressable storage](http://en.wikipedia.org/wiki/Content-addressable_storage) 
+across S3, Redis and MongoDB with Ruby, Python and Java clients.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'digester'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install digester
+
+## Usage
+
+```ruby
+require 'digester'
+data = {x: {y: { z: [1, 2, 3]}}}
+Digester::Digester.new.digest(data)
+ => "d5221448a0765677cbce09eebd557c61"
+Digester::Digester.digest(data, {upcase: true})
+ => "D5221448A0765677CBCE09EEBD557C61"
+```
+
+## 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 @@
+require "bundler/gem_tasks"

data/digester.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'digester/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "digester"
+  spec.version       = Digester::VERSION
+  spec.authors       = ["Simeon Simeonov"]
+  spec.email         = ["sim@swoop_dot_com"]
+  spec.summary       = %q{Digester builds consistent MD5 signatures for arbitrary Ruby data structures.}
+  spec.homepage      = "https://github.com/swoop-inc/digester"
+  spec.license       = "MIT"
+
+  spec.rubyforge_project = "digester"
+
+  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_dependency "activesupport"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.13"
+end

data/lib/digester.rb

@@ -0,0 +1,6 @@
+require "digester/version"
+require "digester/digester"
+
+module Digester
+
+end

data/lib/digester/digester.rb

@@ -0,0 +1,85 @@
+require 'active_support/core_ext'
+require 'digest/md5'
+
+module Digester
+  class Digester
+
+    DEFAULT_NAMESPACE = ''
+    DEFAULT_SEPARATOR = '::'
+
+    attr_accessor :options
+
+    # Creates a digester using a set of options.
+    #
+    # @option opts [String] :namespace ('') The namespace for the digests
+    # @option opts [String] :separator ('::') Internal separator between data structure elements
+    # @option opts [String] :sort (false) Should data structure
+    #   elements be sorted before a digest is computed. Note that this could make two
+    #   different data structures produce the same digest but it is useful in some cases.
+    # @option opts [String] :uniquify (false) Should data structure
+    #   elements be uniquified before a digest is computed. Note that this could make two
+    #   different data structures produce the same digest but it is useful in some cases.
+    # @option opts [String] :upcase (false) Should the MD5 digest be upcased?
+    def initialize(opts = {})
+      @options = self.class.options_from opts
+    end
+
+    # Creates an MD5 digest of its arguments.
+    # The data structures cannot have any circular references.
+    #
+    # @return [String] MD5 digest
+    def digest(*args)
+      self.class.digest(args, options)
+    end
+
+    # Creates an MD5 digest for a tree data structure.
+    # The data structure cannot have any circular references.
+    #
+    # @param args [Object] the data to digest
+    # @option opts [String] :namespace ('') The namespace for the digests.
+    #   This allows different digests for the same data structures used in different contexts.
+    # @option opts [String] :separator ('::') Internal separator between data structure elements.
+    #   This is an aid in ensuring different data structures generate different digests.
+    # @option opts [String] :sort (false) Should data structure
+    #   elements be sorted before a digest is computed. Note that this could make two
+    #   different data structures produce the same digest but it is useful in some cases.
+    # @option opts [String] :uniquify (false) Should data structure
+    #   elements be uniquified before a digest is computed. Note that this could make two
+    #   different data structures produce the same digest but it is useful in some cases.
+    # @option opts [String] :upcase (false) Should the MD5 digest be upcased?
+    # @return [String] MD5 digest
+    def self.digest(args, opts = {})
+      opts = options_from opts
+      args = Array.wrap(args).flatten.map(&:to_s)
+      args.uniq! if opts[:uniquify]
+      args.sort! if opts[:sort]
+      content = args.join(opts[:separator])
+      digest = ::Digest::MD5.hexdigest(content)
+      digest.upcase! if opts[:upcase]
+      if opts[:namespace].blank?
+        digest
+      else
+        namespace = opts[:namespace]
+        namespace.upcase! if opts[:upcase]
+        "#{namespace}:#{digest}"
+      end
+    end
+
+    protected
+
+    def self.options_from(opts)
+      opts.reverse_merge default_opts
+    end
+
+    def self.default_opts
+      {
+          namespace: DEFAULT_NAMESPACE,
+          separator: DEFAULT_SEPARATOR,
+          sort: false,
+          uniquify: false,
+          upcase: false
+      }
+    end
+
+  end
+end

data/lib/digester/version.rb

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

data/spec/lib/digester_spec.rb

@@ -0,0 +1,59 @@
+require 'digester/digester'
+
+describe Digester::Digester do
+  klass = Digester::Digester
+
+  [
+      {},
+      {
+          namespace: 'md5',
+      },
+      {
+          namespace: 'CPO',
+          separator: '.',
+          sort: true,
+          uniquify: true,
+          upcase: false
+      },
+  ].each_with_index do |options, i|
+
+    context "run No.#{i+1} with options #{options}" do
+
+      [
+          [
+              %w(first second third),
+              'first::second::third',
+              [true, true, false]
+          ],
+          [
+              [1, 2, "2", {}, {x: 5}, [1, 2, 3]],
+              '1.2.3.{:x=>5}.{}',
+              [false, false, true]
+          ]
+      ].each do |(input, processed, equals)|
+        context "with input #{input}" do
+          before(:each) do
+            digest = ::Digest::MD5.hexdigest(processed)
+            if options[:namespace]
+              @output_guess = "#{options[:namespace]}:#{digest}"
+            else
+              @output_guess = digest
+            end
+            @output_guess.upcase! if options[:upcase]
+          end
+
+          subject { klass.digest(input, options) }
+
+          it { should be_a String }
+
+          describe "should #{equals[i] ? "" : "not "}match the guessed digest for #{processed}" do
+            specify { equals[i] ?
+                subject.should == @output_guess :
+                subject.should_not == @output_guess }
+          end
+
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: digester
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Simeon Simeonov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+description: 
+email:
+- sim@swoop_dot_com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- digester.gemspec
+- lib/digester.rb
+- lib/digester/digester.rb
+- lib/digester/version.rb
+- spec/lib/digester_spec.rb
+homepage: https://github.com/swoop-inc/digester
+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: 834053746874837549
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 834053746874837549
+requirements: []
+rubyforge_project: digester
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Digester builds consistent MD5 signatures for arbitrary Ruby data structures.
+test_files:
+- spec/lib/digester_spec.rb