check_please 0.4.0 → 0.5.3

data/lib/check_please/path_segment.rb

@@ -0,0 +1,88 @@
+module CheckPlease
+
+  class PathSegment
+    include CheckPlease::Reification
+    can_reify String, Symbol, Numeric, nil
+
+    KEY_EXPR = %r{
+      ^
+      \:       # a literal colon
+      (        # capture key
+        [^\:]+ # followed by one or more things that aren't colons
+      )        # end capture key
+      $
+    }x
+
+    KEY_VAL_EXPR = %r{
+      ^
+      (       # capture key
+        [^=]+ # stuff (just not an equal sign)
+      )       # end capture key
+      \=      # an equal sign
+      (       # capture key value
+        [^=]+ # stuff (just not an equal sign)
+      )       # end capture key value
+      $
+    }x
+
+    attr_reader :name, :key, :key_value
+    alias_method :to_s, :name
+
+    def initialize(name = nil)
+      @name = name.to_s.strip
+      if @name =~ %r(\s) # has any whitespace
+        raise InvalidPathSegment, <<~EOF
+          #{name.inspect} is not a valid #{self.class} name
+        EOF
+      end
+      parse_key_and_value
+      freeze
+    end
+
+    def empty?
+      name.empty?
+    end
+
+    def key_expr?
+      name.match?(KEY_EXPR)
+    end
+
+    def key_val_expr?
+      name.match?(KEY_VAL_EXPR)
+    end
+
+    def match?(other_segment_or_string)
+      other = self.class.reify(other_segment_or_string)
+
+      match_types = [ self.match_type, other.match_type ]
+      case match_types
+      when [ :plain,     :plain     ] ; self.name == other.name
+      when [ :key,       :key_value ] ; self.key  == other.key
+      when [ :key_value, :key       ] ; self.key  == other.key
+      else                            ; false
+      end
+    end
+
+    protected
+
+    def match_type
+      return :key       if key_expr?
+      return :key_value if key_val_expr?
+      :plain
+    end
+
+    private
+
+    def parse_key_and_value
+      case name
+      when KEY_EXPR
+        @key = $1
+      when KEY_VAL_EXPR
+        @key, @key_value = $1, $2
+      else
+        # :nothingtodohere:
+      end
+    end
+  end
+
+end

data/lib/check_please/reification.rb

@@ -0,0 +1,50 @@
+module CheckPlease
+
+  module Reification
+    def self.included(receiver)
+      receiver.extend         ClassMethods
+      receiver.send :include, InstanceMethods
+    end
+
+    module ClassMethods
+      def reifiable
+        @_reifiable ||= []
+      end
+
+      def can_reify(*klasses)
+        klasses.flatten!
+
+        unless ( klasses - [nil] ).all? { |e| e.is_a?(Class) }
+          raise ArgumentError, "classes (or nil) only, please"
+        end
+
+        reifiable.concat klasses
+        reifiable.uniq!
+        nil
+      end
+
+      def reify(primitive_or_object)
+        case primitive_or_object
+        when self       ; return primitive_or_object
+        when Array      ; return primitive_or_object.map { |e| reify(e) }
+        when *reifiable ; return new(primitive_or_object)
+        end
+        # note early return ^^^
+
+        # that didn't work? complain!
+        acceptable = reifiable.map { |e| Class === e ? e.name : e.inspect }
+        raise ArgumentError, <<~EOF
+          #{self}.reify was given: #{primitive_or_object.inspect}
+          but only accepts: #{acceptable.join(", ")}
+        EOF
+      end
+    end
+
+    module InstanceMethods
+      def reify(x)
+        self.class.reify(x)
+      end
+    end
+  end
+
+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.4.0"
+  VERSION = "0.5.3" # about to release? rerun `bundle lock` to update Gemfile.lock
 end

data/usage_examples.rb

@@ -1,7 +1,11 @@
 require 'check_please'
 
-reference = { foo: "wibble" }
-candidate = { bar: "wibble" }
+reference = { "foo" => "wibble" }
+candidate = { "bar" => "wibble" }
+
+
+
+##### Printing diffs #####
 
 puts CheckPlease.render_diff(reference, candidate)
 
@@ -12,3 +16,21 @@ _ = <<EOF
   missing | /foo | wibble    |
   extra   | /bar |           | wibble
 EOF
+
+
+
+##### Doing your own thing with diffs #####
+
+diffs = CheckPlease.diff(reference, candidate)
+
+# `diffs` is a custom collection (type: CheckPlease::Diffs) that contains
+# individual Diff objects for you to inspect as you see fit.
+#
+# If you come up with a useful way to present these, feel free to submit a PR
+# with a new class in `lib/check_please/printers` !
+
+# To print these in the console, you can just do:
+puts diffs
+
+# If for some reason you want to print the JSON version, it gets a little more verbose:
+puts diffs.to_s(format: :json)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: check_please
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.3
 platform: ruby
 authors:
 - Sam Livingston-Gray
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-25 00:00:00.000000000 Z
+date: 2021-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: table_print
@@ -71,6 +71,7 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/gh-md-toc
 - bin/setup
 - check_please.gemspec
 - exe/check_please
@@ -85,11 +86,13 @@ files:
 - lib/check_please/flag.rb
 - lib/check_please/flags.rb
 - lib/check_please/path.rb
+- lib/check_please/path_segment.rb
 - lib/check_please/printers.rb
 - lib/check_please/printers/base.rb
 - lib/check_please/printers/json.rb
 - lib/check_please/printers/table_print.rb
 - lib/check_please/refinements.rb
+- lib/check_please/reification.rb
 - lib/check_please/version.rb
 - usage_examples.rb
 homepage: https://github.com/RealGeeks/check_please