revelio 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d57c3092796a024f71491ecccb201e2e18eec378a1854212d72400b7d1a4d7d2
+  data.tar.gz: 14f760356c957b4e2e5d36d8530866bbee70a3983c3d73ad221a1c05268d6f0d
+SHA512:
+  metadata.gz: 0cee26631803029474d627620cdb62693350efbcd8ede3086d7198355a7eac7000e02de9add776ca1f749ff30d7176de27f872871a05a5f55b90f48efee426b8
+  data.tar.gz: 7d85dd1539a39200675a48cfa92c9a7148bd7627dd4fd7ab3d137c242899b8d4b591403434b04de65d780389abcfff12b525c2bd2116d55695b456dbcbbae1c0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Jose Galisteo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/lib/revelio/config.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Revelio
+  class Config
+    attr_accessor :debug_mode, :project_root, :inject_overlay,
+                  :duration_threshold, :queries_threshold, :gc_objects_threshold
+
+    def initialize
+      @debug_mode = false
+      @project_root = nil
+      @inject_overlay = true
+      @duration_threshold = 200
+      @queries_threshold = 20
+      @gc_objects_threshold = 100_000
+    end
+
+    def thresholds
+      {
+        duration: @duration_threshold,
+        queries: @queries_threshold,
+        gc_objects: @gc_objects_threshold
+      }
+    end
+  end
+end

data/lib/revelio/erb_template_extension.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Revelio
+  module ErbTemplateExtension
+    include TemplateType
+
+    def call(template, source = nil)
+      compiled = super
+      return compiled unless Revelio.config.debug_mode
+      return compiled unless template.format == :html
+
+      relative, type, short = resolve_template_info(template)
+
+      preamble = %{<!-- revelio-begin file="#{relative}" type="#{type}" short="#{short}" -->}
+      postamble = %{<!-- revelio-end file="#{relative}" -->}
+
+      # ERB's output buffer is already initialized by ActionView before the template runs
+      "@output_buffer.safe_append='#{preamble}';#{compiled}\n@output_buffer.safe_append='#{postamble}';\n@output_buffer"
+    end
+  end
+end

data/lib/revelio/haml_tag_compiler_extension.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Revelio
+  module HamlTagCompilerExtension
+    include TemplateType
+
+    def initialize(identity, options)
+      @revelio_filename = options[:filename] || "unknown"
+      super
+    end
+
+    def compile(node, &block)
+      result = super
+      return result unless Revelio.config.debug_mode
+
+      inject_debug_attrs(result, node)
+    end
+
+    private
+
+    def inject_debug_attrs(temple, node)
+      attrs = temple[3]
+      return temple unless attrs.is_a?(Array) && attrs[0] == :html && attrs[1] == :attrs
+
+      filename = @revelio_filename.dup
+      root = Revelio.config.project_root
+      if root && filename.start_with?(root)
+        filename = filename.delete_prefix(root).delete_prefix("/")
+      end
+
+      debug_attrs = [
+        [:html, :attr, "data-revelio-file", [:static, filename]],
+        [:html, :attr, "data-revelio-line", [:static, node.line.to_s]],
+        [:html, :attr, "data-revelio-type", [:static, template_type(filename)]]
+      ]
+
+      temple[3] = [:html, :attrs, *attrs[2..], *debug_attrs]
+      temple
+    end
+  end
+end

data/lib/revelio/haml_template_extension.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Revelio
+  module HamlTemplateExtension
+    include TemplateType
+
+    def call(template, source = nil)
+      return super unless Revelio.config.debug_mode
+
+      source ||= template.source
+      options = Haml::RailsTemplate.options
+
+      if template.respond_to?(:identifier)
+        options = options.merge(filename: template.identifier)
+      end
+
+      if template.respond_to?(:type) && template.type == "text/xml"
+        options = options.merge(format: :xhtml)
+      end
+
+      relative, type, short = resolve_template_info(template)
+
+      preamble_parts = []
+      postamble_parts = []
+
+      if ActionView::Base.try(:annotate_rendered_view_with_filenames) && template.format == :html
+        preamble_parts << "<!-- BEGIN #{template.short_identifier} -->"
+        postamble_parts << "<!-- END #{template.short_identifier} -->"
+      end
+
+      marker_attrs = "file=\"#{relative}\" type=\"#{type}\" short=\"#{short}\""
+      preamble_parts << "<!-- revelio-begin #{marker_attrs} -->"
+      postamble_parts.unshift("<!-- revelio-end file=\"#{relative}\" -->")
+
+      options = options.merge(
+        preamble: preamble_parts.join("\n"),
+        postamble: postamble_parts.join("\n")
+      )
+
+      Haml::Engine.new(options).call(source)
+    end
+  end
+end

data/lib/revelio/middleware.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "render_subscriber"
+
+module Revelio
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      ensure_installed!
+
+      status = nil
+      headers = nil
+      response = nil
+
+      metrics = collect_metrics do
+        status, headers, response = @app.call(env)
+      end
+
+      return [status, headers, response] unless injectable?(status, headers)
+
+      body = +""
+      response.each { |chunk| body << chunk }
+      response.close if response.respond_to?(:close)
+
+      if body.include?("</body>")
+        body.sub!("</body>", "#{devtools_injection(metrics)}\n</body>")
+        headers["content-length"] = body.bytesize.to_s if headers["content-length"]
+      end
+
+      [status, headers, [body]]
+    end
+
+    private
+
+    def collect_metrics
+      all_queries = []
+      subscribers = []
+
+      if defined?(ActiveSupport::Notifications)
+        # SQL tracking -- Rails 8.1 passes a single Event object
+        subscribers << ActiveSupport::Notifications.subscribe("sql.active_record") do |event|
+          next if event.payload[:name] == "SCHEMA"
+          all_queries << {
+            name: event.payload[:name],
+            duration: event.duration.round(2),
+            allocations: event.allocations
+          }
+        end
+
+        # Render tracking with start/finish stack
+        render_tracker = RenderSubscriber.new(all_queries)
+        %w[render_template.action_view render_partial.action_view render.view_component].each do |event|
+          subscribers << ActiveSupport::Notifications.subscribe(event, render_tracker)
+        end
+      end
+
+      gc_before = GC.stat(:total_allocated_objects)
+      start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+
+      yield
+
+      duration = ((Process.clock_gettime(Process::CLOCK_MONOTONIC) - start) * 1000).round(1)
+      gc_allocated = GC.stat(:total_allocated_objects) - gc_before
+
+      subscribers.compact.each { |s| ActiveSupport::Notifications.unsubscribe(s) }
+
+      renders = defined?(render_tracker) ? render_tracker.renders : []
+      query_time = all_queries.sum { |q| q[:duration] }
+
+      {
+        duration: duration,
+        queries: all_queries.size,
+        query_time: query_time.round(1),
+        renders: renders.size,
+        render_time: renders.sum { |r| r[:duration] }.round(1),
+        gc_objects: gc_allocated,
+        thresholds: Revelio.config.thresholds,
+        details: {
+          queries: all_queries.first(50),
+          renders: renders
+        }
+      }
+    end
+
+    def ensure_installed!
+      # Always call install! — it's idempotent per-engine and handles
+      # late-defined constants like Slim::RailsTemplate
+      Revelio.install!
+    end
+
+    def injectable?(status, headers)
+      status == 200 &&
+        !headers["content-disposition"]&.start_with?("attachment") &&
+        headers["content-type"]&.include?("text/html")
+    end
+
+    def devtools_injection(metrics)
+      meta = "<meta name=\"revelio-project-path\" content=\"#{Revelio.config.project_root}\">"
+      metrics_tag = "<script type=\"application/json\" id=\"revelio-metrics\">#{metrics.to_json}</script>"
+      "#{meta}\n#{metrics_tag}\n#{self.class.devtools_script}"
+    end
+
+    def self.devtools_script
+      js = File.read(File.expand_path("overlay.js", __dir__))
+      "<script id=\"revelio\">\n#{js}\n</script>"
+    end
+  end
+end