p2 2.10 → 2.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14c5c67f786953f8783be2cb53cb1eb4ad54be9f1ce769ce340cdc07d45b7a52
-  data.tar.gz: 1788cf26c810fa3f4d47b6db4b0de149b223e47d6a8356af7dea580190664da9
+  metadata.gz: c26b9c214f11c471fb039fba72fdde0b98f8d7c85864ec9db271a295f2e078fa
+  data.tar.gz: 52dc0929deb222d22e496cf451ee927f5047403e1b687f1588e2dccc74f59135
 SHA512:
-  metadata.gz: c898b73cbfeffcc1227bc15889d43e78dd03f745a9aee584767f4e8c22ae25d698190454c5cea9600735dddcc2da91a95fb7324b5cf906ef19824ba3dce7020c
-  data.tar.gz: 6575f62f6158438bc95bea56d60d0f6fe4e11b1e45269584f6a644ffcd3d647e20bd712a869a556d882c4ff00a74a93f1bdefb5e8fe759787588bae9b3ba4abb
+  metadata.gz: cb6032e2a12263ca0ff29cf00b677d1aa88dbd2becf57e662d09c857ecc39e4670af18b1b6493e548b83a4e73d010822b3cca4b07b4ed372e5b63d566bd11861
+  data.tar.gz: cbdbaf04e4beb275463b38ee453b93dac751a74166f3264a41269177f869a04a2082999dc4f2adca03ef85b075d5726fbc0300bb5ffa9d27041bddaf146b87f3

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# 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
+
 # 2.10 2025-09-11
 
 - Add support for rendering XML, implement `Proc#render_xml`

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_atts_injector = nil
+
+    def self.html_atts_injector=(proc)
+      @@html_atts_injector = proc
+    end
+
     # Compiles the given proc, returning the generated source map and the
     # generated optimized source code.
     #
@@ -80,12 +86,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
@@ -155,7 +161,7 @@ module P2
 
       # 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
@@ -456,13 +462,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_atts_injector
+        "<#{tag} #{format_html_attributes(loc, attributes)}>"
       else
         "<#{tag}>"
       end
@@ -551,37 +558,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_atts_injector
+
+      loc = loc_start(loc)
+      @@html_atts_injector&.(@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
+        "#{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/template.rb

@@ -4,10 +4,25 @@ module P2
   # Template wrapper class. This class can be used to distinguish between P2
   # templates and other kinds of procs.
   class Template
-    attr_reader :proc
-    def initialize(proc)  = @proc = proc
-    def render(*, **, &)  = @proc.render(*, **, &)
-    def apply(*, **, &)   = Template.new(@proc.apply(*, **, &))
-    def compiled_proc     = @proc.compiled_proc
+    attr_reader :proc, :mode
+
+    # @param proc [Proc] template proc
+    # @param mode [Symbol] mode (:html, :xml)
+    def initialize(proc, mode: :html)
+      @proc = proc
+      @mode = mode
+    end
+
+    def render(*, **, &)
+      (mode == :xml) ? @proc.render_xml(*, **, &) : @proc.render(*, **, &)
+    end
+
+    def apply(*, **, &)
+      Template.new(@proc.apply(*, **, &), mode: @mode)
+    end
+    
+    def compiled_proc
+      @proc.compiled_proc(mode: @mode)
+    end
   end
 end

data/lib/p2/version.rb

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

metadata

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