reactionview 0.3.0 → 0.4.0

data/lib/generators/reactionview/install_generator.rb

@@ -23,9 +23,15 @@ module ReActionView
             # Enable debug mode in development (adds debug attributes to HTML)
             config.debug_mode = Rails.env.development?
 
+            # Path used for editor "open in editor" links (optional, defaults to Rails.root)
+            # config.project_path = ENV.fetch('PROJECT_PATH', Rails.root.to_s)
+
             # Validation mode (:raise, :overlay, or :none) — defaults to :raise in test, :overlay otherwise
             # config.validation_mode = :overlay
 
+            # How to handle templates that come from gems (:fallback, :skip, or :compile), defaults to :fallback
+            # config.external_template_mode = :skip
+
             # Add custom transform visitors to process templates before compilation
             # config.transform_visitors = [
             #   Herb::Visitor::new

data/lib/reactionview/asset_manifest.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require "json"
+
+module ReActionView
+  class AssetManifest
+    def initialize(assets)
+      @assets = assets
+    end
+
+    def path
+      config = @assets&.config
+
+      return unless config.respond_to?(:manifest_path)
+
+      config.manifest_path
+    end
+
+    def mtime
+      return if path.nil?
+
+      File.mtime(path)
+    rescue SystemCallError
+      nil
+    end
+
+    def exist?
+      !mtime.nil?
+    end
+
+    def missing_assets
+      precompiled = logical_paths
+
+      return [] if precompiled.empty?
+
+      ReActionView::Railtie::PRECOMPILE_ASSETS - precompiled
+    end
+
+    def stale?
+      exist? && !missing_assets.empty?
+    end
+
+    def in_use?
+      @assets.respond_to?(:resolver) && @assets.resolver.respond_to?(:manifest_path)
+    end
+
+    def explanation
+      <<~MESSAGE
+        ReActionView's dev tools assets are missing from your precompiled assets.
+        #{status}
+
+        To fix this, delete the precompiled assets:
+
+            bin/rails assets:clobber
+
+        That is safe in development. Without public/assets/, Propshaft serves each asset straight from
+        the directory it lives in, including ReActionView's.
+
+            Missing:  #{missing_assets.join(", ")}
+            Manifest: #{path}
+
+        public/assets/ was most likely left behind by `RAILS_ENV=production bin/rails assets:precompile`,
+        and a production precompile doesn't include ReActionView's dev tools.
+      MESSAGE
+    end
+
+    private
+
+    def status
+      if in_use?
+        "Because public/assets/.manifest.json exists, Propshaft serves every asset from public/assets/\n" \
+          "and doesn't look anywhere else, which is why the lookup failed."
+      else
+        "This server booted before public/assets/.manifest.json existed, so pages still render for now.\n" \
+          "After the next restart Propshaft will serve assets from public/assets/ only, and rendering\n" \
+          "will fail then."
+      end
+    end
+
+    def logical_paths
+      return [] if path.nil?
+
+      JSON.parse(File.read(path)).keys
+    rescue SystemCallError, JSON::ParserError
+      []
+    end
+  end
+end

data/lib/reactionview/config.rb

@@ -5,12 +5,36 @@ module ReActionView
     attr_accessor :intercept_erb
     attr_accessor :debug_mode
     attr_accessor :transform_visitors
+
+    EXTERNAL_TEMPLATE_MODES = %i[fallback skip compile].freeze
+
+    attr_writer :dev_server_port
+    attr_writer :project_path
     attr_writer :validation_mode
 
     def initialize
       @intercept_erb = false
       @debug_mode = nil
+      @dev_server_port = nil
+      @external_template_mode = nil
       @transform_visitors = []
+      @project_path = nil
+    end
+
+    def external_template_mode
+      @external_template_mode || :fallback
+    end
+
+    def external_template_mode=(mode)
+      unless mode.nil? || EXTERNAL_TEMPLATE_MODES.include?(mode)
+        raise ArgumentError, "external_template_mode must be one of :fallback, :skip, or :compile, got #{mode.inspect}"
+      end
+
+      @external_template_mode = mode
+    end
+
+    def project_path
+      @project_path || Rails.root.to_s
     end
 
     def validation_mode
@@ -36,6 +60,13 @@ module ReActionView
 
       development?
     end
+
+    def dev_server_port
+      return @dev_server_port if @dev_server_port
+      return nil unless development?
+
+      ::Herb.dev_server_port(Rails.root.to_s)
+    end
   end
 
   def self.config

data/lib/reactionview/middleware/asset_manifest_check.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require_relative "../asset_manifest"
+require_relative "../stale_asset_manifest_error"
+
+module ReActionView
+  module Middleware
+    class AssetManifestCheck
+      def initialize(app, assets: nil, logger: nil)
+        @app = app
+        @assets = assets
+        @logger = logger
+        @mutex = Mutex.new
+        @checked_mtime = nil
+      end
+
+      def call(env)
+        warn_about_upcoming_failure
+
+        @app.call(env)
+      rescue StandardError => e
+        raise unless dev_tools_asset_missing?(e)
+
+        manifest = self.manifest
+
+        raise unless manifest.stale?
+
+        raise StaleAssetManifestError.for(manifest)
+      end
+
+      private
+
+      def assets
+        @assets || (defined?(Rails) && Rails.application&.assets)
+      end
+
+      def logger
+        @logger || (defined?(Rails) && Rails.logger)
+      end
+
+      def manifest
+        AssetManifest.new(assets)
+      end
+
+      def warn_about_upcoming_failure
+        manifest = self.manifest
+        mtime = manifest.mtime
+
+        return if mtime.nil?
+
+        @mutex.synchronize do
+          return if @checked_mtime == mtime
+
+          @checked_mtime = mtime
+
+          return if manifest.in_use? || !manifest.stale?
+
+          log("[ReActionView] #{manifest.explanation}")
+        end
+      end
+
+      def dev_tools_asset_missing?(error)
+        error_class = missing_asset_error_class
+
+        return false if error_class.nil?
+
+        while error
+          if error.is_a?(error_class) &&
+             ReActionView::Railtie::PRECOMPILE_ASSETS.any? { |asset| error.message.include?(asset) }
+            return true
+          end
+
+          error = error.cause
+        end
+
+        false
+      end
+
+      def missing_asset_error_class
+        return unless defined?(::Propshaft::MissingAssetError)
+
+        ::Propshaft::MissingAssetError
+      end
+
+      def log(message)
+        if logger
+          logger.warn(message)
+        else
+          warn(message)
+        end
+      end
+    end
+  end
+end

data/lib/reactionview/railtie.rb

@@ -14,8 +14,8 @@ module ReActionView
       reactionview-dev-tools.umd.js
     ].freeze
 
-    initializer "reactionview.assets" do |app|
-      if ReActionView.config.development? && app.config.respond_to?(:assets)
+    initializer "reactionview.assets", after: :load_config_initializers do |app|
+      if ReActionView.config.debug_mode_enabled? && app.config.respond_to?(:assets)
         gem_root = Gem::Specification.find_by_name("reactionview").gem_dir
 
         app.config.assets.paths << File.join(gem_root, "app", "assets", "javascripts")
@@ -23,6 +23,14 @@ module ReActionView
       end
     end
 
+    initializer "reactionview.asset_manifest_check" do |app|
+      next unless ReActionView.config.development?
+
+      require_relative "middleware/asset_manifest_check"
+
+      app.middleware.use ReActionView::Middleware::AssetManifestCheck
+    end
+
     initializer "reactionview.register_herb_handler" do
       ActiveSupport.on_load(:action_view) do
         ActionView::Template.register_template_handler :herb, ReActionView::Template::Handlers::Herb

data/lib/reactionview/stale_asset_manifest_error.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module ReActionView
+  class StaleAssetManifestError < StandardError
+    def self.for(manifest)
+      new(manifest.explanation)
+    end
+  end
+end

data/lib/reactionview/template/handlers/erb.rb

@@ -4,14 +4,50 @@ module ReActionView
   class Template
     module Handlers
       class ERB < ActionView::Template::Handlers::ERB
+        include ReActionView::Template::LocalTemplate
+
         autoload :Herb, "reactionview/template/handlers/herb/herb"
 
         def call(template, source)
-          if template.format == :html && ReActionView.config.intercept_erb
-            ::ReActionView::Template::Handlers::Herb.call(template, source)
-          else
-            super
-          end
+          return super unless intercept_template?(template)
+
+          ::ReActionView::Template::Handlers::Herb.call(
+            template, source, validation_mode: herb_validation_mode(template)
+          )
+        rescue StandardError => e
+          raise unless fall_back_to_erb?(template)
+
+          log_external_template_error(template, e)
+
+          super
+        end
+
+        private
+
+        def intercept_template?(template)
+          return false unless template.format == :html && ReActionView.config.intercept_erb
+
+          local_template?(template) || ReActionView.config.external_template_mode != :skip
+        end
+
+        def herb_validation_mode(template)
+          return nil if local_template?(template)
+          return nil unless ReActionView.config.external_template_mode == :fallback
+
+          :raise
+        end
+
+        def fall_back_to_erb?(template)
+          !local_template?(template) && ReActionView.config.external_template_mode == :fallback
+        end
+
+        def log_external_template_error(template, error)
+          return unless defined?(Rails.logger) && Rails.logger
+
+          Rails.logger.warn(
+            "[ReActionView] #{template.identifier} could not be compiled by Herb, " \
+            "falling back to ActionView::Template::Handlers::ERB: #{error.message.strip.lines.first}"
+          )
         end
       end
     end

data/lib/reactionview/template/handlers/herb.rb

@@ -4,24 +4,30 @@ module ReActionView
   class Template
     module Handlers
       class Herb < ActionView::Template::Handlers::ERB
+        include ReActionView::Template::LocalTemplate
+
         autoload :Herb, "reactionview/template/handlers/herb/herb"
 
         class_attribute :erb_implementation, default: Handlers::Herb::Herb
 
-        def call(template, source)
+        def self.call(template, source, validation_mode: nil)
+          new.call(template, source, validation_mode: validation_mode)
+        end
+
+        def call(template, source, validation_mode: nil)
           visitors = []
 
           if ::ReActionView.config.debug_mode_enabled? && local_template?(template)
             visitors << ::Herb::Engine::DebugVisitor.new(
-              file_path: template.identifier,
-              project_path: Rails.root.to_s
+              file_path: translate_path_for_editor(template.identifier),
+              project_path: ::ReActionView.config.project_path
             )
           end
 
           config = {
             filename: template.identifier,
             project_path: Rails.root.to_s,
-            validation_mode: ReActionView.config.validation_mode,
+            validation_mode: validation_mode || ReActionView.config.validation_mode,
             content_for_head: reactionview_dev_tools_markup(template),
             visitors: visitors + ReActionView.config.transform_visitors,
           }
@@ -37,12 +43,6 @@ module ReActionView
           template.identifier.include?("/layouts/")
         end
 
-        def local_template?(template)
-          return true unless template.respond_to?(:identifier) && template.identifier
-
-          template.identifier.start_with?(Rails.root.to_s)
-        end
-
         def active_support_editor
           return unless defined?(ActiveSupport::Editor)
           return if ActiveSupport::Editor.current.blank?
@@ -50,6 +50,15 @@ module ReActionView
           ActiveSupport::Editor.current.instance_variable_get(:@url_pattern).split("://").first
         end
 
+        def translate_path_for_editor(template_path)
+          rails_root = Rails.root.to_s
+          project_path = ::ReActionView.config.project_path
+
+          return template_path if project_path == rails_root
+
+          template_path.to_s.sub(rails_root, project_path)
+        end
+
         def editor_meta_tag
           editor_name = active_support_editor || ENV["RAILS_EDITOR"] || ENV.fetch("EDITOR", nil)
 
@@ -58,29 +67,36 @@ module ReActionView
           %(<meta name="herb-default-editor" content="#{editor_name}">)
         end
 
+        def dev_server_port_meta_tag
+          port = ::ReActionView.config.dev_server_port
+
+          return if port.blank?
+
+          %(<meta name="herb-dev-server-port" content="#{port}">)
+        end
+
         def reactionview_dev_tools_markup(template)
+          return nil unless ::ReActionView.config.debug_mode_enabled?
           return nil unless layout_template?(template)
           return nil unless local_template?(template)
 
-          markup = +""
+          <<~HTML
+            <meta name="herb-debug-mode" content="true">
+            <meta name="herb-project-path" content="#{Rails.root}">
+            #{dev_server_port_meta_tag}
+            #{editor_meta_tag}
 
-          if ::ReActionView.config.debug_mode_enabled?
-            markup << <<~HTML
-              <meta name="herb-debug-mode" content="true">
-              <meta name="herb-project-path" content="#{Rails.root}">
-              #{editor_meta_tag}
-
-              #{ActionController::Base.new.view_context.javascript_include_tag "reactionview-dev-tools.umd.js", defer: true}
-            HTML
-          end
+            #{ActionController::Base.new.view_context.javascript_include_tag "reactionview-dev-tools.umd.js", defer: true}
+            #{dismiss_hint_template}
+          HTML
+        end
 
-          if ::ReActionView.config.validation_mode == :overlay
-            markup << <<~HTML
-              <template data-herb-dismiss-hint>You can also disable this overlay by setting <code style="color: #ffeb3b; font-family: monospace; font-size: 12pt;">config.validation_mode = :none</code> in <code style="color: #ffeb3b; font-family: monospace; font-size: 12pt;">config/initializers/reactionview.rb</code>.</template>
-            HTML
-          end
+        def dismiss_hint_template
+          return unless ::ReActionView.config.validation_mode == :overlay
 
-          markup.presence
+          <<~HTML.chomp
+            <template data-herb-dismiss-hint>You can also disable this overlay by setting <code style="color: #ffeb3b; font-family: monospace; font-size: 12pt;">config.validation_mode = :none</code> in <code style="color: #ffeb3b; font-family: monospace; font-size: 12pt;">config/initializers/reactionview.rb</code>.</template>
+          HTML
         end
       end
     end

data/lib/reactionview/template/local_template.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module ReActionView
+  class Template
+    module LocalTemplate
+      private
+
+      def local_template?(template)
+        return true unless template.respond_to?(:identifier) && template.identifier
+        return false if vendored_template?(template)
+
+        template.identifier.start_with?(Rails.root.to_s)
+      end
+
+      def vendored_template?(template)
+        return false unless defined?(Bundler)
+
+        template.identifier.start_with?(Bundler.bundle_path.to_s)
+      end
+    end
+  end
+end

data/lib/reactionview/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ReActionView
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/reactionview.rb

@@ -17,6 +17,8 @@ require_relative "reactionview/config"
 
 # require_relative "reactionview/source_annotation_extractor"
 
+require_relative "reactionview/template/local_template"
+
 require_relative "reactionview/template/handlers/erb"
 require_relative "reactionview/template/handlers/herb"
 require_relative "reactionview/template/handlers/herb/herb"

data/reactionview.gemspec

@@ -36,5 +36,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "actionview", ">= 7.0"
-  spec.add_dependency "herb", ">= 0.9.0", "< 1.0.0"
+  spec.add_dependency "cruise"
+  spec.add_dependency "herb", ">= 0.10.0", "< 0.11.0"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: reactionview
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Marco Roth
 bindir: exe
 cert_chain: []
-date: 2026-03-18 00:00:00.000000000 Z
+date: 2026-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -23,26 +23,40 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: cruise
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: herb
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 0.10.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 0.11.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 0.10.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 0.11.0
 description: An ActionView-compatible ERB engine with modern DX - re-imagined with
   Herb.
 email:
@@ -61,11 +75,15 @@ files:
 - lib/generators/reactionview/install_generator.rb
 - lib/reaction_view.rb
 - lib/reactionview.rb
+- lib/reactionview/asset_manifest.rb
 - lib/reactionview/config.rb
+- lib/reactionview/middleware/asset_manifest_check.rb
 - lib/reactionview/railtie.rb
+- lib/reactionview/stale_asset_manifest_error.rb
 - lib/reactionview/template/handlers/erb.rb
 - lib/reactionview/template/handlers/herb.rb
 - lib/reactionview/template/handlers/herb/herb.rb
+- lib/reactionview/template/local_template.rb
 - lib/reactionview/version.rb
 - reactionview.gemspec
 - sig/reactionview.rbs