mjml-rb 0.5.0 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b2c747b6f5afbc288db3ddc0afec65b3f0ff5a208bb2958abf8c9869a76790c
-  data.tar.gz: edd5d4b07c99bfd971bafadf42b11a66c0ace207cdfe835fa2643c64fc4297f9
+  metadata.gz: ffb73c167fce50a47b0513aa071f478625bd28de94a47904980746905f731e8e
+  data.tar.gz: 67977b5a7c57afb011f6e1f7f1b1de4d1872cca1847eb0f61c6413a60b93c919
 SHA512:
-  metadata.gz: 8989b98cecdb8b63d843f87dd980c409581fe11220cbb439d183768259027a04536799e1d9bc43f5f8760aef216c208ff4e0d74d01e13008f65c749f190fc99c
-  data.tar.gz: 83d310d5e9f5f92bf97da53086c56bca1baed0e9bd7495f7c8595f888b6343621e76b6dc98292db801a28c169a85720be6e8afcd674928ec9a3a4a5947d727fd
+  metadata.gz: 1eb9c9b43804484c8c0a5e89e04c83f85bcd0699ada32f6e77b566341795372386bac5fc41766bdc98d6f2844be69e6c456b461c9649971f42a4dbc97016226e
+  data.tar.gz: d49c215799a867e70ced384893081933c596ea65cc2e325782110c796f8f690b410f5a24cb1858e91c3699d635893a3ce273154cd12900575331899c108af54b

data/README.md

@@ -24,6 +24,8 @@ A pure-Ruby MJML v4 compiler — no Node.js required.
 
 ## Installation
 
+`mjml-rb` requires Ruby 3.3 or newer.
+
 ```ruby
 # Gemfile
 gem "mjml-rb"
@@ -95,7 +97,7 @@ Supports Slim and Haml via `config.mjml_rb.rails_template_language = :slim`. See
 MJML string → Parser → AST → Validator → Renderer → HTML
 ```
 
-1. **Parser** — normalizes source, expands `mj-include`, builds `AstNode` tree
+1. **Parser** — normalizes source, expands `mj-include`, produces a Nokogiri XML node tree
 2. **Validator** — checks structure, hierarchy, and attribute types
 3. **Renderer** — resolves head metadata, applies defaults, emits responsive HTML
 

data/lib/mjml-rb/components/attributes.rb

@@ -23,16 +23,16 @@ module MjmlRb
         attributes_node.element_children.each do |child|
           case child.tag_name
           when "mj-all"
-            context[:global_defaults].merge!(child.attributes)
+            context[:global_defaults].merge!(node_string_attributes(child))
           when "mj-class"
-            name = child.attributes["name"]
+            name = child["name"]
             next unless name
 
             context[:classes][name] ||= {}
-            context[:classes][name].merge!(child.attributes.reject { |key, _| key == "name" })
+            context[:classes][name].merge!(node_string_attributes(child).reject { |key, _| key == "name" })
 
             defaults = child.element_children.each_with_object({}) do |class_child, memo|
-              memo[class_child.tag_name] = class_child.attributes
+              memo[class_child.tag_name] = node_string_attributes(class_child)
             end
             next if defaults.empty?
 
@@ -40,7 +40,7 @@ module MjmlRb
             context[:classes_default][name].merge!(defaults)
           else
             context[:tag_defaults][child.tag_name] ||= {}
-            context[:tag_defaults][child.tag_name].merge!(child.attributes)
+            context[:tag_defaults][child.tag_name].merge!(node_string_attributes(child))
           end
         end
       end

data/lib/mjml-rb/components/base.rb

@@ -76,6 +76,10 @@ module MjmlRb
       def html_attrs(hash)
         renderer.send(:html_attrs, hash)
       end
+
+      def node_string_attributes(node)
+        renderer.send(:node_string_attributes, node)
+      end
     end
   end
 end

data/lib/mjml-rb/components/breakpoint.rb

@@ -18,7 +18,7 @@ module MjmlRb
       end
 
       def handle_head(node, context)
-        width = node.attributes["width"].to_s.strip
+        width = node["width"].to_s.strip
         context[:breakpoint] = width unless width.empty?
       end
     end

data/lib/mjml-rb/components/head.rb

@@ -42,14 +42,14 @@ module MjmlRb
           context[:preview] = raw_inner(node).strip
         when "mj-style"
           css = raw_inner(node)
-          if node.attributes["inline"] == "inline"
+          if node["inline"] == "inline"
             context[:inline_styles] << css
           else
             context[:user_styles] << css
           end
         when "mj-font"
-          name = node.attributes["name"]
-          href = node.attributes["href"]
+          name = node["name"]
+          href = node["href"]
           context[:fonts][name] = href if name && href
         end
       end

data/lib/mjml-rb/components/html_attributes.rb

@@ -32,16 +32,16 @@ module MjmlRb
         node.element_children.each do |selector|
           next unless selector.tag_name == "mj-selector"
 
-          path = selector.attributes["path"].to_s.strip
+          path = selector["path"].to_s.strip
           next if path.empty?
 
           custom_attrs = selector.element_children.each_with_object({}) do |child, memo|
             next unless child.tag_name == "mj-html-attribute"
 
-            name = child.attributes["name"].to_s.strip
+            name = child["name"].to_s.strip
             next if name.empty?
 
-            memo[name] = child.text_content
+            memo[name] = child.content
           end
           next if custom_attrs.empty?
 

data/lib/mjml-rb/components/social.rb

@@ -237,7 +237,7 @@ module MjmlRb
 
       def render_social_element(node, attrs)
         a        = attrs # already merged with defaults by caller
-        net_name = node.attributes["name"]
+        net_name = node["name"]
         network  = SOCIAL_NETWORKS[net_name] || {}
 
         # Resolve href: if network has a share-url, substitute [[URL]] with the raw href
@@ -325,7 +325,7 @@ module MjmlRb
         HTML
 
         # Content cell (text)
-        content = node.text_content.strip
+        content = node.content.strip
         content_cell = if content.empty?
                          ""
                        else

data/lib/mjml-rb/components/table.rb

@@ -130,7 +130,7 @@ module MjmlRb
       end
 
       def normalize_table_node_attributes(node)
-        attrs = node.attributes.dup
+        attrs = node_string_attributes(node).dup
         style_map = parse_style_map(attrs["style"])
 
         if %w[table td th a].include?(node.tag_name)

data/lib/mjml-rb/node_compat.rb

@@ -0,0 +1,15 @@
+require "nokogiri"
+
+module MjmlRb
+  module NodeCompat
+    def tag_name
+      name
+    end
+
+    def file
+      self["data-mjml-file"]
+    end
+  end
+end
+
+Nokogiri::XML::Node.prepend(MjmlRb::NodeCompat)

data/lib/mjml-rb/parser.rb

@@ -1,6 +1,6 @@
 require "nokogiri"
 
-require_relative "ast_node"
+require_relative "node_compat"
 
 module MjmlRb
   class Parser
@@ -57,7 +57,8 @@ module MjmlRb
       xml = replace_html_entities(xml)
       doc = Nokogiri::XML(xml) { |config| config.strict }
       normalize_root_head_elements(doc)
-      element_to_ast(doc.root, keep_comments: opts[:keep_comments])
+      prepare_node(doc.root, keep_comments: opts[:keep_comments])
+      doc.root
     rescue Nokogiri::XML::SyntaxError => e
       raise ParseError.new("XML parse error: #{e.message}")
     end
@@ -402,55 +403,37 @@ module MjmlRb
       raise Errno::ENOENT, include_path
     end
 
-    def element_to_ast(element, keep_comments:)
+    def prepare_node(element, keep_comments:)
       raise ParseError, "Missing XML root element" unless element
 
-      # Extract metadata annotations (added by annotate_include_source)
-      # and strip them from the public attributes hash.
-      # Line numbers come from Nokogiri's native node.line.
-      meta_line = element.line
-      meta_file = element["data-mjml-file"]
-      attrs = {}
-      element.attributes.each do |name, attr|
-        attrs[name] = attr.value unless name.start_with?("data-mjml-")
+      # Mark non-mj elements for raw HTML handling
+      unless element.name.start_with?("mj-") || element.name == "mjml"
+        element["data-mjml-raw"] = "true"
       end
-      attrs["data-mjml-raw"] = "true" unless element.name.start_with?("mj-") || element.name == "mjml"
 
-      # For ending-tag elements whose content was wrapped in CDATA, store
-      # the raw HTML directly as content instead of parsing structurally.
+      # For ending-tag elements whose content was wrapped in CDATA,
+      # mark them so raw_inner knows to extract content directly.
       if ENDING_TAGS_FOR_CDATA.include?(element.name)
-        raw_content = element.children.select { |c| c.cdata? || c.text? }.map(&:content).join
-        return AstNode.new(
-          tag_name: element.name,
-          attributes: attrs,
-          children: [],
-          content: raw_content.empty? ? nil : raw_content,
-          line: meta_line,
-          file: meta_file
-        )
+        element["data-mjml-ending-tag"] = "true"
+        return
       end
 
-      children = element.children.each_with_object([]) do |child, memo|
+      # Strip ignorable whitespace text nodes, unwanted comments,
+      # and recurse into element children.
+      element.children.to_a.each do |child|
         if child.element?
-          memo << element_to_ast(child, keep_comments: keep_comments)
+          prepare_node(child, keep_comments: keep_comments)
         elsif child.text? || child.cdata?
           text = child.content
-          next if text.empty?
-          next if text.strip.empty? && ignorable_whitespace_text?(text, parent_element_name: element.name)
-
-          memo << AstNode.new(tag_name: "#text", content: text)
+          if text.empty? || (text.strip.empty? && ignorable_whitespace_text?(text, parent_element_name: element.name))
+            child.remove
+          end
         elsif child.comment?
-          memo << AstNode.new(tag_name: "#comment", content: child.content) if keep_comments
+          child.remove unless keep_comments
+        else
+          child.remove
         end
       end
-
-      AstNode.new(
-        tag_name: element.name,
-        attributes: attrs,
-        children: children,
-        line: meta_line,
-        file: meta_file
-      )
     end
 
     # Lenient XML parse used during include expansion and intermediate steps.

data/lib/mjml-rb/renderer.rb

@@ -26,8 +26,6 @@ require_relative "components/spacer"
 
 module MjmlRb
   class Renderer
-    HTML_VOID_TAGS = Set.new(%w[area base br col embed hr img input link meta param source track wbr]).freeze
-
     DEFAULT_FONTS = {
       "Open Sans" => "https://fonts.googleapis.com/css?family=Open+Sans:300,400,500,700",
       "Droid Sans" => "https://fonts.googleapis.com/css?family=Droid+Sans:300,400,500,700",
@@ -72,9 +70,9 @@ module MjmlRb
 
       context = build_context(head, options)
       context[:before_doctype] = root_file_start_raw(document)
-      context[:lang] = options[:lang] || document.attributes["lang"] || "und"
-      context[:dir] = options[:dir] || document.attributes["dir"] || "auto"
-      context[:force_owa_desktop] = document.attributes["owa"] == "desktop"
+      context[:lang] = options[:lang] || document["lang"] || "und"
+      context[:dir] = options[:dir] || document["dir"] || "auto"
+      context[:force_owa_desktop] = document["owa"] == "desktop"
       context[:printer_support] = options[:printer_support] || options[:printerSupport]
       context[:column_widths] = {}
       append_component_head_styles(document, context)
@@ -227,7 +225,7 @@ module MjmlRb
       return [100] if total == 0
 
       widths = columns.map do |col|
-        w = col.attributes["width"]
+        w = col["width"]
         if w && w.to_s =~ /(\d+(?:\.\d+)?)\s*%/
           $1.to_f
         elsif w && w.to_s =~ /(\d+(?:\.\d+)?)\s*px/
@@ -670,7 +668,7 @@ module MjmlRb
       attrs.merge!(context[:global_defaults] || {})
       attrs.merge!(context[:tag_defaults][node.tag_name] || {})
 
-      node_classes = node.attributes["mj-class"].to_s.split(/\s+/).reject(&:empty?)
+      node_classes = node["mj-class"].to_s.split(/\s+/).reject(&:empty?)
       class_attrs = node_classes.each_with_object({}) do |klass, memo|
         mj_class_attrs = (context[:classes] || {})[klass] || {}
         if memo["css-class"] && mj_class_attrs["css-class"]
@@ -685,43 +683,29 @@ module MjmlRb
         attrs.merge!(((context[:classes_default] || {})[klass] || {})[node.tag_name] || {})
       end
 
-      attrs.merge!(node.attributes)
+      attrs.merge!(node_string_attributes(node))
       attrs
     end
 
     def html_inner(node)
-      if node.respond_to?(:children)
-        node.children.map do |child|
-          if child.text?
-            serialize_text_content(escape_html(child.content.to_s))
-          elsif child.comment?
-            "<!--#{child.content}-->"
-          else
-            serialize_node(child)
-          end
-        end.join
-      else
-        escape_html(node.text_content)
-      end
+      node.inner_html
     end
 
     def raw_inner(node)
-      # For ending-tag nodes whose content was preserved as raw HTML by the parser
-      return node.content if node.element? && node.content
-
-      if node.respond_to?(:children)
-        node.children.map do |child|
-          if child.text?
-            serialize_text_content(child.content.to_s)
-          elsif child.comment?
-            "<!--#{child.content}-->"
-          else
-            serialize_node(child)
-          end
-        end.join
-      else
-        node.text_content
+      # For ending-tag nodes whose content was preserved as raw HTML by the parser.
+      # The parser marks these with data-mjml-ending-tag; their children are CDATA
+      # nodes containing the raw HTML content.
+      if node.element? && node["data-mjml-ending-tag"]
+        return node.children.select { |c| c.cdata? || c.text? }.map(&:content).join
       end
+
+      node.children.map do |child|
+        if child.text?
+          child.content.to_s
+        else
+          child.to_html
+        end
+      end.join
     end
 
     def annotate_raw_html(content)
@@ -750,30 +734,6 @@ module MjmlRb
       text.to_s.gsub(" ", "&#32;").gsub("\t", "&#9;")
     end
 
-    def serialize_node(node)
-      attrs = node.attributes.map { |k, v| %( #{k}="#{escape_attr(v)}") }.join
-      return "<#{node.tag_name}#{attrs} />" if node.children.empty? && html_void_tag?(node.tag_name)
-      return "<#{node.tag_name}#{attrs}></#{node.tag_name}>" if node.children.empty?
-
-      inner = node.children.map { |child| child.text? ? serialize_text_content(child.content.to_s) : serialize_node(child) }.join
-      "<#{node.tag_name}#{attrs}>#{inner}</#{node.tag_name}>"
-    end
-
-    def serialize_text_content(text)
-      value = text.to_s
-      return value unless significant_whitespace_text?(value)
-
-      value.gsub(" ", "&#32;").gsub("\t", "&#9;")
-    end
-
-    def significant_whitespace_text?(text)
-      !text.empty? && text.strip.empty? && !text.match?(/[\r\n]/)
-    end
-
-    def html_void_tag?(tag_name)
-      HTML_VOID_TAGS.include?(tag_name.to_s.downcase)
-    end
-
     def style_join(hash)
       hash.each_with_object([]) do |(key, value), memo|
         next if value.nil? || value.to_s.empty?
@@ -791,7 +751,7 @@ module MjmlRb
 
     def with_inherited_mj_class(context, node)
       previous = context[:inherited_mj_class]
-      current = node.attributes["mj-class"]
+      current = node["mj-class"]
       context[:inherited_mj_class] = (current && !current.empty?) ? current : previous
       yield
     ensure
@@ -801,7 +761,7 @@ module MjmlRb
     def root_file_start_raw(document)
       document.element_children.filter_map do |child|
         next unless child.tag_name == "mj-raw"
-        next unless child.attributes["position"] == "file-start"
+        next unless child["position"] == "file-start"
 
         raw_inner(child)
       end.join("\n")
@@ -815,6 +775,20 @@ module MjmlRb
       result
     end
 
+    # Internal-only attributes set by the parser for metadata tracking.
+    # These are excluded from the public attributes hash; data-mjml-raw
+    # is intentionally kept because it is used by the rendering pipeline.
+    INTERNAL_ATTRIBUTES = %w[data-mjml-file data-mjml-ending-tag].freeze
+
+    def node_string_attributes(node)
+      result = {}
+      node.attributes.each do |name, attr|
+        next if INTERNAL_ATTRIBUTES.include?(name)
+        result[name] = attr.respond_to?(:value) ? attr.value : attr.to_s
+      end
+      result
+    end
+
     def escape_html(value)
       CGI.escapeHTML(value.to_s)
     end

data/lib/mjml-rb/validator.rb

@@ -16,7 +16,7 @@ module MjmlRb
     end
 
     def validate(mjml_or_ast, options = {})
-      root = mjml_or_ast.is_a?(AstNode) ? mjml_or_ast : parse_ast(mjml_or_ast, options)
+      root = mjml_or_ast.is_a?(Nokogiri::XML::Node) ? mjml_or_ast : parse_ast(mjml_or_ast, options)
       unless root&.tag_name == "mjml"
         return { errors: [error("Root element must be <mjml>", tag_name: root&.tag_name)], warnings: [] }
       end
@@ -97,7 +97,7 @@ module MjmlRb
     def validate_required_attributes(node, errors)
       required = REQUIRED_BY_TAG[node.tag_name] || []
       required.each do |attr|
-        next if node.attributes.key?(attr)
+        next if node.has_attribute?(attr)
 
         errors << error("Attribute `#{attr}` is required for <#{node.tag_name}>",
                         tag_name: node.tag_name, line: node.line, file: node.file)
@@ -108,7 +108,7 @@ module MjmlRb
       allowed_attributes = allowed_attributes_for(node.tag_name)
       return if allowed_attributes.empty?
 
-      node.attributes.each_key do |attribute_name|
+      string_attrs(node).each_key do |attribute_name|
         next if allowed_attributes.key?(attribute_name)
         next if GLOBAL_ALLOWED_ATTRIBUTES.include?(attribute_name)
 
@@ -121,7 +121,7 @@ module MjmlRb
       allowed_attributes = allowed_attributes_for(node.tag_name)
       return if allowed_attributes.empty?
 
-      node.attributes.each do |attribute_name, attribute_value|
+      string_attrs(node).each do |attribute_name, attribute_value|
         next if GLOBAL_ALLOWED_ATTRIBUTES.include?(attribute_name)
 
         expected_type = allowed_attributes[attribute_name]
@@ -218,6 +218,17 @@ module MjmlRb
       end
     end
 
+    INTERNAL_ATTRIBUTES = %w[data-mjml-file data-mjml-ending-tag data-mjml-raw].freeze
+
+    def string_attrs(node)
+      result = {}
+      node.attributes.each do |name, attr|
+        next if INTERNAL_ATTRIBUTES.include?(name)
+        result[name] = attr.respond_to?(:value) ? attr.value : attr.to_s
+      end
+      result
+    end
+
     def error(message, line: nil, tag_name: nil, file: nil)
       location = [
         ("line #{line}" if line),

data/lib/mjml-rb/version.rb

@@ -1,3 +1,3 @@
 module MjmlRb
-  VERSION = "0.5.0".freeze
+  VERSION = "0.5.2".freeze
 end

data/lib/mjml-rb.rb

@@ -1,6 +1,6 @@
 require_relative "mjml-rb/version"
 require_relative "mjml-rb/result"
-require_relative "mjml-rb/ast_node"
+require_relative "mjml-rb/node_compat"
 require_relative "mjml-rb/dependencies"
 require_relative "mjml-rb/component_registry"
 require_relative "mjml-rb/config_file"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mjml-rb
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.2
 platform: ruby
 authors:
 - Andrei Andriichuk
@@ -51,7 +51,6 @@ files:
 - Rakefile
 - bin/mjml
 - lib/mjml-rb.rb
-- lib/mjml-rb/ast_node.rb
 - lib/mjml-rb/cli.rb
 - lib/mjml-rb/compiler.rb
 - lib/mjml-rb/component_registry.rb
@@ -80,6 +79,7 @@ files:
 - lib/mjml-rb/components/text.rb
 - lib/mjml-rb/config_file.rb
 - lib/mjml-rb/dependencies.rb
+- lib/mjml-rb/node_compat.rb
 - lib/mjml-rb/parser.rb
 - lib/mjml-rb/railtie.rb
 - lib/mjml-rb/renderer.rb

data/lib/mjml-rb/ast_node.rb

@@ -1,37 +0,0 @@
-module MjmlRb
-  class AstNode
-    attr_reader :tag_name, :attributes, :children, :content, :line, :file
-
-    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?
-      @tag_name == "#text"
-    end
-
-    def comment?
-      @tag_name == "#comment"
-    end
-
-    def element?
-      !text? && !comment?
-    end
-
-    def text_content
-      return @content.to_s if text?
-      result = +""
-      @children.each { |child| result << child.text_content }
-      result
-    end
-
-    def element_children
-      @element_children ||= @children.select(&:element?)
-    end
-  end
-end