hotwire-livereload 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 757248475a762e66a83a9fa3197d20d7a85d022d231777354452b484b3ce881a
-  data.tar.gz: ad896fa7edfe33574afe3b20640330b406d7c45473d3b20476e828489826dd4f
+  metadata.gz: 05ad19b6e77492fec265a2da6af3ddd9aa8b7b149ae284397644db40b553974b
+  data.tar.gz: 7f497acf2a34e1774d80c7a2fa1030b6a2eb9228cc2fe257b73a7cdad0e912fc
 SHA512:
-  metadata.gz: cb6075bb64a45a75a6a284df02c058f40ce97d79aa88e02f442bf87e90e5f2441ed45e3b30efff27b5d765cd8987707a279717e0c37574e9738180da896e9d23
-  data.tar.gz: 0c2ffb6cbb134f97152e029877a4a010a7e366ea1462ffd4bc3eff9dada8c7dd5cfd2f8b916f9b74dafdd4ca0c9e650a45b345ebd73ce451e4f9aa602eedea74
+  metadata.gz: 554901b08d7d257da5660c5020cbfb8bab03e987eff1d329337fa9943119c6e3a8bead3bc62c97edec32250f7c0bb5503b7d306373e794bd7908a208f211284a
+  data.tar.gz: 8e213677c64df89f7903d672c421b7faa9d8a5d12e136ef24e92e7dbc1a0deedc650d92cd882b06627f20e89ddcd4d46ea72943e22cf035152b9aff2e3284c02

data/README.md

@@ -10,7 +10,34 @@ The JavaScript for Hotwire::Livereload is installed via asset pipeline, which is
 
 1. Add `hotwire-livereload` gem to your Gemfile: `gem 'hotwire-livereload'`
 2. Run `./bin/bundle install`
-3. Run `./bin/rails hotwire_livereload:install`
+3. Run `./bin/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/assets/stylesheets")
+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,18 @@
   // 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 consumer = (0, import_actioncable.createConsumer)();
   var received = (0, import_debounce.default)(() => {
-    console.log("Hotwire::Livereload files changed");
+    console.log("[Hotwire::Livereload] Files changed");
     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,20 @@
 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 consumer = createConsumer()
 const received = debounce(() => {
-  console.log("Hotwire::Livereload files changed")
+  console.log("[Hotwire::Livereload] Files changed")
   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

@@ -28,27 +28,21 @@ module Hotwire
       initializer "hotwire_livereload.set_configs" do |app|
         options = app.config.hotwire_livereload
         options.listen_paths = options.listen_paths.map(&:to_s)
-        options.listen_paths << Rails.root.join("app", "views")
-      end
-
-      initializer "hotwire_livereload.cable.config" do |app|
-        config_path = Hotwire::Livereload::Engine.root.join("config", "livereload_cable.yml")
-        cable = Hotwire::Livereload::Engine.cable
-
-        cable.cable = app.config_for(config_path).with_indifferent_access
-        cable.mount_path = "/cable"
-        cable.connection_class = -> { Hotwire::Livereload::Connection }
-        cable.logger ||= Rails.logger
+        options.listen_paths << Rails.root.join("app/views")
+        options.listen_paths << Rails.root.join("app/helpers")
+        if Dir.exist?(Rails.root.join("app/javascript"))
+          options.listen_paths << Rails.root.join("app/javascript")
+        end
       end
 
       config.after_initialize do |app|
-        if Rails.env.development?
+        if Rails.env.development? && defined?(Rails::Server)
           @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 }
-              )
+            unless File.exists?(DISABLE_FILE)
+              if (modified.any? || removed.any? || added.any?)
+                content = { modified: modified, removed: removed, added: added }
+                ActionCable.server.broadcast("hotwire-reload", content)
+              end
             end
           end
           @listener.start
@@ -60,16 +54,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.1"
+    VERSION = "0.2.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,23 @@
-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
+if APP_LAYOUT_PATH.exist?
+  say "Add Hotwire Livereload tag in application layout"
+  insert_into_file APP_LAYOUT_PATH, before: /\s*<\/head>/ do <<-HTML
 \n    <%= hotwire_livereload_tags %>
 HTML
   end
 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?
+  say "Enable redis in bundle"
+  uncomment_lines "Gemfile", %(gem 'redis')
+
+  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.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Kirill Platonov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-03 00:00:00.000000000 Z
+date: 2021-12-04 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

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