actioncable 6.0.0.beta1 → 6.0.1.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20a6bcfcf415a9ea43c5d5c373f866bbef09a40408f9295e0977def92827b56f
-  data.tar.gz: ab61cfc6789eeba117d09b5472adb861d8afaade19486e6bd4b2f34917d13596
+  metadata.gz: 86d46b846c3fb07e49e3a307349c964e9b11d4c7b06f22a126bbeaa01b158e43
+  data.tar.gz: 39167fb170b2d5ea8106427bb3b44cc87079c843e89a96e2bfe6bae489b2370a
 SHA512:
-  metadata.gz: 0fc74fe87659a01fbbb841a36de8bd2027d2c3ec73ea92f23706ae07bc8648e5c92cb1bd08bb4f6e00cbbab2c201db183badb1cecae8d7b4839232116fc43e24
-  data.tar.gz: b09eb6b5430aa9fe60eb41aa8a9e21ad59a49bf281f14cbcf562200ae09e9d2950cc0eb3ebc2d6019f506325cab1c7ff58ea735d4672643ca2de76fd99b86524
+  metadata.gz: e3cf41533f7f14bc919495b240de8f3c6b520f7c4a2dc88ca6190ea7eef7e1ffb578aae6f4089676c3066241b5b0215037a3a89da0c507aa7759018aef002163
+  data.tar.gz: 0b674b1b260ba11b94d8a2e5b290659edd3aeff68939b65327f5d494529a5320144ed957428a14f210f10c29bcc263bc475e1595ce2b355b3bd0c29fa67a783f

data/CHANGELOG.md

@@ -1,5 +1,99 @@
+## Rails 6.0.1.rc1 (October 31, 2019) ##
+
+*   No changes.
+
+
+## Rails 6.0.0 (August 16, 2019) ##
+
+*   No changes.
+
+
+## Rails 6.0.0.rc2 (July 22, 2019) ##
+
+*   No changes.
+
+
+## Rails 6.0.0.rc1 (April 24, 2019) ##
+
+*   No changes.
+
+
+## Rails 6.0.0.beta3 (March 11, 2019) ##
+
+*   No changes.
+
+
+## Rails 6.0.0.beta2 (February 25, 2019) ##
+
+*   PostgreSQL subscription adapters now support `channel_prefix` option in cable.yml
+
+    Avoids channel name collisions when multiple apps use the same database for Action Cable.
+
+    *Vladimir Dementyev*
+
+*   Allow passing custom configuration to `ActionCable::Server::Base`.
+
+    You can now create a standalone Action Cable server with a custom configuration
+    (e.g. to run it in isolation from the default one):
+
+    ```ruby
+    config = ActionCable::Server::Configuration.new
+    config.cable = { adapter: "redis", channel_prefix: "custom_" }
+
+    CUSTOM_CABLE = ActionCable::Server::Base.new(config: config)
+    ```
+
+    Then you can mount it in the `routes.rb` file:
+
+    ```ruby
+    Rails.application.routes.draw do
+      mount CUSTOM_CABLE => "/custom_cable"
+      # ...
+    end
+    ```
+
+    *Vladimir Dementyev*
+
+*   Add `:action_cable_connection` and `:action_cable_channel` load hooks.
+
+    You can use them to extend `ActionCable::Connection::Base` and `ActionCable::Channel::Base`
+    functionality:
+
+    ```ruby
+    ActiveSupport.on_load(:action_cable_channel) do
+      # do something in the context of ActionCable::Channel::Base
+    end
+    ```
+
+    *Vladimir Dementyev*
+
+*   Add `Channel::Base#broadcast_to`.
+
+    You can now call `broadcast_to` within a channel action, which equals to
+    the `self.class.broadcast_to`.
+
+    *Vladimir Dementyev*
+
+*   Make `Channel::Base.broadcasting_for` a public API.
+
+    You can use `.broadcasting_for` to generate a unique stream identifier within
+    a channel for the specified target (e.g. Active Record model):
+
+    ```ruby
+    ChatChannel.broadcasting_for(model) # => "chat:<model.to_gid_param>"
+    ```
+
+    *Vladimir Dementyev*
+
+
 ## Rails 6.0.0.beta1 (January 18, 2019) ##
 
+*   [Rename npm package](https://github.com/rails/rails/pull/34905) from
+    [`actioncable`](https://www.npmjs.com/package/actioncable) to
+    [`@rails/actioncable`](https://www.npmjs.com/package/@rails/actioncable).
+
+    *Javan Makhmali*
+
 *   Merge [`action-cable-testing`](https://github.com/palkan/action-cable-testing) to Rails.
 
     *Vladimir Dementyev*

data/README.md

@@ -13,7 +13,7 @@ You can read more about Action Cable in the [Action Cable Overview](https://edge
 
 API documentation is at:
 
-* http://api.rubyonrails.org
+* https://api.rubyonrails.org
 
 Bug reports for the Ruby on Rails project can be filed here:
 

data/app/assets/javascripts/action_cable.js

@@ -28,6 +28,22 @@
       throw new TypeError("Cannot call a class as a function");
     }
   };
+  var createClass = function() {
+    function defineProperties(target, props) {
+      for (var i = 0; i < props.length; i++) {
+        var descriptor = props[i];
+        descriptor.enumerable = descriptor.enumerable || false;
+        descriptor.configurable = true;
+        if ("value" in descriptor) descriptor.writable = true;
+        Object.defineProperty(target, descriptor.key, descriptor);
+      }
+    }
+    return function(Constructor, protoProps, staticProps) {
+      if (protoProps) defineProperties(Constructor.prototype, protoProps);
+      if (staticProps) defineProperties(Constructor, staticProps);
+      return Constructor;
+    };
+  }();
   var now = function now() {
     return new Date().getTime();
   };
@@ -432,7 +448,7 @@
   var Consumer = function() {
     function Consumer(url) {
       classCallCheck(this, Consumer);
-      this.url = url;
+      this._url = url;
       this.subscriptions = new Subscriptions(this);
       this.connection = new Connection(this);
     }
@@ -452,19 +468,18 @@
         return this.connection.open();
       }
     };
+    createClass(Consumer, [ {
+      key: "url",
+      get: function get$$1() {
+        return createWebSocketURL(this._url);
+      }
+    } ]);
     return Consumer;
   }();
-  function createConsumer() {
-    var url = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : getConfig("url") || INTERNAL.default_mount_path;
-    return new Consumer(createWebSocketURL(url));
-  }
-  function getConfig(name) {
-    var element = document.head.querySelector("meta[name='action-cable-" + name + "']");
-    if (element) {
-      return element.getAttribute("content");
-    }
-  }
   function createWebSocketURL(url) {
+    if (typeof url === "function") {
+      url = url();
+    }
     if (url && !/^wss?:/i.test(url)) {
       var a = document.createElement("a");
       a.href = url;
@@ -475,6 +490,16 @@
       return url;
     }
   }
+  function createConsumer() {
+    var url = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : getConfig("url") || INTERNAL.default_mount_path;
+    return new Consumer(url);
+  }
+  function getConfig(name) {
+    var element = document.head.querySelector("meta[name='action-cable-" + name + "']");
+    if (element) {
+      return element.getAttribute("content");
+    }
+  }
   exports.Connection = Connection;
   exports.ConnectionMonitor = ConnectionMonitor;
   exports.Consumer = Consumer;
@@ -482,10 +507,10 @@
   exports.Subscription = Subscription;
   exports.Subscriptions = Subscriptions;
   exports.adapters = adapters;
+  exports.createWebSocketURL = createWebSocketURL;
   exports.logger = logger;
   exports.createConsumer = createConsumer;
   exports.getConfig = getConfig;
-  exports.createWebSocketURL = createWebSocketURL;
   Object.defineProperty(exports, "__esModule", {
     value: true
   });

data/lib/action_cable/channel/base.rb

@@ -307,3 +307,5 @@ module ActionCable
     end
   end
 end
+
+ActiveSupport.run_load_hooks(:action_cable_channel, ActionCable::Channel::Base)

data/lib/action_cable/channel/broadcasting.rb

@@ -7,22 +7,32 @@ module ActionCable
     module Broadcasting
       extend ActiveSupport::Concern
 
-      delegate :broadcasting_for, to: :class
+      delegate :broadcasting_for, :broadcast_to, to: :class
 
       module ClassMethods
         # Broadcast a hash to a unique broadcasting for this <tt>model</tt> in this channel.
         def broadcast_to(model, message)
-          ActionCable.server.broadcast(broadcasting_for([ channel_name, model ]), message)
+          ActionCable.server.broadcast(broadcasting_for(model), message)
         end
 
-        def broadcasting_for(model) #:nodoc:
+        # Returns a unique broadcasting identifier for this <tt>model</tt> in this channel:
+        #
+        #    CommentsChannel.broadcasting_for("all") # => "comments:all"
+        #
+        # You can pass any object as a target (e.g. Active Record model), and it
+        # would be serialized into a string under the hood.
+        def broadcasting_for(model)
+          serialize_broadcasting([ channel_name, model ])
+        end
+
+        def serialize_broadcasting(object) #:nodoc:
           case
-          when model.is_a?(Array)
-            model.map { |m| broadcasting_for(m) }.join(":")
-          when model.respond_to?(:to_gid_param)
-            model.to_gid_param
+          when object.is_a?(Array)
+            object.map { |m| serialize_broadcasting(m) }.join(":")
+          when object.respond_to?(:to_gid_param)
+            object.to_gid_param
           else
-            model.to_param
+            object.to_param
           end
         end
       end

data/lib/action_cable/channel/streams.rb

@@ -99,7 +99,7 @@ module ActionCable
       # Pass <tt>coder: ActiveSupport::JSON</tt> to decode messages as JSON before passing to the callback.
       # Defaults to <tt>coder: nil</tt> which does no decoding, passes raw messages.
       def stream_for(model, callback = nil, coder: nil, &block)
-        stream_from(broadcasting_for([ channel_name, model ]), callback || block, coder: coder)
+        stream_from(broadcasting_for(model), callback || block, coder: coder)
       end
 
       # Unsubscribes all streams associated with this channel from the pubsub queue.

data/lib/action_cable/channel/test_case.rb

@@ -143,7 +143,7 @@ module ActionCable
     # You need to set up your connection manually to provide values for the identifiers.
     # To do this just use:
     #
-    #   stub_connection(user: users[:john])
+    #   stub_connection(user: users(:john))
     #
     # == Testing broadcasting
     #
@@ -157,9 +157,9 @@ module ActionCable
     #  end
     #
     #  def test_speak
-    #    subscribe room_id: rooms[:chat].id
+    #    subscribe room_id: rooms(:chat).id
     #
-    #    assert_broadcasts_on(rooms[:chat], text: "Hello, Rails!") do
+    #    assert_broadcasts_on(rooms(:chat), text: "Hello, Rails!") do
     #      perform :speak, message: "Hello, Rails!"
     #    end
     #  end
@@ -300,9 +300,7 @@ module ActionCable
           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]
-            )
+            self.class.channel_class.broadcasting_for(stream_or_object)
           end
       end
 

data/lib/action_cable/connection/base.rb

@@ -260,3 +260,5 @@ module ActionCable
     end
   end
 end
+
+ActiveSupport.run_load_hooks(:action_cable_connection, ActionCable::Connection::Base)

data/lib/action_cable/connection/test_case.rb

@@ -42,8 +42,6 @@ module ActionCable
 
     class TestRequest < ActionDispatch::TestRequest
       attr_accessor :session, :cookie_jar
-
-      attr_writer :cookie_jar
     end
 
     module TestConnection
@@ -178,7 +176,7 @@ module ActionCable
         #
         # Accepts request path as the first argument and the following request options:
         #
-        # - params – url parameters (Hash)
+        # - params – URL parameters (Hash)
         # - headers – request headers (Hash)
         # - session – session data (Hash)
         # - env – additional Rack env configuration (Hash)

data/lib/action_cable/gem_version.rb

@@ -9,8 +9,8 @@ module ActionCable
   module VERSION
     MAJOR = 6
     MINOR = 0
-    TINY  = 0
-    PRE   = "beta1"
+    TINY  = 1
+    PRE   = "rc1"
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")
   end

data/lib/action_cable/server/base.rb

@@ -12,14 +12,17 @@ module ActionCable
       include ActionCable::Server::Broadcasting
       include ActionCable::Server::Connections
 
-      cattr_accessor :config, instance_accessor: true, default: ActionCable::Server::Configuration.new
+      cattr_accessor :config, instance_accessor: false, default: ActionCable::Server::Configuration.new
+
+      attr_reader :config
 
       def self.logger; config.logger; end
       delegate :logger, to: :config
 
       attr_reader :mutex
 
-      def initialize
+      def initialize(config: self.class.config)
+        @config = config
         @mutex = Monitor.new
         @remote_connections = @event_loop = @worker_pool = @pubsub = nil
       end

data/lib/action_cable/subscription_adapter/postgresql.rb

@@ -8,6 +8,8 @@ require "digest/sha1"
 module ActionCable
   module SubscriptionAdapter
     class PostgreSQL < Base # :nodoc:
+      prepend ChannelPrefix
+
       def initialize(*)
         super
         @listener = nil

data/lib/action_cable/subscription_adapter/redis.rb

@@ -5,6 +5,8 @@ require "thread"
 gem "redis", ">= 3", "< 5"
 require "redis"
 
+require "active_support/core_ext/hash/except"
+
 module ActionCable
   module SubscriptionAdapter
     class Redis < Base # :nodoc:
@@ -14,7 +16,7 @@ module ActionCable
       # This is needed, for example, when using Makara proxies for distributed Redis.
       cattr_accessor :redis_connector, default: ->(config) do
         config[:id] ||= "ActionCable-PID-#{$$}"
-        ::Redis.new(config.slice(:url, :host, :port, :db, :password, :id))
+        ::Redis.new(config.except(:adapter, :channel_prefix))
       end
 
       def initialize(*)

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

@@ -1,15 +1,15 @@
 import consumer from "./consumer"
 
 consumer.subscriptions.create("<%= class_name %>Channel", {
-  connected: function() {
+  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

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: actioncable
 version: !ruby/object:Gem::Version
-  version: 6.0.0.beta1
+  version: 6.0.1.rc1
 platform: ruby
 authors:
 - Pratik Naik
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-18 00:00:00.000000000 Z
+date: 2019-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 6.0.0.beta1
+        version: 6.0.1.rc1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 6.0.0.beta1
+        version: 6.0.1.rc1
 - !ruby/object:Gem::Dependency
   name: nio4r
   requirement: !ruby/object:Gem::Requirement
@@ -121,12 +121,15 @@ files:
 - 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: http://rubyonrails.org
+homepage: https://rubyonrails.org
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/rails/rails/tree/v6.0.0.beta1/actioncable
-  changelog_uri: https://github.com/rails/rails/blob/v6.0.0.beta1/actioncable/CHANGELOG.md
+  bug_tracker_uri: https://github.com/rails/rails/issues
+  changelog_uri: https://github.com/rails/rails/blob/v6.0.1.rc1/actioncable/CHANGELOG.md
+  documentation_uri: https://api.rubyonrails.org/v6.0.1.rc1/
+  mailing_list_uri: https://groups.google.com/forum/#!forum/rubyonrails-talk
+  source_code_uri: https://github.com/rails/rails/tree/v6.0.1.rc1/actioncable
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -142,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: WebSocket framework for Rails.