hotwire-livereload 1.4.0 → 2.0.0

data/app/javascript/hotwire-livereload.js

@@ -2,7 +2,7 @@ import { createConsumer } from "@rails/actioncable"
 import received from "./lib/hotwire-livereload-received"
 import scrollPosition from "./lib/hotwire-livereload-scroll-position"
 
-const consumer = createConsumer()
+const consumer = createConsumer("/hotwire-livereload")
 consumer.subscriptions.create("Hotwire::Livereload::ReloadChannel", {
   received,
 
@@ -19,4 +19,3 @@ document.addEventListener("turbo:load", () => {
   scrollPosition.restore()
   scrollPosition.remove()
 })
-

data/lib/hotwire/livereload/cable_server.rb

@@ -0,0 +1,11 @@
+module Hotwire
+  module Livereload
+    class CableServer < ActionCable::Server::Base
+      def initialize
+        config = ::ActionCable::Server::Base.config.dup
+        config.connection_class = -> { ::ActionCable::Connection::Base }
+        super(config: config)
+      end
+    end
+  end
+end

data/lib/hotwire/livereload/engine.rb

@@ -1,69 +1,75 @@
-require "rails"
-require "action_cable/engine"
-require "listen"
-
 module Hotwire
   module Livereload
     class Engine < ::Rails::Engine
       isolate_namespace Hotwire::Livereload
+
       config.hotwire_livereload = ActiveSupport::OrderedOptions.new
       config.hotwire_livereload.listen_paths ||= []
       config.hotwire_livereload.skip_listen_paths ||= []
       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[
-        #{root}/app/channels
-        #{root}/app/helpers
-      ]
+      config.autoload_once_paths = %W[#{root}/app/channels]
       config.hotwire_livereload.listen_options ||= {}
       config.hotwire_livereload.debounce_delay_ms = 0
 
-      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]
+      initializer "hotwire_livereload.middleware" do
+        if Hotwire::Livereload.enabled?
+          config.app_middleware.insert_after ActionDispatch::Executor, Hotwire::Livereload::Middleware
         end
       end
 
-      initializer "hotwire_livereload.helpers" do
-        ActiveSupport.on_load(:action_controller_base) do
-          helper Hotwire::Livereload::LivereloadTagsHelper
+      initializer "hotwire_livereload.routes" do
+        if Hotwire::Livereload.enabled?
+          config.after_initialize do |app|
+            app.routes.prepend do
+              mount Hotwire::Livereload.cable_server => "/hotwire-livereload", :internal => true, :anchor => true
+            end
+          end
         end
       end
 
-      initializer "hotwire_livereload.set_configs" do |app|
-        options = app.config.hotwire_livereload
-        skip_listen_paths = options.skip_listen_paths.map(&:to_s).uniq
+      initializer "hotwire_livereload.assets" do
+        if Hotwire::Livereload.enabled? && Rails.application.config.respond_to?(:assets)
+          Rails.application.config.assets.precompile += %w[hotwire-livereload.js hotwire-livereload-turbo-stream.js]
+        end
+      end
 
-        unless options.disable_default_listeners
-          default_listen_paths = %w[
-            app/views
-            app/helpers
-            app/javascript
-            app/assets/stylesheets
-            app/assets/javascripts
-            app/assets/images
-            app/components
-            config/locales
-          ]
-          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]
+      initializer "hotwire_livereload.set_configs" do |app|
+        if Hotwire::Livereload.enabled?
+          options = app.config.hotwire_livereload
+          skip_listen_paths = options.skip_listen_paths.map(&:to_s).uniq
+
+          unless options.disable_default_listeners
+            default_listen_paths = %w[
+              app/views
+              app/helpers
+              app/javascript
+              app/assets/stylesheets
+              app/assets/javascripts
+              app/assets/images
+              app/components
+              config/locales
+            ]
+            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) }
+              .reject { |p| skip_listen_paths.include?(p.to_s) }
           end
-          options.listen_paths += default_listen_paths
-            .uniq
-            .map { |p| Rails.root.join(p) }
-            .select { |p| Dir.exist?(p) }
-            .reject { |p| skip_listen_paths.include?(p.to_s) }
         end
       end
 
       config.after_initialize do |app|
-        if Rails.env.development? && Hotwire::Livereload.server_process?
+        if Hotwire::Livereload.enabled?
           @trigger_reload = (Hotwire::Livereload.debounce(config.hotwire_livereload.debounce_delay_ms) do |options|
             if config.hotwire_livereload.reload_method == :turbo_stream
               Hotwire::Livereload.turbo_stream(options)
@@ -94,52 +100,10 @@ module Hotwire
       end
 
       at_exit do
-        if Rails.env.development?
+        if Hotwire::Livereload.enabled?
           @listener&.stop
         end
       end
     end
-
-    def self.turbo_stream(locals)
-      Turbo::StreamsChannel.broadcast_replace_to(
-        "hotwire-livereload",
-        target: "hotwire-livereload",
-        partial: "hotwire/livereload/turbo_stream",
-        locals: locals
-      )
-    end
-
-    def self.action_cable(opts)
-      ActionCable.server.broadcast("hotwire-reload", opts)
-    end
-
-    def self.server_process?
-      puma_process = defined?(::Puma) && File.basename($0) == "puma"
-      rails_server = defined?(Rails::Server)
-
-      puma_process || rails_server
-    end
-
-    def self.debounce(wait_ms, &block)
-      if wait_ms.zero?
-        return ->(*args) { yield(*args) }
-      end
-
-      mutex = Mutex.new
-      timer_thread = nil
-      seconds = wait_ms.to_f / 1000.0
-
-      lambda do |*args|
-        mutex.synchronize do
-          # Cancel previous timer
-          timer_thread&.kill
-
-          timer_thread = Thread.new do
-            sleep(seconds)
-            yield(*args)
-          end
-        end
-      end
-    end
   end
 end

data/lib/hotwire/livereload/middleware.rb

@@ -0,0 +1,56 @@
+module Hotwire
+  module Livereload
+    class Middleware
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        request = ActionDispatch::Request.new(env)
+        status, headers, response = @app.call(env)
+
+        if html_response?(headers)
+          body = get_response_body(response)
+          if body&.include?("</head>")
+            body = inject_livereload_scripts(body, request)
+            headers["Content-Length"] = body.bytesize.to_s
+            response = [body]
+          end
+        end
+
+        [status, headers, response]
+      end
+
+      private
+
+      def html_response?(headers)
+        headers["content-type"]&.include?("text/html")
+      end
+
+      def get_response_body(response)
+        parts = []
+        response.each { |part| parts << part.to_s }
+        parts.join
+      end
+
+      def inject_livereload_scripts(body, request)
+        body.sub("</head>", "#{livereload_scripts(request)}</head>")
+      end
+
+      def view_helpers
+        ActionController::Base.helpers
+      end
+
+      def livereload_scripts(request)
+        if Hotwire::Livereload::Engine.config.hotwire_livereload.reload_method == :turbo_stream
+          view_helpers.safe_join [
+            view_helpers.turbo_stream_from("hotwire-livereload"),
+            view_helpers.javascript_include_tag("hotwire-livereload-turbo-stream", defer: true, nonce: request&.content_security_policy_nonce)
+          ], "\n"
+        else
+          view_helpers.javascript_include_tag("hotwire-livereload", defer: true, nonce: request&.content_security_policy_nonce)
+        end
+      end
+    end
+  end
+end

data/lib/hotwire/livereload/version.rb

@@ -1,5 +1,5 @@
 module Hotwire
   module Livereload
-    VERSION = "1.4.0"
+    VERSION = "2.0.0"
   end
 end

data/lib/hotwire/livereload.rb

@@ -1,7 +1,69 @@
+# dependencies
+require "rails"
+require "action_cable/engine"
+require "action_cable/server/base"
+require "listen"
+
+# modules
+require "hotwire/livereload/cable_server"
+require "hotwire/livereload/middleware"
+require "hotwire/livereload/version"
 require "hotwire/livereload/engine"
 
 module Hotwire
   module Livereload
     DISABLE_FILE = "tmp/livereload-disabled.txt"
+
+    class << self
+      def turbo_stream(locals)
+        Turbo::StreamsChannel.broadcast_replace_to(
+          "hotwire-livereload",
+          target: "hotwire-livereload",
+          partial: "hotwire/livereload/turbo_stream",
+          locals: locals
+        )
+      end
+
+      def cable_server
+        @cable_server ||= Hotwire::Livereload::CableServer.new
+      end
+
+      def action_cable(opts)
+        cable_server.broadcast("hotwire-reload", opts)
+      end
+
+      def server_process?
+        puma_process = defined?(::Puma) && File.basename($0) == "puma"
+        rails_server = defined?(Rails::Server)
+
+        !!(puma_process || rails_server)
+      end
+
+      def enabled?
+        Rails.env.development? && server_process?
+      end
+
+      def debounce(wait_ms, &block)
+        if wait_ms.zero?
+          return ->(*args) { yield(*args) }
+        end
+
+        mutex = Mutex.new
+        timer_thread = nil
+        seconds = wait_ms.to_f / 1000.0
+
+        lambda do |*args|
+          mutex.synchronize do
+            # Cancel previous timer
+            timer_thread&.kill
+
+            timer_thread = Thread.new do
+              sleep(seconds)
+              yield(*args)
+            end
+          end
+        end
+      end
+    end
   end
 end

data/lib/tasks/livereload_tasks.rake

@@ -1,9 +1,4 @@
 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")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hotwire-livereload
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Kirill Platonov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-30 00:00:00.000000000 Z
+date: 2024-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: 7.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: 7.0.0
 - !ruby/object:Gem::Dependency
   name: actioncable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: 7.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: 7.0.0
 - !ruby/object:Gem::Dependency
   name: listen
   requirement: !ruby/object:Gem::Requirement
@@ -64,7 +64,6 @@ files:
 - app/assets/javascripts/hotwire-livereload-turbo-stream.js
 - app/assets/javascripts/hotwire-livereload.js
 - app/channels/hotwire/livereload/reload_channel.rb
-- app/helpers/hotwire/livereload/livereload_tags_helper.rb
 - app/javascript/hotwire-livereload-turbo-stream.js
 - app/javascript/hotwire-livereload.js
 - app/javascript/lib/hotwire-livereload-received.js
@@ -73,9 +72,10 @@ files:
 - app/views/hotwire/livereload/_head_turbo_stream.html.erb
 - app/views/hotwire/livereload/_turbo_stream.html.erb
 - lib/hotwire/livereload.rb
+- lib/hotwire/livereload/cable_server.rb
 - lib/hotwire/livereload/engine.rb
+- lib/hotwire/livereload/middleware.rb
 - lib/hotwire/livereload/version.rb
-- lib/install/install.rb
 - lib/tasks/livereload_tasks.rake
 homepage: https://github.com/kirillplatonov/hotwire-livereload
 licenses:

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

@@ -1,11 +0,0 @@
-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"
-    else
-      "hotwire/livereload/head_action_cable"
-    end
-
-    render partial
-  end
-end

data/lib/install/install.rb

@@ -1,30 +0,0 @@
-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.exist?
-  say "Add Hotwire Livereload tag in application layout"
-  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
-  say %(  Add <%= hotwire_livereload_tags %> within the <head> tag in your custom layout.)
-  say %(  If using `config.hotwire_livereload.reload_method = :turbo_stream`, place *after* the `<%= action_cable_meta_tag %>`.)
-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", %r{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