check_please 0.3.0 → 0.5.2

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.3.0"
+  VERSION = "0.5.2" # about to release? rerun `bundle check` to update Gemfile.lock also
 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.3.0
+  version: 0.5.2
 platform: ruby
 authors:
 - Sam Livingston-Gray
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-19 00:00:00.000000000 Z
+date: 2021-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: table_print
@@ -71,23 +71,28 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/gh-md-toc
 - bin/setup
 - check_please.gemspec
 - exe/check_please
 - lib/check_please.rb
 - lib/check_please/cli.rb
-- lib/check_please/cli/flag.rb
 - lib/check_please/cli/parser.rb
 - lib/check_please/cli/runner.rb
 - lib/check_please/comparison.rb
 - lib/check_please/diff.rb
 - lib/check_please/diffs.rb
 - lib/check_please/error.rb
+- 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

data/lib/check_please/cli/flag.rb

@@ -1,40 +0,0 @@
-module CheckPlease
-module CLI
-
-  class Flag
-    ATTR_NAMES = %i[ short long desc key block ]
-    attr_accessor(*ATTR_NAMES)
-
-    def initialize(*args)
-      self.short = args.shift if args.any?
-      self.long  = args.shift if args.any?
-
-      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
-    end
-
-    def visit_option_parser(parser, options)
-      parser.on(short, long, desc) do |value|
-        block.call options, value
-      end
-    end
-
-    def set_key(key, message = nil, &b)
-      raise ArgumentError if message && b
-      raise ArgumentError if !message && !b
-
-      self.key = key
-      self.block = ->(options, value) {
-        b ||= message.to_sym.to_proc
-        options[key] = b.call(value)
-      }
-    end
-  end
-
-end
-end