minitest-difftastic 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 692dd87d40229d2fea8ac5e00900e45ae33ec436b33f22d98027037f5448ef22
-  data.tar.gz: d1f4de4c6be40d5bdcd5efed3907ecfc52725d15f8d7606083c0d34b4904e142
+  metadata.gz: ba6f4034a1edfc83d1b99e6640c23ce34a37dfd77a5680c60facbdb67ea06d47
+  data.tar.gz: 9e9b7c26ce30d9349dc8f46604ffff52ef08d299a6b59e9e93e4501dcb0df3e4
 SHA512:
-  metadata.gz: 16c1ffb8e443e9423074ec083cc94f7c90121c44590ca7559ae6e0ed6ba75e4d7bec2b293f576e22a7dd4d48487a20c63ca6e0c28a94355d1f6972e3917f0afb
-  data.tar.gz: fb8c0fa64bed4a4d163a295343083b37418cd27ade769f2b8cb71d1dd6f2f8fbd116d0838b5fdd5e19de0411638c8a503ebf9177a25af55ae493c4865914d0f3
+  metadata.gz: f524a77c4b54560126dd7badf0ee0bdaac377417027381703ff1bd6c48595153458f1a980996111c5d08693addb7fb376eeac5dedf349ea28e51a48a868c919c
+  data.tar.gz: c9162af19d34273740a9c7176e6ce2961713e8610f596aae6be30f2ce98dcdf4784e7506943019706c9655e2df7d94b1475dd59b675a05deea009df0adedc599

data/.rubocop.yml

@@ -7,6 +7,9 @@ Style/StringLiterals:
   Enabled: true
   EnforcedStyle: double_quotes
 
+Style/ClassAndModuleChildren:
+  Enabled: false
+
 Style/Documentation:
   Enabled: false
 
@@ -14,5 +17,19 @@ Style/StringLiteralsInInterpolation:
   Enabled: true
   EnforcedStyle: double_quotes
 
+Style/WordArray:
+  Enabled: false
+
+Style/BlockDelimiters:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 20
+
 Layout/LineLength:
   Max: 120
+
+Metrics/MethodLength:
+  Max: 20
+  Include:
+    - examples/**/*

data/Gemfile

@@ -6,4 +6,4 @@ gemspec
 
 gem "minitest", "~> 5.0"
 gem "rake", "~> 13.0"
-gem "rubocop", "~> 1.21"
+gem "rubocop", "~> 1.71"

data/Gemfile.lock

@@ -1,44 +1,49 @@
 PATH
   remote: .
   specs:
-    minitest-difftastic (0.1.1)
-      difftastic (~> 0.0.1)
+    minitest-difftastic (0.2.0)
+      difftastic (~> 0.6)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    base64 (0.1.1)
-    difftastic (0.0.1-arm64-darwin)
-    difftastic (0.0.1-x86_64-linux)
-    json (2.6.3)
+    difftastic (0.6.0-arm64-darwin)
+      pretty_please
+    difftastic (0.6.0-x86_64-linux)
+      pretty_please
+    dispersion (0.2.0)
+      prism
+    json (2.9.1)
     language_server-protocol (3.17.0.3)
     minitest (5.25.4)
-    parallel (1.23.0)
-    parser (3.2.2.4)
+    parallel (1.26.3)
+    parser (3.3.7.0)
       ast (~> 2.4.1)
       racc
+    pretty_please (0.2.0)
+      dispersion (~> 0.2)
+    prism (1.3.0)
     racc (1.8.1)
     rainbow (3.1.1)
     rake (13.2.1)
-    regexp_parser (2.9.2)
-    rexml (3.2.6)
-    rubocop (1.56.2)
-      base64 (~> 0.1.1)
+    regexp_parser (2.10.0)
+    rubocop (1.71.0)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.2.2.3)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.28.1, < 2.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.36.2, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.29.0)
-      parser (>= 3.2.1.0)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.37.0)
+      parser (>= 3.3.1.0)
     ruby-progressbar (1.13.0)
-    unicode-display_width (2.6.0)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
 
 PLATFORMS
   arm64-darwin-24
@@ -48,7 +53,7 @@ DEPENDENCIES
   minitest (~> 5.0)
   minitest-difftastic!
   rake (~> 13.0)
-  rubocop (~> 1.21)
+  rubocop (~> 1.71)
 
 BUNDLED WITH
    2.4.12

data/README.md

@@ -4,6 +4,28 @@ A Minitest Plugin which uses [`difftastic`](https://github.com/Wilfred/difftasti
 
 Also works for Rails tests using `ActiveSupport::TestCase`.
 
+## Try it yourself
+
+Clone this repo, run `bundle install` and then `rake examples` in your terminal.
+
+```ruby
+rake examples
+```
+
+You will get a few failing assertions printed to your terminal.
+
+```
+Failure:
+Examples::AssertEqual#test_assert_equal [examples/assert_equal.rb:8]:
+
+Expected                      Actual
+1 "Hello World"               1 "Hello Difftastic"
+```
+
+You can also look at the source code for the examples in the [`examples/`](https://github.com/marcoroth/minitest-difftastic/tree/main/examples) folder.
+
+## Screenshots
+
 ### Integers
 
 ![Integers Comparison](./screenshots/integers.png)
@@ -22,10 +44,10 @@ Also works for Rails tests using `ActiveSupport::TestCase`.
 
 ## Installation
 
-Install the gem and add to the application's Gemfile by executing:
+Install the gem and add to the application's Gemfile `test` group by executing:
 
 ```shell
-bundle add minitest-difftastic
+bundle add minitest-difftastic --group=test
 ```
 
 If bundler is not being used to manage dependencies, install the gem by executing:

data/Rakefile

@@ -6,7 +6,13 @@ require "rake/testtask"
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
   t.libs << "lib"
-  t.test_files = FileList["test/**/test_*.rb"]
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+Rake::TestTask.new(:examples) do |t|
+  t.libs << "examples"
+  t.libs << "lib"
+  t.test_files = FileList["examples/**/assert_*.rb"]
 end
 
 require "rubocop/rake_task"

data/examples/assert_equal.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require "example_helper"
+
+module Examples
+  class AssertEqual < Minitest::Test
+    def test_assert_equal_string
+      assert_equal "Hello World", "Hello Difftastic"
+    end
+
+    def test_assert_equal_with_nil
+      assert_equal nil, "nil"
+    end
+
+    def test_assert_equal_with_integer
+      assert_equal 1, "1"
+    end
+
+    def test_assert_equal_with_hash
+      assert_equal({ id: 1 }, { id: 2 })
+    end
+
+    def test_assert_equal_with_nested_hash
+      expected = {
+        id: 1,
+        data: {
+          name: "John A.",
+          tags: ["tag1", "tag2", "tag3"]
+        }
+      }
+
+      actual = {
+        id: 1,
+        data: {
+          name: "John B.",
+          tags: ["tag1", "tag3", "tag2"]
+        }
+      }
+
+      assert_equal expected, actual
+    end
+
+    def test_assert_equal_string_with_newlines
+      expected = <<~RUBY
+        class User < ApplicationRecord
+          has_many :posts
+        end
+      RUBY
+
+      actual = <<~RUBY
+        class User < ApplicationRecord
+          has_many :posts
+          ^^^^^^^^^^^^^^^ Rubocop::SomeRule Missing association to `organization`
+        end
+      RUBY
+
+      assert_equal expected, actual
+    end
+
+    def test_assert_equal_string_with_newlines_on_one_side
+      expected = <<~RUBY
+        Hello
+
+        World
+      RUBY
+
+      actual = "Hello"
+
+      assert_equal expected, actual
+    end
+  end
+end

data/examples/assert_nil.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "example_helper"
+
+module Examples
+  class AssertNil < Minitest::Test
+    def test_assert_nil_with_string
+      assert_nil "String"
+    end
+
+    def test_assert_nil_with_nil
+      assert_nil nil
+    end
+
+    def test_assert_nil_with_true
+      assert_nil true
+    end
+
+    def test_assert_nil_with_false
+      assert_nil false
+    end
+  end
+end

data/examples/assert_operator.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "example_helper"
+
+module Examples
+  class AssertOperator < Minitest::Test
+    def test_operator_case_equality
+      assert_operator "Left", :===, "Right"
+    end
+
+    def test_operator_eql
+      assert_operator 1, :eql?, 1.0
+    end
+
+    def test_operator_equal
+      assert_operator 1, :equal?, 1.0
+    end
+
+    def test_operator_lt
+      assert_operator 1, :>, 2
+    end
+  end
+end

data/examples/assert_predicate.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "example_helper"
+
+module Examples
+  class AssertPredicate < Minitest::Test
+    def test_assert_predicate_array_empty
+      assert_predicate [1], :empty?
+    end
+
+    def test_assert_predicate_string_empty
+      assert_predicate "1", :empty?
+    end
+
+    def test_assert_predicate_object_empty
+      assert_predicate({ id: 1 }, :empty?)
+    end
+
+    def test_assert_predicate_string_frozen
+      assert_predicate(+"", :frozen?)
+    end
+
+    def test_assert_predicate_with_custom_method
+      return if Gem::Version.new(RUBY_VERSION) < "3.2"
+
+      test = Data.define(:enabled) do
+        def self.name
+          "Config"
+        end
+
+        def enabled?
+          enabled
+        end
+      end
+
+      assert_predicate test.new(enabled: false), :enabled?
+    end
+  end
+end

data/examples/example_helper.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+
+require "minitest/difftastic"
+require "minitest/autorun"
+
+require "set"
+require "date"
+require "pathname"

data/lib/minitest/difftastic/patches/assert_nil.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Difftastic
+  module Patches
+    module AssertNil
+      def assert_nil(obj, msg = nil)
+        msg ||= message(nil, "") {
+          differ = ::Difftastic::Differ.new(
+            color: :always,
+            tab_width: 2,
+            syntax_highlight: :off,
+            left_label: "Expected",
+            right_label: "Actual"
+          )
+
+          "\n#{differ.diff_objects(nil, obj)}"
+        }
+        super
+      rescue StandardError
+        super
+      end
+
+      Minitest::Assertions.prepend(self)
+    end
+  end
+end

data/lib/minitest/difftastic/patches/assert_operator.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Difftastic
+  module Patches
+    module AssertOperator
+      def assert_operator(object1, operator, object2 = UNDEFINED, msg = nil)
+        msg ||= message(nil, "") {
+          differ = ::Difftastic::Differ.new(
+            color: :always,
+            tab_width: 2,
+            syntax_highlight: :off,
+            left_label: "Expected",
+            right_label: "to be #{operator}"
+          )
+
+          "\n#{differ.diff_objects(object1, object2)}"
+        }
+
+        super
+      rescue StandardError
+        super
+      end
+
+      Minitest::Assertions.prepend(self)
+    end
+  end
+end

data/lib/minitest/difftastic/patches/assert_predicate.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Difftastic
+  module Patches
+    module AssertPredicate
+      def assert_predicate(object, predicate, msg = nil)
+        msg ||= message(nil, "") {
+          pretty = Difftastic.pretty(object)
+
+          expected = <<~RUBY
+            #{pretty}.#{predicate}
+
+            # => true
+          RUBY
+
+          actual = <<~RUBY
+            #{pretty}.#{predicate}
+
+            # => false
+          RUBY
+
+          differ = ::Difftastic::Differ.new(
+            color: :always,
+            tab_width: 2,
+            syntax_highlight: :on,
+            left_label: "Expected",
+            right_label: "Actual",
+            context: expected.lines.count
+          )
+
+          "\n#{differ.diff_ruby(expected, actual)}"
+        }
+
+        super
+      rescue StandardError
+        super
+      end
+
+      Minitest::Assertions.prepend(self)
+    end
+  end
+end

data/lib/minitest/difftastic/patches/diff.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Difftastic
+  module Patches
+    module Diff
+      def diff(exp, act)
+        case [exp, act]
+        in [String => exp, String => act] if exp.include?("\n") || act.include?("\n")
+          "\n#{::Minitest::Difftastic::STRING_DIFFER.diff_strings(exp, act)}"
+        else
+          "\n#{::Minitest::Difftastic::DEFAULT_DIFFER.diff_objects(exp, act)}"
+        end
+      rescue StandardError => e
+        puts "Minitest::Difftastic error: #{e.inspect} (#{e.backtrace[0]})"
+        super
+      end
+
+      Minitest::Assertions.prepend(self)
+    end
+  end
+end

data/lib/minitest/difftastic/version.rb

@@ -2,6 +2,6 @@
 
 module Minitest
   module Difftastic
-    VERSION = "0.1.1"
+    VERSION = "0.2.0"
   end
 end

data/lib/minitest/difftastic.rb

@@ -1,8 +1,23 @@
 # frozen_string_literal: true
 
-require_relative "difftastic/version"
+require "difftastic"
 
-module Minitest
-  module Difftastic
-  end
+require "minitest/difftastic/version"
+
+module Minitest::Difftastic
+  DEFAULT_DIFFER = ::Difftastic::Differ.new(
+    color: :always,
+    tab_width: 2,
+    syntax_highlight: :off,
+    left_label: "Expected",
+    right_label: "Actual"
+  )
+
+  STRING_DIFFER = ::Difftastic::Differ.new(
+    color: :always,
+    tab_width: 2,
+    syntax_highlight: :off,
+    left_label: "Expected (String)",
+    right_label: "Actual (String)"
+  )
 end

data/lib/minitest/difftastic_plugin.rb

@@ -1,48 +1,9 @@
 # frozen_string_literal: true
 
-require "difftastic"
+require "minitest/difftastic"
 
-# TODO: use refinements
-module Minitest
-  module Assertions
-    MINIMUM_OFFSET = 29
-    TAB_WIDTH = 2
+require "minitest/difftastic/patches/diff"
 
-    RED = "\e[91;1m"
-    GREEN = "\e[92;1m"
-    RESET = "\e[0m"
-
-    DIFFER = ::Difftastic::Differ.new(
-      color: :always,
-      tab_width: TAB_WIDTH,
-      syntax_highlight: :off
-    )
-
-    alias diff_original diff
-
-    def diff(exp, act)
-      diff = DIFFER.diff_objects(exp, act)
-      offset = actual_text_offset(diff.split("\n").first)
-
-      "\n#{RED}#{"Expected".ljust(offset)} #{GREEN}Actual#{RESET}\n#{diff}"
-    rescue StandardError => e
-      puts "Minitest::DiffTastic error: #{e.inspect} (#{e.backtrace[0]})"
-      diff_original(exp, act)
-    end
-
-    private
-
-    def strip_ansi_formatting(string)
-      string.to_s.gsub(/\e\[[0-9;]*m/, "")
-    end
-
-    def actual_text_offset(line)
-      stripped_line = strip_ansi_formatting(line)
-      _lhs, rhs = stripped_line.split(/\s{#{TAB_WIDTH},}/, 2)
-
-      offset = stripped_line.index("#{" " * TAB_WIDTH}#{rhs}") + TAB_WIDTH - 1
-
-      [MINIMUM_OFFSET, offset].max
-    end
-  end
-end
+require "minitest/difftastic/patches/assert_nil"
+require "minitest/difftastic/patches/assert_operator"
+require "minitest/difftastic/patches/assert_predicate"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minitest-difftastic
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Marco Roth
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-01-22 00:00:00.000000000 Z
+date: 2025-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: difftastic
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.1
+        version: '0.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.1
+        version: '0.6'
 description: Minitest Plugin to use difftastic for failed assertions
 email:
 - marco.roth@intergga.ch
@@ -38,7 +38,16 @@ files:
 - Gemfile.lock
 - README.md
 - Rakefile
+- examples/assert_equal.rb
+- examples/assert_nil.rb
+- examples/assert_operator.rb
+- examples/assert_predicate.rb
+- examples/example_helper.rb
 - lib/minitest/difftastic.rb
+- lib/minitest/difftastic/patches/assert_nil.rb
+- lib/minitest/difftastic/patches/assert_operator.rb
+- lib/minitest/difftastic/patches/assert_predicate.rb
+- lib/minitest/difftastic/patches/diff.rb
 - lib/minitest/difftastic/version.rb
 - lib/minitest/difftastic_plugin.rb
 - screenshots/integers.png
@@ -68,7 +77,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Minitest Plugin to use difftastic for failed assertions