action-cable-testing 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1937dec963674b1c524cc2e89fa7e3019861ddc8
-  data.tar.gz: 35c43aacde8ee6c44ce0a0921f4aa8a795e519e9
+  metadata.gz: 49ea4d058ad808b422aee252af3404f7ffc19b09
+  data.tar.gz: fc2a1ab66b7d9dbbcb34a8c59d51f614fe715e8e
 SHA512:
-  metadata.gz: 65a6dbcf9d077659e1da92cc5237b01fa7194f5c929a31790f0ae14aad2d66a02a859c4ec16fbaf099ffbb85362f5b4bef62fdff319ddb1ce06845a3d6b0d4e9
-  data.tar.gz: f74589aff6ea7a682c26107687601c0b4efa3555a783e2e01f20edcfefc6cd9d6cadad8506a1481110e4d53e4557461c41a5fa16b32be67678aafd9507a053ca
+  metadata.gz: 6457b2c9afabf9c6e758a5cbe1cad993c7585734dec33bfed1a96e4d606dcc415e507cefc3d0e6fc7acbcca877edd4d558798919ef2f700846c40d7185faecd7
+  data.tar.gz: 9cc75eb56ad1f4b6f30540e5d3b523be3ab6278604bbc97325e1b3d1d84024dbd72ea9e7feb0894732b134c4832a4040c2c76843d6d14d4e690ae244c91d2b81

data/CHANGELOG.md

@@ -1,8 +1,18 @@
 # Change log
 
-## 0.1.2 (2017-11-14) ([@palkan][])
+## 0.2.0
 
-- Add RSpec shared contexts to switch between adapters.
+- Update minitest's `assert_broadcast_on` and `assert_broadcasts` matchers to support a record as an argument. ([@thesmartnik][])
+
+See https://github.com/palkan/action-cable-testing/issues/11
+
+- Update `have_broadcasted_to` matcher to support a record as an argument. ([@thesmartnik][])
+
+See https://github.com/palkan/action-cable-testing/issues/9
+
+## 0.1.2 (2017-11-14)
+
+- Add RSpec shared contexts to switch between adapters. ([@palkan][])
 
 See https://github.com/palkan/action-cable-testing/issues/4.
 
@@ -15,3 +25,4 @@ See https://github.com/palkan/action-cable-testing/issues/4.
 - Initial version. ([@palkan][])
 
 [@palkan]: https://github.com/palkan
+[@thesmartnik]: https://github.com/thesmartnik

data/README.md

@@ -52,10 +52,16 @@ class ExampleTest < ActionDispatch::IntegrationTest
 
   def test_broadcasts
     room = rooms(:office)
-  
+
     assert_broadcast_on("messages:#{room.id}", text: 'Hello!') do
       post "/say/#{room.id}", xhr: true, params: { message: 'Hello!' }
     end
+
+    # When testing broadcast to an object outside of channel test,
+    # channel should be explicitly specified
+    assert_broadcast_on(room, { text: 'Hello!' }, { channel: ChatChannel } do
+      post "/say/#{room.id}", xhr: true, params: { message: 'Hello!' }
+    end
   end
 end
 ```
@@ -121,6 +127,34 @@ class ChatChannelTest < ActionCable::Channel::TestCase
   end
 end
 ```
+When broadcasting to an object:
+
+```ruby
+class ChatChannelTest < ActionCable::Channel::TestCase
+  include ActionCable::TestHelper
+
+  def setup
+    @room = Room.find 1
+
+    stub_connection(user: users[:john])
+    subscribe room_number: room.id
+  end
+
+  def test_broadcating
+    assert_broadcasts(@room, 1) do
+      perform :speak, message: "I'm here!"
+    end
+  end
+
+  # or
+
+  def test_broadcasted_data
+    assert_broadcasts_on(@room, text: "I'm here!", from: "John") do
+      perform :speak, message: "I'm here!"
+    end
+  end
+end
+```
 
 ### RSpec Usage
 
@@ -152,6 +186,19 @@ RSpec.describe CommentsController do
 end
 ```
 
+Or when broacasting to an object:
+
+```ruby
+RSpec.describe CommentsController do
+  describe "POST #create" do
+    let(:post) { create :post }
+
+    expect { post :create, comment: { text: 'Cool!', post_id: post.id } }.to
+      have_broadcasted_to(post).from_channel(PostChannel).with(text: 'Cool!')
+  end
+end
+```
+
 You can also unit-test your channels:
 
 

data/lib/action_cable/test_helper.rb

@@ -3,6 +3,8 @@
 module ActionCable
   # Provides helper methods for testing Action Cable broadcasting
   module TestHelper
+    CHANNEL_NOT_FOUND = ArgumentError.new("Broadcastnig channel can't be infered. Please, specify it with `:channel`")
+
     def before_setup # :nodoc:
       server = ActionCable.server
       test_adapter = ActionCable::SubscriptionAdapter::Test.new(server)
@@ -42,15 +44,17 @@ module ActionCable
     #     end
     #   end
     #
-    def assert_broadcasts(channel, number)
+    def assert_broadcasts(target, number, channel: nil)
+      stream = stream(target, channel)
+
       if block_given?
-        original_count = broadcasts_size(channel)
+        original_count = broadcasts_size(stream)
         yield
-        new_count = broadcasts_size(channel)
-        assert_equal number, new_count - original_count, "#{number} broadcasts to #{channel} expected, but #{new_count - original_count} were sent"
+        new_count = broadcasts_size(stream)
+        assert_equal number, new_count - original_count, "#{number} broadcasts to #{stream} expected, but #{new_count - original_count} were sent"
       else
-        actual_count = broadcasts_size(channel)
-        assert_equal number, actual_count, "#{number} broadcasts to #{channel} expected, but #{actual_count} were sent"
+        actual_count = broadcasts_size(stream)
+        assert_equal number, actual_count, "#{number} broadcasts to #{stream} expected, but #{actual_count} were sent"
       end
     end
 
@@ -74,8 +78,8 @@ module ActionCable
     #
     #   assert_broadcasts 'messages', 0, &block
     #
-    def assert_no_broadcasts(channel, &block)
-      assert_broadcasts channel, 0, &block
+    def assert_no_broadcasts(target, &block)
+      assert_broadcasts target, 0, &block
     end
 
     # Asserts that the specified message has been sent to the channel.
@@ -93,28 +97,30 @@ module ActionCable
     #     end
     #   end
     #
-    def assert_broadcast_on(channel, data)
+    def assert_broadcast_on(target, data, channel: nil)
       # Encode to JSON and back–we want to use this value to compare
       # with decoded JSON.
       # Comparing JSON strings doesn't work due to the order if the keys.
       serialized_msg =
         ActiveSupport::JSON.decode(ActiveSupport::JSON.encode(data))
-      new_messages = broadcasts(channel)
+      stream = stream(target, channel)
+
+      new_messages = broadcasts(stream)
       if block_given?
         old_messages = new_messages
-        clear_messages(channel)
+        clear_messages(stream)
 
         yield
-        new_messages = broadcasts(channel)
-        clear_messages(channel)
+        new_messages = broadcasts(stream)
+        clear_messages(stream)
 
         # Restore all sent messages
-        (old_messages + new_messages).each { |m| pubsub_adapter.broadcast(channel, m) }
+        (old_messages + new_messages).each { |m| pubsub_adapter.broadcast(stream, m) }
       end
 
       message = new_messages.find { |msg| ActiveSupport::JSON.decode(msg) == serialized_msg }
 
-      assert message, "No messages sent with #{data} to #{channel}"
+      assert message, "No messages sent with #{data} to #{stream}"
     end
 
     def pubsub_adapter # :nodoc:
@@ -127,5 +133,14 @@ module ActionCable
       def broadcasts_size(channel) # :nodoc:
         broadcasts(channel).size
       end
+
+      def stream(target, channel = nil)
+        return target if target.is_a?(String)
+
+        channel ||= @subscription
+        raise CHANNEL_NOT_FOUND unless channel && channel.respond_to?(:channel_name)
+
+        channel.broadcasting_for([channel.channel_name, target])
+      end
   end
 end

data/lib/action_cable/testing/version.rb

@@ -2,6 +2,6 @@
 
 module ActionCable
   module Testing
-    VERSION = "0.1.2"
+    VERSION = "0.2.0"
   end
 end

data/lib/rspec/rails/matchers/action_cable.rb

@@ -10,8 +10,9 @@ module RSpec
         # rubocop: disable Style/ClassLength
         # @private
         class HaveBroadcastedTo < RSpec::Matchers::BuiltIn::BaseMatcher
-          def initialize(stream)
-            @stream = stream
+          def initialize(target, channel:)
+            @target = target
+            @channel = channel
             @block = Proc.new {}
             set_expected_number(:exactly, 1)
           end
@@ -57,7 +58,7 @@ module RSpec
           def failure_message
             "expected to broadcast #{base_message}".tap do |msg|
               if @unmatching_msgs.any?
-                msg << "\nBroadcasted messages to #{@stream}:"
+                msg << "\nBroadcasted messages to #{stream}:"
                 @unmatching_msgs.each do |data|
                   msg << "\n  #{data}"
                 end
@@ -84,15 +85,29 @@ module RSpec
           def matches?(proc)
             raise ArgumentError, "have_broadcasted_to and broadcast_to only support block expectations" unless Proc === proc
 
-            original_sent_messages_count = pubsub_adapter.broadcasts(@stream).size
+            original_sent_messages_count = pubsub_adapter.broadcasts(stream).size
             proc.call
-            in_block_messages = pubsub_adapter.broadcasts(@stream).drop(original_sent_messages_count)
+            in_block_messages = pubsub_adapter.broadcasts(stream).drop(original_sent_messages_count)
 
             check(in_block_messages)
           end
 
+          def from_channel(channel)
+            @channel = channel
+            self
+          end
+
         private
 
+          def stream
+            @stream ||= if @target.is_a?(String)
+              @target
+            else
+              check_channel_presence
+              @channel.broadcasting_for([@channel.channel_name, @target])
+            end
+          end
+
           def check(messages)
             @matching_msgs, @unmatching_msgs = messages.partition do |msg|
               decoded = ActiveSupport::JSON.decode(msg)
@@ -127,7 +142,7 @@ module RSpec
           end
 
           def base_message
-            "#{message_expectation_modifier} #{@expected_number} messages to #{@stream}".tap do |msg|
+            "#{message_expectation_modifier} #{@expected_number} messages to #{stream}".tap do |msg|
               msg << " with #{data_description(@data)}" unless @data.nil?
               msg << ", but broadcast #{@matching_msgs_count}"
             end
@@ -144,18 +159,32 @@ module RSpec
           def pubsub_adapter
             ::ActionCable.server.pubsub
           end
+
+          def check_channel_presence
+            return if @channel.present? && @channel.respond_to?(:channel_name)
+
+            error_msg = "Broadcastnig channel can't be infered. Please, specify it with `from_channel`"
+            raise ArgumentError, error_msg
+          end
         end
         # rubocop: enable Style/ClassLength
       end
 
       # @api public
-      # Passes if a message has been sent to a stream inside block. May chain at_least, at_most or exactly to specify a number of times.
+      # Passes if a message has been sent to a stream/object inside a block.
+      # May chain `at_least`, `at_most` or `exactly` to specify a number of times.
+      # To specify channel from which message has been broadcasted to object use `from_channel`.
+      #
       #
       # @example
       #     expect {
       #       ActionCable.server.broadcast "messages", text: 'Hi!'
       #     }.to have_broadcasted_to("messages")
       #
+      #     expect {
+      #       SomeChannel.broadcast_to(user)
+      #     }.to have_broadcasted_to(user).from_channel(SomeChannel)
+      #
       #     # Using alias
       #     expect {
       #       ActionCable.server.broadcast "messages", text: 'Hi!'
@@ -177,9 +206,11 @@ module RSpec
       #     expect {
       #       ActionCable.server.broadcast "messages", text: 'Hi!'
       #     }.to have_broadcasted_to("messages").with(text: 'Hi!')
-      def have_broadcasted_to(stream = nil)
+
+      def have_broadcasted_to(target = nil)
         check_action_cable_adapter
-        ActionCable::HaveBroadcastedTo.new(stream)
+
+        ActionCable::HaveBroadcastedTo.new(target, channel: described_class)
       end
       alias_method :broadcast_to, :have_broadcasted_to
 
@@ -188,7 +219,7 @@ module RSpec
       # @private
       def check_action_cable_adapter
         return if ::ActionCable::SubscriptionAdapter::Test === ::ActionCable.server.pubsub
-        raise StandardError, "To use ActionCable matchers set `adapter: :test` in your cable.yml"
+        raise StandardError, "To use ActionCable matchers set `adapter: test` in your cable.yml"
       end
     end
   end

data/lib/rspec/rails/shared_contexts/action_cable.rb

@@ -3,7 +3,7 @@
 # Generate contexts to use specific Action Cable adapter:
 # - "action_cable:async" (action_cable: :async)
 # - "action_cable:inline" (action_cable: :inline)
-# - "action_cable:test" (action_cabke: :test)
+# - "action_cable:test" (action_cable: :test)
 %w[async inline test].each do |adapter|
   RSpec.shared_context "action_cable:#{adapter}" do
     require "action_cable/subscription_adapter/#{adapter}"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: action-cable-testing
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-14 00:00:00.000000000 Z
+date: 2017-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actioncable