mismatch-inspectable 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f2e711a465a93a6cf4a13d5f4536df7633f1d42e0a445c4e01558aa9c33e25e
-  data.tar.gz: 3c8439ca0fb0937d4c969d023b40a5bf2571933dc137469755e284c258100b96
+  metadata.gz: 1183239193cb375fb2b4f262b50eae8e5a9c340274e4723ac58ee78f05f5888f
+  data.tar.gz: 86652b1652380b7d712442d7d4f7007f51767206e0f3d784c1ce7cff8277f41a
 SHA512:
-  metadata.gz: ca368e42844554edf57a7a450f4aadf8d2ac799b8ce711be465d2146c022456d379502dda5d030849ac0a8768254c67dbb7688a5db695e64de76aeb689240ab0
-  data.tar.gz: 309644a355739a5a97d9b0e6dd58683514698be2020e9deeab76863ac1f504901a1e44d395107cbd58d1b952d870b70281e5fa450fa21f4b2906c7b31cdfb413
+  metadata.gz: 32129ffe106c2a2ca2b560d1a8d11230f7c7d3564cc99942583ce6b571d8bdffee763a84f790c916156aae74fd46d412f39334915a7e5ecb98a5f3c98ee4fc39
+  data.tar.gz: 5ec76f9a6d31017dca66125cdfe0c82b6fd65270a1bf6fb636b30c8316e3fca6be863118dc14c3cd9d259c18399680a73f6f9abe791087f91e4d612ebdcf823c

data/lib/mismatch_inspectable/{array_formatter.rb → formatter/array_formatter.rb}

@@ -1,8 +1,11 @@
+require_relative "formatter"
+
 module MismatchInspectable
-  class ArrayFormatter
+  class ArrayFormatter < Formatter
     attr_reader :mismatches
 
     def initialize
+      super
       @mismatches = []
     end
 
@@ -10,7 +13,7 @@ module MismatchInspectable
       @mismatches << [prefix + attribute.to_s, curr_val, other_val]
     end
 
-    def merge_mismatches(nested_mismatches)
+    def process_mismatches(nested_mismatches)
       @mismatches.concat(nested_mismatches)
     end
   end

data/lib/mismatch_inspectable/formatter/format_builder.rb

@@ -0,0 +1,22 @@
+require_relative "hash_formatter"
+require_relative "array_formatter"
+require_relative "object_formatter"
+
+module MismatchInspectable
+  FormatBuilder = Struct.new(:format) do
+    def formatter
+      @formatter ||= select_formatter
+    end
+
+    private
+
+    def select_formatter
+      case format
+      when :hash then HashFormatter.new
+      when :array then ArrayFormatter.new
+      when :object then ObjectFormatter.new
+      else raise ArgumentError, "Invalid format: #{format}"
+      end
+    end
+  end
+end

data/lib/mismatch_inspectable/formatter/formatter.rb

@@ -0,0 +1,23 @@
+module MismatchInspectable
+  class Formatter
+    attr_reader :mismatches
+
+    def add_mismatch(prefix, attribute, curr_val, other_val)
+      raise NotImplementedError
+    end
+
+    def merge_mismatches(nested_mismatches)
+      process_mismatches(nested_mismatches) unless no_nested_mismatches?(nested_mismatches)
+    end
+
+    private
+
+    def no_nested_mismatches?(mismatches)
+      mismatches.nil? || mismatches.empty?
+    end
+
+    def process_mismatches(_nested_mismatches)
+      raise NotImplementedError
+    end
+  end
+end

data/lib/mismatch_inspectable/{hash_formatter.rb → formatter/hash_formatter.rb}

@@ -1,8 +1,11 @@
+require_relative "formatter"
+
 module MismatchInspectable
-  class HashFormatter
+  class HashFormatter < Formatter
     attr_reader :mismatches
 
     def initialize
+      super
       @mismatches = Hash.new { |hash, key| hash[key] = {} }
     end
 
@@ -10,7 +13,7 @@ module MismatchInspectable
       @mismatches[prefix + attribute.to_s] = [curr_val, other_val]
     end
 
-    def merge_mismatches(nested_mismatches)
+    def process_mismatches(nested_mismatches)
       nested_mismatches.each { |k, v| mismatches[k] = v }
     end
   end

data/lib/mismatch_inspectable/{object_formatter.rb → formatter/object_formatter.rb}

@@ -1,7 +1,9 @@
 require_relative "deep_merge"
+require_relative "formatter"
 
-class ObjectFormatter
+class ObjectFormatter < MismatchInspectable::Formatter
   def initialize
+    super
     @mismatches = {}.extend(DeepMerge)
   end
 
@@ -19,7 +21,7 @@ class ObjectFormatter
     curr[attribute] = [curr_val, other_val]
   end
 
-  def merge_mismatches(nested_mismatches)
+  def process_mismatches(nested_mismatches)
     mismatches.deep_merge!(nested_mismatches)
   end
 end

data/lib/mismatch_inspectable/inspection_options.rb

@@ -0,0 +1,38 @@
+require_relative "formatter/format_builder"
+
+module MismatchInspectable
+  class InspectionOptions
+    attr_accessor :recursive, :include_class, :prefix, :format, :options
+
+    def initialize(prefix: "", recursive: false, include_class: true, format: :array)
+      @recursive = recursive
+      @include_class = include_class
+      @prefix = prefix
+      @format = format
+    end
+
+    def formatter
+      @formatter ||= FormatBuilder.new(format).formatter
+    end
+
+    def to_h
+      {
+        recursive:,
+        include_class:,
+        prefix:,
+        format:
+      }
+    end
+
+    def update_prefix(target_class)
+      if include_class && comparable_prefix != "#{target_class.class}#"
+        self.prefix = "#{prefix}#{target_class.class}#"
+      end
+    end
+
+    def comparable_prefix
+      prefixes = prefix.split(".")
+      prefixes.length >= 2 ? prefixes[-1] : prefix
+    end
+  end
+end

data/lib/mismatch_inspectable/mismatch_inspectable.rb

@@ -1,8 +1,8 @@
-require_relative "hash_formatter"
-require_relative "array_formatter"
-require_relative "object_formatter"
+require_relative "inspection_options"
 
 module MismatchInspectable
+  attr_reader :options
+
   def self.included(target_class)
     target_class.extend ClassMethods
   end
@@ -21,75 +21,74 @@ module MismatchInspectable
     end
   end
 
-  def inspect_mismatch(other, recursive: false, include_class: true, prefix: "", format: :array)
-    return if self.class != other.class
+  def inspect_mismatch(other_klass, **options)
+    @options = InspectionOptions.new(**options)
+    find_mismatches(other_klass:)
+  end
 
-    formatter = select_formatter(format)
+  protected
 
-    process_attributes(formatter, other, recursive, include_class, prefix, format)
-    formatter.mismatches
-  end
+  def find_mismatches(other_klass:)
+    return if self.class != other_klass.class
 
-  def compare_methods
-    self.class.compare_methods
+    process_attributes!(other_klass:)
+    mismatches
   end
 
   private
 
-  def select_formatter(format)
-    case format
-    when :hash then HashFormatter.new
-    when :array then ArrayFormatter.new
-    when :object then ObjectFormatter.new
-    else raise ArgumentError, "Invalid format: #{format}"
-    end
+  def compare_methods
+    self.class.compare_methods
   end
 
-  # rubocop:disable Metrics/ParameterLists
-  def process_attributes(formatter, other, recursive, include_class, prefix, format)
+  def process_attributes!(other_klass:)
     raise MissingCompareMethodsError if compare_methods.nil?
 
     compare_methods.each do |attribute|
       curr_val = __send__(attribute)
-      other_val = other.__send__(attribute)
+      other_val = other_klass.__send__(attribute)
 
-      if recursive && both_are_inspectable?(curr_val, other_val)
-        process_recursive(formatter, curr_val, other_val, include_class, prefix, attribute, format)
+      if options.recursive && both_are_inspectable?(curr_val:, other_val:)
+        process_recursive!(curr_val:, other_val:, attribute:)
       elsif curr_val != other_val
-        prefix = update_prefix(include_class, prefix)
-        formatter.add_mismatch(prefix, attribute, curr_val, other_val)
+
+        update_prefix(target_class: self)
+        formatter.add_mismatch(options.prefix, attribute, curr_val, other_val)
       end
     end
   end
 
-  def both_are_inspectable?(curr_val, other_val)
+  def both_are_inspectable?(curr_val:, other_val:)
     curr_val.respond_to?(:inspect_mismatch) && other_val.respond_to?(:inspect_mismatch)
   end
 
-  def process_recursive(formatter, curr_val, other_val, include_class, prefix, attribute, format)
+  def process_recursive!(curr_val:, other_val:, attribute:)
+    options.prefix = "#{options.prefix}#{attribute}."
+    options.recursive = true
     nested_mismatches = curr_val.inspect_mismatch(
       other_val,
-      recursive: true,
-      include_class:,
-      prefix: "#{prefix}#{attribute}.",
-      format:
+      **options.to_h
     )
+    merge_mismatches(nested_mismatches:)
+  end
 
-    formatter.merge_mismatches(nested_mismatches) unless no_nested_mismatches?(nested_mismatches)
+  def no_nested_mismatches?(mismatches)
+    mismatches.nil? || mismatches.empty?
   end
-  # rubocop:enable Metrics/ParameterLists
 
-  def update_prefix(include_class, prefix)
-    comparable_prefix = get_comparable_prefix(prefix)
-    include_class && comparable_prefix != "#{self.class}#" ? "#{prefix}#{self.class}#" : prefix
+  def update_prefix(target_class:)
+    options.update_prefix(target_class)
   end
 
-  def no_nested_mismatches?(mismatches)
-    mismatches.nil? || mismatches.empty?
+  def formatter
+    options.formatter
+  end
+
+  def mismatches
+    formatter.mismatches
   end
 
-  def get_comparable_prefix(prefix)
-    prefixes = prefix.split(".")
-    prefixes.length >= 2 ? prefixes[-1] : prefix
+  def merge_mismatches(nested_mismatches:)
+    formatter.merge_mismatches(nested_mismatches)
   end
 end

data/lib/mismatch_inspectable/version.rb

@@ -1,3 +1,3 @@
 module MismatchInspectable
-  VERSION = "0.1.2".freeze
+  VERSION = "0.1.4".freeze
 end

data/spec/examples.txt

@@ -1,24 +1,24 @@
 example_id                                                 | status | run_time        |
 ---------------------------------------------------------- | ------ | --------------- |
-./spec/lib/mismatch_inspectable_spec.rb[1:1:1:1]           | passed | 0.00088 seconds |
-./spec/lib/mismatch_inspectable_spec.rb[1:1:2:1:1]         | passed | 0.00045 seconds |
-./spec/lib/mismatch_inspectable_spec.rb[1:1:2:1:2:1]       | passed | 0.00012 seconds |
-./spec/lib/mismatch_inspectable_spec.rb[1:1:2:1:3:1:1:1]   | passed | 0.00146 seconds |
-./spec/lib/mismatch_inspectable_spec.rb[1:1:2:1:3:1:1:2:1] | passed | 0.00014 seconds |
-./spec/lib/mismatch_inspectable_spec.rb[1:1:2:1:3:1:2:1]   | passed | 0.00012 seconds |
-./spec/lib/mismatch_inspectable_spec.rb[1:1:2:1:3:1:2:2:1] | passed | 0.00013 seconds |
-./spec/lib/mismatch_inspectable_spec.rb[1:1:2:1:3:2:1]     | passed | 0.0001 seconds  |
-./spec/lib/mismatch_inspectable_spec.rb[1:1:2:2:1:1]       | passed | 0.00009 seconds |
-./spec/lib/mismatch_inspectable_spec.rb[1:1:2:2:2:1]       | passed | 0.0001 seconds  |
-./spec/lib/mismatch_inspectable_spec.rb[1:1:2:2:3:1]       | passed | 0.00011 seconds |
-./spec/lib/mismatch_inspectable_spec.rb[1:1:2:2:4:1:1:1:1] | passed | 0.00012 seconds |
-./spec/lib/mismatch_inspectable_spec.rb[1:1:2:2:4:1:1:2:1] | passed | 0.00011 seconds |
-./spec/lib/mismatch_inspectable_spec.rb[1:1:2:2:4:1:1:3:1] | passed | 0.00033 seconds |
-./spec/lib/mismatch_inspectable_spec.rb[1:1:2:2:4:1:2:1:1] | passed | 0.00012 seconds |
-./spec/lib/mismatch_inspectable_spec.rb[1:1:2:2:4:1:2:2:1] | passed | 0.00013 seconds |
-./spec/lib/mismatch_inspectable_spec.rb[1:1:2:2:4:1:2:3:1] | passed | 0.00015 seconds |
-./spec/lib/mismatch_inspectable_spec.rb[1:1:2:2:4:2:1:1]   | passed | 0.0001 seconds  |
-./spec/lib/mismatch_inspectable_spec.rb[1:1:2:2:4:2:2:1]   | passed | 0.00011 seconds |
-./spec/lib/mismatch_inspectable_spec.rb[1:1:2:2:4:2:3:1]   | passed | 0.00011 seconds |
-./spec/lib/mismatch_inspectable_spec.rb[1:1:2:2:4:3:1:1]   | passed | 0.00017 seconds |
-./spec/lib/mismatch_inspectable_spec.rb[1:1:2:2:4:3:2:1]   | passed | 0.0002 seconds  |
+./spec/lib/mismatch_inspectable_spec.rb[1:1:1:1]           | passed | 0.00052 seconds |
+./spec/lib/mismatch_inspectable_spec.rb[1:1:2:1:1]         | passed | 0.00024 seconds |
+./spec/lib/mismatch_inspectable_spec.rb[1:1:2:1:2:1]       | passed | 0.00006 seconds |
+./spec/lib/mismatch_inspectable_spec.rb[1:1:2:1:3:1:1:1]   | passed | 0.00008 seconds |
+./spec/lib/mismatch_inspectable_spec.rb[1:1:2:1:3:1:1:2:1] | passed | 0.00007 seconds |
+./spec/lib/mismatch_inspectable_spec.rb[1:1:2:1:3:1:2:1]   | passed | 0.00007 seconds |
+./spec/lib/mismatch_inspectable_spec.rb[1:1:2:1:3:1:2:2:1] | passed | 0.00007 seconds |
+./spec/lib/mismatch_inspectable_spec.rb[1:1:2:1:3:2:1]     | passed | 0.00006 seconds |
+./spec/lib/mismatch_inspectable_spec.rb[1:1:2:2:1:1]       | passed | 0.00005 seconds |
+./spec/lib/mismatch_inspectable_spec.rb[1:1:2:2:2:1]       | passed | 0.00005 seconds |
+./spec/lib/mismatch_inspectable_spec.rb[1:1:2:2:3:1]       | passed | 0.00007 seconds |
+./spec/lib/mismatch_inspectable_spec.rb[1:1:2:2:4:1:1:1:1] | passed | 0.00094 seconds |
+./spec/lib/mismatch_inspectable_spec.rb[1:1:2:2:4:1:1:2:1] | passed | 0.00006 seconds |
+./spec/lib/mismatch_inspectable_spec.rb[1:1:2:2:4:1:1:3:1] | passed | 0.00091 seconds |
+./spec/lib/mismatch_inspectable_spec.rb[1:1:2:2:4:1:2:1:1] | failed | 0.00696 seconds |
+./spec/lib/mismatch_inspectable_spec.rb[1:1:2:2:4:1:2:2:1] | failed | 0.00043 seconds |
+./spec/lib/mismatch_inspectable_spec.rb[1:1:2:2:4:1:2:3:1] | failed | 0.00046 seconds |
+./spec/lib/mismatch_inspectable_spec.rb[1:1:2:2:4:2:1:1]   | passed | 0.00008 seconds |
+./spec/lib/mismatch_inspectable_spec.rb[1:1:2:2:4:2:2:1]   | passed | 0.00006 seconds |
+./spec/lib/mismatch_inspectable_spec.rb[1:1:2:2:4:2:3:1]   | passed | 0.00008 seconds |
+./spec/lib/mismatch_inspectable_spec.rb[1:1:2:2:4:3:1:1]   | passed | 0.00008 seconds |
+./spec/lib/mismatch_inspectable_spec.rb[1:1:2:2:4:3:2:1]   | failed | 0.00064 seconds |

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mismatch-inspectable
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Tyler Rhodes
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-01 00:00:00.000000000 Z
+date: 2024-10-14 00:00:00.000000000 Z
 dependencies: []
 description: |-
   A library that includes a module that can print mismatched
@@ -23,16 +23,19 @@ files:
 - LICENSE.md
 - README.md
 - lib/mismatch_inspectable.rb
-- lib/mismatch_inspectable/array_formatter.rb
-- lib/mismatch_inspectable/deep_merge.rb
-- lib/mismatch_inspectable/hash_formatter.rb
+- lib/mismatch_inspectable/formatter/array_formatter.rb
+- lib/mismatch_inspectable/formatter/deep_merge.rb
+- lib/mismatch_inspectable/formatter/format_builder.rb
+- lib/mismatch_inspectable/formatter/formatter.rb
+- lib/mismatch_inspectable/formatter/hash_formatter.rb
+- lib/mismatch_inspectable/formatter/object_formatter.rb
+- lib/mismatch_inspectable/inspection_options.rb
 - lib/mismatch_inspectable/mismatch_inspectable.rb
-- lib/mismatch_inspectable/object_formatter.rb
 - lib/mismatch_inspectable/version.rb
 - spec/examples.txt
 - spec/lib/mismatch_inspectable_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/tyleCaineRhodes/mismatch-inspectable
+homepage: https://github.com/tylerCaineRhodes/mismatch-inspectable
 licenses:
 - MIT
 metadata:
@@ -43,7 +46,7 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 3.2.1
 required_rubygems_version: !ruby/object:Gem::Requirement