cable_ready 5.0.0.rc2 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1687c9081cb1be11d90f3bd9c4dc317eb86230c72be676df1f496fc3011c1fed
-  data.tar.gz: ca21279f5a056b68b1491327fbfbc641699a61ac8b856e58f15d273e853b26dd
+  metadata.gz: 2ba59c02e54e924e8c187c22a6f4025775c6de9b7732ffab37e46e9992088a95
+  data.tar.gz: f064e043e65174039dc33f28278436058b1999fb9feecae60d2c880b58385d57
 SHA512:
-  metadata.gz: 9043dd3cf743413f53ec3da53f612213b58b5e231be3a3838b0d629f5df9687dd5f4dbffcec70d85b6f6597fd3a5bd362b194d50416451d6f1230083dab9bd3d
-  data.tar.gz: afe419203dbfba527c79d4673fe37af172d9cd7f8c3549e09eb0b58264178f44090ddc6e66da1828b4a1eb99e29151aae4adfbd04fdf102ba142190d7dcb6685
+  metadata.gz: df84a551ce0d77685c67c60914a020290d89cbd429df12be9bba5bd5031beac2d595f6863bbc624476b0d8e00f25483c327bf00c78108208704aa4940efbeadf
+  data.tar.gz: 0f8222d6fd31691bf60bf3d695478e6a982c1c7471a278a4881ff6cb62e50b6caf22894ee66a9d37222c0aadf0634c3631a2540a459b2b50b72ae0e6d29caab3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cable_ready (5.0.0.rc2)
+    cable_ready (5.0.0)
       actionpack (>= 5.2)
       actionview (>= 5.2)
       activesupport (>= 5.2)

data/app/assets/javascripts/cable_ready.js

@@ -2,7 +2,7 @@ import morphdom from "morphdom";
 
 var name = "cable_ready";
 
-var version = "5.0.0-rc2";
+var version = "5.0.0";
 
 var description = "CableReady helps you create great real-time user experiences by making it simple to trigger client-side DOM changes from server-side Ruby.";
 

data/app/assets/javascripts/cable_ready.umd.js

@@ -4,7 +4,7 @@
 })(this, (function(exports, morphdom) {
   "use strict";
   var name = "cable_ready";
-  var version = "5.0.0-rc2";
+  var version = "5.0.0";
   var description = "CableReady helps you create great real-time user experiences by making it simple to trigger client-side DOM changes from server-side Ruby.";
   var keywords = [ "ruby", "rails", "websockets", "actioncable", "cable", "ssr", "stimulus_reflex", "client-side", "dom" ];
   var homepage = "https://cableready.stimulusreflex.com";

data/{lib → app/models/concerns}/cable_ready/updatable/memory_cache_debounce_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CableReady
   module Updatable
     class MemoryCacheDebounceAdapter

data/app/models/concerns/cable_ready/updatable.rb

@@ -6,7 +6,7 @@ module CableReady
   module Updatable
     extend ::ActiveSupport::Concern
 
-    mattr_accessor :debounce_adapter, default: MemoryCacheDebounceAdapter.instance
+    mattr_accessor :debounce_adapter, default: ::CableReady::Updatable::MemoryCacheDebounceAdapter.instance
 
     included do |base|
       if defined?(ActiveRecord) && base < ActiveRecord::Base

data/cable_ready.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |gem|
   gem.summary = "Out-of-Band Server Triggered DOM Operations"
 
   gem.files = Dir[
-    "lib/**/*.{rb,rake}",
+    "lib/**/*.{rb,rake,tt}",
     "app/**/*.rb",
     "app/assets/javascripts/*",
     "bin/*",

data/lib/cable_ready/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CableReady
-  VERSION = "5.0.0.rc2"
+  VERSION = "5.0.0"
 end

data/lib/cable_ready.rb

@@ -17,8 +17,6 @@ require "cable_ready/version"
 require "cable_ready_helper"
 
 module CableReady
-  autoload :MemoryCacheDebounceAdapter, "cable_ready/updatable/memory_cache_debounce_adapter"
-
   class << self
     def config
       CableReady::Config.instance

data/lib/generators/cable_ready/templates/app/javascript/channels/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/generators/cable_ready/templates/app/javascript/channels/index.js.esbuild.tt

@@ -0,0 +1,4 @@
+// Load all the channels within this directory and all subdirectories.
+// Channel files must be named *_channel.js.
+
+import './**/*_channel.js'

data/lib/generators/cable_ready/templates/app/javascript/channels/index.js.importmap.tt

@@ -0,0 +1,2 @@
+// app/channels/index.js
+// Importmaps don't require anything here

data/lib/generators/cable_ready/templates/app/javascript/channels/index.js.shakapacker.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/generators/cable_ready/templates/app/javascript/channels/index.js.vite.tt

@@ -0,0 +1 @@
+const channels = import.meta.globEager('./**/*_channel.js')

data/lib/generators/cable_ready/templates/app/javascript/channels/index.js.webpacker.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/generators/cable_ready/templates/app/javascript/config/cable_ready.js.tt

@@ -0,0 +1,4 @@
+import consumer from '../channels/consumer'
+import CableReady from 'cable_ready'
+
+CableReady.initialize({ consumer })

data/lib/generators/cable_ready/templates/app/javascript/config/index.js.tt

@@ -0,0 +1 @@
+import './cable_ready'

data/lib/generators/cable_ready/templates/app/javascript/config/mrujs.js.tt

@@ -0,0 +1,9 @@
+import CableReady from "cable_ready"
+import mrujs from "mrujs"
+import { CableCar } from "mrujs/plugins"
+
+mrujs.start({
+  plugins: [
+    new CableCar(CableReady)
+  ]
+})

data/lib/generators/cable_ready/templates/app/javascript/controllers/%file_name%_controller.js.tt

@@ -0,0 +1,38 @@
+import { Controller } from '@hotwired/stimulus'
+import CableReady from 'cable_ready'
+
+export default class extends Controller {
+  static values = { id: Number }
+
+  connect () {
+    if (this.preview) return
+    if (this.application.consumer) {
+      this.channel = this.application.consumer.subscriptions.create(
+        {
+          channel: '<%= class_name %>Channel',
+          id: this.idValue
+        },
+        {
+          received (data) {
+            if (data.cableReady) CableReady.perform(data.operations)
+          }
+        }
+      )
+    } else {
+      console.error(
+        `The "<%= class_name.underscore.dasherize %>" Stimulus controller requires an Action Cable consumer.\nPlease set 'application.consumer = consumer' in your application.js.`
+      )
+    }
+  }
+
+  disconnect () {
+    this.channel.unsubscribe()
+  }
+
+  get preview () {
+    return (
+      document.documentElement.hasAttribute('data-turbolinks-preview') ||
+      document.documentElement.hasAttribute('data-turbo-preview')
+    )
+  }
+}

data/lib/generators/cable_ready/templates/app/javascript/controllers/application.js.tt

@@ -0,0 +1,11 @@
+import { Application } from "@hotwired/stimulus"
+import consumer from "../channels/consumer"
+
+const application = Application.start()
+
+// Configure Stimulus development experience
+application.debug = false
+application.consumer = consumer
+window.Stimulus = application
+
+export { application }

data/lib/generators/cable_ready/templates/app/javascript/controllers/index.js.esbuild.tt

@@ -0,0 +1,7 @@
+import { application } from "./application"
+
+import controllers from "./**/*_controller.js"
+
+controllers.forEach((controller) => {
+  application.register(controller.name, controller.module.default)
+})

data/lib/generators/cable_ready/templates/app/javascript/controllers/index.js.importmap.tt

@@ -0,0 +1,5 @@
+import { application } from "./application"
+
+// Eager load all controllers defined in the import map under controllers/**/*_controller
+import { eagerLoadControllersFrom } from "@hotwired/stimulus-loading"
+eagerLoadControllersFrom("controllers", application)

data/lib/generators/cable_ready/templates/app/javascript/controllers/index.js.shakapacker.tt

@@ -0,0 +1,5 @@
+import { application } from "./application"
+import { definitionsFromContext } from "@hotwired/stimulus-webpack-helpers"
+
+const controllers = definitionsFromContext(require.context("controllers", true, /_controller\.js$/))
+application.load(controllers)

data/lib/generators/cable_ready/templates/app/javascript/controllers/index.js.vite.tt

@@ -0,0 +1,5 @@
+import { application } from "./application"
+import { registerControllers } from "stimulus-vite-helpers"
+
+const controllers = import.meta.globEager("./**/*_controller.js");
+registerControllers(application, controllers)

data/lib/generators/cable_ready/templates/app/javascript/controllers/index.js.webpacker.tt

@@ -0,0 +1,5 @@
+import { application } from "./application"
+import { definitionsFromContext } from "@hotwired/stimulus-webpack-helpers"
+
+const controllers = definitionsFromContext(require.context("controllers", true, /_controller\.js$/))
+application.load(controllers)

data/lib/generators/cable_ready/templates/esbuild.config.mjs.tt

@@ -0,0 +1,94 @@
+#!/usr/bin/env node
+
+// Esbuild is configured with 3 modes:
+//
+// `yarn build` - Build JavaScript and exit
+// `yarn build --watch` - Rebuild JavaScript on change
+// `yarn build --reload` - Reloads page when views, JavaScript, or stylesheets change
+//
+// Minify is enabled when "RAILS_ENV=production"
+// Sourcemaps are enabled in non-production environments
+
+import * as esbuild from "esbuild"
+import path from "path"
+import rails from "esbuild-rails"
+import chokidar from "chokidar"
+import http from "http"
+import { setTimeout } from "timers/promises"
+
+const clients = []
+
+const entryPoints = [
+  "application.js"
+]
+
+const watchDirectories = [
+  "./app/javascript/**/*.js",
+  "./app/views/**/*.html.erb",
+  "./app/assets/builds/**/*.css", // Wait for cssbundling changes
+]
+
+const config = {
+  absWorkingDir: path.join(process.cwd(), "app/javascript"),
+  bundle: true,
+  entryPoints: entryPoints,
+  minify: process.env.RAILS_ENV == "production",
+  outdir: path.join(process.cwd(), "app/assets/builds"),
+  plugins: [rails()],
+  sourcemap: process.env.RAILS_ENV != "production"
+}
+
+async function buildAndReload() {
+  // Foreman & Overmind assign a separate PORT for each process
+  const port = parseInt(process.env.PORT)
+  const context = await esbuild.context({
+    ...config,
+    banner: {
+      js: ` (() => new EventSource("http://localhost:${port}").onmessage = () => location.reload())();`,
+    }
+  })
+
+  // Reload uses an HTTP server as an even stream to reload the browser
+  http.createServer((req, res) => {
+    return clients.push(
+      res.writeHead(200, {
+        "Content-Type": "text/event-stream",
+        "Cache-Control": "no-cache",
+        "Access-Control-Allow-Origin": "*",
+        Connection: "keep-alive",
+      })
+    )
+  }).listen(port)
+
+  await context.rebuild()
+  console.log("[reload] initial build succeeded")
+
+  let ready = false
+  chokidar.watch(watchDirectories).on("ready", () => {
+    console.log("[reload] ready")
+    ready = true
+  }).on("all", async (event, path) => {
+    if (ready === false)  return
+
+    if (path.includes("javascript")) {
+      try {
+        await setTimeout(20)
+        await context.rebuild()
+        console.log("[reload] build succeeded")
+      } catch (error) {
+        console.error("[reload] build failed", error)
+      }
+    }
+    clients.forEach((res) => res.write("data: update\n\n"))
+    clients.length = 0
+  })
+}
+
+if (process.argv.includes("--reload")) {
+  buildAndReload()
+} else if (process.argv.includes("--watch")) {
+  let context = await esbuild.context({...config, logLevel: 'info'})
+  context.watch()
+} else {
+  esbuild.build(config)
+}

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cable_ready",
-  "version": "5.0.0-rc2",
+  "version": "5.0.0",
   "description": "CableReady helps you create great real-time user experiences by making it simple to trigger client-side DOM changes from server-side Ruby.",
   "keywords": [
     "ruby",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cable_ready
 version: !ruby/object:Gem::Version
-  version: 5.0.0.rc2
+  version: 5.0.0
 platform: ruby
 authors:
 - Nathan Hopkins
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-27 00:00:00.000000000 Z
+date: 2023-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -214,6 +214,7 @@ files:
 - app/models/concerns/cable_ready/updatable.rb
 - app/models/concerns/cable_ready/updatable/collection_updatable_callbacks.rb
 - app/models/concerns/cable_ready/updatable/collections_registry.rb
+- app/models/concerns/cable_ready/updatable/memory_cache_debounce_adapter.rb
 - app/models/concerns/cable_ready/updatable/model_updatable_callbacks.rb
 - app/models/concerns/extend_has_many.rb
 - bin/console
@@ -235,11 +236,27 @@ files:
 - lib/cable_ready/operation_builder.rb
 - lib/cable_ready/sanity_checker.rb
 - lib/cable_ready/stream_identifier.rb
-- lib/cable_ready/updatable/memory_cache_debounce_adapter.rb
 - lib/cable_ready/version.rb
 - lib/cable_ready_helper.rb
 - lib/generators/cable_ready/channel_generator.rb
+- lib/generators/cable_ready/templates/app/javascript/channels/consumer.js.tt
+- lib/generators/cable_ready/templates/app/javascript/channels/index.js.esbuild.tt
+- lib/generators/cable_ready/templates/app/javascript/channels/index.js.importmap.tt
+- lib/generators/cable_ready/templates/app/javascript/channels/index.js.shakapacker.tt
+- lib/generators/cable_ready/templates/app/javascript/channels/index.js.vite.tt
+- lib/generators/cable_ready/templates/app/javascript/channels/index.js.webpacker.tt
+- lib/generators/cable_ready/templates/app/javascript/config/cable_ready.js.tt
+- lib/generators/cable_ready/templates/app/javascript/config/index.js.tt
+- lib/generators/cable_ready/templates/app/javascript/config/mrujs.js.tt
+- lib/generators/cable_ready/templates/app/javascript/controllers/%file_name%_controller.js.tt
+- lib/generators/cable_ready/templates/app/javascript/controllers/application.js.tt
+- lib/generators/cable_ready/templates/app/javascript/controllers/index.js.esbuild.tt
+- lib/generators/cable_ready/templates/app/javascript/controllers/index.js.importmap.tt
+- lib/generators/cable_ready/templates/app/javascript/controllers/index.js.shakapacker.tt
+- lib/generators/cable_ready/templates/app/javascript/controllers/index.js.vite.tt
+- lib/generators/cable_ready/templates/app/javascript/controllers/index.js.webpacker.tt
 - lib/generators/cable_ready/templates/config/initializers/cable_ready.rb
+- lib/generators/cable_ready/templates/esbuild.config.mjs.tt
 - lib/install/action_cable.rb
 - lib/install/broadcaster.rb
 - lib/install/bundle.rb
@@ -277,9 +294,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.4.1
 signing_key: