action-cable-testing 0.3.4 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee3c261b614627cd0d9d72bc9084cb4b7408bacaca953260d4c372da8774676c
-  data.tar.gz: bbdde5b4fdb2deb81571c23198443674733962100311b8f013311f4a5a778307
+  metadata.gz: 6e9a6464f3ec1cc6ee48f51d97f0a8e0bebd34c3fee8f9523f01a6e0b6f19382
+  data.tar.gz: 3db543599b78e0944fa89679d47ab02275c09714b59b134430662a74163cddd8
 SHA512:
-  metadata.gz: 4ebdc170789756ee2885f503241048270ecf815b35881474a972373cc51697d25f47d823ebc8fa8b8f0a55f2f2ffa30d31fac3e19b6939e001058f72ad523ea0
-  data.tar.gz: 588e39d4f0c257b0786b966780be8b9ec8299ed87809a98da94fcf3e612c3d3abca5f5dfb861562abe60d9b5a3282cc0ce2439746c8da6f78b4cc8c64bd0d561
+  metadata.gz: 787512840b4dda952c365f770fcfb5858d6cbfb0ce261ca9fcbeb3384fd32a0102f490e4a1e1840a4fa1a3f68b9d4a24a4840322104a33af1a3164036b02bf5b
+  data.tar.gz: 2558049b61e39c42f57bd7a5a98f85522129a7d27001c5721e6525c56ba24136d9de913d579c02fd95205a8653eefed99006da3e722602b3fa7815eae69c9eda

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## master
 
+## 0.4.0 (2019-01-10)
+
+- Add stream assert methods and matchers. ([@sponomarev][])
+
+  See https://github.com/palkan/action-cable-testing/pull/42
+
 - Add session support for connection. ([@sponomarev][])
 
   See https://github.com/palkan/action-cable-testing/pull/35

data/README.md

@@ -79,7 +79,10 @@ class ChatChannelTest < ActionCable::Channel::TestCase
     assert subscription.confirmed?
 
     # Asserts that the channel subscribes connection to a stream
-    assert "chat_1", streams.last
+    assert_has_stream "chat_1"
+
+    # Asserts that the channel subscribes connection to a stream created with `stream_for`
+     assert_has_stream_for Room.find(1)
   end
 
   def test_does_not_subscribe_without_room_number
@@ -87,6 +90,9 @@ class ChatChannelTest < ActionCable::Channel::TestCase
 
     # Asserts that the subscription was rejected
     assert subscription.rejected?
+
+    # Asserts that no streams was started
+    assert_no_streams
   end
 end
 ```
@@ -252,13 +258,19 @@ RSpec.describe ChatChannel, type: :channel do
   it "rejects when no room id" do
     subscribe
     expect(subscription).to be_rejected
+    expect(subscription).not_to have_streams
   end
 
   it "subscribes to a stream when room id is provided" do
     subscribe(room_id: 42)
 
     expect(subscription).to be_confirmed
-    expect(streams).to include("chat_42")
+
+    # check particular stream by name
+    expect(subscription).to have_stream_from("chat_42")
+
+    # or directly by model if you create streams with `stream_for`
+    expect(subscription).to have_stream_for(Room.find(42))
   end
 end
 ```

data/lib/action_cable/channel/test_case.rb

@@ -84,7 +84,18 @@ module ActionCable
     #       assert subscription.confirmed?
     #
     #       # Asserts that the channel subscribes connection to a stream
-    #       assert_equal "chat_1", streams.last
+    #       assert_has_stream "chat_1"
+    #
+    #       # Asserts that the channel subscribes connection to a specific
+    #       # stream created for a model
+    #       assert_has_stream_for Room.find(1)
+    #     end
+    #
+    #     def test_does_not_stream_with_incorrect_room_number
+    #       subscribe room_number: -1
+    #
+    #       # Asserts that not streams was started
+    #       assert_no_streams
     #     end
     #
     #     def test_does_not_subscribe_without_room_number
@@ -115,8 +126,6 @@ module ActionCable
     #      An instance of the current channel, created when you call `subscribe`.
     # <b>transmissions</b>::
     #      A list of all messages that have been transmitted into the channel.
-    # <b>streams</b>::
-    #      A list of all created streams subscriptions (as identifiers) for the subscription.
     #
     #
     # == Channel is automatically inferred
@@ -149,7 +158,13 @@ module ActionCable
           class_attribute :_channel_class
 
           attr_reader :subscription
-          delegate :streams, to: :subscription
+
+          def streams
+            ActiveSupport::Deprecation.warn "Use appropriate `assert_has_stream`, `assert_has_stream_for`, `assert_no_streams` " +
+              "assertion methods for minitest or `have_stream`, `have_stream_for` and `have_stream_from` matchers " +
+              "for RSpec. Direct access to `streams` is deprecated and is going to be removed in version 1.0"
+            subscription.streams
+          end
 
           ActiveSupport.run_load_hooks(:action_cable_channel_test_case, self)
         end
@@ -227,10 +242,51 @@ module ActionCable
           connection.transmissions.map { |data| data["message"] }.compact
         end
 
+        # Asserts that no streams have been started.
+        #
+        #   def test_assert_no_started_stream
+        #     subscribe
+        #     assert_no_streams
+        #   end
+        #
+        def assert_no_streams
+          assert subscription.streams.empty?, "No streams started was expected, but #{subscription.streams.count} found"
+        end
+
+        # Asserts that the specified stream has been started.
+        #
+        #   def test_assert_started_stream
+        #     subscribe
+        #     assert_has_stream 'messages'
+        #   end
+        #
+        def assert_has_stream(stream)
+          assert subscription.streams.include?(stream), "Stream #{stream} has not been started"
+        end
+
+        # 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
+        #
+        def assert_has_stream_for(object)
+          assert_has_stream(broadcasting_for(object))
+        end
+
         private
           def check_subscribed!
             raise "Must be subscribed!" if subscription.nil? || subscription.rejected?
           end
+
+          def broadcasting_for(stream_or_object)
+            return stream_or_object if stream_or_object.is_a?(String)
+
+            self.class.channel_class.broadcasting_for(
+              [self.class.channel_class.channel_name, stream_or_object]
+            )
+          end
       end
 
       include Behavior

data/lib/action_cable/testing/version.rb

@@ -2,6 +2,6 @@
 
 module ActionCable
   module Testing
-    VERSION = "0.3.4"
+    VERSION = "0.4.0"
   end
 end

data/lib/rspec/rails/example/channel_example_group.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "rspec/rails/matchers/action_cable/have_streams"
+
 module RSpec
   module Rails
     # @api public
@@ -39,6 +41,24 @@ if defined?(ActionCable)
         def have_rejected_connection
           raise_error(::ActionCable::Connection::Authorization::UnauthorizedError)
         end
+
+        def have_streams
+          check_subscribed!
+
+          RSpec::Rails::Matchers::ActionCable::HaveStream.new
+        end
+
+        def have_stream_from(stream)
+          check_subscribed!
+
+          RSpec::Rails::Matchers::ActionCable::HaveStream.new(stream)
+        end
+
+        def have_stream_for(object)
+          check_subscribed!
+
+          RSpec::Rails::Matchers::ActionCable::HaveStream.new(broadcasting_for(object))
+        end
       end
     end
   end

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

@@ -1,5 +1,7 @@
 # rubocop: disable Style/FrozenStringLiteralComment
 
+require "rspec/rails/matchers/action_cable/have_broadcasted_to"
+
 module RSpec
   module Rails
     module Matchers
@@ -7,167 +9,6 @@ module RSpec
       #
       # @api private
       module ActionCable
-        # rubocop: disable Metrics/ClassLength
-        # @private
-        class HaveBroadcastedTo < RSpec::Matchers::BuiltIn::BaseMatcher
-          def initialize(target, channel:)
-            @target = target
-            @channel = channel
-            @block = Proc.new {}
-            set_expected_number(:exactly, 1)
-          end
-
-          def with(data = nil)
-            @data = data
-            @data = @data.with_indifferent_access if @data.is_a?(Hash)
-            @block = Proc.new if block_given?
-            self
-          end
-
-          def exactly(count)
-            set_expected_number(:exactly, count)
-            self
-          end
-
-          def at_least(count)
-            set_expected_number(:at_least, count)
-            self
-          end
-
-          def at_most(count)
-            set_expected_number(:at_most, count)
-            self
-          end
-
-          def times
-            self
-          end
-
-          def once
-            exactly(:once)
-          end
-
-          def twice
-            exactly(:twice)
-          end
-
-          def thrice
-            exactly(:thrice)
-          end
-
-          def failure_message
-            "expected to broadcast #{base_message}".tap do |msg|
-              if @unmatching_msgs.any?
-                msg << "\nBroadcasted messages to #{stream}:"
-                @unmatching_msgs.each do |data|
-                  msg << "\n  #{data}"
-                end
-              end
-            end
-          end
-
-          def failure_message_when_negated
-            "expected not to broadcast #{base_message}"
-          end
-
-          def message_expectation_modifier
-            case @expectation_type
-            when :exactly then "exactly"
-            when :at_most then "at most"
-            when :at_least then "at least"
-            end
-          end
-
-          def supports_block_expectations?
-            true
-          end
-
-          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
-            proc.call
-            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)
-              decoded = decoded.with_indifferent_access if decoded.is_a?(Hash)
-
-              if @data.nil? || @data === decoded
-                @block.call(decoded)
-                true
-              else
-                false
-              end
-            end
-
-            @matching_msgs_count = @matching_msgs.size
-
-            case @expectation_type
-            when :exactly then @expected_number == @matching_msgs_count
-            when :at_most then @expected_number >= @matching_msgs_count
-            when :at_least then @expected_number <= @matching_msgs_count
-            end
-          end
-
-          def set_expected_number(relativity, count)
-            @expectation_type = relativity
-            @expected_number =
-              case count
-              when :once then 1
-              when :twice then 2
-              when :thrice then 3
-              else Integer(count)
-              end
-          end
-
-          def base_message
-            "#{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
-          end
-
-          def data_description(data)
-            if data.is_a?(RSpec::Matchers::Composable)
-              data.description
-            else
-              data
-            end
-          end
-
-          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 Metrics/ClassLength
       end
 
       # @api public

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

@@ -0,0 +1,170 @@
+# rubocop: disable Style/FrozenStringLiteralComment
+
+module RSpec
+  module Rails
+    module Matchers
+      module ActionCable
+        # rubocop: disable Metrics/ClassLength
+        # @private
+        class HaveBroadcastedTo < RSpec::Matchers::BuiltIn::BaseMatcher
+          def initialize(target, channel:)
+            @target = target
+            @channel = channel
+            @block = Proc.new {}
+            set_expected_number(:exactly, 1)
+          end
+
+          def with(data = nil)
+            @data = data
+            @data = @data.with_indifferent_access if @data.is_a?(Hash)
+            @block = Proc.new if block_given?
+            self
+          end
+
+          def exactly(count)
+            set_expected_number(:exactly, count)
+            self
+          end
+
+          def at_least(count)
+            set_expected_number(:at_least, count)
+            self
+          end
+
+          def at_most(count)
+            set_expected_number(:at_most, count)
+            self
+          end
+
+          def times
+            self
+          end
+
+          def once
+            exactly(:once)
+          end
+
+          def twice
+            exactly(:twice)
+          end
+
+          def thrice
+            exactly(:thrice)
+          end
+
+          def failure_message
+            "expected to broadcast #{base_message}".tap do |msg|
+              if @unmatching_msgs.any?
+                msg << "\nBroadcasted messages to #{stream}:"
+                @unmatching_msgs.each do |data|
+                  msg << "\n  #{data}"
+                end
+              end
+            end
+          end
+
+          def failure_message_when_negated
+            "expected not to broadcast #{base_message}"
+          end
+
+          def message_expectation_modifier
+            case @expectation_type
+            when :exactly then "exactly"
+            when :at_most then "at most"
+            when :at_least then "at least"
+            end
+          end
+
+          def supports_block_expectations?
+            true
+          end
+
+          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
+            proc.call
+            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)
+              decoded = decoded.with_indifferent_access if decoded.is_a?(Hash)
+
+              if @data.nil? || @data === decoded
+                @block.call(decoded)
+                true
+              else
+                false
+              end
+            end
+
+            @matching_msgs_count = @matching_msgs.size
+
+            case @expectation_type
+            when :exactly then @expected_number == @matching_msgs_count
+            when :at_most then @expected_number >= @matching_msgs_count
+            when :at_least then @expected_number <= @matching_msgs_count
+            end
+          end
+
+          def set_expected_number(relativity, count)
+            @expectation_type = relativity
+            @expected_number =
+              case count
+              when :once then 1
+              when :twice then 2
+              when :thrice then 3
+              else Integer(count)
+              end
+          end
+
+          def base_message
+            "#{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
+          end
+
+          def data_description(data)
+            if data.is_a?(RSpec::Matchers::Composable)
+              data.description
+            else
+              data
+            end
+          end
+
+          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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,60 @@
+# rubocop: disable Style/FrozenStringLiteralComment
+
+module RSpec
+  module Rails
+    module Matchers
+      module ActionCable
+        # @api private
+        # Provides the implementation for `have_stream`, `have_stream_for`, and `have_stream_from`.
+        # Not intended to be instantiated directly.
+        class HaveStream < RSpec::Matchers::BuiltIn::BaseMatcher
+          # @api private
+          # @return [String]
+          def failure_message
+            "expected to have #{base_message}"
+          end
+
+          # @api private
+          # @return [String]
+          def failure_message_when_negated
+            "expected not to have #{base_message}"
+          end
+
+          # @api private
+          # @return [Boolean]
+          def matches?(subscription)
+            raise(ArgumentError, "have_streams is used for negated expectations only") if no_expected?
+
+            match(subscription)
+          end
+
+          # @api private
+          # @return [Boolean]
+          def does_not_match?(subscription)
+            !match(subscription)
+          end
+
+        private
+
+          def match(subscription)
+            case subscription
+            when ::ActionCable::Channel::Base
+              @actual = subscription.streams
+              no_expected? ? actual.any? : actual.any? { |i| expected === i }
+            else
+              raise ArgumentError, "have_stream, have_stream_from and have_stream_from support expectations on subscription only"
+            end
+          end
+
+          def base_message
+            no_expected? ? "any stream started" : "stream #{expected_formatted} started, but have #{actual_formatted}"
+          end
+
+          def no_expected?
+            !defined?(@expected)
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: action-cable-testing
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.4.0
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-06 00:00:00.000000000 Z
+date: 2019-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actioncable
@@ -28,14 +28,14 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.10'
 - !ruby/object:Gem::Dependency
@@ -162,6 +162,8 @@ files:
 - lib/generators/test_unit/channel/templates/unit_test.rb.erb
 - lib/rspec/rails/example/channel_example_group.rb
 - lib/rspec/rails/matchers/action_cable.rb
+- lib/rspec/rails/matchers/action_cable/have_broadcasted_to.rb
+- lib/rspec/rails/matchers/action_cable/have_streams.rb
 - lib/rspec/rails/shared_contexts/action_cable.rb
 homepage: http://github.com/palkan/action-cable-testing
 licenses:
@@ -183,7 +185,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Testing utils for Action Cable