Fix JSON Formatter

[eraffel-MDSol]

Description

With the change to the JSON class, passing pretty as a parameter no longer does anything. pretty_generate should be called for the desired output.

End of the background is also broken if the user has Before hooks that come from libraries other than this one.

Type of change

• Bug fix (non-breaking change which fixes an issue)

Checklist:

Your PR is ready for review once the following checklist is
complete. You can also add some checks if you want to.

• Tests have been added for any changes to behaviour of the code
• New and existing tests are passing locally and on CI
• bundle exec rubocop reports no offenses
• RDoc comments have been updated
• CHANGELOG.md has been updated

[eraffel-MDSol]

Tests are passing locally

[aurelien-reeves]

Thanks a lot for your contribution!

I have a few comments, but no big deal actually 💪

[eraffel-MDSol]

@aurelien-reeves Something else I noticed, the JSON formatter no longer has expanded docstrings for Scenario Outlines. Is there a reason to use the step_source from the lookup here rather than the multiline_arg from the test_step like it used to. https://github.com/cucumber/cucumber-ruby/blob/main/lib/cucumber/formatter/json.rb#L178

It seems like the cucumber gets parsed 3 times, by the old cucumber-core code, the messages code, and the cucumber-gherkin code, and the one it's using here is the only one that doesn't have the expanded docstring text.

[aurelien-reeves]

@aurelien-reeves Something else I noticed, the JSON formatter no longer has expanded docstrings for Scenario Outlines. Is there a reason to use the step_source from the lookup here rather than the multiline_arg from the test_step like it used to. https://github.com/cucumber/cucumber-ruby/blob/main/lib/cucumber/formatter/json.rb#L178

It seems like the cucumber gets parsed 3 times, by the old cucumber-core code, the messages code, and the cucumber-gherkin code, and the one it's using here is the only one that doesn't have the expanded docstring text.

Well, this is beyond my knowledge actually 😅
@aslakhellesoy @luke-hill @mattwynne any idea?

[aslakhellesoy]

Sorry, I haven't made any significant changes to this file for over a decade.

[eraffel-MDSol]

I guess I'll ping @brasmusson since he made the most recent change to the relevant code, and otherwise I'll update it to what I said, using the property from test_step?

[aurelien-reeves]

I guess I'll ping @brasmusson since he made the most recent change to the relevant code, and otherwise I'll update it to what I said, using the property from test_step?

Don't hesitate to submit PRs 👍

[eraffel-MDSol]

My hesitation is that it'd be reverting a change, and I don't understand why the change was made in the first place, lol.

[aurelien-reeves]

If some tests are broken, we will have the opportunity to dig deeper and discuss it 😃
If not, the PR will have the opportunity to be reviewed and merged 🎉

Please note that we won't maintain the JSON formatter our-self - the mainteners - anymore. We won't deprecate and remove it either because it is used a lot, but we want to promote the messages formatter instead.

That said, we won't reject contributions to the JSON formatter. Of course we may have some feedback depending on the impact those contributions may have, but they will always be welcome.

[aurelien-reeves]

@eraffel-MDSol do you want to do something else with that PR? Or is it ready to be merged?

[eraffel-MDSol]

Yea, I still want to fix the issue with placeholders in doc strings. I'll try to get to it this week. Just been busy. Thanks!

[aurelien-reeves]

No worries, no rush :)

[eraffel-MDSol]

@aurelien-reeves I pushed my changes to support doc strings in Scenario Outlines

[aurelien-reeves]

@eraffel-MDSol it looks good, thanks 👍
Just missing an entry in the changelog for the docstring support in scenario outlines, and it should be fine 👌

[aurelien-reeves]

Thanks a lot @eraffel-MDSol 🤩

[aslakhellesoy]

Hi @eraffel-MDSol,

Thanks for your making your first contribution to Cucumber, and welcome to the Cucumber committers team! You can now push directly to this repo and all other repos under the cucumber organization! 🍾

In return for this generous offer we hope you will:

• ✅ Continue to use branches and pull requests. When someone on the core team approves a pull request (yours or someone else's), you're welcome to merge it yourself.
• 💚 Commit to setting a good example by following and upholding our code of conduct in your interactions with other collaborators and users.
• 💬 Join the community Slack channel to meet the rest of the team and make yourself at home.
• ℹ️ Don't feel obliged to help, just do what you can if you have the time and the energy.
• 🙋 Ask if you need anything. We're looking for feedback about how to make the project more welcoming, so please tell us!

On behalf of the Cucumber core team,
Aslak Hellesøy
Creator of Cucumber