json-deep-compare 0.1.0 → 0.2.0

data/lib/json-deep-compare.rb

@@ -1,202 +1,7 @@
-module JsonDeepCompare
-  VERSION = '0.1.0'
-
-  class DocumentComparison
-    def initialize(lval, rval, options = {})
-      if exclusions = options[:exclusions]
-        options[:exclusions] = [exclusions] unless exclusions.is_a?(Array)
-      else
-        options[:exclusions] = []
-      end
-      @root_comparisons = []
-      @root_comparisons << NodeComparison.new(lval, rval, ":root", options)
-      @root_comparisons << NodeComparison.new(rval, lval, ":root", options)
-    end
-
-    def difference_messages
-      ldiffs = @root_comparisons.first.differences
-      rdiffs = @root_comparisons.last.differences
-      differences = ldiffs.dup
-      ldiff_selectors = ldiffs.map { |ldiff| ldiff.selector }
-      rdiffs.each do |rdiff|
-        unless ldiff_selectors.include?(rdiff.selector)
-          differences << rdiff.reverse
-        end
-      end
-      differences = differences.sort_by &:selector
-      differences.map(&:message).join("\n")
-    end
-
-    def equal?
-      @root_comparisons.all?(&:equal?)
-    end
-  end
-
-  class NodeComparison
-    ExcerptPadding = 15
-    attr_reader :lval, :rval, :selector
-
-    def initialize(lval, rval, selector, options = {})
-      @lval, @rval, @selector, @options = lval, rval, selector, options
-      @children = []
-      if lval.is_a?(Hash)
-        if rval.is_a?(Hash)
-          lval.each do |key, left_sub_value|
-            @children << NodeComparison.new(
-              left_sub_value, 
-              rval[key], 
-              "#{selector} > .#{key}", 
-              options
-            )
-          end
-        end
-      elsif lval.is_a?(Array)
-        if rval.is_a?(Array)
-          lval.each_with_index do |left_sub_value, i|
-            @children << NodeComparison.new(
-              left_sub_value, 
-              rval[i], 
-              "#{selector} :nth-child(#{i+1})",
-              options
-            )
-          end
-        end
-      end
-    end
-
-    def blank?(value)
-      value.respond_to?(:empty?) ? value.empty? : !value
-    end
-
-    def blank_equality?
-      @options[:blank_equality]
-    end
-
-    def differences
-      if equal?
-        []
-      else
-        if leaf?
-          if excerptable_difference?
-            [excerpted_difference]
-          else
-            [Difference.new(
-              @selector, "expected to be :lval but was :rval",
-              lval: value_inspect(@lval), rval: value_inspect(@rval)
-            )]
-          end
-        else
-          @children.map(&:differences).compact.flatten
-        end
-      end
-    end
-
-    def equal?
-      if leaf?
-        if selector_excluded?
-          true
-        elsif equality_proc
-          equality_proc.call(@lval, @rval)
-        else
-          @lval == @rval || (blank_equality? && blank?(@lval) && blank?(@rval))
-        end
-      else
-        @children.all?(&:equal?)
-      end
-    end
-
-    def equality_proc
-      @options[:equality]
-    end
+require 'json-deep-compare/assertions'
+require 'json-deep-compare/document_comparison'
+require 'json-deep-compare/node_comparison'
+require 'json-deep-compare/version'
 
-    def excerptable_difference?
-      @lval.is_a?(String) and @rval.is_a?(String) && (
-        @lval.size > ExcerptPadding * 2 || @rval.size > ExcerptPadding * 2
-      )
-    end
-
-    def excerpted_difference
-      difference_start = (0..@lval.length).detect { |i| @lval[i] != @rval[i] }
-      range_start = if difference_start > ExcerptPadding
-        difference_start - ExcerptPadding
-      else
-        0
-      end
-      left_excerpt = @lval[range_start..difference_start+ExcerptPadding]
-      right_excerpt = @rval[range_start..difference_start+ExcerptPadding]
-      if difference_start - ExcerptPadding > 0
-        left_excerpt = "..." + left_excerpt
-        right_excerpt = "..." + right_excerpt
-      end
-      if difference_start + ExcerptPadding < @lval.length
-        left_excerpt = left_excerpt + '...'
-      end
-      if difference_start + ExcerptPadding < @rval.length
-        right_excerpt = right_excerpt + '...'
-      end
-      Difference.new(
-        @selector,
-        "differs starting at char :difference_start: :lval differs from :rval",
-        difference_start: difference_start.to_s,
-        lval: left_excerpt.inspect, rval: right_excerpt.inspect
-      )
-    end
-
-    def leaf?
-      @children.empty?
-    end
-
-    def selector_excluded?
-      @options[:exclusions].any? { |exclusion|
-        if exclusion.is_a?(String)
-          exclusion == @selector
-        else
-          @selector =~ exclusion
-        end
-      }
-    end
-
-    def value_inspect(value)
-      str = value.inspect
-      if str.length >= 40
-        "#{value.class.name} #{str[0..37]}..."
-      else
-        str
-      end
-    end
-
-    class Difference
-      attr_reader :selector
-
-      def initialize(selector, msg_template, variables)
-        @selector, @msg_template, @variables = 
-          selector, msg_template, variables
-      end
-
-      def message
-        msg = @msg_template
-        @variables.each do |name, value|
-          msg = msg.gsub(/#{name.inspect}/, value)
-        end
-        "#{@selector.inspect} #{msg}"
-      end
-
-      def reverse
-        reversed_variables = {lval: @variables[:rval], rval: @variables[:lval]}
-        (@variables.keys - [:lval, :rval]).each do |other_var|
-          reversed_variables[other_var] = @variables[other_var]
-        end
-        Difference.new(@selector, @msg_template, reversed_variables)
-      end
-    end
-  end
-
-  module Assertions
-    def assert_json_equal(expected, actual, exclusions = nil)
-      comparison = DocumentComparison.new(expected, actual, exclusions: exclusions)
-      unless comparison.equal?
-        fail comparison.difference_messages
-      end
-    end
-  end
+module JsonDeepCompare
 end

data/lib/json-deep-compare/assertions.rb

@@ -0,0 +1,10 @@
+module JsonDeepCompare
+  module Assertions
+    def assert_json_equal(expected, actual, options = {})
+      comparison = DocumentComparison.new(expected, actual, options)
+      unless comparison.equal?
+        fail comparison.difference_messages
+      end
+    end
+  end
+end

data/lib/json-deep-compare/document_comparison.rb

@@ -0,0 +1,36 @@
+module JsonDeepCompare
+  class DocumentComparison
+    def initialize(lval, rval, options = {})
+      if exclusions = options[:exclusions]
+        options[:exclusions] = [exclusions] unless exclusions.is_a?(Array)
+      else
+        options[:exclusions] = []
+      end
+      @root_comparisons = []
+      @root_comparisons << NodeComparison.new(
+        lval, rval, ":root", options.merge(direction: :left)
+      )
+      @root_comparisons << NodeComparison.new(
+        rval, lval, ":root", options.merge(direction: :right)
+      )
+    end
+
+    def difference_messages
+      ldiffs = @root_comparisons.first.differences
+      rdiffs = @root_comparisons.last.differences
+      differences = ldiffs.dup
+      ldiff_selectors = ldiffs.map { |ldiff| ldiff.selector }
+      rdiffs.each do |rdiff|
+        unless ldiff_selectors.include?(rdiff.selector)
+          differences << rdiff.reverse
+        end
+      end
+      differences = differences.sort_by &:selector
+      differences.map(&:message).join("\n")
+    end
+
+    def equal?
+      @root_comparisons.all?(&:equal?)
+    end
+  end
+end

data/lib/json-deep-compare/node_comparison.rb

@@ -0,0 +1,194 @@
+module JsonDeepCompare
+  class NodeComparison
+    ExcerptPadding = 15
+    attr_reader :lval, :rval, :selector
+
+    def initialize(lval, rval, selector, options = {})
+      @lval, @rval, @selector, @options = lval, rval, selector, options
+      @children = []
+      if lval.is_a?(Hash)
+        if rval.is_a?(Hash)
+          lval.each do |key, left_sub_value|
+            @children << NodeComparison.new(
+              left_sub_value, 
+              rval[key], 
+              "#{selector} > .#{key}", 
+              options
+            )
+          end
+        end
+      elsif lval.is_a?(Array)
+        if rval.is_a?(Array)
+          lval.each_with_index do |left_sub_value, i|
+            @children << NodeComparison.new(
+              left_sub_value, 
+              rval[i], 
+              "#{selector} :nth-child(#{i+1})",
+              options
+            )
+          end
+        end
+      end
+    end
+
+    def blank?(value)
+      value.respond_to?(:empty?) ? value.empty? : !value
+    end
+
+    def blank_equality?
+      @options[:blank_equality]
+    end
+
+    def differences
+      if equal?
+        []
+      else
+        if leaf?
+          if excerptable_difference?
+            [excerpted_difference]
+          else
+            [Difference.new(
+              @selector, "expected to be :lval but was :rval",
+              lval: value_inspect(@lval), rval: value_inspect(@rval)
+            )]
+          end
+        else
+          @children.map(&:differences).compact.flatten
+        end
+      end
+    end
+
+    def equal?
+      if leaf?
+        if selector_excluded?
+          true
+        elsif equality_proc
+          equality_proc.call(lval_for_equality, rval_for_equality)
+        elsif blank_equality? && blank?(lval_for_equality) && blank?(rval_for_equality)
+          true
+        else
+          lval_for_equality == rval_for_equality
+        end
+      else
+        @children.all?(&:equal?)
+      end
+    end
+
+    def equality_proc
+      @options[:equality]
+    end
+
+    def excerptable_difference?
+      @lval.is_a?(String) and @rval.is_a?(String) && (
+        @lval.size > ExcerptPadding * 2 || @rval.size > ExcerptPadding * 2
+      )
+    end
+
+    def excerpted_difference
+      difference_start = (0..@lval.length).detect { |i| @lval[i] != @rval[i] }
+      range_start = if difference_start > ExcerptPadding
+        difference_start - ExcerptPadding
+      else
+        0
+      end
+      left_excerpt = @lval[range_start..difference_start+ExcerptPadding]
+      right_excerpt = @rval[range_start..difference_start+ExcerptPadding]
+      if difference_start - ExcerptPadding > 0
+        left_excerpt = "..." + left_excerpt
+        right_excerpt = "..." + right_excerpt
+      end
+      if difference_start + ExcerptPadding < @lval.length
+        left_excerpt = left_excerpt + '...'
+      end
+      if difference_start + ExcerptPadding < @rval.length
+        right_excerpt = right_excerpt + '...'
+      end
+      Difference.new(
+        @selector,
+        "differs starting at char :difference_start: :lval differs from :rval",
+        difference_start: difference_start.to_s,
+        lval: left_excerpt.inspect, rval: right_excerpt.inspect
+      )
+    end
+
+    def leaf?
+      @children.empty?
+    end
+
+    def left_to_right?
+      @options[:direction] == :left
+    end
+
+    def lval_for_equality
+      @_lval_for_equality ||= begin
+        if left_to_right? && substitution
+          substitution
+        else
+          lval
+        end
+      end
+    end
+
+    def right_to_left?
+      @options[:direction] == :right
+    end
+
+    def rval_for_equality
+      @_rval_for_equality ||= begin
+        if right_to_left? && substitution
+          substitution
+        else
+          rval
+        end
+      end
+    end
+
+    def selector_excluded?
+      @options[:exclusions].any? { |exclusion|
+        if exclusion.is_a?(String)
+          exclusion == @selector
+        else
+          @selector =~ exclusion
+        end
+      }
+    end
+
+    def substitution
+      @options[:substitutions] && @options[:substitutions][selector]
+    end
+
+    def value_inspect(value)
+      str = value.inspect
+      if str.length >= 40
+        "#{value.class.name} #{str[0..37]}..."
+      else
+        str
+      end
+    end
+
+    class Difference
+      attr_reader :selector
+
+      def initialize(selector, msg_template, variables)
+        @selector, @msg_template, @variables = 
+          selector, msg_template, variables
+      end
+
+      def message
+        msg = @msg_template
+        @variables.each do |name, value|
+          msg = msg.gsub(/#{name.inspect}/, value)
+        end
+        "#{@selector.inspect} #{msg}"
+      end
+
+      def reverse
+        reversed_variables = {lval: @variables[:rval], rval: @variables[:lval]}
+        (@variables.keys - [:lval, :rval]).each do |other_var|
+          reversed_variables[other_var] = @variables[other_var]
+        end
+        Difference.new(@selector, @msg_template, reversed_variables)
+      end
+    end
+  end
+end

data/lib/json-deep-compare/version.rb

@@ -0,0 +1,3 @@
+module JsonDeepCompare
+  VERSION = '0.2.0'
+end

data/test/json_deep_compare_test.rb

@@ -1,6 +1,6 @@
 require 'test/unit'
-$: << '.'
-require 'lib/json-deep-compare'
+$: << 'lib'
+require 'json-deep-compare'
 
 class DocumentComparisonTestCase < Test::Unit::TestCase
   def assert_symmetrically_different(
@@ -198,4 +198,13 @@ class DocumentComparisonTestCase < Test::Unit::TestCase
     )
     assert comparison.equal?
   end
+
+  def test_substitutions
+    lval = {'one' => 'two', 'three' => 'four'}
+    rval = {'one' => 'two', 'three' => 'THREE'}
+    comparison = JsonDeepCompare::DocumentComparison.new(
+      lval, rval, substitutions: {":root > .three" => 'THREE'}
+    )
+    assert comparison.equal?
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: json-deep-compare
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-01 00:00:00.000000000 Z
+date: 2014-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -57,6 +57,10 @@ files:
 - Rakefile
 - json-deep-compare.gemspec
 - lib/json-deep-compare.rb
+- lib/json-deep-compare/assertions.rb
+- lib/json-deep-compare/document_comparison.rb
+- lib/json-deep-compare/node_comparison.rb
+- lib/json-deep-compare/version.rb
 - test/json_deep_compare_test.rb
 homepage: ''
 licenses:
@@ -73,7 +77,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 634763774305586060
+      hash: -2030263147861406758
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -82,7 +86,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 634763774305586060
+      hash: -2030263147861406758
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23