diff_matcher 2.7.0 → 2.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 85c693faa10896940ac3eebf11393668fd78b0e1
-  data.tar.gz: 38be21bd9cd7d420fc53d2a1378156eefcb7c841
+  metadata.gz: 269ffc7ffb370219902eab20adbb33123e12de62
+  data.tar.gz: eeae047d47e866671da62f7fb2f6c5723cf9e935
 SHA512:
-  metadata.gz: 37da42959f13bd42a3c736b959c8f9685bfc0f44f3a14ae330a3586658f71cceefcad2e5ff223bcfd6d1958b0b25b39f6d1efbe631f852dd0e28a1af0abd2ff6
-  data.tar.gz: f2ac31ed19ecdc51f28a0a5ca93a81a4a7d4292a717a770556adc60c43512d763ea00f2c23460216cad04296cb5980f4805958f9459bc956eefe60e970335df3
+  metadata.gz: 826869c482e6c5a60b9b6132e19dd64296be1d7aafa12d66e580d309f624806ee43724bc3cebc2ff78039eca8362e6cde7fe798eba9b351f570b26240ca206cd
+  data.tar.gz: b76a7c7ceec440089b683436969a73b88730a28e670ce0e4565dd79d0f0192f116fae79c4f3bcf1d7dd0a48a5648b29a24b247c66cce5ae1f144601d954a42b3

data/.travis.yml

@@ -10,9 +10,14 @@ rvm:
   - jruby
   - ree
   - 2.0.0
-  - 2.1.1
+  - 2.1
+  - 2.2
+  - 2.3.0
   - ruby-head
 
+before_install:
+  - gem install bundler -v '1.11.2'
+
 matrix:
   fast_finish: true
   allow_failures:

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+### v2.7.1
+
+* Use `failure_message` from RSpec matchers in diff output. (denyago)
+
 ### v2.7.0
 
 * Add rspec custom matcher `be_json_matching` for Rspec v2.x & v3.x

data/README.md

@@ -5,21 +5,23 @@ DiffMatcher
 [![Gem Version](https://badge.fury.io/rb/diff_matcher.png)](http://badge.fury.io/rb/diff_matcher)
 [![Dependency Status](https://gemnasium.com/diff-matcher/diff_matcher.png)](https://gemnasium.com/diff-matcher/diff_matcher)
 [![still maintained](http://stillmaintained.com/diff-matcher/diff_matcher.png)](http://stillmaintained.com/diff-matcher/diff_matcher)
+[![diff_matcher API Documentation](https://www.omniref.com/ruby/gems/diff_matcher.png)](https://www.omniref.com/ruby/gems/diff_matcher)
 
 Generates a diff by matching against user-defined matchers written in ruby.
 
 DiffMatcher matches input data (eg. from a JSON API) against values,
-ranges, classes, regexes, procs, custom matchers and/or easily composed,
+ranges, classes, regexes, procs, custom matchers, RSpec matchers and/or easily composed,
 nested combinations thereof to produce an easy to read diff string.
 
 Actual input values are matched against expected matchers in the following way:
 
 ``` ruby
-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
-actual == expected     # when expected is anything else
-expected.diff actual   # when expected is a built-in DiffMatcher
+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
+expected.matches? actual # when expected implements an RSpec Matcher interface
+actual == expected       # when expected is anything else
+expected.diff actual     # when expected is a built-in DiffMatcher
 ```
 
 Using these building blocks, more complicated nested matchers can be
@@ -200,6 +202,43 @@ puts DiffMatcher::difference(expected, [1, 2.00, "3"])
 # => Where, - 1 missing, + 1 additional, | 2 match_matcher
 ```
 
+When `actual` is matched against some custom logic, an object with an RSpec Matcher
+interface can be used. (NB. `#mathches?(actual)`, `#description` and `#failure_message`
+methods must be implemented.)
+
+So you can use one of the RSpec matchers or you can implement your own.
+
+```ruby
+class BeAWeekend
+  def matches?(day)
+    @day = day
+    %w{Sat Sun}.include?(day)
+  end
+
+  def description
+    'be a weekend day'
+  end
+
+  def failure_message
+    "expected #{@day} to #{description}"
+  end
+end
+
+be_a_weekend = BeAWeekend.new
+puts DiffMatcher::difference(be_a_weekend, 'Mon')
+# => - expected Mon to be a weekend day+ "Mon"
+# => Where, - 1 missing, + 1 additional
+
+
+all_be_weekends = DiffMatcher::AllMatcher.new(be_a_weekend)
+puts DiffMatcher::difference(all_be_weekends, ['Sat', 'Mon'])
+# => [
+# =>   R "Sat" be a weekend day,
+# =>   - expected Mon to be a weekend day+ "Mon"
+# => ]
+# => Where, - 1 missing, + 1 additional, R 1 match_rspec
+```
+
 ### Matcher options
 
 Matcher options can be passed to `DiffMatcher::difference` or `DiffMatcher::Matcher#diff`
@@ -284,6 +323,7 @@ in the following way:
     match matcher => "| "
     match range   => ". "
     match proc    => "{ "
+    match rspec   => "R "
 
 
 #### Colours
@@ -300,6 +340,7 @@ Using the `:default` colour scheme items shown in a difference are coloured as f
     match matcher => blue
     match range   => cyan
     match proc    => cyan
+    match rspec   => cyan
 
 Other colour schemes, eg. `:color_scheme=>:white_background` will use different colour mappings.
 

data/lib/diff_matcher/difference.rb

@@ -88,7 +88,8 @@ module DiffMatcher
         :match_class   => [BLUE  , ":"],
         :match_matcher => [BLUE  , "|"],
         :match_range   => [CYAN  , "."],
-        :match_proc    => [CYAN  , "{"]
+        :match_proc    => [CYAN  , "{"],
+        :match_rspec   => [CYAN  , "R"]
     }
 
     class << self
@@ -186,7 +187,7 @@ module DiffMatcher
       @matches_shown ||= lambda {
         ret = []
         unless @quiet
-          ret += [:match_matcher, :match_class, :match_range, :match_proc, :match_regexp]
+          ret += [:match_matcher, :match_class, :match_range, :match_proc, :match_regexp, :match_rspec]
           ret += [:match_value]
         end
         ret
@@ -273,7 +274,12 @@ module DiffMatcher
         when Range  ; [expected.include?(actual)                      , :match_range  ]
         when Proc   ; [expected.call(actual)                          , :match_proc   ]
         when Regexp ; [actual.is_a?(String) && actual.match(expected) , :match_regexp ]
-        else          [actual == expected                             , :match_value  ]
+        else
+          if expected.respond_to?(:matches?)
+            [expected.matches?(actual), :match_rspec]
+          else
+            [actual == expected, :match_value]
+          end
       end
     end
 
@@ -294,6 +300,7 @@ module DiffMatcher
 
     def match_to_s(expected, actual, match_type)
       actual = match_regexp_to_s(expected, actual) if match_type == :match_regexp
+      actual = "#{actual} #{expected.description}" if match_type == :match_rspec
       markup(match_type, actual) if matches_shown.include?(match_type)
     end
 
@@ -308,6 +315,16 @@ module DiffMatcher
       end
     end
 
+    def summarize_rspec_matcher(matcher)
+      if matcher.respond_to?(:failure_message)
+        matcher.failure_message
+      elsif matcher.respond_to?(:failure_message_for_should)
+        matcher.failure_message_for_should
+      else
+        summarize_item(matcher)
+      end
+    end
+
     def difference_to_s(expected, actual)
       match, match_type, d = match?(expected, actual)
       if match
@@ -316,6 +333,8 @@ module DiffMatcher
         case match_type
         when :match_matcher
           d
+        when :match_rspec
+          "#{markup(:missing, summarize_rspec_matcher(expected))}#{markup(:additional, summarize_item(actual))}"
         else
           exp, act = if [expected, actual].any? { |item| item.is_a?(Proc) }
             [expected, actual].map { |item| item.inspect }

data/lib/diff_matcher/version.rb

@@ -1,3 +1,3 @@
 module DiffMatcher
-  VERSION = "2.7.0"
+  VERSION = "2.7.1"
 end

data/spec/diff_matcher/difference_spec.rb

@@ -470,6 +470,36 @@ describe "DiffMatcher::difference(expected, actual, opts)" do
       end
     end
 
+    context 'a duck-type responding to #matches?' do
+      matchable = Class.new do
+        def initialize(expected)
+          @expected = expected
+        end
+
+        def matches?(actual)
+          actual == @expected
+        end
+
+        def failure_message
+          "the matcher should be eq '#{@expected}'"
+        end
+
+        def description
+          "be eq #{@expected}"
+        end
+      end
+      expected, same, different =
+        matchable.new('foo'),
+        'foo',
+        'bar'
+
+      it_behaves_like "a diff matcher", expected, same, different,
+        <<-EOF
+        - the matcher should be eq 'foo'+ "bar"
+        Where, - 1 missing, + 1 additional
+        EOF
+    end
+
     context "a proc," do
       expected, same, different =
         lambda { |x| [FalseClass, TrueClass].include? x.class },
@@ -654,12 +684,25 @@ describe "DiffMatcher::difference(expected, actual, opts)" do
   end
 
   context "when expected has multiple items," do
+    matchable = Class.new do
+      def initialize(expected)
+        @expected = expected
+      end
+
+      def matches?(actual)
+        actual == @expected
+      end
+
+      def description
+        "be == #{@expected}"
+      end
+    end
     expected, same, different =
-      [ 1,  2, /\d/, Fixnum, 4..6 , lambda { |x| x % 6 == 0 } ],
-      [ 1,  2, "3" , 4     , 5    , 6                         ],
-      [ 0,  2, "3" , 4     , 5    , 6                         ]
+      [ 1,  2, /\d/, Fixnum, 4..6 , lambda { |x| x % 6 == 0 }, matchable.new(7)],
+      [ 1,  2, "3" , 4     , 5    , 6                        , 7               ],
+      [ 0,  2, "3" , 4     , 5    , 6                        , 7               ]
 
-    describe "it shows regex, class, range, proc matches and matches" do
+    describe "it shows regex, class, range, proc matches, matches and RSpec matcher" do
       it_behaves_like "a diff matcher", expected, same, different,
         <<-EOF
         [
@@ -668,9 +711,10 @@ describe "DiffMatcher::difference(expected, actual, opts)" do
           ~ "(3)",
           : 4,
           . 5,
-          { 6
+          { 6,
+          R 7 be == 7
         ]
-        Where, - 1 missing, + 1 additional, ~ 1 match_regexp, : 1 match_class, . 1 match_range, { 1 match_proc
+        Where, - 1 missing, + 1 additional, ~ 1 match_regexp, : 1 match_class, . 1 match_range, { 1 match_proc, R 1 match_rspec
         EOF
     end
 
@@ -693,9 +737,10 @@ describe "DiffMatcher::difference(expected, actual, opts)" do
           ~ "(3)",
           : 4,
           . 5,
-          { 6
+          { 6,
+          R 7 be == 7
         ]
-        Where, - 1 missing, + 1 additional, ~ 1 match_regexp, : 1 match_class, . 1 match_range, { 1 match_proc
+        Where, - 1 missing, + 1 additional, ~ 1 match_regexp, : 1 match_class, . 1 match_range, { 1 match_proc, R 1 match_rspec
         EOF
     end
 
@@ -708,9 +753,10 @@ describe "DiffMatcher::difference(expected, actual, opts)" do
         \e[0m  \e[32m~ \e[0m"\e[32m(\e[1m3\e[0m\e[32m)\e[0m"\e[0m,
         \e[0m  \e[34m: \e[1m4\e[0m,
         \e[0m  \e[36m. \e[1m5\e[0m,
-        \e[0m  \e[36m{ \e[1m6\e[0m
+        \e[0m  \e[36m{ \e[1m6\e[0m,
+        \e[0m  \e[36mR \e[1m7 be == 7\e[0m
         \e[0m]
-        Where, \e[31m- \e[1m1 missing\e[0m, \e[33m+ \e[1m1 additional\e[0m, \e[32m~ \e[1m1 match_regexp\e[0m, \e[34m: \e[1m1 match_class\e[0m, \e[36m. \e[1m1 match_range\e[0m, \e[36m{ \e[1m1 match_proc\e[0m
+        Where, \e[31m- \e[1m1 missing\e[0m, \e[33m+ \e[1m1 additional\e[0m, \e[32m~ \e[1m1 match_regexp\e[0m, \e[34m: \e[1m1 match_class\e[0m, \e[36m. \e[1m1 match_range\e[0m, \e[36m{ \e[1m1 match_proc\e[0m, \e[36mR \e[1m1 match_rspec\e[0m
         EOF
 
       context "on a white background" do
@@ -722,9 +768,10 @@ describe "DiffMatcher::difference(expected, actual, opts)" do
           \e[0m  \e[32m~ \e[0m"\e[32m(\e[1m3\e[0m\e[32m)\e[0m"\e[0m,
           \e[0m  \e[34m: \e[1m4\e[0m,
           \e[0m  \e[36m. \e[1m5\e[0m,
-          \e[0m  \e[36m{ \e[1m6\e[0m
+          \e[0m  \e[36m{ \e[1m6\e[0m,
+          \e[0m  \e[36mR \e[1m7 be == 7\e[0m
           \e[0m]
-          Where, \e[31m- \e[1m1 missing\e[0m, \e[35m+ \e[1m1 additional\e[0m, \e[32m~ \e[1m1 match_regexp\e[0m, \e[34m: \e[1m1 match_class\e[0m, \e[36m. \e[1m1 match_range\e[0m, \e[36m{ \e[1m1 match_proc\e[0m
+          Where, \e[31m- \e[1m1 missing\e[0m, \e[35m+ \e[1m1 additional\e[0m, \e[32m~ \e[1m1 match_regexp\e[0m, \e[34m: \e[1m1 match_class\e[0m, \e[36m. \e[1m1 match_range\e[0m, \e[36m{ \e[1m1 match_proc\e[0m, \e[36mR \e[1m1 match_rspec\e[0m
           EOF
       end
 
@@ -739,9 +786,10 @@ describe "DiffMatcher::difference(expected, actual, opts)" do
           \e[0m  \e[32m~ \e[0m"\e[32m(\e[1m3\e[0m\e[32m)\e[0m"\e[0m,
           \e[0m  \e[34m: \e[1m4\e[0m,
           \e[0m  \e[36m. \e[1m5\e[0m,
-          \e[0m  \e[36m{ \e[1m6\e[0m
+          \e[0m  \e[36m{ \e[1m6\e[0m,
+          \e[0m  \e[36mR \e[1m7 be == 7\e[0m
           \e[0m]
-          Where, \e[31m- \e[1m1 missing\e[0m, \e[33m+ \e[1m1 additional\e[0m, \e[32m~ \e[1m1 match_regexp\e[0m, \e[34m: \e[1m1 match_class\e[0m, \e[36m. \e[1m1 match_range\e[0m, \e[36m{ \e[1m1 match_proc\e[0m
+          Where, \e[31m- \e[1m1 missing\e[0m, \e[33m+ \e[1m1 additional\e[0m, \e[32m~ \e[1m1 match_regexp\e[0m, \e[34m: \e[1m1 match_class\e[0m, \e[36m. \e[1m1 match_range\e[0m, \e[36m{ \e[1m1 match_proc\e[0m, \e[36mR \e[1m1 match_rspec\e[0m
           EOF
       end
 
@@ -756,9 +804,10 @@ describe "DiffMatcher::difference(expected, actual, opts)" do
           \e[0m  \e[32m~ \e[0m"\e[32m(\e[1m3\e[0m\e[32m)\e[0m"\e[0m,
           \e[0m  \e[34m: \e[1m4\e[0m,
           \e[0m  \e[36m. \e[1m5\e[0m,
-          \e[0m  \e[36m{ \e[1m6\e[0m
+          \e[0m  \e[36m{ \e[1m6\e[0m,
+          \e[0m  \e[36mR \e[1m7 be == 7\e[0m
           \e[0m]
-          Where, \e[31m- \e[1m1 missing\e[0m, \e[35m+ \e[1m1 additional\e[0m, \e[32m~ \e[1m1 match_regexp\e[0m, \e[34m: \e[1m1 match_class\e[0m, \e[36m. \e[1m1 match_range\e[0m, \e[36m{ \e[1m1 match_proc\e[0m
+          Where, \e[31m- \e[1m1 missing\e[0m, \e[35m+ \e[1m1 additional\e[0m, \e[32m~ \e[1m1 match_regexp\e[0m, \e[34m: \e[1m1 match_class\e[0m, \e[36m. \e[1m1 match_range\e[0m, \e[36m{ \e[1m1 match_proc\e[0m, \e[36mR \e[1m1 match_rspec\e[0m
           EOF
       end
     end
@@ -778,9 +827,10 @@ describe "DiffMatcher::difference(expected, actual, opts)" do
         \e[0m  \e[32m~ \e[0m"\e[32m(\e[1m3\e[0m\e[32m)\e[0m"\e[0m,
         \e[0m  \e[34m: \e[1m4\e[0m,
         \e[0m  \e[36m. \e[1m5\e[0m,
-        \e[0m  \e[36m{ \e[1m6\e[0m
+        \e[0m  \e[36m{ \e[1m6\e[0m,
+        \e[0m  \e[36mR \e[1m7 be == 7\e[0m
         \e[0m]
-        Where, \e[31m- \e[1m1 missing\e[0m, \e[35m+ \e[1m1 additional\e[0m, \e[32m~ \e[1m1 match_regexp\e[0m, \e[34m: \e[1m1 match_class\e[0m, \e[36m. \e[1m1 match_range\e[0m, \e[36m{ \e[1m1 match_proc\e[0m
+        Where, \e[31m- \e[1m1 missing\e[0m, \e[35m+ \e[1m1 additional\e[0m, \e[32m~ \e[1m1 match_regexp\e[0m, \e[34m: \e[1m1 match_class\e[0m, \e[36m. \e[1m1 match_range\e[0m, \e[36m{ \e[1m1 match_proc\e[0m, \e[36mR \e[1m1 match_rspec\e[0m
         EOF
     end
 
@@ -794,9 +844,10 @@ describe "DiffMatcher::difference(expected, actual, opts)" do
           <span style=\"color:green\">~ </b></span>\"<span style=\"color:green\">(<b>3</b></span><span style=\"color:green\">)</b></span>\"</b></span>,
           <span style=\"color:blue\">: <b>4</b></span>,
           <span style=\"color:cyan\">. <b>5</b></span>,
-          <span style=\"color:cyan\">{ <b>6</b></span>
+          <span style=\"color:cyan\">{ <b>6</b></span>,
+          <span style=\"color:cyan\">R <b>7 be == 7</b></span>
         ]
-        Where, <span style=\"color:red\">- <b>1 missing</b></span>, <span style=\"color:magenta\">+ <b>1 additional</b></span>, <span style=\"color:green\">~ <b>1 match_regexp</b></span>, <span style=\"color:blue\">: <b>1 match_class</b></span>, <span style=\"color:cyan\">. <b>1 match_range</b></span>, <span style=\"color:cyan\">{ <b>1 match_proc</b></span>
+        Where, <span style=\"color:red\">- <b>1 missing</b></span>, <span style=\"color:magenta\">+ <b>1 additional</b></span>, <span style=\"color:green\">~ <b>1 match_regexp</b></span>, <span style=\"color:blue\">: <b>1 match_class</b></span>, <span style=\"color:cyan\">. <b>1 match_range</b></span>, <span style=\"color:cyan\">{ <b>1 match_proc</b></span>, <span style=\"color:cyan\">R <b>1 match_rspec</b></span>
         </pre>
         EOF
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: diff_matcher
 version: !ruby/object:Gem::Version
-  version: 2.7.0
+  version: 2.7.1
 platform: ruby
 authors:
 - locochris
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-30 00:00:00.000000000 Z
+date: 2016-03-02 00:00:00.000000000 Z
 dependencies: []
 description: |
   DiffMatcher matches input data (eg. from a JSON API) against values,
@@ -66,7 +66,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.2
+rubygems_version: 2.2.5
 signing_key: 
 specification_version: 4
 summary: Generates a diff by matching against user-defined matchers written in ruby.
@@ -74,3 +74,4 @@ test_files:
 - spec/diff_matcher/difference_spec.rb
 - spec/diff_matcher/rspec/matchers/diff_matcher_spec.rb
 - spec/spec_helper.rb
+has_rdoc: