mjml-rb 0.2.33 → 0.2.34

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6147ba24e9e7ede9406ebbaa48655e885f72e7f61d14c0da37ecde7ecdc66a68
-  data.tar.gz: 6809e1ba8ee7927d565831840a5938dea5bc37abfaff3691d4b60dd4eacd67d0
+  metadata.gz: bae58d9f87e82dc3c39bd0c9fca4949bb2a953cf8e22a2dd56fa2d5ff057a566
+  data.tar.gz: b892f3ed57cf49cf3935a60cd8abef4f232544b0bb2abf2999ef5a557b49849f
 SHA512:
-  metadata.gz: 961a93196418591ce8d2f485697ac7cdf7bd4ef2cbf2f53eac02b0811190b324e9d035c442d6d53b48e3faa94db47c44a3b32098354e36f5348ae2b4d1351372
-  data.tar.gz: 98a28a390dda4f04d50ab4170c8e277cb7546023bcb5da0aefd242e2524a00d9beb5a91d5c28c18dc308644072911630da43437a5f2b06d96972aa3b13454175
+  metadata.gz: 320fa67da655fcb902557e784e8f1411ab94316b0c1d9e18b2890a6e25fba015ce159fe8ae6e404fbfa60273c9db3a0fdb45320abc9d72eba19a7eff8867706a
+  data.tar.gz: e6e3176e0c1cf87791bac2625ea520c339a4059f9ef474b74e16cc2ffd6bd8c1664caa35bd429e2c963d4f39167051fbaf7e391669d44cec93e7788664e5d519

data/lib/mjml-rb/ast_node.rb

@@ -1,13 +1,14 @@
 module MjmlRb
   class AstNode
-    attr_reader :tag_name, :attributes, :children, :content, :line
+    attr_reader :tag_name, :attributes, :children, :content, :line, :file
 
-    def initialize(tag_name:, attributes: {}, children: [], content: nil, line: nil)
+    def initialize(tag_name:, attributes: {}, children: [], content: nil, line: nil, file: nil)
       @tag_name = tag_name.to_s
       @attributes = attributes.transform_keys(&:to_s)
       @children = Array(children)
       @content = content
       @line = line
+      @file = file
     end
 
     def text?

data/lib/mjml-rb/parser.rb

@@ -33,7 +33,8 @@ module MjmlRb
       xml = normalize_html_void_tags(xml)
       xml = expand_includes(xml, opts) unless opts[:ignore_includes]
 
-      doc = Document.new(sanitize_bare_ampersands(xml))
+      xml = annotate_line_numbers(sanitize_bare_ampersands(xml))
+      doc = Document.new(xml)
       element_to_ast(doc.root, keep_comments: opts[:keep_comments])
     rescue ParseException => e
       raise ParseError.new("XML parse error: #{e.message}")
@@ -119,6 +120,7 @@ module MjmlRb
         fragment = Document.new(sanitize_bare_ampersands("<include-root>#{replacement}</include-root>"))
         insert_before = include_node
         fragment.root.children.each do |child|
+          annotate_include_source(child, resolved_path) if child.is_a?(Element)
           parent.insert_before(insert_before, deep_clone(child))
         end
         parent.delete(include_node)
@@ -211,6 +213,36 @@ module MjmlRb
       content.gsub(/&(?!(?:#[0-9]+|#x[0-9a-fA-F]+|[a-zA-Z][a-zA-Z0-9]*);)/, "&amp;")
     end
 
+    # Adds data-mjml-line attributes to MJML tags so line numbers survive
+    # REXML parsing (which doesn't expose source positions).
+    # Skips content inside CDATA sections to avoid modifying raw HTML.
+    def annotate_line_numbers(xml)
+      line = 1
+      xml.gsub(/(\n)|(<!\[CDATA\[.*?\]\]>)|(<(?:mj-[\w-]+|mjml)(?=[\s\/>]))/m) do
+        if Regexp.last_match(1) # newline
+          line += 1
+          "\n"
+        elsif Regexp.last_match(2) # CDATA section — count newlines, pass through
+          line += Regexp.last_match(2).count("\n")
+          Regexp.last_match(2)
+        else # opening MJML tag
+          "#{Regexp.last_match(3)} data-mjml-line=\"#{line}\""
+        end
+      end
+    end
+
+    # Recursively marks REXML elements from included files with data-mjml-file.
+    # Only sets the attribute on elements that don't already have it (preserving
+    # deeper include annotations from recursive expansion).
+    def annotate_include_source(element, file_path)
+      return unless element.is_a?(Element)
+
+      if (element.name.start_with?("mj-") || element.name == "mjml") && !element.attributes["data-mjml-file"]
+        element.add_attribute("data-mjml-file", file_path)
+      end
+      element.each_element { |child| annotate_include_source(child, file_path) }
+    end
+
     def resolve_include_path(include_path, actual_path, file_path)
       include_path = include_path.to_s
       return include_path if File.absolute_path(include_path) == include_path && File.file?(include_path)
@@ -245,16 +277,25 @@ module MjmlRb
     def element_to_ast(element, keep_comments:)
       raise ParseError, "Missing XML root element" unless element
 
+      # Extract metadata annotations (added by annotate_line_numbers / annotate_include_source)
+      # and strip them from the public attributes hash.
+      meta_line = element.attributes["data-mjml-line"]&.to_i
+      meta_file = element.attributes["data-mjml-file"]
+      attrs = element.attributes.each_with_object({}) do |(name, val), h|
+        h[name] = val unless name.start_with?("data-mjml-")
+      end
+
       # For ending-tag elements whose content was wrapped in CDATA, store
       # the raw HTML directly as content instead of parsing structurally.
       if ENDING_TAGS_FOR_CDATA.include?(element.name)
         raw_content = element.children.select { |c| c.is_a?(Text) }.map(&:value).join
         return AstNode.new(
           tag_name: element.name,
-          attributes: element.attributes.each_with_object({}) { |(name, val), h| h[name] = val },
+          attributes: attrs,
           children: [],
           content: raw_content.empty? ? nil : raw_content,
-          line: nil
+          line: meta_line,
+          file: meta_file
         )
       end
 
@@ -272,9 +313,10 @@ module MjmlRb
 
       AstNode.new(
         tag_name: element.name,
-        attributes: element.attributes.each_with_object({}) { |(name, val), h| h[name] = val },
+        attributes: attrs,
         children: children,
-        line: nil
+        line: meta_line,
+        file: meta_file
       )
     end
   end

data/lib/mjml-rb/validator.rb

@@ -64,7 +64,7 @@ module MjmlRb
 
         errors << error(
           "Element <#{child.tag_name}> is not allowed inside <#{node.tag_name}>",
-          tag_name: child.tag_name
+          tag_name: child.tag_name, line: child.line, file: child.file
         )
       end
     end
@@ -74,7 +74,8 @@ module MjmlRb
       required.each do |attr|
         next if node.attributes.key?(attr)
 
-        errors << error("Attribute `#{attr}` is required for <#{node.tag_name}>", tag_name: node.tag_name)
+        errors << error("Attribute `#{attr}` is required for <#{node.tag_name}>",
+                        tag_name: node.tag_name, line: node.line, file: node.file)
       end
     end
 
@@ -86,7 +87,8 @@ module MjmlRb
         next if allowed_attributes.key?(attribute_name)
         next if GLOBAL_ALLOWED_ATTRIBUTES.include?(attribute_name)
 
-        errors << error("Attribute `#{attribute_name}` is not allowed for <#{node.tag_name}>", tag_name: node.tag_name)
+        errors << error("Attribute `#{attribute_name}` is not allowed for <#{node.tag_name}>",
+                        tag_name: node.tag_name, line: node.line, file: node.file)
       end
     end
 
@@ -103,7 +105,7 @@ module MjmlRb
 
         errors << error(
           "Attribute `#{attribute_name}` on <#{node.tag_name}> has invalid value `#{attribute_value}` for type `#{expected_type}`",
-          tag_name: node.tag_name
+          tag_name: node.tag_name, line: node.line, file: node.file
         )
       end
     end
@@ -183,12 +185,18 @@ module MjmlRb
       end
     end
 
-    def error(message, line: nil, tag_name: nil)
+    def error(message, line: nil, tag_name: nil, file: nil)
+      location = [
+        ("line #{line}" if line),
+        ("in #{file}" if file)
+      ].compact.join(", ")
+
       {
         line: line,
+        file: file,
         message: message,
         tag_name: tag_name,
-        formatted_message: message
+        formatted_message: location.empty? ? message : "#{message} (#{location})"
       }
     end
   end

data/lib/mjml-rb/version.rb

@@ -1,3 +1,3 @@
 module MjmlRb
-  VERSION = "0.2.33".freeze
+  VERSION = "0.2.34".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mjml-rb
 version: !ruby/object:Gem::Version
-  version: 0.2.33
+  version: 0.2.34
 platform: ruby
 authors:
 - Andrei Andriichuk