json-deep-compare 0.0.1

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Francis Hwang
+
+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,68 @@
+# JsonDeepCompare
+
+For quickly finding differences between two large JSON documents.
+
+Currently JsonDeepCompare is test-oriented.  Its utility might be
+expanded in the future.
+
+## Installation
+
+To use in a Test::Unit test case, include `JsonDeepCompare::Assertions`:
+
+    class MyTest < Test::Unit::TestCase
+      include JsonDeepCompare::Assertions
+
+If you're using Rails, put this in `test/test_helper.rb`:
+
+    class ActiveSupport::TestCase
+      include JsonDeepCompare::Assertions
+
+## Usage
+
+`JsonDeepCompare::Assertions` provides the `assert_json_equal` method:
+
+    class MyTest
+      include JsonDeepCompare::Assertions
+
+      def test_comparison
+        left_value = {
+          'total_rows' => 2,
+          'rows' => [
+            {
+              'id' => 'foo',
+              'doc' => {
+                '_id' => 'foo', 'title' => 'Foo', 'sub_document' => { 'one' => 'two' }
+              }
+            }
+          ]
+        }
+        right_value = {
+          'total_rows' => 2,
+          'rows' => [
+            {
+              'id' => 'foo',
+              'doc' => {
+                '_id' => 'foo', 'title' => 'Foo', 'sub_document' => { 'one' => '1' }
+              }
+            }
+          ]
+        }
+        assert_json_equal(left_value, right_value)
+      end
+    end
+  
+Running this test will yield this error:
+
+    RuntimeError: ":root > .rows :nth-child(1) > .doc > .sub_document > .one" expected to be "two" but was "1"
+
+The selector syntax uses a limited subset of
+[JSONSelect](http://jsonselect.org/) to describe where to find the
+differences.
+
+## 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/json-deep-compare.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'json-deep-compare'
+
+Gem::Specification.new do |spec|
+  spec.name          = "json-deep-compare"
+  spec.version       = JsonDeepCompare::VERSION
+  spec.authors       = ["Francis Hwang"]
+  spec.email         = ["sera@fhwang.net"]
+  spec.description   = %q{For quickly finding differences between two large JSON documents.}
+  spec.summary       = %q{For quickly finding differences between two large JSON documents.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/json-deep-compare.rb

@@ -0,0 +1,115 @@
+module JsonDeepCompare
+  VERSION = '0.0.1'
+
+  class NodeComparison
+    ExcerptPadding = 15
+    attr_reader :left_value, :right_value, :selector
+
+    def initialize(left_value, right_value, options = {})
+      @left_value, @right_value = left_value, right_value             
+      @selector = options[:selector] || ':root'
+      @exclusions = options[:exclusions]
+      @exclusions = [@exclusions] unless @exclusions.is_a?(Array)
+      @children = []
+      if left_value.is_a?(Hash)
+        if right_value.is_a?(Hash)
+          left_value.each do |key, left_sub_value|
+            @children << NodeComparison.new(
+              left_sub_value, right_value[key], 
+              selector: "#{selector} > .#{key}", exclusions: @exclusions
+            )
+          end
+        end
+      elsif left_value.is_a?(Array)
+        if right_value.is_a?(Array)
+          left_value.each_with_index do |left_sub_value, i|
+            @children << NodeComparison.new(
+              left_sub_value, right_value[i], 
+              selector: "#{selector} :nth-child(#{i+1})", 
+              exclusions: @exclusions
+            )
+          end
+        end
+      end
+    end
+
+    def value_inspect(value)
+      str = value.inspect
+      if str.length >= 40
+        "#{value.class.name} #{str[0..37]}..."
+      else
+        str
+      end
+    end
+
+    def difference_message
+      unless equal?
+        if leaf?
+          if excerptable_difference?
+            excerpted_difference
+          else
+            "#{@selector.inspect} expected to be #{value_inspect(@left_value)} but was #{value_inspect(@right_value)}"
+          end
+        else
+          @children.reject(&:equal?).map(&:difference_message).join("\n")
+        end
+      end
+    end
+
+    def equal?
+      if leaf?
+        @exclusions.include?(@selector) || @left_value == @right_value
+      else
+        @children.all?(&:equal?)
+      end
+    end
+
+    def excerptable_difference?
+      @left_value.is_a?(String) and @right_value.is_a?(String) && (
+        @left_value.size > ExcerptPadding * 2 || 
+        @right_value.size > ExcerptPadding * 2
+      )
+    end
+
+    def excerpted_difference
+      difference_start = (0..@left_value.length).detect { |i| 
+        @left_value[i] != @right_value[i]
+      }
+      range_start = if difference_start > ExcerptPadding
+        difference_start - ExcerptPadding
+      else
+        0
+      end
+      left_excerpt = @left_value[
+        range_start..difference_start+ExcerptPadding
+      ]
+      right_excerpt = @right_value[
+        range_start..difference_start+ExcerptPadding
+      ]
+      if difference_start - ExcerptPadding > 0
+        left_excerpt = "..." + left_excerpt
+        right_excerpt = "..." + right_excerpt
+      end
+      if difference_start + ExcerptPadding < @left_value.length
+        left_excerpt = left_excerpt + '...'
+      end
+      if difference_start + ExcerptPadding < @right_value.length
+        right_excerpt = right_excerpt + '...'
+      end
+      "#{@selector.inspect} differs starting at char #{difference_start}: #{left_excerpt.inspect} differs from #{right_excerpt.inspect}"
+    end
+
+    def leaf?
+      @children.empty?
+    end
+  end
+
+  module Assertions
+    def assert_json_equal(expected, actual, exclusions = nil)
+      comparison = NodeComparison.new(expected, actual, exclusions: exclusions)
+      unless comparison.equal?
+        fail comparison.difference_message
+      end
+    end
+  end
+end

data/test/json_deep_compare_test.rb

@@ -0,0 +1,126 @@
+require 'test/unit'
+$: << '.'
+require 'lib/json-deep-compare'
+
+class NodeComparisonTestCase < Test::Unit::TestCase
+  def test_detects_difference_in_atoms
+    left_value = {
+      'total_rows' => 2,
+      'rows' => [
+        {
+          'id' => 'foo',
+          'doc' => {
+            '_id' => 'foo',
+            'title' => 'Foo',
+            'sub_document' => { 'one' => 'two' }
+          }
+        }
+      ]
+    }
+    right_value = {
+      'total_rows' => 2,
+      'rows' => [
+        {
+          'id' => 'foo',
+          'doc' => {
+            '_id' => 'foo',
+            'title' => 'Foo',
+            'sub_document' => { 'one' => '1' }
+          }
+        }
+      ]
+    }
+    comparison = JsonDeepCompare::NodeComparison.new(left_value, right_value)
+    assert !comparison.equal?
+    assert_equal(
+      "\":root > .rows :nth-child(1) > .doc > .sub_document > .one\" expected to be \"two\" but was \"1\"", 
+      comparison.difference_message
+    )
+  end
+
+  def test_detects_differences_in_keys
+    left_value = {"doc" => {"foo" => "bar"}}
+    right_value = {"doc" => {"biz" => "bang", "bing" => nil}}
+    comparison = JsonDeepCompare::NodeComparison.new(left_value, right_value)
+    assert !comparison.equal?
+  end
+
+  def test_detects_difference_in_type
+    lval = {"foo" => {'bar' => 'bang'}}
+    rval = {"foo" => [3,4,5]}
+    comparison = JsonDeepCompare::NodeComparison.new(lval, rval)
+    assert !comparison.equal?
+    assert_equal(
+      "\":root > .foo\" expected to be {\"bar\"=>\"bang\"} but was [3, 4, 5]",
+      comparison.difference_message
+    )
+  end
+
+  def test_detects_difference_in_type_and_truncates
+    lval_hash = {}
+    'A'.upto('Z').each do |letter|
+      lval_hash[letter] = letter
+    end
+    lval = {"foo" => lval_hash}
+    rval = {"foo" => [3,4,5]}
+    comparison = JsonDeepCompare::NodeComparison.new(lval, rval)
+    assert !comparison.equal?
+    assert_equal(
+      "\":root > .foo\" expected to be Hash {\"A\"=>\"A\", \"B\"=>\"B\", \"C\"=>\"C\", \"D\"=>\"D... but was [3, 4, 5]",
+      comparison.difference_message
+    )
+  end
+
+  def test_lists_multliple_differences
+    lval = {'one' => {'two' => 'three', 'four' => 'five'}, 'six' => 'seven'}
+    rval = {'one' => {'two' => 'TWO', 'four' => 'five'}, 'six' => 'SIX'}
+    comparison = JsonDeepCompare::NodeComparison.new(lval, rval)
+    assert !comparison.equal?
+    assert_equal(
+      "\":root > .one > .two\" expected to be \"three\" but was \"TWO\"\n\":root > .six\" expected to be \"seven\" but was \"SIX\"",
+      comparison.difference_message
+    )
+  end
+
+  def test_detects_difference_between_array_and_nil
+    lval = {'one' => [1,2,3]}
+    rval = {'one' => nil}
+    comparison = JsonDeepCompare::NodeComparison.new(lval, rval)
+    assert !comparison.equal?
+    assert_equal(
+      "\":root > .one\" expected to be [1, 2, 3] but was nil",
+      comparison.difference_message
+    )
+  end
+
+  def test_shows_first_string_difference
+    lval = {'body' => "Four score and seven years ago our fathers brought forth on this continent, a new nation, conceived in Liberty, and dedicated to the proposition that all men are created equal."}
+    rval = {'body' => "Four score and seven years ago our fathers brought forth on this continent, a new nation, conceived in liberty, and dedicated to the proposition that all men are created equal."}
+    comparison = JsonDeepCompare::NodeComparison.new(lval, rval)
+    assert !comparison.equal?
+    assert_equal(
+      "\":root > .body\" differs starting at char 103: \"..., conceived in Liberty, and ded...\" differs from \"..., conceived in liberty, and ded...\"",
+      comparison.difference_message
+    )
+  end
+
+  def test_shows_string_difference_start
+    lval = {'rev' => "22-23c92a95665bb692313229c8224b7088"}
+    rval = {'rev' => "23-54a5106f8c522a57d6d4c6963bc36611"}
+    comparison = JsonDeepCompare::NodeComparison.new(lval, rval)
+    assert !comparison.equal?
+    assert_equal(
+      "\":root > .rev\" differs starting at char 1: \"22-23c92a95665bb6...\" differs from \"23-54a5106f8c522a...\"",
+      comparison.difference_message
+    )
+  end
+
+  def test_simple_exclusion
+    lval = {'one' => 'two', 'three' => 'four'}
+    rval = {'one' => 'two', 'three' => 'THREE'}
+    comparison = JsonDeepCompare::NodeComparison.new(
+      lval, rval, exclusions: [":root > .three"]
+    )
+    assert comparison.equal?
+  end
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: json-deep-compare
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Francis Hwang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-03 00:00:00.000000000 Z
+dependencies:
+- !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'
+description: For quickly finding differences between two large JSON documents.
+email:
+- sera@fhwang.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- json-deep-compare.gemspec
+- lib/json-deep-compare.rb
+- test/json_deep_compare_test.rb
+homepage: ''
+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: 383603838726367257
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 383603838726367257
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: For quickly finding differences between two large JSON documents.
+test_files:
+- test/json_deep_compare_test.rb