check_please 0.5.2 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c39ef90c83a488ddfa309002bfad243cbfe2415481aa0d82e3efd7119be7e420
-  data.tar.gz: 54deb528cb61709484f86b11b4601e54770a6ce9a2a4694905eb7dcd3cceebd7
+  metadata.gz: d8c12644a3f83d1d263374a88b825a9f705f55d68582e90a50a3065ec2b0105e
+  data.tar.gz: 3f5ddc8b0d9e5c02bc4845e5a4ac21d07b358f75639146f32c71143bc1e6d605
 SHA512:
-  metadata.gz: 2ab7404049194c7b70bf86b2ac4a3edc765e50b1ae63a2725e8877e67b1e49735a607f29f486414892a77d4fe604d8361db0b3bd6669b6c067e7ba90838c00bc
-  data.tar.gz: 97fd7e608cac462e278601372d79a3e9fdee8013f3a13912078aad3d86cf875ce4724f68902282433df9a8fcee314c206414e473b9026c30b06e77c271b34393
+  metadata.gz: c95071934105bc8c8876287bf460a0466ecc996eab6356c64a994566824c95d2f24d6d446bc8bcc6d4d66b0a224023a4347839e75f5d8204860e9e2210e7e07d
+  data.tar.gz: ebdbe6bdeafd3f71bf9461f5eccd73f20772043d9e84ab01fa91c0a1dcff054a21c74d718aa40cf0c89bed3219d36d1f46e89ce37ea6d27483bb268518bb7d59

data/Gemfile.lock

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

data/lib/check_please.rb

@@ -143,6 +143,20 @@ module CheckPlease
     EOF
   end
 
+  Flags.define :match_by_value do |flag|
+    flag.repeatable
+    flag.coerce { |value| CheckPlease::Path.reify(value) }
+
+    flag.cli_long = "--match-by-value FOO"
+    flag.description = <<~EOF
+      When comparing two arrays that match a specified path, the candidate
+      array will be scanned for each element in the reference array.
+        May be repeated; values will be treated as an 'OR' list.
+        NOTE: explodes if either array at a given path contains other collections.
+        NOTE: paths of 'extra' diffs use the index in the candidate array.
+    EOF
+  end
+
   Flags.define :indifferent_keys do |flag|
     flag.default = false
     flag.coerce { |value| !!value }

data/lib/check_please/comparison.rb

@@ -42,8 +42,11 @@ module CheckPlease
       end
 
       def compare_arrays(ref_array, can_array, path)
-        if ( key = path.key_for_compare(flags) )
+        case
+        when ( key = path.key_to_match_by(flags) )
           compare_arrays_by_key ref_array, can_array, path, key
+        when path.match_by_value?(flags)
+          compare_arrays_by_value ref_array, can_array, path
         else
           compare_arrays_by_index ref_array, can_array, path
         end
@@ -107,6 +110,45 @@ module CheckPlease
             elements_by_key
           end
 
+        # FIXME: this can generate duplicate paths.
+        # Time to introduce lft_path, rgt_path ?
+        def compare_arrays_by_value(ref_array, can_array, path)
+          assert_can_match_by_value! ref_array
+          assert_can_match_by_value! can_array
+
+          matches = can_array.map { false }
+
+          # Look for missing values
+          ref_array.each.with_index do |ref, i|
+            new_path = path + (i+1) # count in human pls
+
+            # Weird, but necessary to handle duplicates properly
+            j = can_array.index.with_index { |can, j|
+              matches[j] == false && can == ref
+            }
+
+            if j
+              matches[j] = true
+            else
+              record_diff ref, nil, new_path, :missing
+            end
+          end
+
+          # Look for extra values
+          can_array.zip(matches).each.with_index do |(can, match), i|
+            next if match
+            new_path = path + (i+1) # count in human pls
+            record_diff nil, can, new_path, :extra
+          end
+        end
+
+          def assert_can_match_by_value!(array)
+            if array.any? { |e| Array === e || Hash === e }
+              raise CheckPlease::BehaviorUndefined,
+                "match_by_value behavior is not defined for collections!"
+            end
+          end
+
         def compare_arrays_by_index(ref_array, can_array, path)
           max_len = [ ref_array, can_array ].map(&:length).max
           (0...max_len).each do |i|

data/lib/check_please/error.rb

@@ -6,6 +6,10 @@ module CheckPlease
     # instead....
   end
 
+  class BehaviorUndefined < ::StandardError
+    include CheckPlease::Error
+  end
+
   class DuplicateKeyError < ::IndexError
     include CheckPlease::Error
   end

data/lib/check_please/path.rb

@@ -81,13 +81,10 @@ module CheckPlease
       "<#{self.class.name} '#{to_s}'>"
     end
 
-		# TODO: Naming Things
-    def key_for_compare(flags)
-      mbk_exprs = unpack_mbk_exprs(flags)
-      matches = mbk_exprs.select { |mbk_expr|
-        # NOTE: matching on parent because MBK '/foo/:id' should return 'id' for path '/foo'
-        mbk_expr.parent.match?(self)
-      }
+    def key_to_match_by(flags)
+      key_exprs = unpack_key_exprs(flags.match_by_key)
+      # NOTE: match on parent because if self.to_s == '/foo', MBK '/foo/:id' should return 'id'
+      matches = key_exprs.select { |e| e.parent.match?(self) }
 
       case matches.length
       when 0 ; nil
@@ -96,6 +93,10 @@ module CheckPlease
       end
     end
 
+    def match_by_value?(flags)
+      flags.match_by_value.any? { |e| e.match?(self) }
+    end
+
     def match?(path_or_string)
       # If the strings are literally equal, we're good..
       return true if self == path_or_string
@@ -160,8 +161,8 @@ module CheckPlease
       depth > flags.max_depth
     end
 
-    def unpack_mbk_exprs(flags)
-      flags.match_by_key
+    def unpack_key_exprs(path_list)
+      path_list
         .map { |path| path.send(:key_exprs) }
         .flatten
         .uniq { |e| e.to_s } # use the block form so we don't have to implement #hash and #eql? in horrible ways

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.2" # about to release? rerun `bundle check` to update Gemfile.lock also
+  VERSION = "0.5.3" # 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.2
+  version: 0.5.3
 platform: ruby
 authors:
 - Sam Livingston-Gray
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-29 00:00:00.000000000 Z
+date: 2021-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: table_print