action-cable-testing 0.0.6.1 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8092ab8d50462d20a5192f06dd233f4876a130e9
-  data.tar.gz: 37059d739700e6792a972e405c8a2749f65cc2c2
+  metadata.gz: 96625e06dd39e7a58e78f77601bdc84d440cad8a
+  data.tar.gz: e125b688d9c10e7ad1ed89efeb25bc8c2e7f225b
 SHA512:
-  metadata.gz: 11c87c8eda12f74a453985af75907535bafb90f65e63a9ca588cd2e91ab820d769f85fc2aeea8c4ab8d0bdffc5c1502a0c65c60cde07409de272937bcf1983e6
-  data.tar.gz: 3191e647f6a54aa412c98a9f7585ca45f411d786566c6fb5e1fe54c817aeb2b054907e770d385754a612a7824048c86fe953b530600bdfd709251e49896eb472
+  metadata.gz: 17592526b34d09527d340b414dd0d9664a11fab820fd5d8aa49f5f67ea55c5494cb0044f83d6555d23d6ed745603923e808015b544cc797c6018dc0eb5289f57
+  data.tar.gz: e9c91223b1702d725293ff5e7303e2c2d6bc39a8b90f550ff1d37a98bedd19367c55dd414d8b2a9eced77e922de03e74d792ec441dd9f418b322682f3ff0085a

data/README.md

@@ -124,6 +124,54 @@ end
 
 ### RSpec Usage
 
+
+First, set your adapter to `test` in `cable.yml`:
+
+```yml
+# config/cable.yml
+test:
+  adapter: test
+```
+
+Now you can use `have_broadcasted_to` / `broadcast_to` matchers anywhere in your specs. For example:
+
+```ruby
+RSpec.describe CommentsController do
+  describe "POST #create" do
+    expect { post :create, comment: { text: 'Cool!' } }.to
+      have_broadcasted_to("comments").with(text: 'Cool!')
+  end
+end
+```
+
+You can also unit-test your channels:
+
+
+```ruby
+# spec/channels/chat_channel_spec.rb
+
+require "rails_helper"
+
+RSpec.describe ChatChannel, type: :channel do
+  before do
+    # initialize connection with identifiers
+    stub_connection user_id: user.id
+  end
+
+  it "rejects when no room id" do
+    subscribe
+    expect(subscription).to be_rejected
+  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")
+  end
+end
+```
+
 For more RSpec documentation see https://relishapp.com/palkan/action-cable-testing/docs.
 
 ### Generators

data/lib/action_cable/channel/test_case.rb

@@ -97,7 +97,7 @@ module ActionCable
     #
     #     perform :speak, message: "Hello, Rails!"
     #
-    #     assert_equal "Hello, Rails!", transmissions.last["message"]["text"]
+    #     assert_equal "Hello, Rails!", transmissions.last["text"]
     #   end
     #
     # == Special methods
@@ -110,7 +110,7 @@ module ActionCable
     # <b>subscription</b>::
     #      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 connection (without encoding).
+    #      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.
     #

data/lib/action_cable/subscription_adapter/test.rb

@@ -21,7 +21,7 @@ module ActionCable
         channels_data[channel] = []
       end
 
-      def reset!
+      def clear
         @channels_data = nil
       end
 

data/lib/action_cable/test_helper.rb

@@ -112,9 +112,9 @@ module ActionCable
         (old_messages + new_messages).each { |m| pubsub_adapter.broadcast(channel, m) }
       end
 
-      new_messages = new_messages.map { |msg| ActiveSupport::JSON.decode(msg) }
+      message = new_messages.find { |msg| ActiveSupport::JSON.decode(msg) == serialized_msg }
 
-      assert_includes new_messages, serialized_msg, "No messages sent with #{data} to #{channel}"
+      assert message, "No messages sent with #{data} to #{channel}"
     end
 
     def pubsub_adapter # :nodoc:

data/lib/action_cable/testing/rspec.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "rspec/rails/example/channel_example_group"
+require "rspec/rails/matchers/action_cable"
 
 module RSpec # :nodoc:
   module Rails

data/lib/action_cable/testing/version.rb

@@ -2,6 +2,6 @@
 
 module ActionCable
   module Testing
-    VERSION = "0.0.6.1"
+    VERSION = "0.0.7"
   end
 end

data/lib/generators/rspec/channel/channel_generator.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "generators/rspec"
+
+module Rspec
+  module Generators
+    # @private
+    class ChannelGenerator < Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      def create_channel_spec
+        template "channel_spec.rb.erb", File.join("spec/channels", class_path, "#{file_name}_channel_spec.rb")
+      end
+    end
+  end
+end

data/lib/generators/rspec/channel/templates/channel_spec.rb.erb

@@ -0,0 +1,7 @@
+require 'rails_helper'
+
+<% module_namespacing do -%>
+RSpec.describe <%= class_name %>Channel, <%= type_metatag(:channel) %> do
+  pending "add some examples to (or delete) #{__FILE__}"
+end
+<% end -%>

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

@@ -0,0 +1,195 @@
+# rubocop: disable Style/FrozenStringLiteralComment
+
+module RSpec
+  module Rails
+    module Matchers
+      # Namespace for various implementations of ActionCable features
+      #
+      # @api private
+      module ActionCable
+        # rubocop: disable Style/ClassLength
+        # @private
+        class HaveBroadcastedTo < RSpec::Matchers::BuiltIn::BaseMatcher
+          def initialize(stream)
+            @stream = stream
+            @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
+
+        private
+
+          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
+        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.
+      #
+      # @example
+      #     expect {
+      #       ActionCable.server.broadcast "messages", text: 'Hi!'
+      #     }.to have_broadcasted_to("messages")
+      #
+      #     # Using alias
+      #     expect {
+      #       ActionCable.server.broadcast "messages", text: 'Hi!'
+      #     }.to broadcast_to("messages")
+      #
+      #     expect {
+      #       ActionCable.server.broadcast "messages", text: 'Hi!'
+      #       ActionCable.server.broadcast "all", text: 'Hi!'
+      #     }.to have_broadcasted_to("messages").exactly(:once)
+      #
+      #     expect {
+      #       3.times { ActionCable.server.broadcast "messages", text: 'Hi!' }
+      #     }.to have_broadcasted_to("messages").at_least(2).times
+      #
+      #     expect {
+      #       ActionCable.server.broadcast "messages", text: 'Hi!'
+      #     }.to have_broadcasted_to("messages").at_most(:twice)
+      #
+      #     expect {
+      #       ActionCable.server.broadcast "messages", text: 'Hi!'
+      #     }.to have_broadcasted_to("messages").with(text: 'Hi!')
+      def have_broadcasted_to(stream = nil)
+        check_action_cable_adapter
+        ActionCable::HaveBroadcastedTo.new(stream)
+      end
+      alias_method :broadcast_to, :have_broadcasted_to
+
+    private
+
+      # @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"
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: action-cable-testing
 version: !ruby/object:Gem::Version
-  version: 0.0.6.1
+  version: 0.0.7
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-23 00:00:00.000000000 Z
+date: 2017-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actioncable
@@ -154,9 +154,12 @@ files:
 - lib/action_cable/testing.rb
 - lib/action_cable/testing/rspec.rb
 - lib/action_cable/testing/version.rb
+- lib/generators/rspec/channel/channel_generator.rb
+- lib/generators/rspec/channel/templates/channel_spec.rb.erb
 - lib/generators/test_unit/channel/channel_generator.rb
 - 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
 homepage: http://github.com/palkan/action-cable-testing
 licenses:
 - MIT