actioncable 5.0.1 → 6.1.3

data/lib/action_cable/test_case.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "active_support/test_case"
+
+module ActionCable
+  class TestCase < ActiveSupport::TestCase
+    include ActionCable::TestHelper
+
+    ActiveSupport.run_load_hooks(:action_cable_test_case, self)
+  end
+end

data/lib/action_cable/test_helper.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+module ActionCable
+  # Provides helper methods for testing Action Cable broadcasting
+  module TestHelper
+    def before_setup # :nodoc:
+      server = ActionCable.server
+      test_adapter = ActionCable::SubscriptionAdapter::Test.new(server)
+
+      @old_pubsub_adapter = server.pubsub
+
+      server.instance_variable_set(:@pubsub, test_adapter)
+      super
+    end
+
+    def after_teardown # :nodoc:
+      super
+      ActionCable.server.instance_variable_set(:@pubsub, @old_pubsub_adapter)
+    end
+
+    # Asserts that the number of broadcasted messages to the stream matches the given number.
+    #
+    #   def test_broadcasts
+    #     assert_broadcasts 'messages', 0
+    #     ActionCable.server.broadcast 'messages', { text: 'hello' }
+    #     assert_broadcasts 'messages', 1
+    #     ActionCable.server.broadcast 'messages', { text: 'world' }
+    #     assert_broadcasts 'messages', 2
+    #   end
+    #
+    # If a block is passed, that block should cause the specified number of
+    # messages to be broadcasted.
+    #
+    #   def test_broadcasts_again
+    #     assert_broadcasts('messages', 1) do
+    #       ActionCable.server.broadcast 'messages', { text: 'hello' }
+    #     end
+    #
+    #     assert_broadcasts('messages', 2) do
+    #       ActionCable.server.broadcast 'messages', { text: 'hi' }
+    #       ActionCable.server.broadcast 'messages', { text: 'how are you?' }
+    #     end
+    #   end
+    #
+    def assert_broadcasts(stream, number, &block)
+      if block_given?
+        original_count = broadcasts_size(stream)
+        assert_nothing_raised(&block)
+        new_count = broadcasts_size(stream)
+        actual_count = new_count - original_count
+      else
+        actual_count = broadcasts_size(stream)
+      end
+
+      assert_equal number, actual_count, "#{number} broadcasts to #{stream} expected, but #{actual_count} were sent"
+    end
+
+    # Asserts that no messages have been sent to the stream.
+    #
+    #   def test_no_broadcasts
+    #     assert_no_broadcasts 'messages'
+    #     ActionCable.server.broadcast 'messages', { text: 'hi' }
+    #     assert_broadcasts 'messages', 1
+    #   end
+    #
+    # If a block is passed, that block should not cause any message to be sent.
+    #
+    #   def test_broadcasts_again
+    #     assert_no_broadcasts 'messages' do
+    #       # No job messages should be sent from this block
+    #     end
+    #   end
+    #
+    # Note: This assertion is simply a shortcut for:
+    #
+    #   assert_broadcasts 'messages', 0, &block
+    #
+    def assert_no_broadcasts(stream, &block)
+      assert_broadcasts stream, 0, &block
+    end
+
+    # Asserts that the specified message has been sent to the stream.
+    #
+    #   def test_assert_transmitted_message
+    #     ActionCable.server.broadcast 'messages', text: 'hello'
+    #     assert_broadcast_on('messages', text: 'hello')
+    #   end
+    #
+    # If a block is passed, that block should cause a message with the specified data to be sent.
+    #
+    #   def test_assert_broadcast_on_again
+    #     assert_broadcast_on('messages', text: 'hello') do
+    #       ActionCable.server.broadcast 'messages', text: 'hello'
+    #     end
+    #   end
+    #
+    def assert_broadcast_on(stream, data, &block)
+      # 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(stream)
+      if block_given?
+        old_messages = new_messages
+        clear_messages(stream)
+
+        assert_nothing_raised(&block)
+        new_messages = broadcasts(stream)
+        clear_messages(stream)
+
+        # Restore all sent messages
+        (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 #{stream}"
+    end
+
+    def pubsub_adapter # :nodoc:
+      ActionCable.server.pubsub
+    end
+
+    delegate :broadcasts, :clear_messages, to: :pubsub_adapter
+
+    private
+      def broadcasts_size(channel)
+        broadcasts(channel).size
+      end
+  end
+end

data/lib/action_cable/version.rb

@@ -1,4 +1,6 @@
-require_relative 'gem_version'
+# frozen_string_literal: true
+
+require_relative "gem_version"
 
 module ActionCable
   # Returns the version of the currently loaded Action Cable as a <tt>Gem::Version</tt>

data/lib/rails/generators/channel/USAGE

@@ -1,14 +1,13 @@
 Description:
 ============
-    Stubs out a new cable channel for the server (in Ruby) and client (in CoffeeScript).
+    Generates a new cable channel for the server (in Ruby) and client (in JavaScript).
     Pass the channel name, either CamelCased or under_scored, and an optional list of channel actions as arguments.
 
-    Note: Turn on the cable connection in app/assets/javascript/cable.js after generating any channels.
-
 Example:
 ========
-    rails generate channel Chat speak
+    bin/rails generate channel Chat speak
 
-    creates a Chat channel class and CoffeeScript asset:
+    creates a Chat channel class, test and JavaScript asset:
         Channel:    app/channels/chat_channel.rb
-        Assets:     app/assets/javascript/channels/chat.coffee
+        Test:       test/channels/chat_channel_test.rb
+        Assets:     app/javascript/channels/chat_channel.js

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

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module Rails
   module Generators
     class ChannelGenerator < NamedBase
-      source_root File.expand_path("../templates", __FILE__)
+      source_root File.expand_path("templates", __dir__)
 
       argument :actions, type: :array, default: [], banner: "method method"
 
@@ -9,36 +11,39 @@ module Rails
 
       check_class_collision suffix: "Channel"
 
+      hook_for :test_framework
+
       def create_channel_file
-        template "channel.rb", File.join('app/channels', class_path, "#{file_name}_channel.rb")
+        template "channel.rb", File.join("app/channels", class_path, "#{file_name}_channel.rb")
 
         if options[:assets]
-          if self.behavior == :invoke
-            template "assets/cable.js", "app/assets/javascripts/cable.js"
+          if behavior == :invoke
+            template "javascript/index.js", "app/javascript/channels/index.js"
+            template "javascript/consumer.js", "app/javascript/channels/consumer.js"
           end
 
-          js_template "assets/channel", File.join('app/assets/javascripts/channels', class_path, "#{file_name}")
+          js_template "javascript/channel", File.join("app/javascript/channels", class_path, "#{file_name}_channel")
         end
 
         generate_application_cable_files
       end
 
-      protected
+      private
         def file_name
-          @_file_name ||= super.gsub(/_channel/i, '')
+          @_file_name ||= super.sub(/_channel\z/i, "")
         end
 
         # FIXME: Change these files to symlinks once RubyGems 2.5.0 is required.
         def generate_application_cable_files
-          return if self.behavior != :invoke
+          return if behavior != :invoke
 
           files = [
-            'application_cable/channel.rb',
-            'application_cable/connection.rb'
+            "application_cable/channel.rb",
+            "application_cable/connection.rb"
           ]
 
           files.each do |name|
-            path = File.join('app/channels/', name)
+            path = File.join("app/channels/", name)
             template(name, path) if !File.exist?(path)
           end
         end

data/lib/rails/generators/channel/templates/{assets/channel.js → javascript/channel.js.tt}

@@ -1,13 +1,15 @@
-App.<%= class_name.underscore %> = App.cable.subscriptions.create("<%= class_name %>Channel", {
-  connected: function() {
+import consumer from "./consumer"
+
+consumer.subscriptions.create("<%= class_name %>Channel", {
+  connected() {
     // Called when the subscription is ready for use on the server
   },
 
-  disconnected: function() {
+  disconnected() {
     // Called when the subscription has been terminated by the server
   },
 
-  received: function(data) {
+  received(data) {
     // Called when there's incoming data on the websocket for this channel
   }<%= actions.any? ? ",\n" : '' %>
 <% actions.each do |action| -%>

data/lib/rails/generators/channel/templates/javascript/consumer.js.tt

@@ -0,0 +1,6 @@
+// Action Cable provides the framework to deal with WebSockets in Rails.
+// You can generate new channels where WebSocket features live using the `bin/rails generate channel` command.
+
+import { createConsumer } from "@rails/actioncable"
+
+export default createConsumer()

data/lib/rails/generators/channel/templates/javascript/index.js.tt

@@ -0,0 +1,5 @@
+// Load all the channels within this directory and all subdirectories.
+// Channel files must be named *_channel.js.
+
+const channels = require.context('.', true, /_channel\.js$/)
+channels.keys().forEach(channels)

data/lib/rails/generators/test_unit/channel_generator.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module TestUnit
+  module Generators
+    class ChannelGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path("templates", __dir__)
+
+      check_class_collision suffix: "ChannelTest"
+
+      def create_test_files
+        template "channel_test.rb", File.join("test/channels", class_path, "#{file_name}_channel_test.rb")
+      end
+
+      private
+        def file_name # :doc:
+          @_file_name ||= super.sub(/_channel\z/i, "")
+        end
+    end
+  end
+end

data/lib/rails/generators/test_unit/templates/channel_test.rb.tt

@@ -0,0 +1,8 @@
+require "test_helper"
+
+class <%= class_name %>ChannelTest < ActionCable::Channel::TestCase
+  # test "subscribes" do
+  #   subscribe
+  #   assert subscription.confirmed?
+  # end
+end

metadata

@@ -1,72 +1,72 @@
 --- !ruby/object:Gem::Specification
 name: actioncable
 version: !ruby/object:Gem::Version
-  version: 5.0.1
+  version: 6.1.3
 platform: ruby
 authors:
 - Pratik Naik
 - David Heinemeier Hansson
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-12-21 00:00:00.000000000 Z
+date: 2021-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: actionpack
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.0.1
+        version: 6.1.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.0.1
+        version: 6.1.3
 - !ruby/object:Gem::Dependency
-  name: nio4r
+  name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: 6.1.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: 6.1.3
 - !ruby/object:Gem::Dependency
-  name: websocket-driver
+  name: nio4r
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.1
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.1
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: blade
+  name: websocket-driver
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.1
-  type: :development
+        version: 0.6.1
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: 0.6.1
 description: Structure many real-time application concerns into channels over a single
   WebSocket connection.
 email:
@@ -79,6 +79,7 @@ files:
 - CHANGELOG.md
 - MIT-LICENSE
 - README.md
+- app/assets/javascripts/action_cable.js
 - lib/action_cable.rb
 - lib/action_cable/channel.rb
 - lib/action_cable/channel/base.rb
@@ -87,12 +88,11 @@ files:
 - lib/action_cable/channel/naming.rb
 - lib/action_cable/channel/periodic_timers.rb
 - lib/action_cable/channel/streams.rb
+- lib/action_cable/channel/test_case.rb
 - lib/action_cable/connection.rb
 - lib/action_cable/connection/authorization.rb
 - lib/action_cable/connection/base.rb
 - lib/action_cable/connection/client_socket.rb
-- lib/action_cable/connection/faye_client_socket.rb
-- lib/action_cable/connection/faye_event_loop.rb
 - lib/action_cable/connection/identification.rb
 - lib/action_cable/connection/internal_channel.rb
 - lib/action_cable/connection/message_buffer.rb
@@ -100,6 +100,7 @@ files:
 - lib/action_cable/connection/stream_event_loop.rb
 - lib/action_cable/connection/subscriptions.rb
 - lib/action_cable/connection/tagged_logger_proxy.rb
+- lib/action_cable/connection/test_case.rb
 - lib/action_cable/connection/web_socket.rb
 - lib/action_cable/engine.rb
 - lib/action_cable/gem_version.rb
@@ -115,26 +116,35 @@ files:
 - lib/action_cable/subscription_adapter.rb
 - lib/action_cable/subscription_adapter/async.rb
 - lib/action_cable/subscription_adapter/base.rb
-- lib/action_cable/subscription_adapter/evented_redis.rb
+- lib/action_cable/subscription_adapter/channel_prefix.rb
 - lib/action_cable/subscription_adapter/inline.rb
 - lib/action_cable/subscription_adapter/postgresql.rb
 - lib/action_cable/subscription_adapter/redis.rb
 - lib/action_cable/subscription_adapter/subscriber_map.rb
+- lib/action_cable/subscription_adapter/test.rb
+- lib/action_cable/test_case.rb
+- lib/action_cable/test_helper.rb
 - lib/action_cable/version.rb
-- lib/assets/compiled/action_cable.js
 - lib/rails/generators/channel/USAGE
 - lib/rails/generators/channel/channel_generator.rb
-- lib/rails/generators/channel/templates/application_cable/channel.rb
-- lib/rails/generators/channel/templates/application_cable/connection.rb
-- lib/rails/generators/channel/templates/assets/cable.js
-- lib/rails/generators/channel/templates/assets/channel.coffee
-- lib/rails/generators/channel/templates/assets/channel.js
-- lib/rails/generators/channel/templates/channel.rb
-homepage: http://rubyonrails.org
+- lib/rails/generators/channel/templates/application_cable/channel.rb.tt
+- lib/rails/generators/channel/templates/application_cable/connection.rb.tt
+- lib/rails/generators/channel/templates/channel.rb.tt
+- lib/rails/generators/channel/templates/javascript/channel.js.tt
+- lib/rails/generators/channel/templates/javascript/consumer.js.tt
+- lib/rails/generators/channel/templates/javascript/index.js.tt
+- lib/rails/generators/test_unit/channel_generator.rb
+- lib/rails/generators/test_unit/templates/channel_test.rb.tt
+homepage: https://rubyonrails.org
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  bug_tracker_uri: https://github.com/rails/rails/issues
+  changelog_uri: https://github.com/rails/rails/blob/v6.1.3/actioncable/CHANGELOG.md
+  documentation_uri: https://api.rubyonrails.org/v6.1.3/
+  mailing_list_uri: https://discuss.rubyonrails.org/c/rubyonrails-talk
+  source_code_uri: https://github.com/rails/rails/tree/v6.1.3/actioncable
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -142,17 +152,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.2
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: WebSocket framework for Rails.
 test_files: []
-has_rdoc: