specdiff 0.1.1 → 0.3.0.pre.rc1

data/lib/specdiff/hashprint.rb

@@ -0,0 +1,154 @@
+# Tries to print nested hash/array structures such that they are as convenient
+# as possible for a diffing algorithm designed for text (like source code).
+# Basically tries to reproduce consistent literal source code form for ruby
+# hashes and arrays and objects (although it falls back to #inspect).
+class Specdiff::Hashprint
+  def self.call(...)
+    new.call(...)
+  end
+
+  INDENTATION_SPACES = 2
+  SPACE = " ".freeze
+  COMMA = ",".freeze
+  NEWLINE = "\n".freeze
+
+  def call(thing)
+    @indentation_level = 0
+    @indentation_per_level = SPACE * INDENTATION_SPACES
+    @indent = ""
+    @skip_next_opening_indent = false
+
+    @output = StringIO.new
+
+    output(thing)
+
+    @output.string
+  end
+
+private
+
+  def recalculate_indent
+    @indent = @indentation_per_level * @indentation_level
+  end
+
+  def increase_indentation
+    @indentation_level += 1
+    recalculate_indent
+  end
+
+  def decrease_indentation
+    @indentation_level -= 1
+    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
+
+    nil
+  end
+
+  def this_indent_should_be_skipped
+    if @skip_next_opening_indent
+      @skip_next_opening_indent = false
+      true
+    else
+      false
+    end
+  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
+      output_hash(thing)
+    elsif Array === thing
+      output_array(thing)
+    else
+      output_unknown(thing)
+    end
+  end
+
+  HASH_OPEN = "{".freeze
+  HASH_CLOSE = "}".freeze
+  HASHROCKET = "=>".freeze
+  COLON = ":".freeze
+
+  def output_hash(hash)
+    @output << @indent unless this_indent_should_be_skipped
+
+    @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
+        end
+
+        skip_next_opening_indent
+        output(value)
+
+        @output << COMMA
+        @output << NEWLINE
+      end
+      decrease_indentation
+
+      @output << @indent
+    # end
+
+    @output << HASH_CLOSE
+  end
+
+  ARRAY_OPEN = "[".freeze
+  ARRAY_CLOSE = "]".freeze
+
+  def output_array(array)
+    @output << @indent unless this_indent_should_be_skipped
+
+    @output << ARRAY_OPEN
+
+    # unless array.empty?
+      @output << NEWLINE
+
+      increase_indentation
+      array.each do |element|
+        output(element)
+        @output << COMMA
+        @output << NEWLINE
+      end
+      decrease_indentation
+
+      @output << @indent
+    # end
+
+    @output << ARRAY_CLOSE
+  end
+
+  def output_unknown(thing)
+    @output << @indent unless this_indent_should_be_skipped
+
+    @output << ::Specdiff.diff_inspect(thing)
+  end
+end

data/lib/specdiff/inspect.rb

@@ -0,0 +1,41 @@
+class Specdiff::Inspect
+  TIME_FORMAT = "%Y-%m-%d %H:%M:%S %z"
+  DATE_FORMAT = "%Y-%m-%d"
+
+  def self.call(...)
+    new.call(...)
+  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
+      "#<Time: #{thing.strftime(TIME_FORMAT)}>"
+    elsif DateTime === thing
+      "#<DateTime: #{thing.rfc3339}>"
+    elsif Date === thing
+      "#<Date: #{thing.strftime(DATE_FORMAT)}>"
+    elsif defined?(BigDecimal) && BigDecimal === thing
+      "#<BigDecimal: #{thing.to_s('F')}>"
+    else
+      begin
+        thing.inspect
+      rescue NoMethodError
+        inspect_anyway(thing)
+      end
+    end
+  end
+
+  private def inspect_anyway(uninspectable)
+    "#<uninspectable #{class_of(uninspectable)}>"
+  end
+
+  private def class_of(uninspectable)
+    uninspectable.class
+  rescue NoMethodError
+    singleton_class = class << uninspectable; self; end
+    singleton_class.ancestors
+      .find { |ancestor| !ancestor.equal?(singleton_class) }
+  end
+end

data/lib/specdiff/plugins.rb

@@ -1,9 +1,8 @@
 module Specdiff
-  THREADLOCAL_PLUGINS_KEY = :__specdiff_plugins
-
-  def self.plugins
-    threadlocal[THREADLOCAL_PLUGINS_KEY]
+  class << self
+    attr_reader :plugins
   end
+  @plugins = []
 
   BUILTIN_PLUGINS = %i[json]
   BUILTIN_TYPES = %i[hash array binary text nil]
@@ -59,14 +58,13 @@ module Specdiff
       MSG
     end
 
-    ::Specdiff.plugins << plugin
+    @plugins << plugin
   end
 
   # private
   def self._clear_plugins!
-    threadlocal[THREADLOCAL_PLUGINS_KEY] = []
+    @plugins = []
   end
-  _clear_plugins!
 
   module Plugins
   end

data/lib/specdiff/rspec.rb

@@ -0,0 +1,33 @@
+class RSpec::Support::Differ
+  alias old_diff diff
+
+  def diff(actual, expected)
+    diff = ::Specdiff.diff(expected, actual)
+    if diff.empty?
+      ""
+    else
+      "\n#{diff}"
+    end
+  end
+end
+
+# This stops rspec from truncating strings w/ ellipsis, as well as making the
+# "inspect" output consistent with specdiff's.
+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

data/lib/specdiff/version.rb

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

data/lib/specdiff/webmock.rb

@@ -1 +1,41 @@
-require_relative "webmock/request_body_diff"
+require "hashdiff"
+require "json"
+
+module WebMock
+  class RequestBodyDiff
+    def initialize(request_signature, request_stub)
+      @request_signature = request_signature
+      @request_stub      = request_stub
+    end
+
+    PrettyPrintableThingy = Struct.new(:specdiff) do
+      # webmock does not print the diff if it responds true to this.
+      def empty?
+        specdiff.empty?
+      end
+
+      # webmock prints the diff by passing us to PP.pp, which in turn uses this
+      # method.
+      def pretty_print(pp)
+        pp.text("\r") # remove a space that isn't supposed to be there
+        pp.text(specdiff.to_s)
+      end
+    end
+
+    def body_diff
+      specdiff = Specdiff.diff(request_stub_body, request_signature.body)
+      PrettyPrintableThingy.new(specdiff)
+    end
+
+    attr_reader :request_signature, :request_stub
+    private :request_signature, :request_stub
+
+    private
+
+    def request_stub_body
+      request_stub.request_pattern &&
+        request_stub.request_pattern.body_pattern &&
+        request_stub.request_pattern.body_pattern.pattern
+    end
+  end
+end

data/lib/specdiff.rb

@@ -1,12 +1,26 @@
 require_relative "specdiff/version"
-require_relative "specdiff/threadlocal"
 require_relative "specdiff/config"
 require_relative "specdiff/colorize"
+require_relative "specdiff/inspect"
+require_relative "specdiff/hashprint"
+require_relative "specdiff/compare"
 
 module Specdiff
-  # Diff two things
+  # Compare two things, returns a Specdiff::Diff.
   def self.diff(...)
-    ::Specdiff::Differ.call(...)
+    ::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
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: specdiff
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.3.0.pre.rc1
 platform: ruby
 authors:
 - Odin Heggvold Bekkelund
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-04 00:00:00.000000000 Z
+date: 2024-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashdiff
@@ -38,7 +38,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
-description: 
+description:
 email:
 - odinhb@protonmail.com
 executables: []
@@ -54,6 +54,13 @@ files:
 - 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
@@ -61,19 +68,21 @@ files:
 - glossary.txt
 - lib/specdiff.rb
 - lib/specdiff/colorize.rb
+- lib/specdiff/compare.rb
 - lib/specdiff/config.rb
 - lib/specdiff/diff.rb
 - lib/specdiff/differ.rb
 - lib/specdiff/differ/hashdiff.rb
 - lib/specdiff/differ/not_found.rb
 - lib/specdiff/differ/text.rb
+- lib/specdiff/hashprint.rb
+- lib/specdiff/inspect.rb
 - lib/specdiff/plugin.rb
 - lib/specdiff/plugins.rb
 - lib/specdiff/plugins/json.rb
-- lib/specdiff/threadlocal.rb
+- lib/specdiff/rspec.rb
 - lib/specdiff/version.rb
 - lib/specdiff/webmock.rb
-- lib/specdiff/webmock/request_body_diff.rb
 - specdiff.gemspec
 homepage: https://github.com/odinhb/specdiff
 licenses:
@@ -82,7 +91,7 @@ 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
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -93,12 +102,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: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.4.10
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Improved request body diffs for webmock
 test_files: []

data/lib/specdiff/threadlocal.rb

@@ -1,8 +0,0 @@
-module Specdiff
-  THREADLOCAL_KEY = :__specdiff_threadlocals
-
-  def self.threadlocal
-    Thread.current.thread_variable_get(THREADLOCAL_KEY) ||
-      Thread.current.thread_variable_set(THREADLOCAL_KEY, {})
-  end
-end

data/lib/specdiff/webmock/request_body_diff.rb

@@ -1,41 +0,0 @@
-require "hashdiff"
-require "json"
-
-module WebMock
-  class RequestBodyDiff
-    def initialize(request_signature, request_stub)
-      @request_signature = request_signature
-      @request_stub      = request_stub
-    end
-
-    PrettyPrintableThingy = Struct.new(:specdiff) do
-      # webmock does not print the diff if it responds true to this.
-      def empty?
-        specdiff.empty?
-      end
-
-      # webmock prints the diff by passing us to PP.pp, which in turn uses this
-      # method.
-      def pretty_print(pp)
-        pp.text("\r") # remove a space that isn't supposed to be there
-        pp.text(specdiff.to_s)
-      end
-    end
-
-    def body_diff
-      specdiff = Specdiff.diff(request_stub_body, request_signature.body)
-      PrettyPrintableThingy.new(specdiff)
-    end
-
-    attr_reader :request_signature, :request_stub
-    private :request_signature, :request_stub
-
-    private
-
-    def request_stub_body
-      request_stub.request_pattern &&
-        request_stub.request_pattern.body_pattern &&
-        request_stub.request_pattern.body_pattern.pattern
-    end
-  end
-end