cable_ready 5.0.0.pre10 → 5.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7240cc96726bfeff504657e69096170f4971cd94357bb0fcf0431d14db26c953
-  data.tar.gz: b32acb97a059ee03bab8c8a973917d934e208a4aaf44015a2fe082fe5d42086f
+  metadata.gz: 727abefeeee7c2b5775ce2ca9b9e4521cf8172ba99f0a3ce4d6c0e4c49a77fae
+  data.tar.gz: f42905f8cc53e8effade6db00fa24d569c398b7f163e9a06aa19425c1bcdd888
 SHA512:
-  metadata.gz: 8d641446ac2e71ce6cb901e38c37851886e10a0076c796429ca8476cfde68094a1e7ad096eba8c058d24b9acd9125f81f7b85c7cf0385e6d898931185629ccfb
-  data.tar.gz: ac2d450ccd867b52c154053337f80d56af0221eee3a4ddd0e9597d93c8defb0a67b28efc34c14cf454241875303e43a01ecfe51bf13f2180e23e5e2df23e3a94
+  metadata.gz: 99bb047390e54d2143be5cfa9c7115203b0464d39aca3eab2d28486560043b26338f1d9f18b74507aa928afb87c7e08c93ecc475666730d6f1caae0eaf1486c2
+  data.tar.gz: 96e773ba9e75a9603a47850cd14784a47576fdb6b98b58d40c701deabc363342be1e626d55f845fa6186e57957f9cd52d9c67c79e72837d33a0d50be015630de

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cable_ready (5.0.0.pre10)
+    cable_ready (5.0.0.rc1)
       actionpack (>= 5.2)
       actionview (>= 5.2)
       activesupport (>= 5.2)
@@ -121,7 +121,7 @@ GEM
     pry-nav (1.0.0)
       pry (>= 0.9.10, < 0.15)
     racc (1.6.2)
-    rack (2.2.6.2)
+    rack (2.2.6.4)
     rack-test (2.0.2)
       rack (>= 1.3)
     rails (6.1.7.2)

data/README.md

@@ -1,5 +1,5 @@
 <p align="center">
-  <img src="https://raw.githubusercontent.com/stimulusreflex/cable_ready/master/assets/cable-ready-logo-with-copy.svg" width="360" />
+  <img src="https://raw.githubusercontent.com/stimulusreflex/cable_ready/main/assets/cable-ready-logo-with-copy.svg" width="360" />
   <h1 align="center">Welcome to CableReady 👋</h1>
   <p align="center">
     <a href="https://rubygems.org/gems/cable_ready">
@@ -11,16 +11,13 @@
     <a href="https://www.npmjs.com/package/cable_ready">
       <img alt="downloads" src="https://img.shields.io/npm/dm/cable_ready.svg?color=blue" target="_blank" />
     </a>
-    <a href="https://github.com/stimulusreflex/cable_ready/blob/master/LICENSE">
+    <a href="https://github.com/stimulusreflex/cable_ready/blob/main/LICENSE">
       <img alt="License: MIT" src="https://img.shields.io/badge/license-MIT-brightgreen.svg" target="_blank" />
     </a>
-    <a href="http://blog.codinghorror.com/the-best-code-is-no-code-at-all/" target="_blank">
-      <img alt="Lines of Code" src="https://img.shields.io/badge/lines_of_code-1203-brightgreen.svg?style=flat" />
-    </a>
-    <br />
     <a href="https://cableready.stimulusreflex.com" target="_blank">
       <img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" />
     </a>
+    <br />
     <a href="#badge">
       <img alt="semantic-release" src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg">
     </a>
@@ -31,12 +28,15 @@
       <img alt="JavaScript Code Style" src="https://img.shields.io/badge/JavaScript_Code_Style-prettier_standard-ff69b4.svg" />
     </a>
     <br />
-    <a target="_blank" rel="noopener noreferrer" href="https://github.com/stimulusreflex/cable_ready/workflows/Prettier-Standard/badge.svg">
+    <a target="_blank" rel="noopener noreferrer" href="https://github.com/stimulusreflex/cable_ready/actions/workflows/prettier-standard.yml">
       <img src="https://github.com/stimulusreflex/cable_ready/workflows/Prettier-Standard/badge.svg" alt="Prettier-Standard" style="max-width:100%;">
     </a>
-    <a target="_blank" rel="noopener noreferrer" href="https://github.com/stimulusreflex/cable_ready/workflows/StandardRB/badge.svg">
+    <a target="_blank" rel="noopener noreferrer" href="https://github.com/stimulusreflex/cable_ready/actions/workflows/standardrb.yml">
       <img src="https://github.com/stimulusreflex/cable_ready/workflows/StandardRB/badge.svg" alt="StandardRB" style="max-width:100%;">
     </a>
+    <a target="_blank" rel="noopener noreferrer" href="https://github.com/stimulusreflex/cable_ready/actions/workflows/tests.yml">
+      <img src="https://github.com/stimulusreflex/cable_ready/workflows/Tests/badge.svg" alt="Tests" style="max-width:100%;">
+    </a>
   </p>
 </p>
 <br />
@@ -49,7 +49,7 @@ to learn more about ActionCable before proceeding.
 ## 📚 Docs
 
 - [Official Documentation](https://cableready.stimulusreflex.com)
-- [Documentation Source Code](https://github.com/stimulusreflex/cable_ready/tree/master/docs)
+- [Documentation Source Code](https://github.com/stimulusreflex/cable_ready/tree/main/docs)
 
 ## 💙 Community
 
@@ -80,7 +80,7 @@ yarn add cable_ready
 
 # ...
 
-pin 'cable_ready', to: 'cable_ready.min.js', preload: true
+pin 'cable_ready', to: 'cable_ready.js', preload: true
 ```
 
 #### Rails Asset pipeline (Sprockets):
@@ -88,7 +88,7 @@ pin 'cable_ready', to: 'cable_ready.min.js', preload: true
 ```html+erb
 <!-- app/views/layouts/application.html.erb -->
 
-<%= javascript_include_tag "cable_ready.umd.min.js", "data-turbo-track": "reload" %>
+<%= javascript_include_tag "cable_ready.umd.js", "data-turbo-track": "reload" %>
 ```
 
 Checkout the [documentation](https://cableready.stimulusreflex.com) to continue!
@@ -111,7 +111,7 @@ Please run `./bin/standardize` prior submitting pull requests.
 1. Make sure that you run `yarn` and `bundle` to pick up the latest.
 1. Bump version number at `lib/cable_ready/version.rb`. Pre-release versions use `.preN`
 1. Run `rake build` and `yarn build`
-1. Commit and push changes to github
+1. Commit and push changes to GitHub
 1. Run `rake release`
 1. Run `yarn publish --no-git-tag-version`
 1. Yarn will prompt you for the new version. Pre-release versions use `-preN`

data/app/assets/javascripts/cable_ready.js

@@ -2,7 +2,7 @@ import morphdom from "morphdom";
 
 var name = "cable_ready";
 
-var version = "5.0.0-pre10";
+var version = "5.0.0-rc1";
 
 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.";
 
@@ -33,13 +33,14 @@ var umd = "./dist/cable_ready.umd.js";
 var files = [ "dist/*", "javascript/*" ];
 
 var scripts = {
-  lint: "yarn run prettier-standard:check",
-  format: "yarn run prettier-standard:format",
-  "prettier-standard:check": "yarn run prettier-standard --check ./javascript/**/*.js rollup.config.js",
-  "prettier-standard:format": "yarn run prettier-standard ./javascript/**/*.js rollup.config.js",
+  lint: "yarn run format --check",
+  format: "yarn run prettier-standard ./javascript/**/*.js rollup.config.mjs",
   build: "yarn rollup -c",
   watch: "yarn rollup -wc",
-  test: "web-test-runner javascript/test/**/*.test.js"
+  test: "web-test-runner javascript/test/**/*.test.js",
+  "docs:dev": "vitepress dev docs",
+  "docs:build": "vitepress build docs && cp ./docs/_redirects ./docs/.vitepress/dist",
+  "docs:preview": "vitepress preview docs"
 };
 
 var dependencies = {
@@ -53,10 +54,13 @@ var devDependencies = {
   "@rollup/plugin-terser": "^0.4.0",
   "@web/dev-server-esbuild": "^0.3.3",
   "@web/dev-server-rollup": "^0.3.21",
-  "@web/test-runner": "^0.15.0",
+  "@web/test-runner": "^0.15.1",
   "prettier-standard": "^16.4.1",
-  rollup: "^3.15.0",
-  sinon: "^15.0.1"
+  rollup: "^3.19.1",
+  sinon: "^15.0.2",
+  vite: "^4.1.4",
+  vitepress: "^1.0.0-alpha.56",
+  "vitepress-plugin-search": "^1.0.4-alpha.19"
 };
 
 var packageInfo = {
@@ -1057,7 +1061,7 @@ class UpdatesForElement extends SubscribingElement {
       Log.cancel(this.lastUpdateTimestamp, "All elements filtered out");
       return;
     }
-    // first updates-for element in the DOM *at any given moment* updates all of the others
+    // first <cable-ready-updates-for> element in the DOM *at any given moment* updates all of the others
         if (blocks[0].element !== this) {
       Log.cancel(this.lastUpdateTimestamp, "Update already requested");
       return;
@@ -1142,7 +1146,7 @@ class Block {
       const selector = `turbo-frame#${frame.id}`;
       const frameContent = frameTemplate.content.querySelector(selector);
       const content = frameContent ? frameContent.innerHTML.trim() : "";
-      docFragment.querySelector(selector).innerHTML = content;
+      documentFragment.querySelector(selector).innerHTML = content;
       resolve();
     })))));
   }

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-pre10";
+  var version = "5.0.0-rc1";
   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";
@@ -20,13 +20,14 @@
   var umd = "./dist/cable_ready.umd.js";
   var files = [ "dist/*", "javascript/*" ];
   var scripts = {
-    lint: "yarn run prettier-standard:check",
-    format: "yarn run prettier-standard:format",
-    "prettier-standard:check": "yarn run prettier-standard --check ./javascript/**/*.js rollup.config.js",
-    "prettier-standard:format": "yarn run prettier-standard ./javascript/**/*.js rollup.config.js",
+    lint: "yarn run format --check",
+    format: "yarn run prettier-standard ./javascript/**/*.js rollup.config.mjs",
     build: "yarn rollup -c",
     watch: "yarn rollup -wc",
-    test: "web-test-runner javascript/test/**/*.test.js"
+    test: "web-test-runner javascript/test/**/*.test.js",
+    "docs:dev": "vitepress dev docs",
+    "docs:build": "vitepress build docs && cp ./docs/_redirects ./docs/.vitepress/dist",
+    "docs:preview": "vitepress preview docs"
   };
   var dependencies = {
     morphdom: "2.6.1"
@@ -38,10 +39,13 @@
     "@rollup/plugin-terser": "^0.4.0",
     "@web/dev-server-esbuild": "^0.3.3",
     "@web/dev-server-rollup": "^0.3.21",
-    "@web/test-runner": "^0.15.0",
+    "@web/test-runner": "^0.15.1",
     "prettier-standard": "^16.4.1",
-    rollup: "^3.15.0",
-    sinon: "^15.0.1"
+    rollup: "^3.19.1",
+    sinon: "^15.0.2",
+    vite: "^4.1.4",
+    vitepress: "^1.0.0-alpha.56",
+    "vitepress-plugin-search": "^1.0.4-alpha.19"
   };
   var packageInfo = {
     name: name,
@@ -978,7 +982,7 @@
         Log.cancel(this.lastUpdateTimestamp, "All elements filtered out");
         return;
       }
-      // first updates-for element in the DOM *at any given moment* updates all of the others
+      // first <cable-ready-updates-for> element in the DOM *at any given moment* updates all of the others
             if (blocks[0].element !== this) {
         Log.cancel(this.lastUpdateTimestamp, "Update already requested");
         return;
@@ -1062,7 +1066,7 @@
         const selector = `turbo-frame#${frame.id}`;
         const frameContent = frameTemplate.content.querySelector(selector);
         const content = frameContent ? frameContent.innerHTML.trim() : "";
-        docFragment.querySelector(selector).innerHTML = content;
+        documentFragment.querySelector(selector).innerHTML = content;
         resolve();
       })))));
     }

data/app/jobs/{cable_ready_broadcast_job.rb → cable_ready/broadcast_job.rb}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 if defined?(ActiveJob::Base)
-  class CableReadyBroadcastJob < ActiveJob::Base
+  class CableReady::BroadcastJob < ActiveJob::Base
     include CableReady::Broadcaster
 
     def perform(identifier:, operations:, model: nil)

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

@@ -2,6 +2,18 @@
 
 module CableReady
   module Updatable
+    Collection = Struct.new(
+      :klass,
+      :name,
+      :reflection,
+      :options,
+      :foreign_key,
+      :inverse_association,
+      :through_association,
+      :debounce_time,
+      keyword_init: true
+    )
+
     class CollectionsRegistry
       def initialize
         @registered_collections = []
@@ -12,23 +24,35 @@ module CableReady
       end
 
       def broadcast_for!(model, operation)
-        @registered_collections.select { |c| c[:options][:on].include?(operation) }
+        @registered_collections.select { |c| c.options[:on].include?(operation) }
           .each do |collection|
           resource = find_resource_for_update(collection, model)
           next if resource.nil?
 
-          collection[:klass].cable_ready_update_collection(resource, collection[:name], model) if collection[:options][:if].call(resource)
+          collection.klass.cable_ready_update_collection(resource, collection.name, model, debounce: collection.debounce_time) if collection.options[:if].call(resource)
         end
       end
 
       private
 
       def find_resource_for_update(collection, model)
-        raise ArgumentError, "Could not find inverse_of for #{collection[:name]}" unless collection[:inverse_association]
+        collection.reflection ||= collection.klass.reflect_on_association(collection.name)
+
+        collection.foreign_key ||= collection.reflection&.foreign_key
+
+        # lazy load and store through and inverse associations
+        if collection.reflection&.through_reflection?
+          collection.inverse_association ||= collection.reflection&.through_reflection&.inverse_of&.name&.to_s
+          collection.through_association = collection.reflection&.through_reflection&.name&.to_s&.singularize
+        else
+          collection.inverse_association ||= collection.reflection&.inverse_of&.name&.to_s
+        end
+
+        raise ArgumentError, "Could not find inverse_of for #{collection.name}" unless collection.inverse_association
 
         resource = model
-        resource = resource.send(collection[:through_association].underscore) if collection[:through_association]
-        resource.send(collection[:inverse_association].underscore)
+        resource = resource.send(collection.through_association.underscore) if collection.through_association
+        resource.send(collection.inverse_association.underscore)
       end
     end
   end

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

@@ -3,9 +3,10 @@
 module CableReady
   module Updatable
     class ModelUpdatableCallbacks
-      def initialize(operation, enabled_operations = %i[create update destroy])
+      def initialize(operation, enabled_operations = %i[create update destroy], debounce: CableReady.config.updatable_debounce_time)
         @operation = operation
         @enabled_operations = enabled_operations
+        @debounce = debounce
       end
 
       def after_commit(model)
@@ -17,14 +18,15 @@ module CableReady
       private
 
       def broadcast_create(model)
-        model.class.send(:broadcast_updates, model.class, {})
+        model.class.send(:broadcast_updates, model.class, {debounce: @debounce})
       end
       alias_method :broadcast_destroy, :broadcast_create
 
       def broadcast_update(model)
         changeset = model.respond_to?(:previous_changes) ? {changed: model.previous_changes.keys} : {}
-        model.class.send(:broadcast_updates, model.class, changeset)
-        model.class.send(:broadcast_updates, model.to_global_id, changeset)
+        options = changeset.merge({debounce: @debounce})
+        model.class.send(:broadcast_updates, model.class, options.dup)
+        model.class.send(:broadcast_updates, model.to_global_id, options)
       end
     end
   end

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

@@ -6,6 +6,8 @@ module CableReady
   module Updatable
     extend ::ActiveSupport::Concern
 
+    mattr_accessor :debounce_adapter, default: MemoryCacheDebounceAdapter.instance
+
     included do |base|
       if defined?(ActiveRecord) && base < ActiveRecord::Base
         include ExtendHasMany
@@ -30,14 +32,15 @@ module CableReady
           options = options.extract_options!
           options = {
             on: [:create, :update, :destroy],
-            if: -> { true }
+            if: -> { true },
+            debounce: CableReady.config.updatable_debounce_time
           }.merge(options)
 
           enabled_operations = Array(options[:on])
 
-          after_commit(ModelUpdatableCallbacks.new(:create, enabled_operations), {on: :create, if: options[:if]})
-          after_commit(ModelUpdatableCallbacks.new(:update, enabled_operations), {on: :update, if: options[:if]})
-          after_commit(ModelUpdatableCallbacks.new(:destroy, enabled_operations), {on: :destroy, if: options[:if]})
+          after_commit(ModelUpdatableCallbacks.new(:create, enabled_operations, debounce: options[:debounce]), {on: :create, if: options[:if]})
+          after_commit(ModelUpdatableCallbacks.new(:update, enabled_operations, debounce: options[:debounce]), {on: :update, if: options[:if]})
+          after_commit(ModelUpdatableCallbacks.new(:destroy, enabled_operations, debounce: options[:debounce]), {on: :destroy, if: options[:if]})
         end
 
         def self.skip_cable_ready_updates
@@ -52,6 +55,8 @@ module CableReady
     private
 
     module ClassMethods
+      include Compoundable
+
       def has_many(name, scope = nil, **options, &extension)
         option = if options.has_key?(:enable_updates)
           warn "DEPRECATED: please use `enable_cable_ready_updates` instead. The `enable_updates` option will be removed from a future version of CableReady 5"
@@ -61,10 +66,11 @@ module CableReady
         end
 
         descendants = options.delete(:descendants)
+        debounce_time = options.delete(:debounce)
 
         broadcast = option.present?
         result = super
-        enrich_association_with_updates(name, option, descendants) if broadcast
+        enrich_association_with_updates(name, option, descendants, debounce: debounce_time) if broadcast
         result
       end
 
@@ -77,10 +83,11 @@ module CableReady
         end
 
         descendants = options.delete(:descendants)
+        debounce_time = options.delete(:debounce)
 
         broadcast = option.present?
         result = super
-        enrich_association_with_updates(name, option, descendants) if broadcast
+        enrich_association_with_updates(name, option, descendants, debounce: debounce_time) if broadcast
         result
       end
 
@@ -94,9 +101,11 @@ module CableReady
           options.delete(:enable_cable_ready_updates)
         end
 
+        debounce_time = options.delete(:debounce)
+
         broadcast = option.present?
         result = super
-        enrich_attachments_with_updates(name, option) if broadcast
+        enrich_attachments_with_updates(name, option, debounce: debounce_time) if broadcast
         result
       end
 
@@ -104,50 +113,45 @@ module CableReady
         @cable_ready_collections ||= CollectionsRegistry.new
       end
 
-      def cable_ready_update_collection(resource, name, model)
+      def cable_ready_update_collection(resource, name, model, debounce: CableReady.config.updatable_debounce_time)
         identifier = resource.to_global_id.to_s + ":" + name.to_s
-        broadcast_updates(identifier, model.respond_to?(:previous_changes) ? {changed: model.previous_changes.keys} : {})
+        changeset = model.respond_to?(:previous_changes) ? {changed: model.previous_changes.keys} : {}
+        options = changeset.merge({debounce: debounce})
+
+        broadcast_updates(identifier, options)
       end
 
-      def enrich_association_with_updates(name, option, descendants = nil)
+      def enrich_association_with_updates(name, option, descendants = nil, debounce: CableReady.config.updatable_debounce_time)
         reflection = reflect_on_association(name)
 
-        inverse_of = reflection.inverse_of&.name&.to_s
-        through_association = nil
-
-        if reflection.through_reflection?
-          inverse_of = reflection.through_reflection.inverse_of&.name&.to_s
-          through_association = reflection.through_reflection.name.to_s.singularize
-        end
-
         options = build_options(option)
 
         [reflection.klass, *descendants&.map(&:to_s)&.map(&:constantize)].each do |klass|
           klass.send(:include, CableReady::Updatable) unless klass.respond_to?(:cable_ready_collections)
-          klass.cable_ready_collections.register({
+          klass.cable_ready_collections.register(Collection.new(
             klass: self,
-            foreign_key: reflection.foreign_key,
             name: name,
-            inverse_association: inverse_of,
-            through_association: through_association,
-            options: options
-          })
+            options: options,
+            reflection: reflection,
+            debounce_time: debounce
+          ))
         end
       end
 
-      def enrich_attachments_with_updates(name, option)
+      def enrich_attachments_with_updates(name, option, debounce: CableReady.config.updatable_debounce_time)
         options = build_options(option)
 
         ActiveStorage::Attachment.send(:include, CableReady::Updatable) unless ActiveStorage::Attachment.respond_to?(:cable_ready_collections)
 
-        ActiveStorage::Attachment.cable_ready_collections.register({
+        ActiveStorage::Attachment.cable_ready_collections.register(Collection.new(
           klass: self,
           foreign_key: "record_id",
           name: name,
           inverse_association: "record",
           through_association: nil,
-          options: options
-        })
+          options: options,
+          debounce_time: debounce
+        ))
       end
 
       def build_options(option)
@@ -180,7 +184,23 @@ module CableReady
       def broadcast_updates(model_class, options)
         return if skip_updates_classes.any? { |klass| klass >= self }
         raise("ActionCable must be enabled to use Updatable") unless defined?(ActionCable)
-        ActionCable.server.broadcast(model_class, options)
+
+        debounce_time = options.delete(:debounce)
+        debounce_time ||= CableReady.config.updatable_debounce_time
+
+        if debounce_time.to_f > 0
+          key = compound([model_class, *options])
+          old_wait_until = CableReady::Updatable.debounce_adapter[key]
+          now = Time.now.to_f
+
+          if old_wait_until.nil? || old_wait_until < now
+            new_wait_until = now + debounce_time.to_f
+            CableReady::Updatable.debounce_adapter[key] = new_wait_until
+            ActionCable.server.broadcast(model_class, options)
+          end
+        else
+          ActionCable.server.broadcast(model_class, options)
+        end
       end
 
       def skip_updates_classes

data/lib/cable_ready/channel.rb

@@ -28,7 +28,7 @@ module CableReady
 
     def broadcast_later(clear: true, queue: nil)
       raise("Action Cable must be enabled to use broadcast_later") unless defined?(ActionCable)
-      CableReadyBroadcastJob
+      CableReady::BroadcastJob
         .set(queue: queue ? queue.to_sym : CableReady.config.broadcast_job_queue)
         .perform_later(identifier: identifier, operations: operations_payload)
       reset! if clear
@@ -36,7 +36,7 @@ module CableReady
 
     def broadcast_later_to(model, clear: true, queue: nil)
       raise("Action Cable must be enabled to use broadcast_later_to") unless defined?(ActionCable)
-      CableReadyBroadcastJob
+      CableReady::BroadcastJob
         .set(queue: queue ? queue.to_sym : CableReady.config.broadcast_job_queue)
         .perform_later(identifier: identifier.name, operations: operations_payload, model: model)
       reset! if clear

data/lib/cable_ready/config.rb

@@ -11,7 +11,7 @@ module CableReady
     include Observable
     include Singleton
 
-    attr_accessor :on_failed_sanity_checks, :broadcast_job_queue, :precompile_assets
+    attr_accessor :on_failed_sanity_checks, :broadcast_job_queue, :precompile_assets, :updatable_debounce_time
     attr_writer :verifier_key
 
     def on_new_version_available
@@ -28,6 +28,7 @@ module CableReady
       @on_failed_sanity_checks = :exit
       @broadcast_job_queue = :default
       @precompile_assets = true
+      @updatable_debounce_time = 0.1.seconds
     end
 
     def observers

data/lib/cable_ready/engine.rb

@@ -12,31 +12,40 @@ module CableReady
     # end
     PRECOMPILE_ASSETS = %w[
       cable_ready.js
-      cable_ready.min.js
-      cable_ready.min.js.map
       cable_ready.umd.js
-      cable_ready.umd.min.js
-      cable_ready.umd.min.js.map
     ]
 
+    initializer "cable_ready.assets" do |app|
+      if app.config.respond_to?(:assets) && CableReady.config.precompile_assets
+        app.config.assets.precompile += PRECOMPILE_ASSETS
+      end
+    end
+
     initializer "cable_ready.sanity_check" do
       SanityChecker.check! unless Rails.env.production?
     end
 
+    initializer "cable_ready.mimetype" do
+      Mime::Type.register "text/vnd.cable-ready.json", :cable_ready
+    end
+
     initializer "cable_ready.renderer" do
       ActiveSupport.on_load(:action_controller) do
         ActionController::Renderers.add :operations do |operations, options|
+          warn "DEPRECATED: CableReady's `render operations:` call has been renamed to `render cable_ready:`. Please update your render call."
+
           response.content_type ||= Mime[:cable_ready]
-          render json: operations.dispatch
+          response.headers["X-Cable-Ready-Version"] = CableReady::VERSION
+
+          render json: operations.respond_to?(:dispatch) ? operations.dispatch : operations
         end
 
-        Mime::Type.register "application/vnd.cable-ready.json", :cable_ready
-      end
-    end
+        ActionController::Renderers.add :cable_ready do |operations, options|
+          response.content_type ||= Mime[:cable_ready]
+          response.headers["X-Cable-Ready-Version"] = CableReady::VERSION
 
-    initializer "cable_ready.assets" do |app|
-      if app.config.respond_to?(:assets) && CableReady.config.precompile_assets
-        app.config.assets.precompile += PRECOMPILE_ASSETS
+          render json: operations.respond_to?(:dispatch) ? operations.dispatch : operations
+        end
       end
     end
 

data/lib/cable_ready/importmap.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 
 pin "morphdom", to: "https://ga.jspm.io/npm:morphdom@2.6.1/dist/morphdom.js", preload: true
-pin "cable_ready", to: "cable_ready.min.js", preload: true
+pin "cable_ready", to: "cable_ready.js", preload: true

data/lib/cable_ready/updatable/memory_cache_debounce_adapter.rb

@@ -0,0 +1,22 @@
+module CableReady
+  module Updatable
+    class MemoryCacheDebounceAdapter
+      include Singleton
+
+      delegate_missing_to :@store
+
+      def initialize
+        super
+        @store = ActiveSupport::Cache::MemoryStore.new(expires_in: 5.minutes, size: 8.megabytes)
+      end
+
+      def []=(key, value)
+        @store.write(key, value)
+      end
+
+      def [](key)
+        @store.read(key)
+      end
+    end
+  end
+end

data/lib/cable_ready/version.rb

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

data/lib/cable_ready.rb

@@ -17,6 +17,8 @@ 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/config/initializers/cable_ready.rb

@@ -19,4 +19,9 @@ CableReady.configure do |config|
   # Change the default Active Job queue used for broadcast_later and broadcast_later_to
   #
   # config.broadcast_job_queue = :default
+
+  # Specify a default debounce time for CableReady::Updatable callbacks
+  # Doing so is a best practice to avoid heavy ActionCable traffic
+  #
+  # config.updatable_debounce_time = 0.1.seconds
 end