check_please_rspec_matcher 0.2.4 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94fc21b277f06b61034bac5bf57bdc1f03a8df30141fdd6c7a548f8b62418bf8
-  data.tar.gz: e23cc3d6eb461067ddaf2c5aa52fdb77e937719ad897cdca8d354d9b74632e10
+  metadata.gz: 226a0cec769389fa71dff70198d182eca4236c8dfa4632a55a9e8e95a701eeda
+  data.tar.gz: 821a5d101352198d209c5514b33a0b5b4751332b254770076679efa13b10bb48
 SHA512:
-  metadata.gz: 64a8f6d12146546e3db0fecaf6eb729565d3005fc390b8cb34a15d40ae2e383512726c9a506b3c827a5cd2f1a80ff890282f646c5c3fe143ef4528b74a02a754
-  data.tar.gz: 55977844dae06e9bbb5e344c650474558400942fd80f863b8ec909c41d3952a41d07768d10ae20620492d8426d880736c34aeea92feee7cfab0ac0df5bd5ff1f
+  metadata.gz: c9c77624663653ebf8e17591caa9dc1a63695bee73e3f57e1a9a66ae4945e03101ae04574996a83a0348335b1bc2c898fa373cec4a5f1547146dca2d7ea468e5
+  data.tar.gz: b613778045fe1dd43b5ff811a8bc5fedcffad74103d0b511f3966d0b1ddce0431f4e082e9399932ca9b07f30818f85e54305e1d970d0e05febb8d7f5fb8539c2

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    check_please_rspec_matcher (0.2.4)
-      check_please (~> 0.2.4)
+    check_please_rspec_matcher (0.5.0)
+      check_please (~> 0.4.1)
       rspec (~> 3.9)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    check_please (0.2.4)
+    check_please (0.4.1)
       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", "~> #{CheckPleaseRspecMatcher::VERSION}" # this may turn out to be a bad idea?
+  spec.add_dependency "check_please", "~> 0.4.1" # 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,8 +20,7 @@ module CheckPleaseRspecMatcher
     end
 
     def failure_message
-      format = opts[:format_diffs]
-      diff_text = CheckPlease::Printers.render(diffs, format)
+      diff_text = ::CheckPlease::Printers.render(diffs, flags)
       <<~EOF
         Expected two JSON data structures to match, but found the following diffs:
 
@@ -30,10 +29,10 @@ module CheckPleaseRspecMatcher
     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: the gemspec declares its dependency on 'check_please' as '~>' to this
-  VERSION = "0.2.4"
+  # NOTE: don't forget to change the dependency on the 'check_please' gem in the .gemspec file
+  VERSION = "0.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: check_please_rspec_matcher
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.5.0
 platform: ruby
 authors:
 - Sam Livingston-Gray
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-18 00:00:00.000000000 Z
+date: 2020-11-30 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.2.4
+        version: 0.4.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.4
+        version: 0.4.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement