check_please_rspec_matcher 0.3.0 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2569d6fdbb53fd05080c37c98327514a11ac997775d26df068b3e472ebc25efb
-  data.tar.gz: 1f4f69b52c7b9e505b66abb21aecb054ab5ba9e3f4b6e2c700609a701b49ec51
+  metadata.gz: 4805b31a16927ec62b4f5347d29cc40a2e2f79aa2e9ebfd6c5323cbf6805358d
+  data.tar.gz: d030a63536aa185a0513705b2a4a7367f3a788546e47cd9a6c630dcf1a012e3b
 SHA512:
-  metadata.gz: be70d5dadf909d44d7c6b62a03cf46658e161c0c23749636dddd200d3922240cb4284ee35751ea920c0caa9eef40095d20868d5932ad03c9628bd833ae5e4901
-  data.tar.gz: abf4fbb597787941a70d5ce89cf9f78d1f47157c8da731759369226372fce8e295e42c6300060c06a18f9ffc9af884e8ce80b9869ad07a7ded33234367a3bfbe
+  metadata.gz: '049586b53390fd7d2f4ecfdc889cf3efa74cc8f9027e25ed5fcf130338f6da483a0bfc3d42423ce541dbb19b3b3a806b5123f7019feedc8ca14389f605a5ce54'
+  data.tar.gz: f5f218d15b7087a9bb84e394234489a9b9e0302cb85ec3629de1ee1c06a74a6496a35c5beba94d73cb40495c4096cb8404139f73924ebe9c4b668b630a2ef39f

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    check_please_rspec_matcher (0.3.0)
-      check_please (~> 0.3.0)
+    check_please_rspec_matcher (0.5.2)
+      check_please (~> 0.5.0)
       rspec (~> 3.9)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    check_please (0.3.0)
+    check_please (0.5.3)
       table_print
     diff-lcs (1.4.4)
     rake (12.3.3)

data/README.md

@@ -5,6 +5,13 @@ structures parsed from them).  Most of the heavy lifting is done by the
 [check_please](https://github.com/RealGeeks/check_please) gem; this is merely
 an RSpec wrapper that I didn't want to include in the main gem.
 
+## See Also
+
+If you'd like more control over the output formatting, and especially if you'd
+like to provide custom logic for diffing your own classes, you might be better
+served by the [super_diff](https://github.com/mcmire/super_diff) gem.  Check it
+out!
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -48,12 +55,16 @@ mismatch | /foo | 42        | 43
 
 ### Options
 
-The `check_please` helper method currently accepts a single keyword argument:
+The `check_please` helper method accepts keyword arguments that correspond to
+the flags defined in the CheckPlease gem.  I haven't documented these yet, but
+if you feel like reading some source code, search [this
+file](https://github.com/RealGeeks/check_please/blob/main/lib/check_please.rb)
+for `Flags.define`.
 
 ```ruby
 reference = '{ "foo": 42 }'
 candidate = '{ "foo": 43 }'
-expect( candidate ).to check_please( reference, format_diffs: :json )
+expect( candidate ).to check_please( reference, format: :json )
 ```
 
 Using `:json` as above will output the diffs in JSON instead of a table:

data/check_please_rspec_matcher.gemspec

@@ -25,6 +25,6 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "check_please", "~> 0.3.0" # NOTE: this should *usually* correspond with this gem's VERSION constant
+  spec.add_dependency "check_please", "~> 0.5.0" # NOTE: this should *usually* correspond with this gem's VERSION constant
   spec.add_dependency "rspec", "~> 3.9"
 end

data/lib/check_please_rspec_matcher/matcher.rb

@@ -3,15 +3,15 @@ require 'check_please'
 module CheckPleaseRspecMatcher
 
   module RSpecHelper
-    def check_please(expected, format_diffs: nil)
-      CheckPleaseRspecMatcher::Matcher.new(expected, format_diffs: format_diffs)
+    def check_please(expected, flags = {})
+      ::CheckPleaseRspecMatcher::Matcher.new(expected, flags)
     end
   end
 
   class Matcher
-    def initialize(expected, opts = {})
+    def initialize(expected, flags = {})
       @expected = expected
-      @opts = opts || {}
+      @flags = flags || {}
     end
 
     def matches?(actual)
@@ -20,20 +20,20 @@ module CheckPleaseRspecMatcher
     end
 
     def failure_message
-      format = opts[:format_diffs]
-      diff_text = CheckPlease::Printers.render(diffs, format: format)
+      diff_text = ::CheckPlease::Printers.render(diffs, flags)
+      count = diffs.length == 1 ? "1 diff" : "#{diffs.length} diffs"
       <<~EOF
-        Expected two JSON data structures to match, but found the following diffs:
+        Expected two JSON data structures to match, but found the following #{count}:
 
         #{diff_text}
       EOF
     end
 
     private
-    attr_reader :expected, :opts, :actual
+    attr_reader :expected, :flags, :actual
 
     def diffs
-      @_diffs ||= ::CheckPlease.diff(@expected, @actual)
+      @_diffs ||= ::CheckPlease.diff(expected, actual, flags)
     end
   end
 

data/lib/check_please_rspec_matcher/version.rb

@@ -1,4 +1,4 @@
 module CheckPleaseRspecMatcher
   # NOTE: don't forget to change the dependency on the 'check_please' gem in the .gemspec file
-  VERSION = "0.3.0"
+  VERSION = "0.5.2" # about to release? rerun `bundle lock` to update Gemfile.lock
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: check_please_rspec_matcher
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.2
 platform: ruby
 authors:
 - Sam Livingston-Gray
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-19 00:00:00.000000000 Z
+date: 2021-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: check_please
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement