live_cable 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20702ab1185b4176ee5c141e8d3aebf94f84c1125ea4dff99d77f1e811d291be
-  data.tar.gz: 0c98c9fb64b5cd6c0beb7c42d7a941f146159b176bcd1b794d4054387cfcd333
+  metadata.gz: e0376ac919c3ed29e3c63181364e512f51aa39aeeb84f1b8a0584b42e1c89985
+  data.tar.gz: 8bb42eb86866bddf18fb83e0a16770c4ddb48c3ec22524b680e272d155e22431
 SHA512:
-  metadata.gz: 7d5fee026e4323afaa5341089f016e0444e830ad29cf06b2279a2861173bf7294c204a4429b5d02bc814e0a2a44abbfaad040fc6f6edd3979e990808f6c835bd
-  data.tar.gz: 1d59e9aa056f2a088f395214105a973c80d6d43ac354b31a9ac313db3fb9465e1773aeaa83017bc95be81b2f9ee91c0f00b8a1d7155e587411a51c675a9b43b4
+  metadata.gz: 4f95c867c6f65a85ceca7fad4c23cc572bc1cfb6c90e008ebb24403dbc7624cd9977ae711bc133484612b0e3ac16440f3d18bf365c656c8d537f009387dfd0fe
+  data.tar.gz: 01d716fd63f39335bbaaed9aa8b0643f5b9a1493b9f1ca449635b4aa7f3cecc6d67992f31503412cbba6fd53860778918627430365af614b8598beb0666306b4

data/README.md

@@ -48,14 +48,32 @@ end
 
 ## JavaScript Setup
 
-### 1. Register the LiveController
+LiveCable works with both **importmap-rails** (default for Rails 7+) and **JavaScript bundlers** (esbuild, Vite, webpack, Rollup via jsbundling-rails or vite_ruby).
 
-Register the `LiveController` in your Stimulus application (`app/javascript/controllers/application.js`):
+### Using importmap-rails (default)
+
+The gem automatically pins all necessary modules when you install it. No additional setup is needed.
+
+### Using a JavaScript bundler (yarn/npm)
+
+Install the npm package:
+
+```bash
+yarn add @isometriks/live_cable
+# or
+npm install @isometriks/live_cable
+```
+
+This will also install the required peer dependencies (`@rails/actioncable`, `@hotwired/stimulus`, and `morphdom`).
+
+### Register the LiveController
+
+Register the `LiveController` in your Stimulus application (`app/javascript/controllers/application.js`). The imports are the same regardless of whether you use importmap or a bundler:
 
 ```javascript
 import { Application } from "@hotwired/stimulus"
-import LiveController from "live_cable_controller"
-import "live_cable"  // Automatically starts DOM observer
+import LiveController from "@isometriks/live_cable/controller"
+import "@isometriks/live_cable"  // Automatically starts DOM observer
 
 const application = Application.start()
 application.register("live", LiveController)
@@ -69,9 +87,9 @@ If you want to call LiveCable actions from your own Stimulus controllers, add th
 
 ```javascript
 import { Application, Controller } from "@hotwired/stimulus"
-import LiveController from "live_cable_controller"
-import LiveCableBlessing from "live_cable_blessing"
-import "live_cable"  // Automatically starts DOM observer
+import LiveController from "@isometriks/live_cable/controller"
+import LiveCableBlessing from "@isometriks/live_cable/blessing"
+import "@isometriks/live_cable"  // Automatically starts DOM observer
 
 // Enable the blessing for all controllers
 Controller.blessings = [

data/app/assets/javascript/controllers/live_controller.js

@@ -1,5 +1,5 @@
 import { Controller } from "@hotwired/stimulus"
-import SubscriptionManager from "live_cable_subscriptions"
+import SubscriptionManager from "@isometriks/live_cable/subscriptions"
 
 export default class extends Controller {
   static values = {

data/app/assets/javascript/live_cable.js

@@ -1,6 +1,6 @@
-import LiveObserver from 'live_cable_observer'
-import SubscriptionManager from 'live_cable_subscriptions'
-import DOM from 'live_cable_dom'
+import LiveObserver from '@isometriks/live_cable/observer'
+import SubscriptionManager from '@isometriks/live_cable/subscriptions'
+import DOM from '@isometriks/live_cable/dom'
 
 const observer = new LiveObserver()
 observer.start()

data/app/assets/javascript/live_cable_blessing.js

@@ -1,4 +1,4 @@
-import LiveController from "live_cable_controller"
+import LiveController from "@isometriks/live_cable/controller"
 
 export default function LiveCableBlessing(constructor) {
   Object.assign(constructor.prototype, {

data/app/assets/javascript/observer.js

@@ -1,4 +1,4 @@
-import DOM from "live_cable_dom"
+import DOM from "@isometriks/live_cable/dom"
 
 /**
  * LiveCable DOM Observer

data/app/assets/javascript/subscriptions.js

@@ -20,7 +20,7 @@
 
 import { createConsumer } from "@rails/actioncable"
 import morphdom from "morphdom"
-import DOM from "live_cable_dom"
+import DOM from "@isometriks/live_cable/dom"
 
 const consumer = createConsumer()
 

data/config/importmap.rb

@@ -3,9 +3,9 @@
 pin '@rails/actioncable', to: 'actioncable.esm.js'
 pin 'morphdom', to: 'https://ga.jspm.io/npm:morphdom@2.7.8/dist/morphdom-esm.js'
 
-pin 'live_cable_controller', to: 'controllers/live_controller.js'
-pin 'live_cable_blessing', to: 'live_cable_blessing.js'
-pin 'live_cable_subscriptions', to: 'subscriptions.js'
-pin 'live_cable_observer', to: 'observer.js'
-pin 'live_cable_dom', to: 'dom.js'
-pin 'live_cable', to: 'live_cable.js'
+pin '@isometriks/live_cable/controller', to: 'controllers/live_controller.js'
+pin '@isometriks/live_cable/blessing', to: 'live_cable_blessing.js'
+pin '@isometriks/live_cable/subscriptions', to: 'subscriptions.js'
+pin '@isometriks/live_cable/observer', to: 'observer.js'
+pin '@isometriks/live_cable/dom', to: 'dom.js'
+pin '@isometriks/live_cable', to: 'live_cable.js'

data/lib/live_cable/engine.rb

@@ -12,8 +12,10 @@ module LiveCable
         warn("[LiveCable Warning] #{live_component_dir} does not exist for components.")
       end
 
-      # Add LiveCable to importmap
-      app.config.importmap.paths << root.join('config/importmap.rb')
+      # Add LiveCable to importmap (skip when using jsbundling/npm)
+      if app.config.respond_to?(:importmap)
+        app.config.importmap.paths << root.join('config/importmap.rb')
+      end
     end
 
     initializer 'live_cable.assets_precompile' do |app|

data/lib/live_cable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LiveCable
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: live_cable
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Craig Blanchette