TEST_CODEOWNERS/rails
3
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

Action Cable assert_broadcasts API docs [ci skip]

Browse Source 
Follow-up to [#48798][]
Reverts [#47837][]

The `capture_broadcasts` helper was introduced in [#48798][] to remove
the return value from the `assert_broadcasts` call. The behavior was
changed, but the corresponding documentation for the `assert_broadcasts`
method did not revert the changes added in [#47837][].

This change should probably also get backported to `7-1-0-stable`.

[#47837]: https://github.com/rails/rails/pull/47837
[#48798]: https://github.com/rails/rails/pull/48798

Co-authored-by: Matheus Richard <matheusrichardt@gmail.com>
This commit is contained in:
Sean Doyle 2024-02-19 10:35:05 -05:00
parent cd4a5b0733
commit cfab11c959
1 changed files with 3 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
actioncable/lib/action_cable/test_helper.rb
View File

@ -32,21 +32,17 @@ def after_teardown # :nodoc:
# end
#
# If a block is passed, that block should cause the specified number of messages
# to be broadcasted. It returns the messages that were broadcasted.
# to be broadcasted.
#
# def test_broadcasts_again
# message = assert_broadcasts('messages', 1) do
# assert_broadcasts('messages', 1) do
# ActionCable.server.broadcast 'messages', { text: 'hello' }
# end
# assert_equal({ text: 'hello' }, message)
#
# messages = assert_broadcasts('messages', 2) do
# assert_broadcasts('messages', 2) do
# ActionCable.server.broadcast 'messages', { text: 'hi' }
# ActionCable.server.broadcast 'messages', { text: 'how are you?' }
# end
# assert_equal 2, messages.length
# assert_equal({ text: 'hi' }, messages.first)
# assert_equal({ text: 'how are you?' }, messages.last)
# end
#
def assert_broadcasts(stream, number, &block)