Improve implicit description for RSpec::Rails::Matchers::ActionCable::HaveBroadcastedTo #2795
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
boardfish
force-pushed
the
implicit-description-for-have-broadcasted-to
branch
from
622523a
to
045fe57
Compare
pirj
reviewed
Sep 5, 2024
spec/rspec/rails/matchers/action_cable/have_broadcasted_to_spec.rb
Outdated
Show resolved
Hide resolved
pirj
reviewed
Sep 5, 2024
spec/rspec/rails/matchers/action_cable/have_broadcasted_to_spec.rb
Outdated
Show resolved
Hide resolved
pirj
reviewed
Sep 5, 2024
spec/rspec/rails/matchers/action_cable/have_broadcasted_to_spec.rb
Outdated
Show resolved
Hide resolved
pirj
reviewed
Sep 5, 2024
spec/rspec/rails/matchers/action_cable/have_broadcasted_to_spec.rb
Outdated
Show resolved
Hide resolved
JonRowe
reviewed
Sep 5, 2024
JonRowe
requested changes
Sep 5, 2024
spec/rspec/rails/matchers/action_cable/have_broadcasted_to_spec.rb
Outdated
Show resolved
Hide resolved
spec/rspec/rails/matchers/action_cable/have_broadcasted_to_spec.rb
Outdated
Show resolved
Hide resolved
spec/rspec/rails/matchers/action_cable/have_broadcasted_to_spec.rb
Outdated
Show resolved
Hide resolved
spec/rspec/rails/matchers/action_cable/have_broadcasted_to_spec.rb
Outdated
Show resolved
Hide resolved
spec/rspec/rails/matchers/action_cable/have_broadcasted_to_spec.rb
Outdated
Show resolved
Hide resolved
spec/rspec/rails/matchers/action_cable/have_broadcasted_to_spec.rb
Outdated
Show resolved
Hide resolved
boardfish
force-pushed
the
implicit-description-for-have-broadcasted-to
branch
2 times, most recently
from
02b8639
to
7ca8249
Compare
|
Thank you both for your speedy reviews! I think I've addressed everything you've mentioned 👍 |
JonRowe
requested changes
Sep 5, 2024
| @@ -151,7 +160,7 @@ def data_description(data) | |||
| if data.is_a?(RSpec::Matchers::Composable) | |||
| data.description | |||
| else | |||
| data | |||
| data.inspect | |||
There was a problem hiding this comment.
What did this actually come from, I'm on the fence wether letting user values user to_s is fine or not.
There was a problem hiding this comment.
I would expect a matcher to use this if mentioning an object. The default description for the eq matcher does this:
it { expect("foo").to eq("foo") }Resultant description:
is expected to eq "foo"
This adds some clarity to what the object is in context.
spec/rspec/rails/matchers/action_cable/have_broadcasted_to_spec.rb
Outdated
Show resolved
Hide resolved
…:HaveBroadcastedTo
Previously, tests defined like this:
```rb
it do
expect { some_action }.to have_broadcasted_to("stream_name").from_channel(SomeChannel).with("some_data")
end
```
would implicitly be given the description `have broadcasted to`, which is derived from the name of the matcher method.
This didn't carry any extra information about the data we're expecting to be broadcast from the channel - behaviour
which would be very welcome in combination with Turbo Streams. With a matcher for Turbo Streams, we might benefit from
a description like "broadcast exactly 1 messages to stream with turbo-stream[action="append"][target="some_list"]".
Co-authored-by: Jon Rowe <hello@jonrowe.co.uk>
Co-authored-by: Phil Pirozhkov <pirj@users.noreply.github.com>
boardfish
force-pushed
the
implicit-description-for-have-broadcasted-to
branch
from
7ca8249
to
86db479
Compare
JonRowe
reviewed
Sep 7, 2024
spec/rspec/rails/matchers/action_cable/have_broadcasted_to_spec.rb
Outdated
Show resolved
Hide resolved
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Previously, tests defined like this:
would implicitly be given the description
have broadcasted to, which is derived from the name of the matcher method.This didn't carry any extra information about the data we're expecting to be broadcast from the channel - behaviour
which would be very welcome in combination with Turbo Streams. With a matcher for Turbo Streams, we might benefit from
a description like
"broadcast exactly 1 messages to stream with turbo-stream[action="append"][target="some_list"]".