check_please 0.5.5 → 0.5.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c80defc851cfda5e74a5590da7be40388643084c1e06818639685bfe05e8a46
-  data.tar.gz: fe1a9a3b8be29b8e148917ed19052ae2d0195218624b0bf195421cc29c83c20b
+  metadata.gz: 9c5a664d82f1f1d267e0e45d5e259f6443e23f19d2d53aafdeca8a908984d6fe
+  data.tar.gz: 9296b3b4c859c7e07d96991dbaaaaf48ae005ac9c4c09d9be9353b85f668f33b
 SHA512:
-  metadata.gz: 0b70a2c80630b51d789327c36e9b288aa2484d2b80cc888f5e8a94acf6bed1d7eef67c659f7ac17a9e7ed6c14aacc8cad9c18414881b2cfe07bf4e96aaad785e
-  data.tar.gz: 2cde0b422e2ae297517680f2408201b3f7c88e2e1f81da667d2c875dfddd31b544bef57864dff3ac8739be01b09676e5fd22ff1cbb54677e64f791ff606d3a05
+  metadata.gz: f5e0293242c66c30aa1f093d78427183263e9be492577e081a8daa810e16250827401c7ee81e1764dcade73fd7934932430595f14ea9aecb5bf67219d2422124
+  data.tar.gz: 4bbe14148472e8c49d0af0a6b7eaf2ee3acd7f29ec26af23fd6f2fd23181ce5510886773a835474d0e53102d9c360702a3a5de90311ccb38bb552e0982055ced

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    check_please (0.5.5)
+    check_please (0.5.6)
       table_print
 
 GEM

data/README.md

@@ -22,6 +22,7 @@ structures parsed from either of those.
          * [Repeatable Flags](#repeatable-flags)
          * [Expanded Documentation for Specific Flags](#expanded-documentation-for-specific-flags)
             * [Flag: match_by_key](#flag-match_by_key)
+            * [Flag: normalize_values](#flag-normalize_values)
    * [TODO (maybe)](#todo-maybe)
    * [Development](#development)
    * [Contributing](#contributing)
@@ -420,6 +421,37 @@ the following path expression: `/authors/id=1/books/isbn=12345`
 **This syntax is intended to be readable by humans first.**  If you need to
 build tooling that consumes it... well, I'm open to suggestions.  :)
 
+#### Flag: `normalize_values`
+
+NOTE: This flag is only accessible via the Ruby API.
+(I have no idea how to reasonably express it in a CLI flag.)
+
+Before comparing values at specified paths, normalize both values using
+the provided message or Proc.
+
+To use an example from the tests, the following reference/candidate pair would
+normally create three "mismatch" diffs:
+
+```ruby
+  ref = { list: [ "foo", "bar", "yak" ] }
+  can = { list: [ :foo,  :bar,  :yak ] }
+```
+
+However, the values can be converted to String before comparison via any of the following:
+
+```ruby
+  CheckPlease.diff(ref, can, normalize_values: { "/list/*" => ->(v) { v.to_s } })
+  CheckPlease.diff(ref, can, normalize_values: { "/list/*" => :to_s })
+  CheckPlease.diff(ref, can, normalize_values: { "/list/*" => "to_s" })
+```
+
+Note that the value of the flag is a Hash.
+* Its keys must be strings representing path expressions.
+* If the value associated with a given path is a lambda/proc, it will be
+  called with both the reference value and the candidate value.
+* If the value is a String or Symbol, it will be sent as a message to
+  both the reference and candidate values using Object#send.
+
 -----
 
 # TODO (maybe)

data/lib/check_please.rb

@@ -177,4 +177,9 @@ module CheckPlease
     EOF
   end
 
+  Flags.define :normalize_values do |flag|
+    # NOTE: This flag is only accessible via the Ruby API.
+    #       See the README for documentation.
+  end
+
 end

data/lib/check_please/comparison.rb

@@ -210,14 +210,36 @@ module CheckPlease
         end
 
       def compare_others(ref, can, path)
-        if flags.indifferent_values
-          ref = stringify_symbol(ref)
-          can = stringify_symbol(can)
-        end
+        ref = normalize_value(path, ref)
+        can = normalize_value(path, can)
+
         return if ref == can
         record_diff ref, can, path, :mismatch
       end
 
+        def normalize_value(path, value)
+          if flags.indifferent_values
+            value = stringify_symbol(value)
+          end
+
+          if flags.normalize_values
+            # We assume that normalize_values is a hash of path expression strings to a proc, string, or symbol that will be used to normalize the value
+            _, normalizer = flags.normalize_values.detect { |path_string, a_proc|
+              path.match?(path_string)
+            }
+
+            case normalizer
+            when nil            ; value
+            when Proc           ; normalizer.call(value)
+            when String, Symbol ; value.send(normalizer)
+            else                ; raise ArgumentError, "Not sure how to use #{normalizer.inspect} to normalize #{value.inspect}"
+            end
+          else
+            return value
+          end
+
+        end
+
     def record_diff(ref, can, path, type)
       diff = Diff.new(type, path, ref, can)
       diffs << diff

data/lib/check_please/version.rb

@@ -1,5 +1,5 @@
 module CheckPlease
   # NOTE: 'check_please_rspec_matcher' depends on this,
   #       so try to keep them roughly in sync
-  VERSION = "0.5.5" # about to release? rerun `bundle lock` to update Gemfile.lock
+  VERSION = "0.5.6" # about to release? rerun `bundle lock` to update Gemfile.lock
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: check_please
 version: !ruby/object:Gem::Version
-  version: 0.5.5
+  version: 0.5.6
 platform: ruby
 authors:
 - Sam Livingston-Gray
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-11 00:00:00.000000000 Z
+date: 2021-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: table_print