p2 2.11 → 2.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9f7d2a86ea17670a7bcc69301db096ec2a2b667c7eb8f2c0df1ac28178eb823
-  data.tar.gz: 6dd4d03825d1a881fd7b721fea58af43b7c2f2c68f7ceb8bd8031a2fbfdab0de
+  metadata.gz: ba1f3d8dbb8965fd65ec2d047c69679a4a07b994495422eb3cf09ca39c47c338
+  data.tar.gz: 7247dff71984c7903de1043383ef4049f8e6e6149962aa9ec5600a490da2a0c9
 SHA512:
-  metadata.gz: 6cf0579fe72241ae904f417d1fd2f6e97ef347d8a3106b7069c232b8332440ef3eea5dc8b7c059516d3ad17903d207941d3e4c795768943950295fd345304248
-  data.tar.gz: 0b44037b06cc328543ed6809a5f5c0b675318902fcb36800559d1b100bf190f42e56d9249905a0ee50dd59cf0006a3fb4f17a31dcff10d6d86b70b9608d31842
+  metadata.gz: e9c51b267d5e350b4806de9d2f27ea03680ccfa985d237e4909614ec8f384c304c67bde8981d3a7cc20e5c8ed3cdeb1066bad068847652f3073f7dc7b1023ad0
+  data.tar.gz: 4adbb063d72b4d52c61df05512a19a8845ada41cd7c958e6d66677876401de53804a95a3f66d520f16b40e55ad8c625de92c2d0755b8a1169e70fc00a9708136

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# 2.13 2025-09-11
+
+- Pass level to HTML debug attribute injection proc
+
+# 2.12 2025-09-11
+
+- Add support for injecting location attributes into HTML tags (for debug purposes)
+
 # 2.11 2025-09-11
 
 - Add mode param to `P2::Template` wrapper class

data/lib/p2/compiler.rb

@@ -10,6 +10,12 @@ module P2
   # A Compiler converts a template into an optimized form that generates HTML
   # efficiently.
   class Compiler < Sirop::Sourcifier
+    @@html_debug_attribute_injector = nil
+
+    def self.html_debug_attribute_injector=(proc)
+      @@html_debug_attribute_injector = proc
+    end
+
     # Compiles the given proc, returning the generated source map and the
     # generated optimized source code.
     #
@@ -72,6 +78,7 @@ module P2
       super(**)
       @mode = mode
       @pending_html_parts = []
+      @level = 0
     end
 
     # Initializes a source map.
@@ -80,12 +87,12 @@ module P2
     # @param orig_ast [Prism::Node] template AST
     # @return [self]
     def with_source_map(orig_proc, orig_ast)
-      fn = Compiler.source_location_to_fn(orig_proc.source_location)
+      @fn = orig_proc.source_location.first
       @orig_proc = orig_proc
       @orig_proc_fn = orig_proc.source_location.first
       @source_map = {
         source_fn: orig_proc.source_location.first,
-        compiled_fn: fn
+        compiled_fn: Compiler.source_location_to_fn(orig_proc.source_location)
       }
       @source_map_line_ofs = 2
       self
@@ -151,11 +158,12 @@ module P2
     # @param node [P2::TagNode] node
     # @return [void]
     def visit_tag_node(node)
+      @level += 1
       tag = node.tag
 
       # adjust_whitespace(node.location)
       is_void = is_void_element?(tag)
-      emit_html(node.tag_location, format_html_tag_open(tag, node.attributes))
+      emit_html(node.tag_location, format_html_tag_open(node.tag_location, tag, node.attributes))
       return if is_void
 
       case node.block
@@ -175,6 +183,8 @@ module P2
         end
       end
       emit_html(node.location, format_html_tag_close(tag))
+    ensure
+      @level -= 1
     end
 
     # Visits a const tag node.
@@ -456,13 +466,14 @@ module P2
 
     # Formats an open tag with optional attributes.
     #
+    # @param loc [Prism::Location] tag location
     # @param tag [String, Symbol] HTML tag
     # @param attributes [Hash, nil] attributes
     # @return [String] HTML
-    def format_html_tag_open(tag, attributes)
+    def format_html_tag_open(loc, tag, attributes)
       tag = convert_tag(tag)
-      if attributes && attributes&.elements.size > 0
-        "<#{tag} #{format_html_attributes(attributes)}>"
+      if attributes && attributes&.elements.size > 0 || @@html_debug_attribute_injector
+        "<#{tag} #{format_html_attributes(loc, attributes)}>"
       else
         "<#{tag}>"
       end
@@ -551,37 +562,85 @@ module P2
 
     # Formats HTML attributes from the given node.
     #
-    # @param node [Prism::Node] AST node
+    # @param loc [Prism::Location] tag location
+    # @param node [Prism::Node] attributes node
     # @return [String] HTML
-    def format_html_attributes(node)
-      elements = node.elements
-      dynamic_attributes = elements.any? do
-        it.is_a?(Prism::AssocSplatNode) ||
-          !is_static_node?(it.key) || !is_static_node?(it.value)
+    def format_html_attributes(loc, node)
+      elements = node&.elements || []
+      if elements.any? { is_dynamic_attribute?(it) }
+        return format_html_dynamic_attributes(loc, node)
       end
 
-      return interpolated("P2.format_tag_attrs(#{format_code(node)})") if dynamic_attributes
+      injected_atts = format_injected_attributes(loc)
+      parts = elements.map { format_attribute(it.key, it.value) }
+      (injected_atts + parts).compact.join(' ')
+    end
+
+    # Formats dynamic HTML attributes from the given node.
+    #
+    # @param loc [Prism::Location] tag location
+    # @param node [Prism::Node] attributes node
+    # @return [String] HTML
+    def format_html_dynamic_attributes(loc, node)
+      injected_atts = compute_injected_attributes(loc)
+      if injected_atts.empty?
+        return interpolated("P2.format_tag_attrs(#{format_code(node)})")
+      else
+        return interpolated("P2.format_tag_attrs(#{injected_atts.inspect}.merge(#{format_code(node)}))")
+      end
+    end
 
-      parts = elements.map do
-        key = it.key
-        value = it.value
-        case value
-        when Prism::TrueNode
-          format_literal(key)
-        when Prism::FalseNode, Prism::NilNode
-          nil
+    # Returns true if the given node is a dynamic node.
+    # 
+    # @param node [Prism::Node] attributes node
+    # @return [bool] is node dynamic
+    def is_dynamic_attribute?(node)
+      node.is_a?(Prism::AssocSplatNode) || !is_static_node?(node.key) || !is_static_node?(node.value)
+    end
+
+    # Computes injected attributes for the given tag location.
+    # 
+    # @param loc [Prism::Location] tag location
+    # @return [Hash] injected attributes hash
+    def compute_injected_attributes(loc)
+      return {} if (@mode == :xml) || !@@html_debug_attribute_injector
+
+      loc = loc_start(loc)
+      @@html_debug_attribute_injector&.(@level, @fn, loc[0], loc[1] + 1)
+    end
+
+    # Computes injected attributes for the given tag location.
+    # 
+    # @param loc [Prism::Location] tag location
+    # @return [Array<String>] array of attribute strings
+    def format_injected_attributes(loc)
+      atts = compute_injected_attributes(loc)
+      atts.map { |k, v| format_attribute(k, v) }
+    end
+
+    # Formats a tag attribute with the given key and value. A nil, or false
+    # value will return nil.
+    #
+    # @param key [any] attribute key
+    # @param value [any] attribute value
+    # @return [String, nil] formatted attribute
+    def format_attribute(key, value)
+      case value
+      when Prism::TrueNode
+        format_literal(key)
+      when Prism::FalseNode, Prism::NilNode
+        nil
+      when String, Integer, Float, Symbol
+        "#{P2.underscores_to_dashes(key)}=\\\"#{value}\\\""
+      else
+        key = format_literal(key)
+        if is_static_node?(value)
+          value = format_literal(value)
+          "#{P2.underscores_to_dashes(key)}=\\\"#{value}\\\""
         else
-          k = format_literal(key)
-          if is_static_node?(value)
-            value = format_literal(value)
-            "#{P2.underscores_to_dashes(k)}=\\\"#{value}\\\""
-          else
-            "#{P2.underscores_to_dashes(k)}=\\\"#\{#{format_code(value)}}\\\""
-          end
+          "#{P2.underscores_to_dashes(key)}=\\\"#\{#{format_code(value)}}\\\""
         end
       end
-
-      parts.compact.join(' ')
     end
 
     # Emits HTML into the pending HTML buffer.

data/lib/p2/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module P2
-  VERSION = '2.11'
+  VERSION = '2.13'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: p2
 version: !ruby/object:Gem::Version
-  version: '2.11'
+  version: '2.13'
 platform: ruby
 authors:
 - Sharon Rosner