Ensure response.parsed_body support for pattern matching

[seanpdoyle]

Motivation / Background

Both Nokogiri and Minitest have merged the PRs mentioned to integrate support for Ruby's Pattern matching
(sparklemotion/nokogiri#2523 and minitest/minitest#936, respectively).

Detail

This commit adds coverage for those new assertions, and incorporates examples into the documentation for the response.parsed_body method.

Additional information

In order to incorporate pattern-matching support for JSON responses, this commit changes the response parser to call JSON.parse with object_class: ActiveSupport::HashWithIndifferentAccess, since String instances for Hash keys are incompatible with Ruby's syntactically pattern matching.

For example:

irb(main):001:0> json = {"key" => "value"}
=> {"key"=>"value"}
irb(main):002:0> json in {key: /value/}
=> false

irb(main):001:0> json = {"key" => "value"}
=> {"key"=>"value"}
irb(main):002:0> json in {"key" => /value/}
.../3.2.0/lib/ruby/gems/3.2.0/gems/irb-1.7.4/lib/irb/workspace.rb:113:in `eval': (irb):2: syntax error, unexpected terminator, expecting literal content or tSTRING_DBEG or tSTRING_DVAR or tLABEL_END (SyntaxError)
json in {"key" => /value/}
             ^

        .../ruby/3.2.0/lib/ruby/gems/3.2.0/gems/irb-1.7.4/exe/irb:9:in `<top (required)>'
        .../ruby/3.2.0/bin/irb:25:in `load'
        .../ruby/3.2.0/bin/irb:25:in `<main>'

When the Hash maps String keys to Symbol keys, it's able to be pattern matched:

irb(main):005:0> json = {"key" => "value"}.with_indifferent_access
=> {"key"=>"value"}
irb(main):006:0> json in {key: /value/}
=> true

Checklist

Before submitting the PR make sure the following are checked:

• This Pull Request is related to one change. Changes that are unrelated should be opened in separate PRs.
• Commit message has a detailed description of what changed and why. If this PR fixes a related issue include it in the commit message. Ex: [Fix #issue-number]
• Tests are added or updated if you fix a bug or add a feature.
• CHANGELOG files are updated for the changed libraries if there is a behavior change or additional feature. Minor bug fixes and documentation changes should not be included.

[seanpdoyle]

This change is potentially breaking and not backwards compatible.

Since it's a test harness change, and doesn't affect host application's implementations, I'm uncertain of the impact.

The risk is that it makes callers of response.parsed_body more flexible than the authors originally intended.

While that's true, tests that are currently passing would continue to pass, since String and Symbol keys are interchangeable.

The trouble is that subsequent changes to those suites that used symbols would pass when the did not before.

Some alternatives to this change:

• Wrap the Hash or Array constructed by JSON.parse in a new Class that only uses an indifferent access Hash when calling #deconstruct_keys to limit the change to only affect pattern matching
• Add a new framework default for 7.1 that uses object_class: ActiveSupport::HashWithIndifferentAccess, then fall back to using object_class: Hash)
• revert any change to the implementation, and encourage callers to chain .with_indifferent_access or .deep_symbolize_keys when using Ruby's pattern matching

[rafaelfranca]

One test failed because of this change

[seanpdoyle]

Since we support versions of Ruby that pre-date pattern matching, the test cases in this file need to be declared separate from the _test.rb file, then included conditionally based on RUBY_VERSION.

If there is a way to do this with Ruby compiler directives that instruct <= 3.0 versions to ignore them, I'm happy to revert this split and unify the files.

[flavorjones]

FWIW, what @zenspider asked me to do in the tests for pattern matching minitest is to conditionally eval the code. But what you did above is what I did in the Nokogiri test suite.

[seanpdoyle]

One test failed because of this change

@rafaelfranca I've made the necessary changes to pass the suite in CI.

[flavorjones]

@seanpdoyle Thank you for this! It's the first feedback I've heard that the pattern matching work in nokogiri and minitest was useful. ❤️ ❤️ ❤️