extension_cable 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8e82701171a978a8d05bfdf9a494b18817f8549a0e130ddd497d98e8cd3462b6
+  data.tar.gz: 2156a7a4ec6dd84764f547caf01072f31fc4633e628771c7d5605b7be81ed8cf
+SHA512:
+  metadata.gz: 1657057743f328474958f1583de5c671325f2ca5a82b3a0a7f59a1d791dc29efa702413bedcc7d2d1bf876cfdb5a2d2c1a2f28a5f57a0073947554918513b9ff
+  data.tar.gz: a65e6f8c3fdbd5563b60dbcbab2bc214a17012cd927867a83bf4514d65548deb8a92eb3a1d5f1996d48b43c74b7fc2228a3bdeac3f55dacee90fee845bddd93c

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.3.7

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Will Bryant
+
+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.

data/README.md

@@ -0,0 +1,31 @@
+# ExtensionCable
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/extension_cable`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/extension_cable.

data/Rakefile

@@ -0,0 +1,17 @@
+#!/usr/bin/env rake
+
+require 'bundler/gem_tasks'
+require 'rake'
+require 'rake/testtask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the constant_table_saver plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/*_test.rb'
+  t.verbose = true
+  t.warning = false
+end

data/extension_cable.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative "lib/extension_cable/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "extension_cable"
+  spec.version = ExtensionCable::VERSION
+  spec.authors = ["Will Bryant"]
+  spec.email = ["will.bryant@gmail.com"]
+
+  spec.summary = "Add a second ActionCable PubSub adapter"
+  spec.description = "Allows you to use two ActionCable PubSub adapters in one app."
+  spec.homepage = "https://github.com/DelivereasyNZ/extension_cable"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/DelivereasyNZ/extension_cable.git"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "actioncable"
+end

data/lib/extension_cable/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class ExtensionCable
+  VERSION = "1.0.0"
+end

data/lib/extension_cable.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require "action_cable"
+
+require_relative "extension_cable/version"
+
+class ExtensionCable
+  include ActionCable::Server::Broadcasting
+
+  ActiveSupport.on_load(:action_cable) do
+    app = Rails.application
+    app.paths.add "config/extension_cable", with: "config/extension_cable.yml"
+    if (config_path = Pathname.new(app.config.paths["config/extension_cable"].first)).exist?
+      ExtensionCable.config = app.config_for(config_path).to_h.with_indifferent_access
+    end
+  end
+
+  # We don't really run a "server" as such, as we don't serve any HTTP endpoints or run our own threads.
+  # But for the ease of porting existing application code, let's use the same nomenclature as ActionCable.
+  def self.server
+    @server ||= new
+  end
+
+  cattr_accessor :config
+
+  delegate :mutex, :logger, :event_loop, to: "ActionCable.server"
+
+  def config
+    # Reuse the pubsub_adapter logic from ActionCable to get the nice require behavior and constantizing fudges
+    @config ||= ActionCable::Server::Configuration.new.tap do |config|
+      config.cable = self.class.config
+    end
+  end
+
+  def pubsub
+    @pubsub || mutex.synchronize { @pubsub ||= config.pubsub_adapter.new(self) }
+  end
+
+  module Channel
+    extend ActiveSupport::Concern
+
+    included do
+      delegate :broadcast_to, to: :class
+    end
+
+    # This redefinition changes the implementation of stream_from and stream_for so that they stream from the
+    # ExtensionCable pubsub adapter, instead of the default ActionCable pubsub adapter.
+    def pubsub
+      ExtensionCable.server.pubsub
+    end
+
+    module ClassMethods
+      # Broadcast a hash to a unique broadcasting for this <tt>model</tt> in this channel.
+      def broadcast_to(model, message)
+        ExtensionCable.server.broadcast(broadcasting_for(model), message)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: extension_cable
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Will Bryant
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-03-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actioncable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Allows you to use two ActionCable PubSub adapters in one app.
+email:
+- will.bryant@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".tool-versions"
+- LICENSE.txt
+- README.md
+- Rakefile
+- extension_cable.gemspec
+- lib/extension_cable.rb
+- lib/extension_cable/version.rb
+homepage: https://github.com/DelivereasyNZ/extension_cable
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/DelivereasyNZ/extension_cable
+  source_code_uri: https://github.com/DelivereasyNZ/extension_cable.git
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Add a second ActionCable PubSub adapter
+test_files: []