hotwire-livereload 1.2.3 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3fafdcbb8509b000d033c3917dbde0fc0277948090d8eb5d6da0469ba8da7eae
-  data.tar.gz: 4680dc48e1158dcc87fca9e6a8694209d6c06a8742121b70f1d8e70514ec4f20
+  metadata.gz: 588323a498a0f2aa7b4ebb53c417b0f937b3d9df5e06af8ec4039e26f35de0c9
+  data.tar.gz: 15c0688010ad47a244cbcf4c1bb543ce199f5ba9f73b822228b9d5aafe71c5b0
 SHA512:
-  metadata.gz: b002ac0a2bb344aedc2b4085b7360004b26557082a90e2d1bbb0dd12978384a89be84319a991949890c9a8fa0a6bf118051674be6e49dd8e8834c7b6ff823a0f
-  data.tar.gz: 442258d2370585623836bf19f9bb88f334fc9bb54c80b5c233969e536cfb99cf1296d95fc5a2cb1413628cf5e7128db938865903385be33d385c6380d510f612
+  metadata.gz: c4389aeae81c93d5f9ec646748e587a084bebf0993173bce97bf3629f81dd1c8763d31635729218b0e2631b5529a16e2d63403c696301f24c9a788d84aa6c5fc
+  data.tar.gz: 429fb41ac85243a1dd9aa0b7f5461b189e10f06f98e5547af125f65996026b4ea44ea1ceceb8c0dbe07ce297091438490d257b51b0e7f9319e0e7e7a80bbf6f2

data/README.md

@@ -12,7 +12,7 @@ https://user-images.githubusercontent.com/839922/148676469-0acfa036-832e-4b40-aa
 
 Add `hotwire-livereload` to your Gemfile:
 ```
-bundle add hotwire-livereload
+bundle add hotwire-livereload --group development
 ```
 
 Run installer:
@@ -30,6 +30,8 @@ Folders listened by default:
 - `app/components`
 - `config/locales`
 
+The gem detects if you use [`jsbundling-rails`](https://github.com/rails/jsbundling-rails) or [`cssbundling-rails`](https://github.com/rails/cssbundling-rails) and watches for changes in their output folder `app/assets/builds` automatically.
+
 ## Configuration
 
 You can watch for changes in additional folders by adding them to `listen_paths`:

data/app/assets/javascripts/hotwire-livereload-turbo-stream.js

@@ -5,28 +5,32 @@
   var __getOwnPropNames = Object.getOwnPropertyNames;
   var __getProtoOf = Object.getPrototypeOf;
   var __hasOwnProp = Object.prototype.hasOwnProperty;
-  var __markAsModule = (target) => __defProp(target, "__esModule", { value: true });
   var __commonJS = (cb, mod) => function __require() {
-    return mod || (0, cb[Object.keys(cb)[0]])((mod = { exports: {} }).exports, mod), mod.exports;
+    return mod || (0, cb[__getOwnPropNames(cb)[0]])((mod = { exports: {} }).exports, mod), mod.exports;
   };
-  var __reExport = (target, module, desc) => {
-    if (module && typeof module === "object" || typeof module === "function") {
-      for (let key of __getOwnPropNames(module))
-        if (!__hasOwnProp.call(target, key) && key !== "default")
-          __defProp(target, key, { get: () => module[key], enumerable: !(desc = __getOwnPropDesc(module, key)) || desc.enumerable });
+  var __copyProps = (to, from, except, desc) => {
+    if (from && typeof from === "object" || typeof from === "function") {
+      for (let key of __getOwnPropNames(from))
+        if (!__hasOwnProp.call(to, key) && key !== except)
+          __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
     }
-    return target;
-  };
-  var __toModule = (module) => {
-    return __reExport(__markAsModule(__defProp(module != null ? __create(__getProtoOf(module)) : {}, "default", module && module.__esModule && "default" in module ? { get: () => module.default, enumerable: true } : { value: module, enumerable: true })), module);
+    return to;
   };
+  var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+    // If the importer is in node compatibility mode or this is not an ESM
+    // file that has been converted to a CommonJS file using a Babel-
+    // compatible transform (i.e. "__esModule" has not been set), then set
+    // "default" to the CommonJS "module.exports" for node compatibility.
+    isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+    mod
+  ));
 
   // node_modules/debounce/index.js
   var require_debounce = __commonJS({
     "node_modules/debounce/index.js"(exports, module) {
       function debounce2(func, wait, immediate) {
         var timeout, args, context, timestamp, result;
-        if (wait == null)
+        if (null == wait)
           wait = 100;
         function later() {
           var last = Date.now() - timestamp;
@@ -76,7 +80,7 @@
   });
 
   // app/javascript/lib/hotwire-livereload-received.js
-  var import_debounce = __toModule(require_debounce());
+  var import_debounce = __toESM(require_debounce());
   var hotwire_livereload_received_default = (0, import_debounce.default)(({ force_reload }) => {
     const onErrorPage = document.title === "Action Controller: Exception caught";
     if (onErrorPage || force_reload) {

data/app/assets/javascripts/hotwire-livereload.js

@@ -5,21 +5,25 @@
   var __getOwnPropNames = Object.getOwnPropertyNames;
   var __getProtoOf = Object.getPrototypeOf;
   var __hasOwnProp = Object.prototype.hasOwnProperty;
-  var __markAsModule = (target) => __defProp(target, "__esModule", { value: true });
   var __commonJS = (cb, mod) => function __require() {
-    return mod || (0, cb[Object.keys(cb)[0]])((mod = { exports: {} }).exports, mod), mod.exports;
+    return mod || (0, cb[__getOwnPropNames(cb)[0]])((mod = { exports: {} }).exports, mod), mod.exports;
   };
-  var __reExport = (target, module, desc) => {
-    if (module && typeof module === "object" || typeof module === "function") {
-      for (let key of __getOwnPropNames(module))
-        if (!__hasOwnProp.call(target, key) && key !== "default")
-          __defProp(target, key, { get: () => module[key], enumerable: !(desc = __getOwnPropDesc(module, key)) || desc.enumerable });
+  var __copyProps = (to, from, except, desc) => {
+    if (from && typeof from === "object" || typeof from === "function") {
+      for (let key of __getOwnPropNames(from))
+        if (!__hasOwnProp.call(to, key) && key !== except)
+          __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
     }
-    return target;
-  };
-  var __toModule = (module) => {
-    return __reExport(__markAsModule(__defProp(module != null ? __create(__getProtoOf(module)) : {}, "default", module && module.__esModule && "default" in module ? { get: () => module.default, enumerable: true } : { value: module, enumerable: true })), module);
+    return to;
   };
+  var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+    // If the importer is in node compatibility mode or this is not an ESM
+    // file that has been converted to a CommonJS file using a Babel-
+    // compatible transform (i.e. "__esModule" has not been set), then set
+    // "default" to the CommonJS "module.exports" for node compatibility.
+    isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+    mod
+  ));
 
   // node_modules/@rails/actioncable/app/assets/javascripts/action_cable.js
   var require_action_cable = __commonJS({
@@ -74,7 +78,7 @@
           };
         }();
         var now = function now2() {
-          return new Date().getTime();
+          return (/* @__PURE__ */ new Date()).getTime();
         };
         var secondsSince = function secondsSince2(time) {
           return (now() - time) / 1e3;
@@ -318,6 +322,7 @@
               case message_types.ping:
                 return this.monitor.recordPing();
               case message_types.confirmation:
+                this.subscriptions.confirmSubscription(identifier);
                 return this.subscriptions.notify(identifier, "connected");
               case message_types.rejection:
                 return this.subscriptions.reject(identifier);
@@ -385,10 +390,52 @@
           };
           return Subscription2;
         }();
+        var SubscriptionGuarantor = function() {
+          function SubscriptionGuarantor2(subscriptions) {
+            classCallCheck(this, SubscriptionGuarantor2);
+            this.subscriptions = subscriptions;
+            this.pendingSubscriptions = [];
+          }
+          SubscriptionGuarantor2.prototype.guarantee = function guarantee(subscription) {
+            if (this.pendingSubscriptions.indexOf(subscription) == -1) {
+              logger.log("SubscriptionGuarantor guaranteeing " + subscription.identifier);
+              this.pendingSubscriptions.push(subscription);
+            } else {
+              logger.log("SubscriptionGuarantor already guaranteeing " + subscription.identifier);
+            }
+            this.startGuaranteeing();
+          };
+          SubscriptionGuarantor2.prototype.forget = function forget(subscription) {
+            logger.log("SubscriptionGuarantor forgetting " + subscription.identifier);
+            this.pendingSubscriptions = this.pendingSubscriptions.filter(function(s) {
+              return s !== subscription;
+            });
+          };
+          SubscriptionGuarantor2.prototype.startGuaranteeing = function startGuaranteeing() {
+            this.stopGuaranteeing();
+            this.retrySubscribing();
+          };
+          SubscriptionGuarantor2.prototype.stopGuaranteeing = function stopGuaranteeing() {
+            clearTimeout(this.retryTimeout);
+          };
+          SubscriptionGuarantor2.prototype.retrySubscribing = function retrySubscribing() {
+            var _this = this;
+            this.retryTimeout = setTimeout(function() {
+              if (_this.subscriptions && typeof _this.subscriptions.subscribe === "function") {
+                _this.pendingSubscriptions.map(function(subscription) {
+                  logger.log("SubscriptionGuarantor resubscribing " + subscription.identifier);
+                  _this.subscriptions.subscribe(subscription);
+                });
+              }
+            }, 500);
+          };
+          return SubscriptionGuarantor2;
+        }();
         var Subscriptions = function() {
           function Subscriptions2(consumer2) {
             classCallCheck(this, Subscriptions2);
             this.consumer = consumer2;
+            this.guarantor = new SubscriptionGuarantor(this);
             this.subscriptions = [];
           }
           Subscriptions2.prototype.create = function create(channelName, mixin) {
@@ -403,7 +450,7 @@
             this.subscriptions.push(subscription);
             this.consumer.ensureActiveConnection();
             this.notify(subscription, "initialized");
-            this.sendCommand(subscription, "subscribe");
+            this.subscribe(subscription);
             return subscription;
           };
           Subscriptions2.prototype.remove = function remove(subscription) {
@@ -422,6 +469,7 @@
             });
           };
           Subscriptions2.prototype.forget = function forget(subscription) {
+            this.guarantor.forget(subscription);
             this.subscriptions = this.subscriptions.filter(function(s) {
               return s !== subscription;
             });
@@ -435,7 +483,7 @@
           Subscriptions2.prototype.reload = function reload() {
             var _this2 = this;
             return this.subscriptions.map(function(subscription) {
-              return _this2.sendCommand(subscription, "subscribe");
+              return _this2.subscribe(subscription);
             });
           };
           Subscriptions2.prototype.notifyAll = function notifyAll(callbackName) {
@@ -461,6 +509,18 @@
               return typeof subscription2[callbackName] === "function" ? subscription2[callbackName].apply(subscription2, args) : void 0;
             });
           };
+          Subscriptions2.prototype.subscribe = function subscribe(subscription) {
+            if (this.sendCommand(subscription, "subscribe")) {
+              this.guarantor.guarantee(subscription);
+            }
+          };
+          Subscriptions2.prototype.confirmSubscription = function confirmSubscription(identifier) {
+            var _this4 = this;
+            logger.log("Subscription confirmed " + identifier);
+            this.findAll(identifier).map(function(subscription) {
+              return _this4.guarantor.forget(subscription);
+            });
+          };
           Subscriptions2.prototype.sendCommand = function sendCommand(subscription, command) {
             var identifier = subscription.identifier;
             return this.consumer.send({
@@ -531,6 +591,7 @@
         exports2.INTERNAL = INTERNAL;
         exports2.Subscription = Subscription;
         exports2.Subscriptions = Subscriptions;
+        exports2.SubscriptionGuarantor = SubscriptionGuarantor;
         exports2.adapters = adapters;
         exports2.createWebSocketURL = createWebSocketURL;
         exports2.logger = logger;
@@ -546,9 +607,9 @@
   // node_modules/debounce/index.js
   var require_debounce = __commonJS({
     "node_modules/debounce/index.js"(exports, module) {
-      function debounce2(func, wait, immediate) {
+      function debounce3(func, wait, immediate) {
         var timeout, args, context, timestamp, result;
-        if (wait == null)
+        if (null == wait)
           wait = 100;
         function later() {
           var last = Date.now() - timestamp;
@@ -592,16 +653,16 @@
         };
         return debounced;
       }
-      debounce2.debounce = debounce2;
-      module.exports = debounce2;
+      debounce3.debounce = debounce3;
+      module.exports = debounce3;
     }
   });
 
   // app/javascript/hotwire-livereload.js
-  var import_actioncable = __toModule(require_action_cable());
+  var import_actioncable = __toESM(require_action_cable());
 
   // app/javascript/lib/hotwire-livereload-received.js
-  var import_debounce = __toModule(require_debounce());
+  var import_debounce = __toESM(require_debounce());
   var hotwire_livereload_received_default = (0, import_debounce.default)(({ force_reload }) => {
     const onErrorPage = document.title === "Action Controller: Exception caught";
     if (onErrorPage || force_reload) {
@@ -613,7 +674,30 @@
     }
   }, 300);
 
+  // app/javascript/lib/hotwire-livereload-scroll-position.js
+  var KEY = "hotwire-livereload-scrollPosition";
+  function read() {
+    const value = localStorage.getItem(KEY);
+    if (!value)
+      return 0;
+    return parseInt(value);
+  }
+  function save() {
+    const pos = window.scrollY;
+    localStorage.setItem(KEY, pos.toString());
+  }
+  function reset() {
+    localStorage.setItem(KEY, "0");
+  }
+  function restore() {
+    const value = read();
+    console.log("[Hotwire::Livereload] Restoring scroll position to", value);
+    window.scrollTo(0, value);
+  }
+  var hotwire_livereload_scroll_position_default = { read, save, restore, reset };
+
   // app/javascript/hotwire-livereload.js
+  var import_debounce2 = __toESM(require_debounce());
   var consumer = (0, import_actioncable.createConsumer)();
   consumer.subscriptions.create("Hotwire::Livereload::ReloadChannel", {
     received: hotwire_livereload_received_default,
@@ -624,4 +708,19 @@
       console.log("[Hotwire::Livereload] Websocket disconnected");
     }
   });
+  var debouncedScroll = (0, import_debounce2.default)(() => {
+    if (window.scrollY !== 0)
+      return hotwire_livereload_scroll_position_default.save();
+    setTimeout(() => {
+      if (window.scrollY !== 0)
+        return;
+      hotwire_livereload_scroll_position_default.save();
+    }, 1e3);
+  }, 100);
+  window.addEventListener("scroll", debouncedScroll);
+  document.addEventListener("turbo:click", hotwire_livereload_scroll_position_default.reset);
+  document.addEventListener("turbo:before-visit", hotwire_livereload_scroll_position_default.restore);
+  document.addEventListener("turbo:load", hotwire_livereload_scroll_position_default.restore);
+  document.addEventListener("DOMContentLoaded", hotwire_livereload_scroll_position_default.restore);
+  document.addEventListener("turbo:frame-load", hotwire_livereload_scroll_position_default.restore);
 })();

data/app/helpers/hotwire/livereload/livereload_tags_helper.rb

@@ -1,9 +1,9 @@
 module Hotwire::Livereload::LivereloadTagsHelper
   def hotwire_livereload_tags
     partial = if Hotwire::Livereload::Engine.config.hotwire_livereload.reload_method == :turbo_stream
-      'hotwire/livereload/head_turbo_stream'
+      "hotwire/livereload/head_turbo_stream"
     else
-      'hotwire/livereload/head_action_cable'
+      "hotwire/livereload/head_action_cable"
     end
 
     render partial

data/app/javascript/hotwire-livereload.js

@@ -1,5 +1,7 @@
 import { createConsumer } from "@rails/actioncable"
 import received from "./lib/hotwire-livereload-received"
+import scrollPosition from "./lib/hotwire-livereload-scroll-position"
+import debounce from "debounce"
 
 const consumer = createConsumer()
 consumer.subscriptions.create("Hotwire::Livereload::ReloadChannel", {
@@ -13,3 +15,22 @@ consumer.subscriptions.create("Hotwire::Livereload::ReloadChannel", {
     console.log("[Hotwire::Livereload] Websocket disconnected")
   },
 })
+
+const debouncedScroll = debounce(() => {
+  if (window.scrollY !== 0) return scrollPosition.save();
+
+  // On a second update, the page mysteriously jumps to the top and sends a scroll event.
+  // So we wait a bit and if the page is still is at the top, it was likely on purpose.
+  setTimeout(() => {
+    if (window.scrollY !== 0) return;
+    scrollPosition.save();
+  }, 1000);
+}, 100)
+window.addEventListener("scroll", debouncedScroll)
+
+document.addEventListener("turbo:click", scrollPosition.reset)
+document.addEventListener("turbo:before-visit", scrollPosition.restore)
+document.addEventListener("turbo:load", scrollPosition.restore)
+document.addEventListener("DOMContentLoaded", scrollPosition.restore)
+document.addEventListener("turbo:frame-load", scrollPosition.restore)
+

data/app/javascript/lib/hotwire-livereload-scroll-position.js

@@ -0,0 +1,24 @@
+const KEY = "hotwire-livereload-scrollPosition"
+
+export function read() {
+  const value = localStorage.getItem(KEY)
+  if (!value) return 0;
+  return parseInt(value)
+}
+
+export function save() {
+  const pos = window.scrollY
+  localStorage.setItem(KEY, pos.toString())
+}
+
+export function reset() {
+  localStorage.setItem(KEY, "0");
+}
+
+export function restore() {
+  const value = read()
+  console.log("[Hotwire::Livereload] Restoring scroll position to", value)
+  window.scrollTo(0, value)
+}
+
+export default { read, save, restore, reset }

data/app/views/hotwire/livereload/_head_action_cable.html.erb

@@ -1,3 +1,3 @@
 <% if Rails.env.development? %>
-  <%= javascript_include_tag('hotwire-livereload', defer: true) %>
+  <%= javascript_include_tag('hotwire-livereload', defer: true, nonce: true) %>
 <% end %>

data/app/views/hotwire/livereload/_head_turbo_stream.html.erb

@@ -1,4 +1,4 @@
 <% if Rails.env.development? %>
   <%= turbo_stream_from('hotwire-livereload') %>
-  <%= javascript_include_tag('hotwire-livereload-turbo-stream', defer: true) %>
+  <%= javascript_include_tag('hotwire-livereload-turbo-stream', defer: true, nonce: true) %>
 <% end %>

data/lib/hotwire/livereload/engine.rb

@@ -11,14 +11,14 @@ module Hotwire
       config.hotwire_livereload.force_reload_paths ||= []
       config.hotwire_livereload.reload_method = :action_cable
       config.hotwire_livereload.disable_default_listeners = false
-      config.autoload_once_paths = %W(
+      config.autoload_once_paths = %W[
         #{root}/app/channels
         #{root}/app/helpers
-      )
+      ]
 
       initializer "hotwire_livereload.assets" do
         if Rails.application.config.respond_to?(:assets)
-          Rails.application.config.assets.precompile += %w( hotwire-livereload.js hotwire-livereload-turbo-stream.js)
+          Rails.application.config.assets.precompile += %w[hotwire-livereload.js hotwire-livereload-turbo-stream.js]
         end
       end
 
@@ -41,8 +41,19 @@ module Hotwire
             app/assets/images
             app/components
             config/locales
-          ].map { |p| Rails.root.join(p) }
-          options.listen_paths += default_listen_paths.select { |p| Dir.exist?(p) }
+          ]
+          if defined?(Jsbundling)
+            default_listen_paths -= %w[app/javascript]
+            default_listen_paths += %w[app/assets/builds]
+          end
+          if defined?(Cssbundling)
+            default_listen_paths -= %w[app/assets/stylesheets]
+            default_listen_paths += %w[app/assets/builds]
+          end
+          options.listen_paths += default_listen_paths
+            .uniq
+            .map { |p| Rails.root.join(p) }
+            .select { |p| Dir.exist?(p) }
         end
       end
 
@@ -55,7 +66,7 @@ module Hotwire
           @listener = Listen.to(*listen_paths) do |modified, added, removed|
             unless File.exist?(DISABLE_FILE)
               changed = [modified, removed, added].flatten.uniq
-              return unless changed.any?
+              next unless changed.any?
 
               force_reload = force_reload_paths.present? && changed.any? do |path|
                 path.match(%r{#{force_reload_paths}})

data/lib/hotwire/livereload/version.rb

@@ -1,5 +1,5 @@
 module Hotwire
   module Livereload
-    VERSION = "1.2.3"
+    VERSION = "1.3.0"
   end
 end

data/lib/install/install.rb

@@ -3,9 +3,9 @@ CABLE_CONFIG_PATH = Rails.root.join("config/cable.yml")
 
 if APP_LAYOUT_PATH.exist?
   say "Add Hotwire Livereload tag in application layout"
-  content = <<-HTML
-\n    <%= hotwire_livereload_tags if Rails.env.development? %>
-HTML
+  content = <<~HTML
+    \n    <%= hotwire_livereload_tags if Rails.env.development? %>
+  HTML
   insert_into_file APP_LAYOUT_PATH, content.chop, before: /\s*<\/head>/
 else
   say "Default application.html.erb is missing!", :red

data/lib/tasks/livereload_tasks.rake

@@ -1,7 +1,7 @@
 namespace :livereload do
   desc "Install Hotwire::Livereload into the app"
   task :install do
-    system "#{RbConfig.ruby} ./bin/rails app:template LOCATION=#{File.expand_path("../install/install.rb",  __dir__)}"
+    system "#{RbConfig.ruby} ./bin/rails app:template LOCATION=#{File.expand_path("../install/install.rb", __dir__)}"
   end
 
   desc "Disable Hotwire::Livereload"

metadata

@@ -1,17 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: hotwire-livereload
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.3.0
 platform: ruby
 authors:
 - Kirill Platonov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-26 00:00:00.000000000 Z
+date: 2023-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: actioncable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -54,6 +68,7 @@ files:
 - app/javascript/hotwire-livereload-turbo-stream.js
 - app/javascript/hotwire-livereload.js
 - app/javascript/lib/hotwire-livereload-received.js
+- app/javascript/lib/hotwire-livereload-scroll-position.js
 - app/views/hotwire/livereload/_head_action_cable.html.erb
 - app/views/hotwire/livereload/_head_turbo_stream.html.erb
 - app/views/hotwire/livereload/_turbo_stream.html.erb
@@ -81,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.20
 signing_key:
 specification_version: 4
 summary: Automatically reload Hotwire Turbo when app files are modified.