hotwire-livereload 0.1.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5bcabf2d518f67b06afa47b3b462f6d190b35ee3cfe2690148b599a0c28ba94e
-  data.tar.gz: 87d3401bddb1a879fb40b73aaef596ff0f17ba019e421411e9a0a3ce4b6562a2
+  metadata.gz: a4397b862ba6f621e8442f674fbf5ffa478422e8d01b293f299afbd8213154ac
+  data.tar.gz: e9e4a35a16d3f09c9f88467e2e0267ee98220d6be0ddda7bd28fc9b3cb8bff95
 SHA512:
-  metadata.gz: a517e60ba65450c6346e6c574ff047f12a8dd09c1b8ebaed16cb393ddaba254490869c829f022c7cc929b6d00c4c32bf0f86c3d2b0e986ac608fcad471107995
-  data.tar.gz: 544f51ca80f96bd73d30ee582acaecf1e734e44d4132d5a1a415bb11b1f87dbc969e0885663c961554e3635a2c72080e03a6952b6abdf4f6f4e435e075f472e5
+  metadata.gz: 71e11b2197803862c7afb86717f6ccc753ddd60923e7f330b715af28f2263fe49e8baa839bf6d7110ff5bf6dfddeba49c84c7182ea5edc54400c9597e7cbd0ec
+  data.tar.gz: a847e23ec3f9eb51ba0f7a7cc3d9ee112980b5eae0ae250e5d82505c19cebd97f6849c01a058d227946d9c075c043cca5909120aa09cc3f95fafa4e121233fe9

data/README.md

@@ -8,9 +8,61 @@ https://user-images.githubusercontent.com/839922/131983979-afd0bcc7-86e8-4c53-97
 
 The JavaScript for Hotwire::Livereload is installed via asset pipeline, which is included with this gem.
 
-1. Add `hotwire-livereload` gem to your Gemfile: `gem 'hotwire-livereload'`
-2. Run `./bin/bundle install`
-3. Run `./bin/rails hotwire_livereload:install`
+Add `hotwire-livereload` to your Gemfile:
+```
+bundle add hotwire-livereload --group development
+```
+
+Run installer:
+```
+rails livereload:install
+```
+
+## Configuration
+
+You can watch for changes in additional folders by adding them to `listen_paths`. For example, you can watch for CSS changes:
+```ruby
+# config/environments/development.rb
+
+Rails.application.configure do
+  # ...
+  config.hotwire_livereload.listen_paths << Rails.root.join("app/custom_folder")
+end
+```
+
+Folders listened by default:
+- `app/views`
+- `app/helpers`
+- `app/javascript`
+- `app/assets/stylesheets`
+- `app/assets/javascripts`
+- `app/assets/images`
+- `app/components`
+- `config/locales`
+
+You can setup force reloading (full page reload) for changes in some folders using `force_reload_paths` option. For example, you can trigger force reload on JS changes:
+```ruby
+# config/environments/development.rb
+
+Rails.application.configure do
+  # ...
+  config.hotwire_livereload.force_reload_paths << Rails.root.join("app/javascript")
+end
+```
+
+## Disable livereload
+
+To temporarily disable livereload use:
+```bash
+bin/rails livereload:disable
+```
+
+To re-enable:
+```bash
+bin/rails livereload:enable
+```
+
+No server restart is required. Disabling is managed by `tmp/livereload-disabled.txt` file.
 
 ## Development
 

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

@@ -600,20 +600,24 @@
   // app/javascript/hotwire-livereload.js
   var import_actioncable = __toModule(require_action_cable());
   var import_debounce = __toModule(require_debounce());
-  var endpoint = "/hotwire-livereload/cable";
-  var uid = (Date.now() + (Math.random() * 100 | 0)).toString();
-  var consumer = (0, import_actioncable.createConsumer)(`${endpoint}?uid=${uid}`);
-  var received = (0, import_debounce.default)(() => {
-    console.log("Hotwire::Livereload files changed");
-    Turbo.visit(window.location.href);
+  var consumer = (0, import_actioncable.createConsumer)();
+  var received = (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);
+    }
   }, 300);
   consumer.subscriptions.create("Hotwire::Livereload::ReloadChannel", {
     received,
     connected() {
-      console.log("Hotwire::Livereload websocket connected");
+      console.log("[Hotwire::Livereload] Websocket connected");
     },
     disconnected() {
-      console.log("Hotwire::Livereload websocket disconnected");
+      console.log("[Hotwire::Livereload] Websocket disconnected");
     }
   });
 })();

data/app/channels/hotwire/livereload/reload_channel.rb

@@ -1,5 +1,5 @@
 class Hotwire::Livereload::ReloadChannel < ActionCable::Channel::Base
   def subscribed
-    stream_from "reload"
+    stream_from "hotwire-reload"
   end
 end

data/app/javascript/hotwire-livereload.js

@@ -1,20 +1,27 @@
 import { createConsumer } from "@rails/actioncable"
 import debounce from "debounce"
 
-const endpoint = "/hotwire-livereload/cable"
-const uid = (Date.now() + ((Math.random() * 100) | 0)).toString()
-const consumer = createConsumer(`${endpoint}?uid=${uid}`)
-const received = debounce(() => {
-  console.log("Hotwire::Livereload files changed")
-  Turbo.visit(window.location.href)
+const consumer = createConsumer()
+const received = debounce(({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)
+  }
 }, 300)
 
 consumer.subscriptions.create("Hotwire::Livereload::ReloadChannel", {
   received,
+
   connected() {
-    console.log("Hotwire::Livereload websocket connected")
+    console.log("[Hotwire::Livereload] Websocket connected")
   },
+
   disconnected() {
-    console.log("Hotwire::Livereload websocket disconnected")
+    console.log("[Hotwire::Livereload] Websocket disconnected")
   },
 })

data/lib/hotwire/livereload/engine.rb

@@ -8,6 +8,7 @@ module Hotwire
       isolate_namespace Hotwire::Livereload
       config.hotwire_livereload = ActiveSupport::OrderedOptions.new
       config.hotwire_livereload.listen_paths ||= []
+      config.hotwire_livereload.force_reload_paths ||= []
       config.autoload_once_paths = %W(
         #{root}/app/channels
         #{root}/app/helpers
@@ -26,31 +27,40 @@ module Hotwire
       end
 
       initializer "hotwire_livereload.set_configs" do |app|
+        default_listen_paths = %w[
+          app/views
+          app/helpers
+          app/javascript
+          app/assets/stylesheets
+          app/assets/javascripts
+          app/assets/images
+          app/components
+          config/locales
+        ].map { |p| Rails.root.join(p) }
+
         options = app.config.hotwire_livereload
-        options.listen_paths = options.listen_paths.map(&:to_s)
-        options.listen_paths << Rails.root.join("app", "views")
+        options.listen_paths += default_listen_paths.select { |p| Dir.exist?(p) }
       end
 
-      initializer "hotwire_livereload.cable.config" do |app|
-        config_path = Hotwire::Livereload::Engine.root.join("config", "livereload_cable.yml")
-        cable = Hotwire::Livereload::Engine.cable
+      config.after_initialize do |app|
+        if Rails.env.development? && defined?(Rails::Server)
+          options = app.config.hotwire_livereload
+          listen_paths = options.listen_paths.map(&:to_s).uniq
+          force_reload_paths = options.force_reload_paths.map(&:to_s).uniq.join("|")
 
-        if Rails.env.development?
-          cable.cable = app.config_for(config_path).with_indifferent_access
-          cable.mount_path = "/cable"
-          cable.connection_class = -> { Hotwire::Livereload::Connection }
-          cable.logger ||= Rails.logger
-        end
-      end
+          @listener = Listen.to(*listen_paths) do |modified, added, removed|
+            unless File.exists?(DISABLE_FILE)
+              changed = [modified, removed, added].flatten.uniq
+              return unless changed.any?
 
-      config.after_initialize do |app|
-        if Rails.env.development?
-          @listener = Listen.to(*app.config.hotwire_livereload.listen_paths) do |modified, added, removed|
-            if modified.any? || removed.any? || added.any?
-              Hotwire::Livereload::Engine.websocket.broadcast(
-                "reload",
-                { modified: modified, removed: removed, added: added }
-              )
+              force_reload = force_reload_paths.present? && changed.any? do |path|
+                path.match(%r{#{force_reload_paths}})
+              end
+
+              ActionCable.server.broadcast("hotwire-reload", {
+                changed: changed,
+                force_reload: force_reload
+              })
             end
           end
           @listener.start
@@ -62,16 +72,6 @@ module Hotwire
           @listener&.stop
         end
       end
-
-      class << self
-        def websocket
-          @websocket ||= ActionCable::Server::Base.new(config: Hotwire::Livereload::Engine.cable)
-        end
-
-        def cable
-          @cable ||= ActionCable::Server::Configuration.new
-        end
-      end
     end
   end
 end

data/lib/hotwire/livereload/version.rb

@@ -1,5 +1,5 @@
 module Hotwire
   module Livereload
-    VERSION = "0.1.2"
+    VERSION = "0.3.0"
   end
 end

data/lib/hotwire/livereload.rb

@@ -2,5 +2,6 @@ require "hotwire/livereload/engine"
 
 module Hotwire
   module Livereload
+    DISABLE_FILE = "tmp/livereload-disabled.txt"
   end
 end

data/lib/install/install.rb

@@ -1,12 +1,31 @@
-route("mount Hotwire::Livereload::Engine, at: '/hotwire-livereload'")
+APP_LAYOUT_PATH = Rails.root.join("app/views/layouts/application.html.erb")
+CABLE_CONFIG_PATH = Rails.root.join("config/cable.yml")
 
-if (app_layout_path = Rails.root.join("app/views/layouts/application.html.erb")).exist?
-  say "Add Hotwire::Livereload tag in application layout"
-  insert_into_file app_layout_path.to_s, before: /\s*<\/head>/ do <<-HTML
-\n    <%= hotwire_livereload_tags %>
+if APP_LAYOUT_PATH.exist?
+  say "Add Hotwire Livereload tag in application layout"
+  content = <<-HTML
+\n    <% if Rails.env.development? %>
+      <%= javascript_include_tag "hotwire-livereload", defer: true %>
+    <% end %>
 HTML
-  end
+  insert_into_file APP_LAYOUT_PATH, content.chop, before: /\s*<\/head>/
 else
   say "Default application.html.erb is missing!", :red
-  say %(        Add <%= hotwire_livereload_tags %> within the <head> tag in your custom layout.)
+  say %(  Add <%= hotwire_livereload_tags %> within the <head> tag in your custom layout.)
+end
+
+if CABLE_CONFIG_PATH.exist?
+  gemfile = File.read(Rails.root.join("Gemfile"))
+  if gemfile.include?("redis")
+    say "Uncomment redis in Gemfile"
+    uncomment_lines "Gemfile", %(gem "redis")
+  else
+    say "Add redis to Gemfile"
+    gem "redis"
+  end
+
+  say "Switch development cable to use redis"
+  gsub_file CABLE_CONFIG_PATH.to_s, /development:\n\s+adapter: async/, "development:\n  adapter: redis\n  url: redis://localhost:6379/1"
+else
+  say 'ActionCable config file (config/cable.yml) is missing. Uncomment "gem \'redis\'" in your Gemfile and create config/cable.yml to use Hotwire Livereload.'
 end

data/lib/tasks/livereload_tasks.rake

@@ -0,0 +1,21 @@
+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__)}"
+  end
+
+  desc "Disable Hotwire::Livereload"
+  task :disable do
+    FileUtils.mkdir_p("tmp")
+    FileUtils.touch Hotwire::Livereload::DISABLE_FILE
+    puts "Livereload disabled."
+  end
+
+  desc "Enable Hotwire::Livereload"
+  task :enable do
+    if File.exist?(Hotwire::Livereload::DISABLE_FILE)
+      File.delete Hotwire::Livereload::DISABLE_FILE
+    end
+    puts "Livereload enabled."
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hotwire-livereload
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Kirill Platonov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-03 00:00:00.000000000 Z
+date: 2021-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -48,17 +48,14 @@ files:
 - MIT-LICENSE
 - README.md
 - app/assets/javascripts/hotwire-livereload.js
-- app/channels/hotwire/livereload/connection.rb
 - app/channels/hotwire/livereload/reload_channel.rb
 - app/helpers/hotwire/livereload/livereload_tags_helper.rb
 - app/javascript/hotwire-livereload.js
-- config/livereload_cable.yml
-- config/routes.rb
 - lib/hotwire/livereload.rb
 - lib/hotwire/livereload/engine.rb
 - lib/hotwire/livereload/version.rb
 - lib/install/install.rb
-- lib/tasks/hotwire/livereload/install.rake
+- lib/tasks/livereload_tasks.rake
 homepage: https://github.com/kirillplatonov/hotwire-livereload
 licenses:
 - MIT
@@ -78,8 +75,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
-summary: Automatically reload Hotwire Turbo when 'view' files are modified.
+summary: Automatically reload Hotwire Turbo when app files are modified.
 test_files: []

data/app/channels/hotwire/livereload/connection.rb

@@ -1,9 +0,0 @@
-class Hotwire::Livereload::Connection < ActionCable::Connection::Base
-  identified_by :uid
-
-  def connect
-    self.uid = request.params[:uid]
-    logger.add_tags(uid)
-    logger.info "connected to Hotwire::Livereload"
-  end
-end

data/config/livereload_cable.yml

@@ -1,2 +0,0 @@
-development:
-  adapter: async

data/config/routes.rb

@@ -1,5 +0,0 @@
-Hotwire::Livereload::Engine.routes.draw do
-  if Rails.env.development?
-    mount Hotwire::Livereload::Engine.websocket => Hotwire::Livereload::Engine.cable.mount_path
-  end
-end

data/lib/tasks/hotwire/livereload/install.rake

@@ -1,6 +0,0 @@
-namespace :hotwire_livereload do
-  desc "Setup Hotwire Livereload"
-  task :install do
-    system "#{RbConfig.ruby} ./bin/rails app:template LOCATION=#{File.expand_path("../../../install/install.rb",  __dir__)}"
-  end
-end