hotwire-livereload 1.3.0 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 588323a498a0f2aa7b4ebb53c417b0f937b3d9df5e06af8ec4039e26f35de0c9
-  data.tar.gz: 15c0688010ad47a244cbcf4c1bb543ce199f5ba9f73b822228b9d5aafe71c5b0
+  metadata.gz: 44376128ac37b1619d34c7ee8dee64eb1901804cc170dd0bd5c2114973e98225
+  data.tar.gz: 9053700099d671c33b11fa0483100ec5f921016a7e2f1315113072c5c1bba587
 SHA512:
-  metadata.gz: c4389aeae81c93d5f9ec646748e587a084bebf0993173bce97bf3629f81dd1c8763d31635729218b0e2631b5529a16e2d63403c696301f24c9a788d84aa6c5fc
-  data.tar.gz: 429fb41ac85243a1dd9aa0b7f5461b189e10f06f98e5547af125f65996026b4ea44ea1ceceb8c0dbe07ce297091438490d257b51b0e7f9319e0e7e7a80bbf6f2
+  metadata.gz: 5677a61e971bfa24bb8c8ea76970420e370e03003f07970632bf07b22c187cc6dfc3289963509c8597f7b12c08e112d8db56f308fa85008023c3160a9f700846
+  data.tar.gz: 4e91a4a01f3e5b8d54e18b2344351c17bef3e1ac09568adc3b1802dc6a8f95eaa4abc6c972e93c8edd7eafa61a944e2b390e339697b1bc802cc7a8e85176b6ff

data/README.md

@@ -34,6 +34,8 @@ The gem detects if you use [`jsbundling-rails`](https://github.com/rails/jsbundl
 
 ## Configuration
 
+### Listen paths
+
 You can watch for changes in additional folders by adding them to `listen_paths`:
 ```ruby
 # config/environments/development.rb
@@ -58,6 +60,8 @@ Rails.application.configure do
 end
 ```
 
+### Force reload
+
 If you don't have `data-turbo-track="reload"` attribute on your JS and CSS bundles you might need to setup force reloading. This will trigger full browser reloading for JS and CSS files only:
 ```ruby
 # config/environments/development.rb
@@ -69,6 +73,8 @@ Rails.application.configure do
 end
 ```
 
+### Reload method
+
 Instead of a direct ActionCable websocket connection, you can reuse the existing TurboStream websocket connection and send updates using standard turbo-streams:
 ```ruby
 # config/environments/development.rb
@@ -90,6 +96,22 @@ In that case you need to place `hotwire_livereload_tags` helper in your layout *
 </head>
 ```
 
+### Listen options
+
+[Listen gem](https://github.com/guard/listen), which is used for file system monitoring, accepts [options](https://github.com/guard/listen?tab=readme-ov-file#options) like enabling a fallback mechanism called "polling" to detect file changes.
+
+By default, Listen uses a more efficient mechanism called "native" which relies on the operating system's file system events to detect changes. However, in some cases, such as when working with network-mounted file systems or in certain virtualized environments, the native mechanism may not work reliably. In such cases, enabling force_polling ensures that file changes are still detected, albeit with a slightly higher resource usage.
+
+You may use listen_options to pass these options like:
+```ruby
+# config/environments/development.rb
+
+Rails.application.configure do
+  # ...
+  config.hotwire_livereload.listen_options[:force_polling] = true
+end
+```
+
 ## Disable livereload
 
 To temporarily disable livereload use:

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

@@ -81,6 +81,32 @@
 
   // app/javascript/lib/hotwire-livereload-received.js
   var import_debounce = __toESM(require_debounce());
+
+  // app/javascript/lib/hotwire-livereload-scroll-position.js
+  var KEY = "hotwire-livereload-scrollPosition";
+  function read() {
+    const value = localStorage.getItem(KEY);
+    if (!value)
+      return;
+    return parseInt(value);
+  }
+  function save() {
+    const pos = window.scrollY;
+    localStorage.setItem(KEY, pos.toString());
+  }
+  function remove() {
+    localStorage.removeItem(KEY);
+  }
+  function restore() {
+    const value = read();
+    if (value) {
+      console.log("[Hotwire::Livereload] Restoring scroll position to", value);
+      window.scrollTo(0, value);
+    }
+  }
+  var hotwire_livereload_scroll_position_default = { read, save, restore, remove };
+
+  // app/javascript/lib/hotwire-livereload-received.js
   var hotwire_livereload_received_default = (0, import_debounce.default)(({ force_reload }) => {
     const onErrorPage = document.title === "Action Controller: Exception caught";
     if (onErrorPage || force_reload) {
@@ -88,6 +114,8 @@
       document.location.reload();
     } else {
       console.log("[Hotwire::Livereload] Files changed. Reloading..");
+      hotwire_livereload_scroll_position_default.save();
+      Turbo.cache.clear();
       Turbo.visit(window.location.href, { action: "replace" });
     }
   }, 300);

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

@@ -453,7 +453,7 @@
             this.subscribe(subscription);
             return subscription;
           };
-          Subscriptions2.prototype.remove = function remove(subscription) {
+          Subscriptions2.prototype.remove = function remove2(subscription) {
             this.forget(subscription);
             if (!this.findAll(subscription.identifier).length) {
               this.sendCommand(subscription, "unsubscribe");
@@ -607,7 +607,7 @@
   // node_modules/debounce/index.js
   var require_debounce = __commonJS({
     "node_modules/debounce/index.js"(exports, module) {
-      function debounce3(func, wait, immediate) {
+      function debounce2(func, wait, immediate) {
         var timeout, args, context, timestamp, result;
         if (null == wait)
           wait = 100;
@@ -653,8 +653,8 @@
         };
         return debounced;
       }
-      debounce3.debounce = debounce3;
-      module.exports = debounce3;
+      debounce2.debounce = debounce2;
+      module.exports = debounce2;
     }
   });
 
@@ -663,41 +663,46 @@
 
   // app/javascript/lib/hotwire-livereload-received.js
   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) {
-      console.log("[Hotwire::Livereload] Files changed. Force reloading..");
-      document.location.reload();
-    } else {
-      console.log("[Hotwire::Livereload] Files changed. Reloading..");
-      Turbo.visit(window.location.href, { action: "replace" });
-    }
-  }, 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;
     return parseInt(value);
   }
   function save() {
     const pos = window.scrollY;
     localStorage.setItem(KEY, pos.toString());
   }
-  function reset() {
-    localStorage.setItem(KEY, "0");
+  function remove() {
+    localStorage.removeItem(KEY);
   }
   function restore() {
     const value = read();
-    console.log("[Hotwire::Livereload] Restoring scroll position to", value);
-    window.scrollTo(0, value);
+    if (value) {
+      console.log("[Hotwire::Livereload] Restoring scroll position to", value);
+      window.scrollTo(0, value);
+    }
   }
-  var hotwire_livereload_scroll_position_default = { read, save, restore, reset };
+  var hotwire_livereload_scroll_position_default = { read, save, restore, remove };
+
+  // app/javascript/lib/hotwire-livereload-received.js
+  var hotwire_livereload_received_default = (0, import_debounce.default)(({ force_reload }) => {
+    const onErrorPage = document.title === "Action Controller: Exception caught";
+    if (onErrorPage || force_reload) {
+      console.log("[Hotwire::Livereload] Files changed. Force reloading..");
+      document.location.reload();
+    } else {
+      console.log("[Hotwire::Livereload] Files changed. Reloading..");
+      hotwire_livereload_scroll_position_default.save();
+      Turbo.cache.clear();
+      Turbo.visit(window.location.href, { action: "replace" });
+    }
+  }, 300);
 
   // 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,
@@ -708,19 +713,8 @@
       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);
+  document.addEventListener("turbo:load", () => {
+    hotwire_livereload_scroll_position_default.restore();
+    hotwire_livereload_scroll_position_default.remove();
+  });
 })();

data/app/javascript/hotwire-livereload.js

@@ -1,7 +1,6 @@
 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", {
@@ -16,21 +15,8 @@ consumer.subscriptions.create("Hotwire::Livereload::ReloadChannel", {
   },
 })
 
-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)
+document.addEventListener("turbo:load", () => {
+  scrollPosition.restore()
+  scrollPosition.remove()
+})
 

data/app/javascript/lib/hotwire-livereload-received.js

@@ -1,4 +1,5 @@
 import debounce from "debounce"
+import scrollPosition from "./hotwire-livereload-scroll-position"
 
 export default debounce(({force_reload}) => {
   const onErrorPage = document.title === "Action Controller: Exception caught"
@@ -8,6 +9,8 @@ export default debounce(({force_reload}) => {
     document.location.reload()
   } else {
     console.log("[Hotwire::Livereload] Files changed. Reloading..")
+    scrollPosition.save()
+    Turbo.cache.clear()
     Turbo.visit(window.location.href, { action: 'replace' })
   }
 }, 300)

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

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

data/lib/hotwire/livereload/engine.rb

@@ -15,6 +15,7 @@ module Hotwire
         #{root}/app/channels
         #{root}/app/helpers
       ]
+      config.hotwire_livereload.listen_options ||= {}
 
       initializer "hotwire_livereload.assets" do
         if Rails.application.config.respond_to?(:assets)
@@ -63,7 +64,7 @@ module Hotwire
           listen_paths = options.listen_paths.map(&:to_s).uniq
           force_reload_paths = options.force_reload_paths.map(&:to_s).uniq.join("|")
 
-          @listener = Listen.to(*listen_paths) do |modified, added, removed|
+          @listener = Listen.to(*listen_paths, **config.hotwire_livereload.listen_options) do |modified, added, removed|
             unless File.exist?(DISABLE_FILE)
               changed = [modified, removed, added].flatten.uniq
               next unless changed.any?

data/lib/hotwire/livereload/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hotwire-livereload
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.2
 platform: ruby
 authors:
 - Kirill Platonov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-11 00:00:00.000000000 Z
+date: 2024-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties