check_please_rspec_matcher 0.2.5 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 330750259cb547b825013c8c36ce00143a7681397388f8441725b0bab1535e24
-  data.tar.gz: 7144c7d1e8253991f5d1060be38a57ba181b43bbe7c0e9ab817fc6c789a1566a
+  metadata.gz: 1fc284d1a6c957f037446c6dea6a5e9d38076aafce1b1e64db1f23bf7c536489
+  data.tar.gz: 793fa3a941bf7bb8082d2abc53199048c07a61176c6e750a02b4bd60da0eebce
 SHA512:
-  metadata.gz: 18911a11e12733a422e8ea42c8f53937f341f6b374435f5c41d5cb9149eed437cc53554dd74dd17d80d269c57fd52b3facc1b624ab5032f9844fbbfa6eb9139f
-  data.tar.gz: fddbeff00feaa96bf40944a6033c910687ff98a4640021bb326a7cc4d5800014fe2c2a731c16188c103637ad3626c47e0a10822175cefa4646524c813c274468
+  metadata.gz: 11b1e79a81469c563650504a75fd31a3957bde72ec27feb4fadd757c0c59dc45d1038f0b9dbfa53ac8dbfa6c1d439b4d798bd8a8440f891e976c4a36934d9d86
+  data.tar.gz: 597a273f2c326d01ef35427805761334144afba1a8bcc0d0c59e42a5e14eccecb4847995c9f54e95d5a2fb223c7c5ee17c32d7aa8782e25edba18b45b5588bf4

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    check_please_rspec_matcher (0.2.5)
-      check_please (~> 0.2.4)
+    check_please_rspec_matcher (0.5.1)
+      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", "~> 0.2.4" # NOTE: this should *usually* correspond with this gem's VERSION constant
+  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,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.2.5"
+  VERSION = "0.5.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: check_please_rspec_matcher
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.5.1
 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