actioncable-next 0.1.0

data/lib/action_cable.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+#--
+# Copyright (c) 37signals LLC
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#++
+
+require "active_support"
+require "active_support/rails"
+require "zeitwerk"
+
+# We compute lib this way instead of using __dir__ because __dir__ gives a real
+# path, while __FILE__ honors symlinks. If the gem is stored under a symlinked
+# directory, this matters.
+lib = File.dirname(__FILE__)
+
+Zeitwerk::Loader.for_gem.tap do |loader|
+  loader.ignore(
+    "#{lib}/rails", # Contains generators, templates, docs, etc.
+    "#{lib}/action_cable/gem_version.rb",
+    "#{lib}/action_cable/version.rb",
+    "#{lib}/action_cable/deprecator.rb",
+    "#{lib}/actioncable-next.rb",
+  )
+
+  loader.do_not_eager_load(
+    "#{lib}/action_cable/subscription_adapter", # Adapters are required and loaded on demand.
+    "#{lib}/action_cable/test_helper.rb",
+    Dir["#{lib}/action_cable/**/test_case.rb"]
+  )
+
+  loader.inflector.inflect("postgresql" => "PostgreSQL")
+end.setup
+
+# :markup: markdown
+# :include: ../README.md
+module ActionCable
+  require_relative "action_cable/version"
+  require_relative "action_cable/deprecator"
+
+  INTERNAL = {
+    message_types: {
+      welcome: "welcome",
+      disconnect: "disconnect",
+      ping: "ping",
+      confirmation: "confirm_subscription",
+      rejection: "reject_subscription"
+    },
+    disconnect_reasons: {
+      unauthorized: "unauthorized",
+      invalid_request: "invalid_request",
+      server_restart: "server_restart",
+      remote: "remote"
+    },
+    default_mount_path: "/cable",
+    protocols: ["actioncable-v1-json", "actioncable-unsupported"].freeze
+  }
+
+  # Singleton instance of the server
+  module_function def server
+    @server ||= ActionCable::Server::Base.new
+  end
+end

data/lib/actioncable-next.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ActionCableNext
+  VERSION = "0.1.0"
+end

data/lib/rails/generators/channel/USAGE

@@ -0,0 +1,19 @@
+Description:
+    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.
+
+Examples:
+    `bin/rails generate channel notification`
+
+    creates a notification channel class, test and JavaScript asset:
+        Channel:    app/channels/notification_channel.rb
+        Test:       test/channels/notification_channel_test.rb
+        Assets:     $JAVASCRIPT_PATH/channels/notification_channel.js
+
+    `bin/rails generate channel chat speak`
+
+    creates a chat channel with a speak action.
+
+    `bin/rails generate channel comments --no-assets`
+
+    creates a comments channel without JavaScript assets.

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

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+# :markup: markdown
+
+module Rails
+  module Generators
+    class ChannelGenerator < NamedBase
+      source_root File.expand_path("templates", __dir__)
+
+      argument :actions, type: :array, default: [], banner: "method method"
+
+      class_option :assets, type: :boolean
+
+      check_class_collision suffix: "Channel"
+
+      hook_for :test_framework
+
+      def create_channel_files
+        create_shared_channel_files
+        create_channel_file
+
+        if using_javascript?
+          if first_setup_required?
+            create_shared_channel_javascript_files
+            import_channels_in_javascript_entrypoint
+
+            if using_importmap?
+              pin_javascript_dependencies
+            elsif using_js_runtime?
+              install_javascript_dependencies
+            end
+          end
+
+          create_channel_javascript_file
+          import_channel_in_javascript_entrypoint
+        end
+      end
+
+      private
+        def create_shared_channel_files
+          return if behavior != :invoke
+
+          copy_file "#{__dir__}/templates/application_cable/channel.rb",
+            "app/channels/application_cable/channel.rb"
+          copy_file "#{__dir__}/templates/application_cable/connection.rb",
+            "app/channels/application_cable/connection.rb"
+        end
+
+        def create_channel_file
+          template "channel.rb",
+            File.join("app/channels", class_path, "#{file_name}_channel.rb")
+        end
+
+        def create_shared_channel_javascript_files
+          template "javascript/index.js", "app/javascript/channels/index.js"
+          template "javascript/consumer.js", "app/javascript/channels/consumer.js"
+        end
+
+        def create_channel_javascript_file
+          channel_js_path = File.join("app/javascript/channels", class_path, "#{file_name}_channel")
+          js_template "javascript/channel", channel_js_path
+          gsub_file "#{channel_js_path}.js", /\.\/consumer/, "channels/consumer" unless using_js_runtime?
+        end
+
+        def import_channels_in_javascript_entrypoint
+          append_to_file "app/javascript/application.js",
+            using_js_runtime? ? %(import "./channels"\n) : %(import "channels"\n)
+        end
+
+        def import_channel_in_javascript_entrypoint
+          append_to_file "app/javascript/channels/index.js",
+            using_js_runtime? ? %(import "./#{file_name}_channel"\n) : %(import "channels/#{file_name}_channel"\n)
+        end
+
+        def install_javascript_dependencies
+          say "Installing JavaScript dependencies", :green
+          if using_bun?
+            run "bun add @rails/actioncable"
+          elsif using_node?
+            run "yarn add @rails/actioncable"
+          end
+        end
+
+        def pin_javascript_dependencies
+          append_to_file "config/importmap.rb", <<-RUBY
+pin "@rails/actioncable", to: "actioncable.esm.js"
+pin_all_from "app/javascript/channels", under: "channels"
+          RUBY
+        end
+
+        def file_name
+          @_file_name ||= super.sub(/_channel\z/i, "")
+        end
+
+        def first_setup_required?
+          !root.join("app/javascript/channels/index.js").exist?
+        end
+
+        def using_javascript?
+          @using_javascript ||= options[:assets] && root.join("app/javascript").exist?
+        end
+
+        def using_js_runtime?
+          @using_js_runtime ||= root.join("package.json").exist?
+        end
+
+        def using_bun?
+          # Cannot assume bun.lockb has been generated yet so we look for a file known to
+          # be generated by the jsbundling-rails gem
+          @using_bun ||= using_js_runtime? && root.join("bun.config.js").exist?
+        end
+
+        def using_node?
+          # Bun is the only runtime that _isn't_ node.
+          @using_node ||= using_js_runtime? && !root.join("bun.config.js").exist?
+        end
+
+        def using_importmap?
+          @using_importmap ||= root.join("config/importmap.rb").exist?
+        end
+
+        def root
+          @root ||= Pathname(destination_root)
+        end
+    end
+  end
+end

data/lib/rails/generators/channel/templates/application_cable/channel.rb.tt

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/lib/rails/generators/channel/templates/application_cable/connection.rb.tt

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

data/lib/rails/generators/channel/templates/channel.rb.tt

@@ -0,0 +1,16 @@
+<% module_namespacing do -%>
+class <%= class_name %>Channel < ApplicationCable::Channel
+  def subscribed
+    # stream_from "some_channel"
+  end
+
+  def unsubscribed
+    # Any cleanup needed when channel is unsubscribed
+  end
+<% actions.each do |action| -%>
+
+  def <%= action %>
+  end
+<% end -%>
+end
+<% end -%>

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

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

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 @@
+// Import all the channels to be used by Action Cable

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# :markup: markdown
+
+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

@@ -0,0 +1,191 @@
+--- !ruby/object:Gem::Specification
+name: actioncable-next
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pratik Naik
+- David Heinemeier Hansson
+- Vladimir Dementyev
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-09-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '8.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '8.1'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '8.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '8.1'
+- !ruby/object:Gem::Dependency
+  name: nio4r
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: websocket-driver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+description: Next-gen version of Action Cable
+email:
+- pratiknaik@gmail.com
+- david@loudthinking.com
+- palkan@evilmartians.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- MIT-LICENSE
+- README.md
+- lib/action_cable.rb
+- lib/action_cable/channel/base.rb
+- lib/action_cable/channel/broadcasting.rb
+- lib/action_cable/channel/callbacks.rb
+- 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/authorization.rb
+- lib/action_cable/connection/base.rb
+- lib/action_cable/connection/callbacks.rb
+- lib/action_cable/connection/identification.rb
+- lib/action_cable/connection/internal_channel.rb
+- lib/action_cable/connection/subscriptions.rb
+- lib/action_cable/connection/test_case.rb
+- lib/action_cable/deprecator.rb
+- lib/action_cable/engine.rb
+- lib/action_cable/gem_version.rb
+- lib/action_cable/helpers/action_cable_helper.rb
+- lib/action_cable/remote_connections.rb
+- lib/action_cable/server/base.rb
+- lib/action_cable/server/broadcasting.rb
+- lib/action_cable/server/configuration.rb
+- lib/action_cable/server/connections.rb
+- lib/action_cable/server/socket.rb
+- lib/action_cable/server/socket/client_socket.rb
+- lib/action_cable/server/socket/message_buffer.rb
+- lib/action_cable/server/socket/stream.rb
+- lib/action_cable/server/socket/web_socket.rb
+- lib/action_cable/server/stream_event_loop.rb
+- lib/action_cable/server/tagged_logger_proxy.rb
+- lib/action_cable/server/worker.rb
+- lib/action_cable/server/worker/active_record_connection_management.rb
+- lib/action_cable/subscription_adapter/async.rb
+- lib/action_cable/subscription_adapter/base.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/actioncable-next.rb
+- lib/rails/generators/channel/USAGE
+- lib/rails/generators/channel/channel_generator.rb
+- 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://github.com/anycable/action_cable-next
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/anycable/actioncable-next
+  changelog_uri: https://github.com/anycable/actioncable-next/blob/v0.1.0/CHANGELOG.md
+  source_code_uri: https://github.com/anycable/actioncable-next
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.18
+signing_key:
+specification_version: 4
+summary: Next-gen version of Action Cable
+test_files: []