3.4 generating a couple warnings

[searls]

Absolutely love super_diff and grateful for your work keeping this project alive.

I'm revitalizing my & @tenderlove's TLDR project and noticed a couple warnings in its test output:

Run options: --seed 34394

# Running:

......................................................../Users/justin/.rbenv/versions/3.4.1/lib/ruby/gems/3.4.0/gems/super_diff-0.15.0/lib/super_diff/core/inspection_tree.rb:17: warning: the block passed to 'SuperDiff::Core::InspectionTree#add_node' defined at /Users/justin/.rbenv/versions/3.4.1/lib/ruby/gems/3.4.0/gems/super_diff-0.15.0/lib/super_diff/core/inspection_tree.rb:119 may be ignored
/Users/justin/.rbenv/versions/3.4.1/lib/ruby/gems/3.4.0/gems/super_diff-0.15.0/lib/super_diff/core/inspection_tree.rb:122: warning: the block passed to 'SuperDiff::Core::InspectionTree#build_node' defined at /Users/justin/.rbenv/versions/3.4.1/lib/ruby/gems/3.4.0/gems/super_diff-0.15.0/lib/super_diff/core/inspection_tree.rb:129 may be ignored
.................................................................................

Finished in 2.268127s, 60.4023 runs/s, 231.9094 assertions/s.

137 runs, 526 assertions, 0 failures, 0 errors, 0 skips

To replicate:

git clone git@github.com:tendersearls/tldr.git
cd tldr
./script/setup 
./script/test

Sorry I don't have time right now to pinpoint which test is triggering it right now!

[searls]

Update: I realized this warning will just ship with TLDR if I cut a release, so I looked into it and was able to build a minimal repro test:

require "minitest/autorun"
require "super_diff"

# run with $ ruby -w dumb_test.rb
#
# You should get this under 3.4
# lib/super_diff/core/inspection_tree.rb:17: warning: the block passed to 'SuperDiff::Core::InspectionTree#add_node' defined at /Users/justin/.rbenv/versions/3.4.1/lib/ruby/gems/3.4.0/gems/super_diff-0.15.0/lib/super_diff/core/inspection_tree.rb:119 may be ignored
# lib/super_diff/core/inspection_tree.rb:122: warning: the block passed to 'SuperDiff::Core::InspectionTree#build_node' defined at /Users/justin/.rbenv/versions/3.4.1/lib/ruby/gems/3.4.0/gems/super_diff-0.15.0/lib/super_diff/core/inspection_tree.rb:129 may be ignored
class DumbTest < Minitest::Test
  def test_superdiff_issue
    SuperDiff::EqualityMatchers::Main.call(expected: 1, actual: 2)
  end
end

You should be able to run with ruby -w dumb_test.rb

Basically, it appears that the issue is triggered whenever superdiff is invoked in a situation where a diff needs to be generated (i.e. 1 does not equal 2) , which is a pretty major issue since most folks run tests with warnings enabled, so I imagine this warning will fire every time an assertion fails. As a result, I think this is an important issue to fix

(The reason our build was seeing it on every run was because our assert_raises that force test failures were all invoking this code path intentionally to exercise our assertion library and then rescuing.)

[searls]

Pulled down the repo and confirmed that under 3.4, the test suite also generates these warnings.

Ran:

BUNDLE_GEMFILE="gemfiles/no_rails_rspec_gte_3_13.gemfile" bundle 
BUNDLE_GEMFILE="gemfiles/no_rails_rspec_gte_3_13.gemfile" bundle exec rake

Yielded this:

---------- super_diff warnings: -------------------------------------------
/Users/justin/code/splitwise/super_diff/lib/super_diff/core/inspection_tree.rb:17: warning: the block passed to 'SuperDiff::Core::InspectionTree#add_node' defined at /Users/justin/code/splitwise/super_diff/lib/super_diff/core/inspection_tree.rb:119 may be ignored
/Users/justin/code/splitwise/super_diff/lib/super_diff/core/inspection_tree.rb:122: warning: the block passed to 'SuperDiff::Core::InspectionTree#build_node' defined at /Users/justin/code/splitwise/super_diff/lib/super_diff/core/inspection_tree.rb:129 may be ignored
/Users/justin/code/splitwise/super_diff/lib/super_diff/rspec/matcher_text_template.rb:31: warning: the block passed to 'SuperDiff::RSpec::MatcherTextTemplate#add_token' defined at /Users/justin/code/splitwise/super_diff/lib/super_diff/rspec/matcher_text_template.rb:72 may be ignored
/Users/justin/code/splitwise/super_diff/lib/super_diff/rspec/matcher_text_template.rb:23: warning: the block passed to 'SuperDiff::RSpec::MatcherTextTemplate#add_token' defined at /Users/justin/code/splitwise/super_diff/lib/super_diff/rspec/matcher_text_template.rb:72 may be ignored
---------------------------------------------------------------------------
super_diff warnings written to /Users/justin/code/splitwise/super_diff/tmp/warnings_logger/relevant_warnings.txt.
Non super_diff warnings were raised during the test run. These have been written to /Users/justin/code/splitwise/super_diff/tmp/warnings_logger/irrelevant_warnings.txt.
All warnings were written to /Users/justin/code/splitwise/super_diff/tmp/warnings_logger/all_warnings.txt.

[searls]

Just confirmed this was a Prism bug fixed in Ruby and released in 3.4.2.

Under 3.4.2, I actually get a different set of warnings, but they're not affecting super_diff users

/Users/justin/.rbenv/versions/3.4.2/lib/ruby/gems/3.4.0/gems/rspec-expectations-3.13.0/lib/rspec/matchers/dsl.rb:38: warning: method redefined; discarding old an_array_matching
/Users/justin/.rbenv/versions/3.4.2/lib/ruby/gems/3.4.0/gems/rspec-expectations-3.13.0/lib/rspec/matchers/dsl.rb:38: warning: previous definition of an_array_matching was here
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:17: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:17: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:17: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:17: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:17: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:17: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:17: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:17: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:17: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:17: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:17: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:17: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:17: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:17: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:17: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:17: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:17: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:17: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:17: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:17: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:17: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:17: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:17: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:17: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:17: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:17: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:17: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:17: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:17: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:17: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:17: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:17: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:17: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:17: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:17: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:17: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:18: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:18: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:17: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:17: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:19: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:19: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:18: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:18: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:17: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:17: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:18: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:18: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:17: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:17: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:18: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:18: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:18: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:18: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:17: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:17: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:19: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:19: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:17: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:17: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:17: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:17: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:17: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:17: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:17: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:17: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:17: warning: mismatched indentations at 'end' with 'class' at 15
/Users/justin/code/splitwise/super_diff/tmp/integration_spec.rb:17: warning: mismatched indentations at 'end' with 'class' at 15

[jas14]

Thanks for all the investigation, @searls ! I'll see what I can do about tracking down those warnings. I know the mismatched end is coming from the generated test files; not sure why the redefinition warning is being emitted.