crimp 0.0.1 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d887596d2b57389ff5f4542a66b6feb0675597c9
-  data.tar.gz: fbc0a8b3882d8100ca3e75f9a2fff070480df6e5
+  metadata.gz: a3c9582fb50d4c24f80f495871d85326c8db1034
+  data.tar.gz: 6965f4d813151e897087fd66aef13dbfa930221d
 SHA512:
-  metadata.gz: 9e9990c056596d3c3b559690bd931db0dd9207bdece77a2f7dd0c65b1b0c30decb8709f896fac86413f582ec2b712dc5569716c937feaf807d1bf6b4becefced
-  data.tar.gz: cd88bcba3e77022a349f27d780025b4feb5f6ad77b6fbdd16b2b8dc4e71152f367404737064bd632f3e74c9dea854a3fe8a8dabbb4ed9099ac5e2ff76225918e
+  metadata.gz: b32357f31dff6cb09241cd676acbeb9aa027b472090444b6364631a661c3dab052f6c21db401b5e29ed97250b5b22e13ca4645e34e295f8e35e0fadb7ffebcc0
+  data.tar.gz: 5b374574b25360818eef4946c7c24526be6dfe44d28d4d71f046a11e01c3a771b9f77826f1f910ce7dc4a43e3a136b4b2383dab1a904fdc801d9b680629d4027

data/.ruby-version

@@ -1 +1 @@
-jruby-1.7.9
+jruby-1.7.17

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - "jruby"
+notifications:
+  email:
+    recipients:
+      - kenoir@gmail.com
+    on_failure: change
+    on_success: never

data/README.md

@@ -1,5 +1,8 @@
 # Crimp
 
+[![Build Status](https://travis-ci.org/BBC-News/crimp.png?branch=master)](https://travis-ci.org/BBC-News/crimp)
+[![Gem Version](https://badge.fury.io/rb/crimp.png)](http://badge.fury.io/rb/crimp)
+
 Creating an md5 hash of a number, string, array, or hash in Ruby
 
 ![mighty-boosh-four-way-crimp-o](https://f.cloud.github.com/assets/180050/2148112/b44fd6fa-93de-11e3-9f9a-ad941f069b5c.gif)
@@ -28,8 +31,7 @@ require 'crimp'
 
 Crimp.stringify({:a => {:b => 'b', :c => 'c'}, :d => 'd'})
 
-# => [\"aSymbol=>[\\\"bSymbol=>b\\\", \\\"cSymbol=>c\\\"]Array\",
-\"dSymbol=>d\"]Array"
+# => [\"aSymbol=>[\\\"bSymbol=>b\\\", \\\"cSymbol=>c\\\"]Array\",\"dSymbol=>d\"]Array"
 
 Crimp.signature({:a => {:b => 'b', :c => 'c'}, :d => 'd'})
 

data/Rakefile

@@ -1 +1,6 @@
-require "bundler/gem_tasks"
+$:.unshift File.join(File.dirname(__FILE__), 'lib')
+
+require 'bundler/gem_tasks'
+require 'rake/rspec'
+
+task :default => :spec

data/crimp.gemspec

@@ -6,8 +6,8 @@ require 'crimp/version'
 Gem::Specification.new do |spec|
   spec.name          = "crimp"
   spec.version       = Crimp::VERSION
-  spec.authors       = ["Robert Kenny", "Mark McDonnell"]
-  spec.email         = ["kenoir@gmail.com","mark.mcdx@gmail.com"]
+  spec.authors       = ["BBC News"]
+  spec.email         = ["FutureMediaNewsRubyGems@bbc.co.uk"]
   spec.summary       = %q{Creating an md5 hash of a number, string, array, or hash in Ruby}
   spec.description   = <<-EOS.gsub /^\s+/, ""
                          Shamelessly lifted from http://stackoverflow.com/questions/6461812/creating-an-md5-hash-of-a-number-string-array-or-hash-in-ruby
@@ -25,11 +25,11 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rake-rspec"
   spec.add_development_dependency "rspec-nc"
   spec.add_development_dependency "guard"
   spec.add_development_dependency "guard-rspec"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "pry-remote"
   spec.add_development_dependency "pry-nav"
-
 end

data/lib/crimp.rb

@@ -2,29 +2,48 @@ require "crimp/version"
 require "digest"
 
 module Crimp
+  def self.signature(obj)
+    Digest::MD5.hexdigest stringify(obj)
+  end
+
   def self.stringify(obj)
-    if obj.class == Hash
-      arr = []
-      obj.each do |key, value|
-        arr << "#{self.stringify key}=>#{self.stringify value}"
-      end
-      obj = arr
-    end
-    if obj.class == Array
-      str = ''
-      obj.map! do |value|
-        self.stringify value
-      end.sort!.each do |value|
-        str << value
-      end
+    convert(obj).tap { |o| return o.class == String ? o : to_string(o) }
+  end
+
+  private
+
+  def self.convert(obj)
+    case obj
+    when Array
+      parse_array obj
+    when Hash
+      parse_hash obj
+    when String
+      obj
+    else
+      to_string obj
     end
-    if obj.class != String
-      obj = obj.to_s << obj.class.to_s
+  end
+
+  def self.hash_to_array(hash)
+    [].tap do |a|
+      hash.each { |k, v| a << pair_to_string(k, v) }
     end
-    obj
   end
 
-  def self.signature(obj)
-    Digest::MD5.hexdigest( self.stringify obj )
+  def self.pair_to_string(k, v)
+    "#{stringify k}=>#{stringify v}"
+  end
+
+  def self.parse_array(array)
+    array.map! { |e| stringify(e) }.sort!
+  end
+
+  def self.parse_hash(hash)
+    stringify hash_to_array(hash)
+  end
+
+  def self.to_string(obj)
+    "#{obj.to_s}#{obj.class.to_s}"
   end
 end

data/lib/crimp/version.rb

@@ -1,3 +1,3 @@
 module Crimp
-  VERSION = "0.0.1"
+  VERSION = "0.1.1"
 end

data/spec/consistency_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe Crimp do
+  describe '.signature' do
+    context 'check MD5 consistent across versions' do
+      context 'given a Hash' do
+        let(:hash) do
+          {
+            :a => 123,
+            :b => 1.23,
+            :c => 'string',
+            :d => :sym
+          }
+        end
+        let(:md5) { '1dd744d51279187cc08cabe240f98be2' }
+
+        specify { expect(subject.signature hash).to eq md5 }
+      end
+
+      context 'given legacy Hash' do
+        let(:hash) do
+          {:a => {:b => 'b', :c => 'c'}, :d => 'd'}
+        end
+        let(:md5) { '68d07febc4f47f56fa6ef5de063a77b1' }
+
+        specify { expect(subject.signature hash).to eq md5 }
+      end
+
+      context 'given an Array' do
+        let(:array) { [123, 1.23, 'string', :sym] }
+        let(:md5) { 'cd29980f258eef3faceca4f4da02ec65' }
+
+        specify { expect(subject.signature array).to eq md5 }
+      end
+
+      context 'given legacy Array' do
+        let(:array) { [1, 2, 3, [4, [5, 6]]] }
+        let(:md5) { '4dc4e1161c9315db0bc43c0201b3ec05' }
+
+        specify { expect(subject.signature array).to eq md5 }
+      end
+    end
+  end
+end

data/spec/crimp_spec.rb

@@ -1,70 +1,60 @@
 require 'spec_helper'
 
 describe Crimp do
-  let (:example_hash) { {:a => {:b => 'b', :c => 'c'}, :d => 'd'} }
-  let (:example_hash_unordered) { {:d => 'd', :a => {:c => 'c', :b => 'b'}} }
-  let (:example_array) { [1,2,3,[4,[5,6]]] }
-  let (:example_array_unordered) { [3,2,1,[[5,6],4]] }
+  let (:hash) { {:a => {:b => 'b', :c => 'c'}, :d => 'd'} }
+  let (:hash_unordered) { {:d => 'd', :a => {:c => 'c', :b => 'b'}} }
+  let (:array) { [1, 2, 3, [4, [5, 6]]] }
+  let (:array_unordered) { [3, 2, 1, [[5, 6], 4]] }
 
-  describe ".signature(obj)" do
-    context "obj.class == Hash" do
-      it "returns a string" do
-        expect(subject.signature(example_hash)).to be_a String
-      end
+  describe ".signature" do
+    context "given a Hash" do
+      specify { expect(subject.signature hash).to be_a String }
 
-      it "returns Digest::MD5.hexdigest of self.stringify(obj)" do
+      it "returns MD5 hash of stringified Hash" do
         expect(
-          subject.signature(example_hash)
+          subject.signature(hash)
         ).to eq(
-          Digest::MD5.hexdigest(subject.stringify(example_hash))
+          Digest::MD5.hexdigest(subject.stringify(hash))
         )
       end
     end
 
-    context "obj.class == Array" do
-      it "returns a string" do
-        expect(subject.signature(example_array)).to be_a String
-      end
+    context "given an Array" do
+      specify { expect(subject.signature array).to be_a String }
 
-      it "returns Digest::MD5.hexdigest of self.stringify(obj)" do
+      it "returns MD5 hash of stringified Array" do
         expect(
-          subject.signature(example_array)
+          subject.signature(array)
         ).to eq(
-          Digest::MD5.hexdigest(subject.stringify(example_array))
+          Digest::MD5.hexdigest(subject.stringify(array))
         )
       end
     end
-
   end
 
-  describe ".stringify(obj)" do
-    context "obj.class == Hash" do
-      it "returns a string" do
-        expect(subject.stringify(example_hash)).to be_a String
-      end
+  describe ".stringify" do
+    context "given a Hash" do
+      specify { expect(subject.stringify hash).to be_a String }
 
-      it "will return equal strings for differently ordered hashes" do
+      it "returns equal strings for differently ordered hashes" do
         expect(
-          subject.stringify(example_hash)
+          subject.stringify(hash)
         ).to eq(
-        subject.stringify(example_hash_unordered)
+          subject.stringify(hash_unordered)
         )
       end
     end
 
-    context "obj.class == Array" do
-      it "returns a string" do
-        expect(subject.stringify(example_array)).to be_a String
-      end
+    context "given an Array" do
+      specify { expect(subject.stringify array).to be_a String }
 
-      it "will return equal strings for differently ordered arrays" do
+      it "returns equal strings for differently ordered arrays" do
         expect(
-          subject.stringify(example_array)
+          subject.stringify(array)
         ).to eq(
-        subject.stringify(example_array_unordered)
+          subject.stringify(array_unordered)
         )
       end
-
     end
   end
 end

metadata

@@ -1,154 +1,167 @@
 --- !ruby/object:Gem::Specification
 name: crimp
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.1
 platform: ruby
 authors:
-- Robert Kenny
-- Mark McDonnell
+- BBC News
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-02-12 00:00:00.000000000 Z
+date: 2015-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
   name: bundler
+  prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.5'
+- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '0'
+  name: rake
   prerelease: false
   type: :development
-- !ruby/object:Gem::Dependency
-  name: rake
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+  name: rspec
   prerelease: false
   type: :development
-- !ruby/object:Gem::Dependency
-  name: rspec
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+  name: rake-rspec
   prerelease: false
   type: :development
-- !ruby/object:Gem::Dependency
-  name: rspec-nc
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+  name: rspec-nc
   prerelease: false
   type: :development
-- !ruby/object:Gem::Dependency
-  name: guard
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+  name: guard
   prerelease: false
   type: :development
-- !ruby/object:Gem::Dependency
-  name: guard-rspec
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+  name: guard-rspec
   prerelease: false
   type: :development
-- !ruby/object:Gem::Dependency
-  name: pry
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+  name: pry
   prerelease: false
   type: :development
-- !ruby/object:Gem::Dependency
-  name: pry-remote
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+  name: pry-remote
   prerelease: false
   type: :development
-- !ruby/object:Gem::Dependency
-  name: pry-nav
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+  name: pry-nav
   prerelease: false
   type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |
   Shamelessly lifted from http://stackoverflow.com/questions/6461812/creating-an-md5-hash-of-a-number-string-array-or-hash-in-ruby
   All credit should go to http://stackoverflow.com/users/394282/luke
 email:
-- kenoir@gmail.com
-- mark.mcdx@gmail.com
+- FutureMediaNewsRubyGems@bbc.co.uk
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
 - .ruby-version
+- .travis.yml
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -157,6 +170,7 @@ files:
 - crimp.gemspec
 - lib/crimp.rb
 - lib/crimp/version.rb
+- spec/consistency_spec.rb
 - spec/crimp_spec.rb
 - spec/spec_helper.rb
 homepage: ''
@@ -184,5 +198,6 @@ signing_key:
 specification_version: 4
 summary: Creating an md5 hash of a number, string, array, or hash in Ruby
 test_files:
+- spec/consistency_spec.rb
 - spec/crimp_spec.rb
 - spec/spec_helper.rb