check_please 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d25dd7c99923b45110f0bfb0903006414f50a60f89e0e3f4385487a3cf11d68b
-  data.tar.gz: c1e4457594ba8f1234692a431acf859f9f708e26e14512c2c7a348359ef0ab04
+  metadata.gz: c39ef90c83a488ddfa309002bfad243cbfe2415481aa0d82e3efd7119be7e420
+  data.tar.gz: 54deb528cb61709484f86b11b4601e54770a6ce9a2a4694905eb7dcd3cceebd7
 SHA512:
-  metadata.gz: 38b21a94a84943dabc03fda78f8054b36340363a932e53754a437f8a813cfa72fbd04d232d924a16e3897dab019951b35bc47e03f6f46aa0deaea050d64553b4
-  data.tar.gz: 45bedfd9641c128f1e0f21c308f323fa497ef0bf0c91e255fe3e0afde528a90e2e84c15103de32ed1020fd0a71862b143d812bce498570394d9be37fcd9aea17
+  metadata.gz: 2ab7404049194c7b70bf86b2ac4a3edc765e50b1ae63a2725e8877e67b1e49735a607f29f486414892a77d4fe604d8361db0b3bd6669b6c067e7ba90838c00bc
+  data.tar.gz: 97fd7e608cac462e278601372d79a3e9fdee8013f3a13912078aad3d86cf875ce4724f68902282433df9a8fcee314c206414e473b9026c30b06e77c271b34393

data/Gemfile.lock

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

data/lib/check_please.rb

@@ -143,4 +143,24 @@ module CheckPlease
     EOF
   end
 
+  Flags.define :indifferent_keys do |flag|
+    flag.default = false
+    flag.coerce { |value| !!value }
+
+    flag.cli_long = "--indifferent-keys"
+    flag.description = <<~EOF
+      When comparing hashes, convert symbol keys to strings
+    EOF
+  end
+
+  Flags.define :indifferent_values do |flag|
+    flag.default = false
+    flag.coerce { |value| !!value }
+
+    flag.cli_long = "--indifferent-values"
+    flag.description = <<~EOF
+      When comparing values (that aren't arrays or hashes), convert symbols to strings
+    EOF
+  end
+
 end

data/lib/check_please/comparison.rb

@@ -22,7 +22,7 @@ module CheckPlease
     def compare(ref, can, path)
       return if path.excluded?(flags)
 
-      case types(ref, can)
+      case types_for_compare(ref, can)
       when [ :array, :array ] ; compare_arrays ref, can, path
       when [ :hash,  :hash  ] ; compare_hashes ref, can, path
       when [ :other, :other ] ; compare_others ref, can, path
@@ -31,7 +31,7 @@ module CheckPlease
       end
     end
 
-      def types(*list)
+      def types_for_compare(*list)
         list.map { |e|
           case e
           when Array ; :array
@@ -52,6 +52,7 @@ module CheckPlease
         def compare_arrays_by_key(ref_array, can_array, path, key_name)
           refs_by_key = index_array!(ref_array, path, key_name, "reference")
           cans_by_key = index_array!(can_array, path, key_name, "candidate")
+
           key_values = (refs_by_key.keys | cans_by_key.keys)
 
           key_values.compact! # NOTE: will break if nil is ever used as a key (but WHO WOULD DO THAT?!)
@@ -79,6 +80,10 @@ module CheckPlease
                   "The element at position #{i} in the #{ref_or_can} array is not a hash."
               end
 
+              if flags.indifferent_keys
+                h = stringify_symbol_keys(h)
+              end
+
               # try to get the value of the attribute identified by key_name
               key_value = h.fetch(key_name) {
                 raise CheckPlease::NoSuchKeyError, \
@@ -121,11 +126,27 @@ module CheckPlease
         end
 
       def compare_hashes(ref_hash, can_hash, path)
+        if flags.indifferent_keys
+          ref_hash = stringify_symbol_keys(ref_hash)
+          can_hash = stringify_symbol_keys(can_hash)
+        end
         record_missing_keys ref_hash, can_hash, path
         compare_common_keys ref_hash, can_hash, path
         record_extra_keys   ref_hash, can_hash, path
       end
 
+        def stringify_symbol_keys(h)
+          Hash[
+            h.map { |k,v|
+              [ stringify_symbol(k), v ]
+            }
+          ]
+        end
+
+          def stringify_symbol(x)
+            Symbol === x ? x.to_s : x
+          end
+
         def record_missing_keys(ref_hash, can_hash, path)
           keys = ref_hash.keys - can_hash.keys
           keys.each do |k|
@@ -148,6 +169,10 @@ module CheckPlease
         end
 
       def compare_others(ref, can, path)
+        if flags.indifferent_values
+          ref = stringify_symbol(ref)
+          can = stringify_symbol(can)
+        end
         return if ref == can
         record_diff ref, can, path, :mismatch
       end

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.1" # about to release? rerun `bundle check` to update Gemfile.lock also
+  VERSION = "0.5.2" # about to release? rerun `bundle check` to update Gemfile.lock also
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: check_please
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Sam Livingston-Gray
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-26 00:00:00.000000000 Z
+date: 2021-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: table_print