edge badge
Namespace
Methods
A
P
S
T
U
Included Modules
Constants
CHANNEL_IDENTIFIER = "test_stub"
 
Instance Public methods
assert_broadcast_on(stream_or_object, *args)
# File actioncable/lib/action_cable/channel/test_case.rb, line 258
def assert_broadcast_on(stream_or_object, *args)
  super(broadcasting_for(stream_or_object), *args)
end
assert_broadcasts(stream_or_object, *args)

Enhance TestHelper assertions to handle non-String broadcastings

# File actioncable/lib/action_cable/channel/test_case.rb, line 254
def assert_broadcasts(stream_or_object, *args)
  super(broadcasting_for(stream_or_object), *args)
end
assert_has_stream(stream)

Asserts that the specified stream has been started.

def test_assert_started_stream
  subscribe
  assert_has_stream 'messages'
end
# File actioncable/lib/action_cable/channel/test_case.rb, line 280
def assert_has_stream(stream)
  assert subscription.streams.include?(stream), "Stream #{stream} has not been started"
end
assert_has_stream_for(object)

Asserts that the specified stream for a model has started.

def test_assert_started_stream_for
  subscribe id: 42
  assert_has_stream_for User.find(42)
end
# File actioncable/lib/action_cable/channel/test_case.rb, line 291
def assert_has_stream_for(object)
  assert_has_stream(broadcasting_for(object))
end
assert_no_streams()

Asserts that no streams have been started.

def test_assert_no_started_stream
  subscribe
  assert_no_streams
end
# File actioncable/lib/action_cable/channel/test_case.rb, line 269
def assert_no_streams
  assert subscription.streams.empty?, "No streams started was expected, but #{subscription.streams.count} found"
end
perform(action, data = {})

Perform action on a channel.

NOTE: Must be subscribed.

# File actioncable/lib/action_cable/channel/test_case.rb, line 241
def perform(action, data = {})
  check_subscribed!
  subscription.perform_action(data.stringify_keys.merge("action" => action.to_s))
end
stub_connection(identifiers = {})

Setup test connection with the specified identifiers:

class ApplicationCable < ActionCable::Connection::Base
  identified_by :user, :token
end

stub_connection(user: users[:john], token: 'my-secret-token')
# File actioncable/lib/action_cable/channel/test_case.rb, line 219
def stub_connection(identifiers = {})
  @connection = ConnectionStub.new(identifiers)
end
subscribe(params = {})

Subscribe to the channel under test. Optionally pass subscription parameters as a Hash.

# File actioncable/lib/action_cable/channel/test_case.rb, line 224
def subscribe(params = {})
  @connection ||= stub_connection
  @subscription = self.class.channel_class.new(connection, CHANNEL_IDENTIFIER, params.with_indifferent_access)
  @subscription.singleton_class.include(ChannelStub)
  @subscription.subscribe_to_channel
  @subscription
end
transmissions()

Returns messages transmitted into channel

# File actioncable/lib/action_cable/channel/test_case.rb, line 247
def transmissions
  # Return only directly sent message (via #transmit)
  connection.transmissions.map { |data| data["message"] }.compact
end
unsubscribe()

Unsubscribe the subscription under test.

# File actioncable/lib/action_cable/channel/test_case.rb, line 233
def unsubscribe
  check_subscribed!
  subscription.unsubscribe_from_channel
end