diff_matcher 1.0.1 → 2.0.0

data/README.md

@@ -2,6 +2,7 @@ DiffMatcher
 ===
 
 [![build status](http://travis-ci.org/playup/diff_matcher.png)](http://travis-ci.org/playup/diff_matcher)
+[![still maintained](http://stillmaintained.com/playupchris/diff_matcher.png)](http://stillmaintained.com/playupchris/diff_matcher)
 
 Generates a diff by matching against expected values, classes, regexes and/or procs.
 
@@ -9,10 +10,24 @@ DiffMatcher performs recursive matches on values contained in hashes, arrays and
 
 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
+``` 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
+```
+
+Example:
+
+``` ruby
+    puts DiffMatcher::difference(
+      { :a=>{ :a1=>11          }, :b=>[ 21, 22 ], :c=>/\d/, :d=>Fixnum, :e=>lambda { |x| (4..6).include? x } },
+      { :a=>{ :a1=>10, :a2=>12 }, :b=>[ 21     ], :c=>'3' , :d=>4     , :e=>5                                },
+      :color_scheme=>:white_background
+    )
+```
+
+![example output](https://raw.github.com/playup/diff_matcher/master/doc/diff_matcher.gif)
 
 
 Installation
@@ -84,7 +99,7 @@ puts DiffMatcher::difference([1], [1, 2])
 # => [
 # => + 2
 # => ]
-# => Where, - 1 additional
+# => Where, + 1 additional
 ```
 
 ### Options
@@ -96,7 +111,7 @@ p DiffMatcher::difference([1], [1, 2], :ignore_additional=>true)
 # => nil
 ```
 
-`:verbose=>true` shows only missing and additional items in the output
+`:quiet=>true` shows only missing and additional items in the output
 
 ``` ruby
 puts DiffMatcher::difference([Fixnum, 2], [1], :quiet=>true)
@@ -106,21 +121,8 @@ puts DiffMatcher::difference([Fixnum, 2], [1], :quiet=>true)
 # => Where, - 1 missing
 ```
 
-`:verbose=>true` shows all matched items in the output
-
-``` ruby
-puts DiffMatcher::difference([Fixnum, 2], [1], :verbose=>true)
-# => [
-# = >  : 1,
-# => - 2
-# => ]
-# => Where, - 1 missing, : 1 match_class
-```
-
 #### Prefixes
 
-NB. The `: 1` from above includes a `:` prefix that shows the `1` was matched against a class (ie. `Fixnum`)
-
 The items shown in a difference are prefixed as follows:
 
     missing       => "- "
@@ -130,6 +132,7 @@ The items shown in a difference are prefixed as follows:
     match class   => ": "
     match proc    => "{ "
 
+
 #### Colours
 
 Colours (defined in colour schemes) can also appear in the difference.
@@ -143,19 +146,9 @@ Using the `:default` colour scheme items shown in a difference are coloured as f
     match class   => blue
     match proc    => cyan
 
+Other colour schemes, eg. `:color_scheme=>:white_background` will use different colour mappings.
 
-`:color_scheme=>:white_background` shows difference as follows
-
-``` ruby
-    puts DiffMatcher::difference(
-      { :a=>{ :a1=>11          }, :b=>[ 21, 22 ], :c=>/\d/, :d=>Fixnum, :e=>lambda { |x| (4..6).includes? x },
-      { :a=>{ :a1=>10, :a2=>12 }, :b=>[ 21     ], :c=>'3' , :d=>4     , :e=>5                               },
-      :verbose=>true, :color_scheme=>:white_background
-    )
-```
-
-![example output](https://raw.github.com/playup/diff_matcher/master/doc/example_output.png)
-
+  
 
 Similar gems
 ---

data/lib/diff_matcher/difference.rb

@@ -40,7 +40,6 @@ module DiffMatcher
     def initialize(expected, actual, opts={})
       @ignore_additional = opts[:ignore_additional]
       @quiet             = opts[:quiet]
-      @verbose           = opts[:verbose]
       @color_enabled     = opts[:color_enabled] || !!opts[:color_scheme]
       @color_scheme      = COLOR_SCHEMES[opts[:color_scheme] || :default]
       @difference = difference(expected, actual)
@@ -89,7 +88,7 @@ module DiffMatcher
         ret = []
         unless @quiet
           ret += [:match_class, :match_proc, :match_regexp]
-          ret += [:match_value] if @verbose
+          ret += [:match_value]
         end
         ret
       }.call

data/lib/diff_matcher/version.rb

@@ -1,3 +1,3 @@
 module DiffMatcher
-  VERSION = "1.0.1"
+  VERSION = "2.0.0"
 end

data/spec/diff_matcher/difference_spec.rb

@@ -12,10 +12,10 @@ def fix_EOF_problem(s)
   s.gsub("\n#{" " * indentation}", "\n").strip
 end
 
-describe DiffMatcher do
+describe "DiffMatcher::difference(expected, actual, opts)" do
   subject { DiffMatcher::difference(expected, actual, opts) }
 
-  shared_examples_for "a differ" do |expected, same, different, difference, opts|
+  shared_examples_for "a diff matcher" do |expected, same, different, difference, opts|
     opts ||= {}
     context "with #{opts.size > 0 ? opts_to_s(opts) : "no opts"}" do
       describe "difference(#{expected.inspect}, #{same.inspect}#{opts_to_s(opts)})" do
@@ -26,7 +26,7 @@ describe DiffMatcher do
         it { should be_nil }
       end
 
-      describe "#new(#{expected.inspect}, #{different.inspect}#{opts_to_s(opts)})" do
+      describe "difference(#{expected.inspect}, #{different.inspect}#{opts_to_s(opts)})" do
         let(:expected) { expected  }
         let(:actual  ) { different }
         let(:opts    ) { opts      }
@@ -48,7 +48,7 @@ describe DiffMatcher do
         1,
         2
 
-      it_behaves_like "a differ", expected, same, different,
+      it_behaves_like "a diff matcher", expected, same, different,
         <<-EOF, {}
         - 1+ 2
         Where, - 1 missing, + 1 additional
@@ -61,7 +61,7 @@ describe DiffMatcher do
         "a",
         "b"
 
-      it_behaves_like "a differ", expected, same, different,
+      it_behaves_like "a diff matcher", expected, same, different,
         <<-EOF, {}
         - "a"+ "b"
         Where, - 1 missing, + 1 additional
@@ -70,7 +70,7 @@ describe DiffMatcher do
       context "when actual is of a different class" do
         different = 0
 
-        it_behaves_like "a differ", expected, same, different,
+        it_behaves_like "a diff matcher", expected, same, different,
           <<-EOF, {}
           - "a"+ 0
           Where, - 1 missing, + 1 additional
@@ -80,7 +80,7 @@ describe DiffMatcher do
       context "when actual is nil" do
         different = nil
 
-        it_behaves_like "a differ", expected, same, different,
+        it_behaves_like "a diff matcher", expected, same, different,
           <<-EOF, {}
           - "a"+ nil
           Where, - 1 missing, + 1 additional
@@ -94,7 +94,7 @@ describe DiffMatcher do
         nil,
         false
 
-      it_behaves_like "a differ", expected, same, different,
+      it_behaves_like "a diff matcher", expected, same, different,
         <<-EOF, {}
         - nil+ false
         Where, - 1 missing, + 1 additional
@@ -107,7 +107,7 @@ describe DiffMatcher do
         [ 1 ],
         [ 2 ]
 
-      it_behaves_like "a differ", expected, same, different,
+      it_behaves_like "a diff matcher", expected, same, different,
         <<-EOF, {}
         [
           - 1+ 2
@@ -121,32 +121,23 @@ describe DiffMatcher do
           [ 1, 2, 3 ],
           [ 0, 2, 3 ]
 
-        it_behaves_like "a differ", expected, same, different,
+        it_behaves_like "a diff matcher", expected, same, different,
           <<-EOF, :ignore_additional=>true
           [
             - 1+ 0,
+            2,
           + 3
           ]
           Where, - 1 missing, + 2 additional
           EOF
 
-        it_behaves_like "a differ", expected, same, different,
+        it_behaves_like "a diff matcher", expected, same, different,
           <<-EOF, :ignore_additional=>true, :quiet=>true
           [
             - 1+ 0
           ]
           Where, - 1 missing, + 1 additional
           EOF
-
-        it_behaves_like "a differ", expected, same, different,
-          <<-EOF, :ignore_additional=>true, :verbose=>true
-          [
-            - 1+ 0,
-            2,
-          + 3
-          ]
-          Where, - 1 missing, + 2 additional
-          EOF
       end
 
       context "where actual has missing items" do
@@ -155,16 +146,16 @@ describe DiffMatcher do
           [ 1, 2, 3 ],
           [ 1, 2    ]
 
-        it_behaves_like "a differ", expected, same, different,
-          <<-EOF, {}
+        it_behaves_like "a diff matcher", expected, same, different,
+          <<-EOF, { :quiet => true }
           [
           - 3
           ]
           Where, - 1 missing
           EOF
 
-        it_behaves_like "a differ", expected, same, different,
-          <<-EOF, :verbose=>true
+        it_behaves_like "a diff matcher", expected, same, different,
+          <<-EOF
           [
             1,
             2,
@@ -181,8 +172,8 @@ describe DiffMatcher do
         { "a"=>1 },
         { "a"=>2 }
 
-      it_behaves_like "a differ", expected, same, different,
-        <<-EOF, {}
+      it_behaves_like "a diff matcher", expected, same, different,
+        <<-EOF
         {
           "a"=>- 1+ 2
         }
@@ -195,8 +186,8 @@ describe DiffMatcher do
           { "a"=>{ "b"=>1 } },
           { "a"=>[ "b", 1 ] }
 
-        it_behaves_like "a differ", expected, same, different,
-          <<-EOF, {}
+        it_behaves_like "a diff matcher", expected, same, different,
+          <<-EOF
           {
             "a"=>- {"b"=>1}+ ["b", 1]
           }
@@ -211,8 +202,8 @@ describe DiffMatcher do
           {        "b"=>{ "c"=>1 }   }
 
         describe "it won't match the descendents" do
-          it_behaves_like "a differ", expected, same, different,
-            <<-EOF, {}
+          it_behaves_like "a diff matcher", expected, same, different,
+            <<-EOF
             {
             - "a"=>{"b"=>{"c"=>1}},
             + "b"=>{"c"=>1}
@@ -231,8 +222,8 @@ describe DiffMatcher do
         "a",
         1
 
-      it_behaves_like "a differ", expected, same, different,
-        <<-EOF, {}
+      it_behaves_like "a diff matcher", expected, same, different,
+        <<-EOF
         - String+ 1
         Where, - 1 missing, + 1 additional
         EOF
@@ -246,8 +237,8 @@ describe DiffMatcher do
         "a",
         "A"
 
-      it_behaves_like "a differ", expected, same, different,
-        <<-EOF, {}
+      it_behaves_like "a diff matcher", expected, same, different,
+        <<-EOF
         - /[a-z]/+ "A"
         Where, - 1 missing, + 1 additional
         EOF
@@ -255,8 +246,8 @@ describe DiffMatcher do
       context "and when actual is not a String," do
         different = :a
 
-        it_behaves_like "a differ", expected, same, different,
-          <<-EOF, {}
+        it_behaves_like "a diff matcher", expected, same, different,
+          <<-EOF
           - /[a-z]/+ :a
           Where, - 1 missing, + 1 additional
           EOF
@@ -271,7 +262,7 @@ describe DiffMatcher do
         true,
         "true"
 
-      it_behaves_like "a differ", expected, same, different,
+      it_behaves_like "a diff matcher", expected, same, different,
         /- #<Proc.*?>\+ \"true\"\nWhere, - 1 missing, \+ 1 additional/
     end
   end
@@ -282,11 +273,12 @@ describe DiffMatcher do
       [ 1,  2, "3" , 4     , 5                                ],
       [ 0,  2, "3" , 4     , 5                                ]
 
-    describe "it shows regex, class, proc matches and" do
-      it_behaves_like "a differ", expected, same, different,
-        <<-EOF, {}
+    describe "it shows regex, class, proc matches and matches" do
+      it_behaves_like "a diff matcher", expected, same, different,
+        <<-EOF
         [
           - 1+ 0,
+          2,
           ~ (3),
           : 4,
           { 5
@@ -295,8 +287,8 @@ describe DiffMatcher do
         EOF
     end
 
-    describe "it doesn't show matches and" do
-      it_behaves_like "a differ", expected, same, different,
+    describe "it doesn't show matches" do
+      it_behaves_like "a diff matcher", expected, same, different,
         <<-EOF, :quiet=>true
         [
           - 1+ 0
@@ -305,9 +297,9 @@ describe DiffMatcher do
         EOF
     end
 
-    describe "it shows all matches and" do
-      it_behaves_like "a differ", expected, same, different,
-        <<-EOF ,:verbose=>true
+    describe "it shows all matches" do
+      it_behaves_like "a diff matcher", expected, same, different,
+        <<-EOF
         [
           - 1+ 0,
           2,
@@ -319,9 +311,9 @@ describe DiffMatcher do
         EOF
     end
 
-    describe "it shows matches in color and" do
-      it_behaves_like "a differ", expected, same, different,
-        <<-EOF ,:verbose=>true, :color_scheme=>:default
+    describe "it shows matches in color" do
+      it_behaves_like "a diff matcher", expected, same, different,
+        <<-EOF , :color_scheme=>:default
         \e[0m[
         \e[0m  \e[31m- \e[1m1\e[0m\e[33m+ \e[1m0\e[0m,
         \e[0m  2,
@@ -333,8 +325,8 @@ describe DiffMatcher do
         EOF
 
       context "on a white background" do
-        it_behaves_like "a differ", expected, same, different,
-          <<-EOF ,:verbose=>true, :color_scheme=>:white_background
+        it_behaves_like "a diff matcher", expected, same, different,
+          <<-EOF , :color_scheme=>:white_background
           \e[0m[
           \e[0m  \e[31m- \e[1m1\e[0m\e[35m+ \e[1m0\e[0m,
           \e[0m  2,

metadata

@@ -2,7 +2,7 @@
 name: diff_matcher
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.0.1
+  version: 2.0.0
 platform: ruby
 authors: 
 - Playup
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-21 00:00:00 +10:00
+date: 2011-11-18 00:00:00 +11:00
 default_executable: 
 dependencies: []
 
@@ -39,6 +39,7 @@ files:
 - README.md
 - Rakefile
 - diff_matcher.gemspec
+- doc/diff_matcher.gif
 - doc/example_output.png
 - lib/diff_matcher.rb
 - lib/diff_matcher/difference.rb
@@ -59,7 +60,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 245833137
+      hash: 465980701
       segments: 
       - 0
       version: "0"