check_please 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c16110449be99d5ff509c720c4365b2fe6f176f23094784628db2de0e5f3bf9
-  data.tar.gz: b45c9d1b7dea9b4405f4ca80dbce5f04d0aec14ad50e4e919802e09b469c86c8
+  metadata.gz: 33a26fc2e249e7ff6bba107ba2da856f0f70a9e232862b3650893b1844117cac
+  data.tar.gz: c8624e0cfc38a4f7bcd9db9af22215f0d2d6311ab061ec156318894fa8a01b60
 SHA512:
-  metadata.gz: 023b9fdd6f227f8381dfba06a82d30961adab9b2ab5a2b5a0d820c8b8697d300f59d416c801808e88e7e625720776f1cec4cf0a6f57d1eec07e6cb656881d4b8
-  data.tar.gz: eca955971798d00dd45bf5e068779aebeb33b304fe592d84534081d0068eaa981f6b765fd5c4ea9a30e7d65b2edd456ed9093c039964e3691c646e0c7d23b2b0
+  metadata.gz: 93c0b1d909dbdaf606a0376f38062eaaa26bd19573413ce0d81002b120aa247176d7a564752b83f6ac9a359974df32a7a5c2997f20468f95d683b28369d5548b
+  data.tar.gz: 78fe71950e42986ef0b9857984310fa51955d08a5b1b9b432d2b277fb9191b188b173f78575d0f88a927d4668065ac35fc32f1d74bba082894f897c0d9896267

data/Gemfile.lock

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

data/README.md

@@ -163,8 +163,6 @@ print diffs as JSON to facilitate parsing.  In Ruby, pass `format: :json` to
 ## TODO
 
 * command line flags for :allthethings:!
-  * --fail-fast
-  * limit to first N
   * sort by path?
   * max depth (for iterative refinement?)
 * detect timestamps and compare after parsing?

data/Rakefile

@@ -1,6 +1,21 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
-RSpec::Core::RakeTask.new(:spec)
+namespace :spec do
+  RSpec::Core::RakeTask.new(:all)
+
+  RSpec::Core::RakeTask.new(:not_cli) do |t|
+    t.rspec_opts = "--tag ~cli"
+  end
+  task fast: :not_cli
+
+  # These are much slower than the rest, since they use Kernel#`
+  RSpec::Core::RakeTask.new(:cli) do |t|
+    t.rspec_opts = "--tag cli"
+  end
+end
+
+# By default, `rake spec` should run fast specs first, then cli if those all pass
+task :spec => [ "spec:not_cli", "spec:cli" ]
 
 task :default => :spec

data/lib/check_please.rb

@@ -10,14 +10,14 @@ require_relative "check_please/cli"
 module CheckPlease
   ELEVATOR_PITCH = "Tool for parsing and diffing two JSON documents."
 
-  def self.diff(reference, candidate)
+  def self.diff(reference, candidate, options = {})
     reference = maybe_parse(reference)
     candidate = maybe_parse(candidate)
-    Comparison.perform(reference, candidate)
+    Comparison.perform(reference, candidate, options)
   end
 
   def self.render_diff(reference, candidate, options = {})
-    diffs = diff(reference, candidate)
+    diffs = diff(reference, candidate, options)
     Printers.render(diffs, options)
   end
 

data/lib/check_please/cli.rb

@@ -13,17 +13,33 @@ module CheckPlease
 
 
     FLAGS = []
-    def self.flag(*args, &block)
-      flag = Flag.new(*args, &block)
+    def self.flag(long:, short: nil, &block)
+      flag = Flag.new(short, long, &block)
       FLAGS << flag
     end
 
     ##### Define CLI flags here #####
 
-    flag "-f FORMAT", "--format FORMAT" do |f|
+    flag short: "-f FORMAT", long: "--format FORMAT" do |f|
       f.desc = "format in which to present diffs (available options: [#{CheckPlease::Printers::FORMATS.join(", ")}])"
       f.set_key :format, :to_sym
     end
+
+    flag short: "-n MAX_DIFFS", long: "--max-diffs MAX_DIFFS" do |f|
+      f.desc = "Stop after encountering a specified number of diffs"
+      f.set_key :max_diffs, :to_i
+    end
+
+    flag long: "--fail-fast" do |f|
+      f.desc = "Stop after encountering the very first diff"
+      f.set_key(:max_diffs) { 1 }
+    end
+
+    flag short: "-d MAX_DEPTH", long: "--max-depth MAX_DEPTH" do |f|
+      f.desc = "Limit the number of levels to descend when comparing documents (NOTE: root has depth=1)"
+      f.set_key :max_depth, :to_i
+    end
+
   end
 
 end

data/lib/check_please/cli/flag.rb

@@ -12,6 +12,7 @@ module CLI
       yield self if block_given?
 
       missing = ATTR_NAMES.select { |e| self.send(e).nil? }
+      missing -= %i[ short ] # short is optional!
       if missing.any?
         raise ArgumentError, "Missing attributes: #{missing.join(', ')}"
       end

data/lib/check_please/comparison.rb

@@ -3,16 +3,22 @@ module CheckPlease
   module Comparison
     extend self
 
-    def perform(reference, candidate)
+    def perform(reference, candidate, options = {})
       root = CheckPlease::Path.new
-      diffs = Diffs.new
-      compare reference, candidate, root, diffs
+      diffs = Diffs.new(options: options)
+      catch(:max_diffs_reached) do
+        compare reference, candidate, root, diffs
+      end
       diffs
     end
 
     private
 
     def compare(ref, can, path, diffs)
+      if (d = diffs.options[:max_depth])
+        return if path.depth > d
+      end
+
       case types(ref, can)
       when [ :array, :array ] ; compare_arrays ref, can, path, diffs
       when [ :hash,  :hash  ] ; compare_hashes ref, can, path, diffs

data/lib/check_please/diffs.rb

@@ -5,7 +5,9 @@ module CheckPlease
   # Custom collection class for Diff instances.
   # Can retrieve members using indexes or paths.
   class Diffs
-    def initialize(diff_list = nil)
+    attr_reader :options
+    def initialize(diff_list = nil, options: {})
+      @options = options
       @list = []
       @hash = {}
       Array(diff_list).each do |diff|
@@ -27,6 +29,11 @@ module CheckPlease
     end
 
     def <<(diff)
+      if (n = options[:max_diffs])
+        # It seems no one can help me now / I'm in too deep, there's no way out
+        throw :max_diffs_reached if length >= n
+      end
+
       @list << diff
       @hash[diff.path] = diff
     end

data/lib/check_please/path.rb

@@ -11,6 +11,10 @@ module CheckPlease
       self.class.new( Array(@segments) + Array(new_basename.to_s) )
     end
 
+    def depth
+      1 + @segments.length
+    end
+
     def to_s
       SEPARATOR + @segments.join(SEPARATOR)
     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.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: check_please
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Sam Livingston-Gray
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-13 00:00:00.000000000 Z
+date: 2020-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: table_print