specdiff 0.3.0.pre.rc1 → 0.3.0

data/lib/specdiff/hashprint.rb

@@ -13,10 +13,11 @@ class Specdiff::Hashprint
   NEWLINE = "\n".freeze
 
   def call(thing)
+    @recursion_trail = []
     @indentation_level = 0
     @indentation_per_level = SPACE * INDENTATION_SPACES
     @indent = ""
-    @skip_next_opening_indent = false
+    @next_value_is_hash_value = false
 
     @output = StringIO.new
 
@@ -41,37 +42,39 @@ private
     recalculate_indent
   end
 
-  def with_indentation_level(temporary_level)
-    old_level = @indentation_level
-    @indentation_level = temporary_level
-    recalculate_indent
-
-    yield
-
-    @indentation_level = old_level
-    recalculate_indent
-  end
-
-  def skip_next_opening_indent
-    @skip_next_opening_indent = true
+  def next_value_is_hash_value
+    @next_value_is_hash_value = true
 
     nil
   end
 
-  def this_indent_should_be_skipped
-    if @skip_next_opening_indent
-      @skip_next_opening_indent = false
+  def outputting_hash_value?
+    if @next_value_is_hash_value
+      @next_value_is_hash_value = false
       true
     else
       false
     end
   end
 
+  def track_recursion(thing)
+    @recursion_trail.push(thing)
+    result = yield
+    @recursion_trail.pop
+    result
+  end
+
+  def deja_vu?(current_place)
+    @recursion_trail.any? { |previous_place| previous_place == current_place }
+  end
+
   # #=== allows us to rely on Module implementing #=== instead of relying on the
   # thing (which could be any kind of wacky object) having to implement
   # #is_a? or #kind_of?
   def output(thing)
-    if Hash === thing
+    if deja_vu?(thing)
+      output_deja_vu(thing)
+    elsif Hash === thing
       output_hash(thing)
     elsif Array === thing
       output_array(thing)
@@ -86,69 +89,93 @@ private
   COLON = ":".freeze
 
   def output_hash(hash)
-    @output << @indent unless this_indent_should_be_skipped
+    @output << @indent unless outputting_hash_value?
 
     @output << HASH_OPEN
-    # unless hash.empty?
-      @output << NEWLINE
-
-      increase_indentation
-      hash.each do |key, value|
-        @output << @indent
-
-        if key.is_a?(Symbol)
-          @output << key
-          @output << COLON
-          @output << SPACE
-        else
-          @output << ::Specdiff.diff_inspect(key)
-          @output << SPACE
-          @output << HASHROCKET
-          @output << SPACE
+    @output << NEWLINE
+
+    increase_indentation
+    track_recursion(hash) do
+      try_to_sort(hash)
+        .each do |key, value|
+          @output << @indent
+
+          if key.is_a?(Symbol)
+            @output << key
+            @output << COLON
+            @output << SPACE
+          else
+            @output << ::Specdiff.diff_inspect(key)
+            @output << SPACE
+            @output << HASHROCKET
+            @output << SPACE
+          end
+
+          next_value_is_hash_value
+          output(value)
+
+          @output << COMMA
+          @output << NEWLINE
         end
+    end
+    decrease_indentation
 
-        skip_next_opening_indent
-        output(value)
-
-        @output << COMMA
-        @output << NEWLINE
-      end
-      decrease_indentation
+    @output << @indent
+    @output << HASH_CLOSE
+  end
 
-      @output << @indent
-    # end
+  def try_to_sort(hash)
+    return hash unless hash.keys.all? { |k| String === k || Symbol === k }
 
-    @output << HASH_CLOSE
+    hash.sort_by { |k, _v| k.to_s }
   end
 
   ARRAY_OPEN = "[".freeze
   ARRAY_CLOSE = "]".freeze
 
   def output_array(array)
-    @output << @indent unless this_indent_should_be_skipped
+    @output << @indent unless outputting_hash_value?
 
     @output << ARRAY_OPEN
+    @output << NEWLINE
 
-    # unless array.empty?
-      @output << NEWLINE
-
-      increase_indentation
+    increase_indentation
+    track_recursion(array) do
       array.each do |element|
         output(element)
         @output << COMMA
         @output << NEWLINE
       end
-      decrease_indentation
-
-      @output << @indent
-    # end
+    end
+    decrease_indentation
 
+    @output << @indent
     @output << ARRAY_CLOSE
   end
 
   def output_unknown(thing)
-    @output << @indent unless this_indent_should_be_skipped
+    @output << @indent unless outputting_hash_value?
 
     @output << ::Specdiff.diff_inspect(thing)
   end
+
+  # The stdlib inspect code returns this when you have recursive structures.
+  STANDARD_INSPECT_RECURSIVE_ARRAY = "[...]".freeze
+  STANDARD_INSPECT_RECURSIVE_HASH = "{...}".freeze
+
+  def output_deja_vu(thing)
+    @output << @indent unless outputting_hash_value?
+
+    case thing
+    when Array
+      # "#<Array ##{thing.object_id}>"
+      @output << STANDARD_INSPECT_RECURSIVE_ARRAY
+    when Hash
+      # "#<Hash ##{thing.object_id}>"
+      @output << STANDARD_INSPECT_RECURSIVE_HASH
+    else
+      # this should never happen
+      raise "Specdiff::Hashprint missing deja vu for: #{thing.inspect}"
+    end
+  end
 end

data/lib/specdiff/inspect.rb

@@ -6,11 +6,17 @@ class Specdiff::Inspect
     new.call(...)
   end
 
+  def initialize
+    @recursion_trail = []
+  end
+
   # #=== allows us to rely on Module implementing #=== instead of relying on the
   # thing (which could be any kind of wacky object) having to implement
   # #is_a? or #kind_of?
   def call(thing)
-    if Time === thing
+    if Hash === thing || Array === thing
+      recursive_replace_inspect(thing).inspect
+    elsif Time === thing
       "#<Time: #{thing.strftime(TIME_FORMAT)}>"
     elsif DateTime === thing
       "#<DateTime: #{thing.rfc3339}>"
@@ -18,6 +24,12 @@ class Specdiff::Inspect
       "#<Date: #{thing.strftime(DATE_FORMAT)}>"
     elsif defined?(BigDecimal) && BigDecimal === thing
       "#<BigDecimal: #{thing.to_s('F')}>"
+    elsif rspec_matcher?(thing)
+      # Turns out rspec depends on the recursion in its inspection logic to
+      # print the "description" of rspec matchers, in situations such as when
+      # using multi-matchers (.all, .or or .and), or when nesting them inside
+      # eachother (such as match([have_attributes(...)])).
+      thing.description
     else
       begin
         thing.inspect
@@ -27,6 +39,12 @@ class Specdiff::Inspect
     end
   end
 
+  private def rspec_matcher?(thing)
+    defined?(::Specdiff::RSpecIntegration) &&
+      ::RSpec::Support.is_a_matcher?(thing) &&
+      thing.respond_to?(:description)
+  end
+
   private def inspect_anyway(uninspectable)
     "#<uninspectable #{class_of(uninspectable)}>"
   end
@@ -38,4 +56,79 @@ class Specdiff::Inspect
     singleton_class.ancestors
       .find { |ancestor| !ancestor.equal?(singleton_class) }
   end
+
+  # recursion below
+
+  InspectWrapper = Struct.new(:text) do
+    def inspect
+      text
+    end
+  end
+
+  private def recursive_replace_inspect(thing)
+    if deja_vu?(thing)
+      # I've just been in this place before
+      # And I know it's my time to go...
+      return InspectWrapper.new(inspect_deja_vu(thing))
+    end
+
+    case thing
+    when Array
+      track_recursion(thing) do
+        thing.map { |element| recursive_replace_inspect(element) }
+      end
+    when Hash
+      track_recursion(thing) do
+        new_hash = {}
+
+        thing.each do |key, value|
+          new_hash[recursive_replace_inspect(key)] = recursive_replace_inspect(value)
+        end
+
+        new_hash
+      end
+    else
+      wrap_inspect(thing)
+    end
+  rescue SystemStackError => e
+    wrap_inspect(
+      thing,
+      text: "#{e.class}: #{e.message}\n\n" \
+            "encountered when inspecting #{thing.inspect}"
+    )
+  end
+
+  private def track_recursion(thing)
+    @recursion_trail.push(thing)
+    result = yield
+    @recursion_trail.pop
+    result
+  end
+
+  private def deja_vu?(current_place)
+    @recursion_trail.any? { |previous_place| previous_place == current_place }
+  end
+
+  private def wrap_inspect(thing, text: :_use_diff_inspect)
+    text = call(thing) if text == :_use_diff_inspect
+    InspectWrapper.new(text)
+  end
+
+  # The stdlib inspect code returns this when you have recursive structures.
+  STANDARD_INSPECT_RECURSIVE_ARRAY = "[...]".freeze
+  STANDARD_INSPECT_RECURSIVE_HASH = "{...}".freeze
+
+  private def inspect_deja_vu(thing)
+    case thing
+    when Array
+      # "#<Array ##{thing.object_id}>"
+      STANDARD_INSPECT_RECURSIVE_ARRAY
+    when Hash
+      # "#<Hash ##{thing.object_id}>"
+      STANDARD_INSPECT_RECURSIVE_HASH
+    else
+      # this should never happen
+      raise "Specdiff::Inspect missing deja vu for: #{thing.inspect}"
+    end
+  end
 end

data/lib/specdiff/rspec.rb

@@ -1,3 +1,7 @@
+raise "rspec must be required before specdiff/rspec!" unless defined?(RSpec)
+raise "RSpec::Support is missing????" unless defined?(RSpec::Support)
+
+# https://github.com/rspec/rspec-support/blob/v3.13.1/lib/rspec/support/differ.rb
 class RSpec::Support::Differ
   alias old_diff diff
 
@@ -13,21 +17,12 @@ end
 
 # This stops rspec from truncating strings w/ ellipsis, as well as making the
 # "inspect" output consistent with specdiff's.
+# https://github.com/rspec/rspec-support/blob/v3.13.1/lib/rspec/support/object_formatter.rb
 class RSpec::Support::ObjectFormatter
-  class SpecdiffCustomInspector < BaseInspector
-    def self.can_inspect?(_)
-      true
-    end
-
-    def inspect
-      ::Specdiff.diff_inspect(object)
-    end
-  end
-
-  remove_const("INSPECTOR_CLASSES")
-  const_set("INSPECTOR_CLASSES", [SpecdiffCustomInspector])
-
   def format(object)
     ::Specdiff.diff_inspect(object)
   end
 end
+
+# marker for successfully loading this integration
+class Specdiff::RSpecIntegration; end # rubocop: disable Lint/EmptyClass

data/lib/specdiff/version.rb

@@ -1,3 +1,3 @@
 module Specdiff
-  VERSION = "0.3.0-rc1"
+  VERSION = "0.3.0"
 end

data/lib/specdiff/webmock.rb

@@ -1,6 +1,6 @@
-require "hashdiff"
-require "json"
+raise "webmock must be required before specdiff/webmock" unless defined?(WebMock)
 
+# https://github.com/bblimke/webmock/blob/v3.23.0/lib/webmock/request_body_diff.rb
 module WebMock
   class RequestBodyDiff
     def initialize(request_signature, request_stub)
@@ -39,3 +39,6 @@ module WebMock
     end
   end
 end
+
+# marker for successfully loading this integration
+class Specdiff::WebmockIntegration; end # rubocop: disable Lint/EmptyClass

data/lib/specdiff.rb

@@ -6,19 +6,14 @@ require_relative "specdiff/hashprint"
 require_relative "specdiff/compare"
 
 module Specdiff
-  # Compare two things, returns a Specdiff::Diff.
   def self.diff(...)
     ::Specdiff::Compare.call(...)
   end
 
-  # Use Specdiff's implementation for turning a nested hash/array structure
-  # into a string. Optimized for diff quality.
   def self.hashprint(...)
     ::Specdiff::Hashprint.call(...)
   end
 
-  # Use Specdiff's inspect, which has some extra logic layered in for
-  # dates/time/bigdecimal. For most objects this just delegates to #inspect.
   def self.diff_inspect(...)
     ::Specdiff::Inspect.call(...)
   end

data/specdiff.gemspec

@@ -6,10 +6,18 @@ Gem::Specification.new do |spec|
   spec.name = "specdiff"
   spec.version = Specdiff::VERSION
   spec.authors = ["Odin Heggvold Bekkelund"]
-  spec.email = ["odinhb@protonmail.com"]
+  spec.email = ["odin.heggvold.bekkelund@dev.dodo.no"]
 
-  spec.summary = "Improved request body diffs for webmock"
-  spec.homepage = "https://github.com/odinhb/specdiff"
+  spec.summary = "Improved diffing for WebMock and RSpec"
+  spec.description = <<~TXT
+    Specdiff aims to improve both RSpec's and WebMock's diffing by applying \
+    opinionated heuristics, and comes with integrations (monkey-patches) for \
+    both. Particularly noteworthy improvements are made to working with deeply \
+    nested hash/array structures in RSpec, and plaintext/xml request bodies in \
+    WebMock.
+  TXT
+
+  spec.homepage = "https://github.com/dodoas/specdiff"
   spec.license = "MIT"
   spec.required_ruby_version = ">= 3.0.0"
 
@@ -17,13 +25,12 @@ Gem::Specification.new do |spec|
   spec.metadata["source_code_uri"] = spec.homepage
   spec.metadata["changelog_uri"] = "#{spec.homepage}/CHANGELOG.md"
 
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
-    end
-  end
+  spec.files =
+    Dir["*.gemspec"] +
+    Dir["*.md"] +
+    Dir["*.txt"] +
+    Dir[".gitignore"] +
+    Dir["lib/**/*.rb"]
   spec.require_paths = ["lib"]
 
   spec.add_dependency "hashdiff", "~> 1.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: specdiff
 version: !ruby/object:Gem::Version
-  version: 0.3.0.pre.rc1
+  version: 0.3.0
 platform: ruby
 authors:
 - Odin Heggvold Bekkelund
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-02 00:00:00.000000000 Z
+date: 2024-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashdiff
@@ -38,33 +38,23 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
-description:
+description: 'Specdiff aims to improve both RSpec''s and WebMock''s diffing by applying
+  opinionated heuristics, and comes with integrations (monkey-patches) for both. Particularly
+  noteworthy improvements are made to working with deeply nested hash/array structures
+  in RSpec, and plaintext/xml request bodies in WebMock.
+
+  '
 email:
-- odinhb@protonmail.com
+- odin.heggvold.bekkelund@dev.dodo.no
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rspec"
-- ".rubocop.yml"
-- ".tool-versions"
+- ".gitignore"
 - CHANGELOG.md
-- Gemfile
-- Gemfile.lock
+- DEVELOPMENT.md
 - LICENSE.txt
 - README.md
-- Rakefile
-- assets/webmock_json_with_specdiff.png
-- assets/webmock_text_with_specdiff.png
-- examples/rspec/.rspec
-- examples/rspec/Gemfile
-- examples/rspec/Gemfile.lock
-- examples/rspec/spec/example_spec.rb
-- examples/rspec/spec/spec_helper.rb
-- examples/webmock/Gemfile
-- examples/webmock/Gemfile.lock
-- examples/webmock/json.rb
-- examples/webmock/text.rb
 - glossary.txt
 - lib/specdiff.rb
 - lib/specdiff/colorize.rb
@@ -72,7 +62,7 @@ files:
 - lib/specdiff/config.rb
 - lib/specdiff/diff.rb
 - lib/specdiff/differ.rb
-- lib/specdiff/differ/hashdiff.rb
+- lib/specdiff/differ/hash.rb
 - lib/specdiff/differ/not_found.rb
 - lib/specdiff/differ/text.rb
 - lib/specdiff/hashprint.rb
@@ -84,13 +74,13 @@ files:
 - lib/specdiff/version.rb
 - lib/specdiff/webmock.rb
 - specdiff.gemspec
-homepage: https://github.com/odinhb/specdiff
+homepage: https://github.com/dodoas/specdiff
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/odinhb/specdiff
-  source_code_uri: https://github.com/odinhb/specdiff
-  changelog_uri: https://github.com/odinhb/specdiff/CHANGELOG.md
+  homepage_uri: https://github.com/dodoas/specdiff
+  source_code_uri: https://github.com/dodoas/specdiff
+  changelog_uri: https://github.com/dodoas/specdiff/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -102,12 +92,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
-summary: Improved request body diffs for webmock
+summary: Improved diffing for WebMock and RSpec
 test_files: []

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper