action-cable-testing 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4b6269f11a5590fddc954a824bd3af62f7a64e83
-  data.tar.gz: '079a0c9dbf1507e5238d40085a459649f962131d'
+  metadata.gz: c5796425a4e5ab73343b517a89d64d5aa2be0fd6
+  data.tar.gz: 58e1d065fbf5038ab793ed22a7d204d1c3c045ef
 SHA512:
-  metadata.gz: 98e4529e68c95d98e3ae33c7a8302c4c492cbb8c96dd70cdbe702e9481aadce1fc58d77331e2cd713c5b8a9dcaf2138ac47c291a947542e8d7b6967bad3e13a2
-  data.tar.gz: f3238297625a5ef0a9dc38fc536d3d07ba19785de42313f199b3a9d67352f8d0e8910b144885fe4593c221982dcb52d19c89cd09e3e8db13ee0680de0d2162a8
+  metadata.gz: e5b188a2a39bc37f77a8456ba9e308098210899fbf33686e847d4ddd1b6e7337004c7a1c8e79c8df94e34e5e19fc2f9b0f83ffe03294529320ce612f027c0290
+  data.tar.gz: 0dab5c1a7ac3ac23a9bbe61a3701e0a559bd5347e2a4722933f964b66b5935bdcefdf98058262c782d27d197dcfb8e7c605983983ba80f621448f776e1b9bda7

data/.yardopts

@@ -1,2 +1,3 @@
 --exclude /templates/
+--exclude /rspec/
 --quiet

data/README.md

@@ -21,8 +21,6 @@ And then execute:
 
 ## Usage
 
-[Documentation](http://www.rubydoc.info/gems/action-cable-testing)
-
 ### Test Adapter and Broadcasting
 
 We add `ActionCable::SubscriptionAdapter::Test` (very similar Active Job and Action Mailer tests adapters) and `ActionCable::TestCase` with a couple of matchers to track broadcasting messages in our tests:
@@ -102,7 +100,7 @@ def test_perform_speak
   perform :speak, message: "Hello, Rails!"
 
   # `transmissions` stores messages sent directly to the channel (i.e. with `transmit` method)
-  assert_equal "Hello, Rails!", transmissions.last["message"]["text"]
+  assert_equal "Hello, Rails!", transmissions.last["text"]
 end
 ```
 
@@ -124,6 +122,10 @@ class ChatChannelTest < ActionCable::Channel::TestCase
 end
 ```
 
+### RSpec Usage
+
+For more RSpec documentation see https://relishapp.com/palkan/action-cable-testing/docs.
+
 ### Generators
 
 This gem also provides Rails generators:
@@ -131,6 +133,9 @@ This gem also provides Rails generators:
 ```sh
 # Generate a channel test case for ChatChannel
 rails generate test_unit:channel chat
+
+# or for RSpec
+rails generate rspec:channel chat
 ```
 
 ## Development

data/lib/action_cable/channel/test_case.rb

@@ -138,11 +138,12 @@ module ActionCable
         include ActiveSupport::Testing::ConstantLookup
         include ActionCable::TestHelper
 
+        CHANNEL_IDENTIFIER = "test_stub"
+
         included do
           class_attribute :_channel_class
 
           attr_reader :subscription
-          delegate :transmissions, to: :connection
           delegate :streams, to: :subscription
 
           ActiveSupport.run_load_hooks(:action_cable_channel_test_case, self)
@@ -190,7 +191,7 @@ module ActionCable
 
         # Subsribe to the channel under test. Optionally pass subscription parameters as a Hash.
         def subscribe(params = {})
-          @subscription = self.class.channel_class.new(connection, "test_stub", params.with_indifferent_access)
+          @subscription = self.class.channel_class.new(connection, CHANNEL_IDENTIFIER, params.with_indifferent_access)
           @subscription.singleton_class.include(ChannelStub)
           @subscription.subscribe_to_channel
           @subscription
@@ -208,6 +209,12 @@ module ActionCable
           @connection ||= stub_connection
         end
 
+        # Returns messages transmitted into channel
+        def transmissions
+          # Return only directly sent message (via #transmit)
+          connection.transmissions.map { |data| data["message"] }.compact
+        end
+
         private
           def check_subscribed!
             raise "Must be subscribed!" if subscription.nil? || subscription.rejected?

data/lib/action_cable/testing.rb

@@ -18,3 +18,5 @@ module ActionCable
     autoload :Test
   end
 end
+
+require "action_cable/testing/rspec" if defined?(::RSpec::Rails)

data/lib/action_cable/testing/rspec.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "rspec/rails/example/channel_example_group"
+
+module RSpec
+  module Rails
+    module FeatureCheck
+      module_function
+        def has_action_cable?
+          defined?(::ActionCable)
+        end
+    end
+
+    self::DIRECTORY_MAPPINGS[:channel] = %w[spec channels]
+  end
+end
+
+RSpec.configure do |config|
+  if defined?(ActionCable)
+    config.include RSpec::Rails::ChannelExampleGroup, type: :channel
+  end
+end

data/lib/action_cable/testing/version.rb

@@ -2,6 +2,6 @@
 
 module ActionCable
   module Testing
-    VERSION = "0.0.5"
+    VERSION = "0.0.6"
   end
 end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module RSpec
+  module Rails
+    # @api public
+    # Container module for channel spec functionality. It is only available if
+    # ActionCable has been loaded before it.
+    module ChannelExampleGroup
+      # This blank module is only necessary for YARD processing. It doesn't
+      # handle the conditional `defined?` check below very well.
+    end
+  end
+end
+
+if defined?(ActionCable)
+  module RSpec
+    module Rails
+      # Container module for channel spec functionality.
+      module ChannelExampleGroup
+        extend ActiveSupport::Concern
+        include RSpec::Rails::RailsExampleGroup
+        include ActionCable::Channel::TestCase::Behavior
+
+        # Class-level DSL for channel specs.
+        module ClassMethods
+          # @private
+          def channel_class
+            described_class
+          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.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-22 00:00:00.000000000 Z
+date: 2017-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actioncable
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.5
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -53,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -66,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.4
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -125,9 +153,11 @@ files:
 - lib/action_cable/test_case.rb
 - lib/action_cable/test_helper.rb
 - lib/action_cable/testing.rb
+- lib/action_cable/testing/rspec.rb
 - lib/action_cable/testing/version.rb
 - 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
 homepage: http://github.com/palkan/action-cable-testing
 licenses:
 - MIT