Fix error backtrace formatting on Ruby 3.4+ #1771
Conversation
| @@ -17,12 +17,15 @@ jobs: | |||
| fail-fast: false | |||
| matrix: | |||
| os: [ubuntu-latest, macos-latest, windows-latest] | |||
| ruby: ['3.0', '3.1', '3.2', '3.3'] | |||
| ruby: ['3.0', '3.1', '3.2', '3.3', '3.4'] | |||
There was a problem hiding this comment.
Add Ruby 3.4 to the CI build matrix.
| # This cop supports unsafe autocorrection (--autocorrect-all). | ||
| # Configuration parameters: EnforcedStyle, AllowModifiersOnSymbols. | ||
| # SupportedStyles: inline, group | ||
| Style/AccessModifierDeclarations: |
There was a problem hiding this comment.
The CI build was failing on several violations of this cop (unrelated to the code changes proposed in this pull request).
Mark the violations as TODO, so the CI build can pass.
| @@ -9,7 +9,7 @@ | |||
| let(:cucumber_command) { 'bundle exec cucumber --publish-quiet --profile none --format message' } | |||
|
|
|||
| CCK::Examples.gherkin.each do |example_name| | |||
| describe "'#{example_name}' example" do | |||
| describe "'#{example_name}' example", pending: example_name == 'empty' do # TODO: resolve the empty example. | |||
There was a problem hiding this comment.
Some tests were failing on the main branch. Specifically, the CCK specs on the empty example.
Let's mark these specs as pending until someone has time to investigate and resolve the issue.
| @io.print options.inspect | ||
| @io.print options.to_json |
There was a problem hiding this comment.
In Ruby 3.4 the Hash#inspect method produces a different format:
Ruby 3.4:
irb:001> { a: 1 }.inspect
=> "{a: 1}"
irb:002> { 'a' => 1 }.inspect
=> "{\"a\" => 1}"
irb:003> { 2 => 1 }.inspect
=> "{2 => 1}"
Ruby 3.3
irb:001> { a: 1 }.inspect
=> "{:a=>1}"
irb:002> { 'a' => 1 }.inspect
=> "{\"a\"=>1}"
irb:003> { 2 => 1 }.inspect
=> "{2=>1}"
Let's change the test to use to_json instead of inspect. This way the test expectations will be consistent across all versions of Ruby in the CI build matrix.
orien
changed the title
Accomodate the new Ruby 3.4+ backtrace display format
orien
force-pushed
the
accomodate-ruby-3.4-backtraces
branch
from
79026d3 to
7559a86
Compare
orien
force-pushed
the
accomodate-ruby-3.4-backtraces
branch
from
7559a86 to
92684f6
Compare
Description
Context
Cucumber performs filtering and formatting on error backtraces before displaying them in terminal output.
When running on Ruby 3.4, the filtering and formatting is not working. This is defect is caused by the new backtrace format introduced in Ruby 3.4.
See:
Change
Update the
Cucumber::Glue:: InvokeInWorldandCucumber::Formatter:: BacktraceFilterto support both styles of bactraces.Fixes #1770
Type of change
Checklist:
Your PR is ready for review once the following checklist is
complete. You can also add some checks if you want to.
bundle exec rubocopreports no offenses