diff_matcher 2.2.3 → 2.3.1

data/Gemfile.lock

@@ -0,0 +1,26 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    multi_json (1.0.4)
+    rake (0.9.2.2)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    simplecov (0.5.4)
+      multi_json (~> 1.0.3)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake (~> 0.9)
+  rspec (~> 2.6.0)
+  simplecov

data/README.md

@@ -74,6 +74,13 @@ p DiffMatcher::difference(/[a-z]/, "a")
 # => nil
 ```
 
+When `actual` is a fixnum that matches the `expected` range
+
+``` ruby
+p DiffMatcher::difference(1..3, 3)
+# => nil
+```
+
 When `actual` is passed to an `expected` proc and it returns true
 
 ``` ruby
@@ -217,7 +224,7 @@ The items shown in a difference are prefixed as follows:
     match regexp  => "~ "
     match class   => ": "
     match matcher => "| "
-    match proc    => ". "
+    match range   => ". "
     match proc    => "{ "
 
 
@@ -258,6 +265,7 @@ Similar gems
 ### JSON matchers
   * <http://github.com/collectiveidea/json_spec> (Easily handle JSON in RSpec and Cucumber)
   * <http://github.com/lloyd/JSONSelect> (CSS-like selectors for JSON)
+  * <http://github.com/chancancode/json_expressions> (JSON matchmaking for all your API testing needs)
 
 
 Why another differ?
@@ -277,6 +285,15 @@ And the difference string that it outputs can be formatted in several ways as ne
 
 As for matching JSON, the matchers above work well, but don't allow for matching patterns.
 
+#### Update 2012/07/14:
+
+[json_expressions](http://github.com/chancancode/json_expressions) (as mentioned in [Ruby5 - Episode #288](http://ruby5.envylabs.com/episodes/292-episode-288-july-13th-2012)) *does*
+do pattern matching and also looks like a good alternative to diff_matcher, it has the following advantages:
+  * define capture symbols that can be used to extract values from the matched object
+  * (if a symbol is used multiple times, it will make sure all the extracted values match)
+  * can optionally match unordered arrays (diff_matcher only matches ordered arrays)
+  * because it doesn't bother generating a pretty difference string it might be faster
+
 
 Use with rspec
 ---

data/examples/tennis_score.rb

@@ -0,0 +1,15 @@
+require 'diff_matcher'
+
+set_scores = [
+  [[6,4], [6,4], [6,4]],
+  [[8,4], [6,9], [6,4]],
+]
+
+pat_set_scores = DiffMatcher::AllMatcher.new(
+  [0..6, 0..6],
+  :size => 2..3
+)
+
+invalid_scores = set_scores.map { |score| pat_set_scores.diff(score) }.compact
+
+puts invalid_scores

data/lib/diff_matcher/difference.rb

@@ -181,6 +181,20 @@ module DiffMatcher
       }.call
     end
 
+    def summarize_item_str(item, method)
+      if [:missing, :additional].include?(method)
+        if item.match(/\A\[.*\]\Z/) and [:missing, :additional].include?(method)
+          '[...]'
+        elsif item.match(/\A\{.*\}\Z/)
+          '{...}'
+        else
+          item
+        end
+      else
+        item
+      end
+    end
+
     def difference(expected, actual)
       if actual.is_a? expected.class
         left = diff(expected, actual)
@@ -188,7 +202,9 @@ module DiffMatcher
         items_to_s(
           expected,
           (item_types_shown).inject([]) { |a, method|
-            a + send(method, left, right, expected).compact.map { |item| markup(method, item) }
+            a + send(method, left, right, expected).compact.map { |item|
+              markup(method, summarize_item_str(item, method))
+            }
           }
         )
       else
@@ -269,22 +285,43 @@ module DiffMatcher
       markup(match_type, actual) if matches_shown.include?(match_type)
     end
 
+    def summarize_item(item)
+      case item
+      when Array
+        '[...]'
+      when Hash
+        '{...}'
+      else
+        item.inspect
+      end
+    end
+
     def difference_to_s(expected, actual)
       match, match_type, d = match?(expected, actual)
       if match
         match_to_s(expected, actual.inspect, match_type)
       else
-        match_type == :match_matcher ? d :
-          "#{markup(:missing, expected.inspect)}#{markup(:additional, actual.inspect)}"
+        case match_type
+        when :match_matcher
+          d
+        else
+          exp, act = if [expected, actual].any? { |item| item.is_a?(Proc) }
+            [expected, actual].map { |item| item.inspect }
+          else
+            [expected, actual].map { |item| summarize_item(item) }
+          end
+
+          "#{markup(:missing, exp)}#{markup(:additional, act)}"
+        end
       end
     end
 
-    def markup(item_type, item)
-      if item_type == :different
+    def markup(match_type, item)
+      if match_type == :different
         item.split("\n").map {|line| "  #{line}"}.join("\n") if item
       else
-        color, prefix = @color_scheme[item_type]
-        "#{color}#{prefix+' ' if prefix}#{BOLD if color and item_type != :match_regexp}#{RESET if item_type == :match_regexp}#{item}#{RESET if color}" if item
+        color, prefix = @color_scheme[match_type]
+        "#{color}#{prefix+' ' if prefix}#{BOLD if color and match_type != :match_regexp}#{RESET if match_type == :match_regexp}#{item}#{RESET if color}" if item
       end if item
     end
   end

data/lib/diff_matcher/version.rb

@@ -1,3 +1,3 @@
 module DiffMatcher
-  VERSION = "2.2.3"
+  VERSION = "2.3.1"
 end

data/spec/diff_matcher/difference_spec.rb

@@ -90,7 +90,7 @@ describe "DiffMatcher::AllMatcher[expected]" do
     context "when actual is not an array" do
       let(:actual) { 'a' }
 
-      it { should eql "\e[31m- \e[1m[1]\e[0m\e[33m+ \e[1m\"a\"\e[0m" }
+      it { should eql "\e[31m- \e[1m[...]\e[0m\e[33m+ \e[1m\"a\"\e[0m" }
     end
   end
 end
@@ -252,6 +252,40 @@ describe "DiffMatcher::difference(expected, actual, opts)" do
           ]
           Where, - 1 missing, + 1 additional
           EOF
+
+        context "where actual has additional items, it summarizes the Array item with ... and" do
+          expected, same, different =
+            [ 1, 2        ],
+            [ 1, 2, [ 3 ] ],
+            [ 0, 2, [ 3 ] ]
+
+          it_behaves_like "a diff matcher", expected, same, different,
+            <<-EOF, :ignore_additional=>true
+            [
+              - 1+ 0,
+              2,
+            + [...]
+            ]
+            Where, - 1 missing, + 2 additional
+            EOF
+        end
+
+        context "where actual has additional items, it summarizes the Hash item with ... and" do
+          expected, same, different =
+            [ 1, 2                 ],
+            [ 1, 2, { :a=> [ 3 ] } ],
+            [ 0, 2, { :a=> [ 3 ] } ]
+
+          it_behaves_like "a diff matcher", expected, same, different,
+            <<-EOF, :ignore_additional=>true
+            [
+              - 1+ 0,
+              2,
+            + {...}
+            ]
+            Where, - 1 missing, + 2 additional
+            EOF
+        end
       end
 
       context "where actual has missing items" do
@@ -278,6 +312,19 @@ describe "DiffMatcher::difference(expected, actual, opts)" do
           Where, - 1 missing
           EOF
       end
+
+      context "where actual is not an array, it summarizes the diff with ... and" do
+        expected, same, different =
+          [ 1 ],
+          [ 1 ],
+          { 0 => 1 }
+
+        it_behaves_like "a diff matcher", expected, same, different,
+          <<-EOF
+          - [...]+ {...}
+          Where, - 1 missing, + 1 additional
+          EOF
+      end
     end
 
     context "of an Array derived class," do
@@ -323,7 +370,7 @@ describe "DiffMatcher::difference(expected, actual, opts)" do
         Where, - 1 missing, + 1 additional
         EOF
 
-      context "with keys of differing classes" do
+      context "with values of differing classes" do
         expected, same, different =
           { "a"=>{ "b"=>1 } },
           { "a"=>{ "b"=>1 } },
@@ -332,7 +379,7 @@ describe "DiffMatcher::difference(expected, actual, opts)" do
         it_behaves_like "a diff matcher", expected, same, different,
           <<-EOF
           {
-            "a"=>- {"b"=>1}+ ["b", 1]
+            "a"=>- {...}+ [...]
           }
           Where, - 1 missing, + 1 additional
           EOF

metadata

@@ -1,40 +1,32 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: diff_matcher
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 2.3.1
   prerelease: 
-  version: 2.2.3
 platform: ruby
-authors: 
+authors:
 - Playup
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-07-08 00:00:00 Z
+date: 2012-08-02 00:00:00.000000000 +10:00
+default_executable: 
 dependencies: []
-
-description: |
-  DiffMatcher performs recursive matches on values contained in hashes, arrays and combinations thereof.
-  
-  Values in a containing object match when:
-  
-      - actual == expected
-      - actual.is_a? expected  # when expected is a class
-      - expected.match actual  # when expected is a regexp
-      - expected.call actual   # when expected is a proc
-
+description: ! "DiffMatcher performs recursive matches on values contained in hashes,
+  arrays and combinations thereof.\n\nValues in a containing object match when:\n\n
+  \   - actual == expected\n    - actual.is_a? expected  # when expected is a class\n
+  \   - expected.match actual  # when expected is a regexp\n    - expected.call actual
+  \  # when expected is a proc\n"
 email: chris@playup.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .rspec
 - .travis.yml
 - CHANGELOG.md
 - Gemfile
+- Gemfile.lock
 - License.txt
 - README.md
 - Rakefile
@@ -42,40 +34,39 @@ files:
 - diff_matcher.gemspec
 - doc/diff_matcher.gif
 - doc/example_output.png
+- examples/tennis_score.rb
 - lib/diff_matcher.rb
 - lib/diff_matcher/difference.rb
 - lib/diff_matcher/version.rb
 - spec/diff_matcher/difference_spec.rb
 - spec/spec_helper.rb
+has_rdoc: true
 homepage: http://github.com/playup/diff_matcher
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 2610392382067707608
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: -173866385
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.21
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
-summary: Generates a diff by matching against expected values, classes, regexes and/or procs.
+summary: Generates a diff by matching against expected values, classes, regexes and/or
+  procs.
 test_files: []
-