mjml-rb 0.2.34 → 0.2.36

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bae58d9f87e82dc3c39bd0c9fca4949bb2a953cf8e22a2dd56fa2d5ff057a566
-  data.tar.gz: b892f3ed57cf49cf3935a60cd8abef4f232544b0bb2abf2999ef5a557b49849f
+  metadata.gz: 2075cd423603c4070dae0acdbecf052f474931e96c079d6369eabbefb505306c
+  data.tar.gz: 1d5fd4664d222e546cbf61c51f1e8fbe6e76880d9e1e0eb858cce266cec58989
 SHA512:
-  metadata.gz: 320fa67da655fcb902557e784e8f1411ab94316b0c1d9e18b2890a6e25fba015ce159fe8ae6e404fbfa60273c9db3a0fdb45320abc9d72eba19a7eff8867706a
-  data.tar.gz: e6e3176e0c1cf87791bac2625ea520c339a4059f9ef474b74e16cc2ffd6bd8c1664caa35bd429e2c963d4f39167051fbaf7e391669d44cec93e7788664e5d519
+  metadata.gz: 3e82ec6fe3d8af7361b3fe5691eed18449724f3b4fc5c2318077ccfe5f406b20bed0f8aaa724a059d2298a53d8a4a04a470ee2484ab259f007d5a67fa4da8e08
+  data.tar.gz: a09686d9b4cffab082e5c3bb0a7b3049c2702e857eaec5234aa3185c1cb8b47949e772711470ea29b9d0884932c7b5a9bc62016bcb76f8a96fd348d2688eee18

data/Gemfile

@@ -1,3 +1,5 @@
 source "https://rubygems.org"
 
 gemspec
+
+gem "minitest", group: :test

data/README.md

@@ -46,4 +46,4 @@ bundle exec bin/mjml --migrate old.mjml -s
 > MJML templates the same way you render ERB — no extra runtime, no
 > `package.json`, no `node_modules`.
 
-Remaining parity work is tracked in [doc/TODO.md](/doc/TODO.md).
+Remaining parity work is tracked in [npm ↔ Ruby Parity Audit](/docs/PARITY_AUDIT.md).

data/lib/mjml-rb/compiler.rb

@@ -10,6 +10,7 @@ module MjmlRb
       minify: false,
       keep_comments: true,
       ignore_includes: false,
+      printer_support: false,
       preprocessors: [],
       validation_level: "soft",
       file_path: ".",

data/lib/mjml-rb/parser.rb

@@ -66,6 +66,7 @@ module MjmlRb
       return xml if includes.empty?
 
       css_includes = []
+      head_includes = []
 
       includes.reverse_each do |include_node|
         path_attr = include_node.attributes["path"]
@@ -109,23 +110,34 @@ module MjmlRb
         replacement = if include_type == "html"
                         %(<mj-raw><![CDATA[#{escape_cdata(include_content)}]]></mj-raw>)
                       else
-                        prepared = wrap_ending_tags_in_cdata(normalize_html_void_tags(strip_xml_declaration(include_content)))
-                        # Recursively expand includes in the included content
-                        expand_includes(prepared, options.merge(
+                        prepared = prepare_mjml_include_document(include_content)
+                        prepared = wrap_ending_tags_in_cdata(normalize_html_void_tags(prepared))
+                        expanded = expand_includes(prepared, options.merge(
                           actual_path: resolved_path,
                           file_path: File.dirname(resolved_path)
                         ), included_in + [resolved_path])
+                        body_children, include_head_children = extract_mjml_include_children(expanded)
+                        head_includes.unshift(*include_head_children)
+                        body_children
                       end
 
-        fragment = Document.new(sanitize_bare_ampersands("<include-root>#{replacement}</include-root>"))
         insert_before = include_node
-        fragment.root.children.each do |child|
+        replacement_nodes = if replacement.is_a?(Array)
+                              replacement
+                            else
+                              fragment = Document.new(sanitize_bare_ampersands("<include-root>#{replacement}</include-root>"))
+                              fragment.root.children.map { |child| deep_clone(child) }
+                            end
+
+        replacement_nodes.each do |child|
           annotate_include_source(child, resolved_path) if child.is_a?(Element)
-          parent.insert_before(insert_before, deep_clone(child))
+          parent.insert_before(insert_before, child)
         end
         parent.delete(include_node)
       end
 
+      inject_head_includes(doc, head_includes) unless head_includes.empty?
+
       # Inject CSS includes into mj-head
       unless css_includes.empty?
         inject_css_includes(doc, css_includes)
@@ -138,22 +150,34 @@ module MjmlRb
       raise ParseError, "Failed to parse included content: #{e.message}"
     end
 
-    def inject_css_includes(doc, css_includes)
-      mjml_root = doc.root
-      return unless mjml_root
+    def prepare_mjml_include_document(content)
+      stripped = strip_xml_declaration(content)
+      return stripped if stripped.match?(/<mjml(?=[\s>])/i)
+
+      "<mjml><mj-body>#{stripped}</mj-body></mjml>"
+    end
+
+    def extract_mjml_include_children(xml)
+      include_doc = Document.new(sanitize_bare_ampersands(xml))
+      mjml_root = include_doc.root
+      return [[], []] unless mjml_root&.name == "mjml"
 
-      # Find or create mj-head
+      body = XPath.first(mjml_root, "mj-body")
       head = XPath.first(mjml_root, "mj-head")
-      unless head
-        head = Element.new("mj-head")
-        # Insert mj-head before mj-body if possible
-        body = XPath.first(mjml_root, "mj-body")
-        if body
-          mjml_root.insert_before(body, head)
-        else
-          mjml_root.add(head)
-        end
-      end
+
+      [
+        body ? body.children.map { |child| deep_clone(child) } : [],
+        head ? head.children.map { |child| deep_clone(child) } : []
+      ]
+    end
+
+    def inject_head_includes(doc, head_includes)
+      head = ensure_head(doc)
+      head_includes.each { |child| head.add(child) }
+    end
+
+    def inject_css_includes(doc, css_includes)
+      head = ensure_head(doc)
 
       # Add each CSS include as an mj-style element
       css_includes.each do |css_include|
@@ -164,6 +188,23 @@ module MjmlRb
       end
     end
 
+    def ensure_head(doc)
+      mjml_root = doc.root
+      return unless mjml_root
+
+      head = XPath.first(mjml_root, "mj-head")
+      return head if head
+
+      head = Element.new("mj-head")
+      body = XPath.first(mjml_root, "mj-body")
+      if body
+        mjml_root.insert_before(body, head)
+      else
+        mjml_root.add(head)
+      end
+      head
+    end
+
     def strip_xml_declaration(content)
       content.sub(/\A<\?xml[^>]*\?>\s*/m, "")
     end

data/lib/mjml-rb/renderer.rb

@@ -27,7 +27,11 @@ module MjmlRb
     HTML_VOID_TAGS = %w[area base br col embed hr img input link meta param source track wbr].freeze
 
     DEFAULT_FONTS = {
-      "Roboto" => "https://fonts.googleapis.com/css?family=Roboto:300,400,500,700"
+      "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",
+      "Lato" => "https://fonts.googleapis.com/css?family=Lato:300,400,500,700",
+      "Roboto" => "https://fonts.googleapis.com/css?family=Roboto:300,400,500,700",
+      "Ubuntu" => "https://fonts.googleapis.com/css?family=Ubuntu:300,400,500,700"
     }.freeze
 
     DOCUMENT_RESET_CSS = <<~CSS.freeze
@@ -68,6 +72,8 @@ module MjmlRb
       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[:printer_support] = options[:printer_support] || options[:printerSupport]
       context[:column_widths] = {}
       append_component_head_styles(document, context)
       content = render_node(body, context, parent: "mjml")
@@ -106,15 +112,21 @@ module MjmlRb
     end
 
     def build_html_document(content, context)
+      content = minify_outlook_conditionals(content)
       title = context[:title].to_s
       preview = context[:preview]
       head_raw = Array(context[:head_raw]).join("\n")
       before_doctype = context[:before_doctype].to_s
       font_tags = build_font_tags(content, context[:inline_styles], context[:fonts])
-      media_queries_tags = build_media_queries_tags(context[:breakpoint], context[:column_widths])
+      media_queries_tags = build_media_queries_tags(
+        context[:breakpoint],
+        context[:column_widths],
+        force_owa_desktop: context[:force_owa_desktop],
+        printer_support: context[:printer_support]
+      )
       component_styles_tag = build_style_tag(unique_strings(context[:component_head_styles]))
       user_styles_tag = build_style_tag(unique_strings(context[:user_styles]))
-      preview_block = preview.empty? ? "" : %(<div style="display:none;max-height:0;overflow:hidden;opacity:0;">#{escape_html(preview)}</div>)
+      preview_block = preview.empty? ? "" : %(<div style="display:none;font-size:1px;color:#ffffff;line-height:1px;max-height:0px;max-width:0px;opacity:0;overflow:hidden;">#{escape_html(preview)}</div>)
       html_attributes = {
         "lang" => context[:lang],
         "dir" => context[:dir],
@@ -122,7 +134,10 @@ module MjmlRb
         "xmlns:v" => "urn:schemas-microsoft-com:vml",
         "xmlns:o" => "urn:schemas-microsoft-com:office:office"
       }
-      body_style = style_join("word-spacing" => "normal")
+      body_style = style_join(
+        "word-spacing" => "normal",
+        "background-color" => context[:background_color]
+      )
 
       html = <<~HTML
         <!doctype html>
@@ -133,7 +148,6 @@ module MjmlRb
             <meta http-equiv="X-UA-Compatible" content="IE=edge">
             <!--<![endif]-->
             <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-            <meta charset="utf-8">
             <meta name="viewport" content="width=device-width, initial-scale=1">
             <style type="text/css">#{DOCUMENT_RESET_CSS}</style>
             #{OUTLOOK_DOCUMENT_SETTINGS}
@@ -153,6 +167,7 @@ module MjmlRb
 
       html = apply_html_attributes(html, context)
       html = apply_inline_styles(html, context)
+      html = merge_outlook_conditionals(html)
       before_doctype.empty? ? html : "#{before_doctype}\n#{html}"
     end
 
@@ -231,7 +246,7 @@ module MjmlRb
       end
     end
 
-    def build_media_queries_tags(breakpoint, column_widths)
+    def build_media_queries_tags(breakpoint, column_widths, force_owa_desktop: false, printer_support: false)
       widths = column_widths || {}
       return "" if widths.empty?
 
@@ -256,7 +271,13 @@ module MjmlRb
         parts << "<style media=\"screen and (min-width:#{bp})\">\n#{moz_rules.join("\n")}\n</style>"
       end
 
-      parts << "<style type=\"text/css\">\n#{owa_rules.join("\n")}\n</style>"
+      if printer_support
+        parts << "<style type=\"text/css\">\n@media only print {\n#{base_rules.join("\n")}\n}\n</style>"
+      end
+
+      if force_owa_desktop
+        parts << "<style type=\"text/css\">\n#{owa_rules.join("\n")}\n</style>"
+      end
       parts.join("\n")
     end
 
@@ -272,6 +293,20 @@ module MjmlRb
       html.gsub(/<!\[endif\]-->\s*<!--\[if mso \| IE\]>/m, "")
     end
 
+    def minify_outlook_conditionals(html)
+      html.gsub(/(<!--\[if\s[^\]]+\]>)([\s\S]*?)(<!\[endif\]-->)/m) do
+        prefix = Regexp.last_match(1)
+        content = Regexp.last_match(2)
+        suffix = Regexp.last_match(3)
+
+        processed = content
+                    .gsub(/(^|>)(\s+)(<|$)/m, '\1\3')
+                    .gsub(/\s{2,}/m, " ")
+
+        "#{prefix}#{processed}#{suffix}"
+      end
+    end
+
     def apply_html_attributes(html, context)
       rules = context[:html_attributes] || {}
       return html if rules.empty?

data/lib/mjml-rb/validator.rb

@@ -43,14 +43,26 @@ module MjmlRb
     def walk(node, errors)
       return unless node.element?
 
+      validate_known_tag(node, errors)
       validate_allowed_children(node, errors)
       validate_required_attributes(node, errors)
       validate_supported_attributes(node, errors)
       validate_attribute_types(node, errors)
 
+      return if Dependencies::ENDING_TAGS.include?(node.tag_name)
+
       node.element_children.each { |child| walk(child, errors) }
     end
 
+    def validate_known_tag(node, errors)
+      return if known_tag?(node.tag_name)
+
+      errors << error(
+        "Element <#{node.tag_name}> doesn't exist or is not registered",
+        tag_name: node.tag_name, line: node.line, file: node.file
+      )
+    end
+
     def validate_allowed_children(node, errors)
       # Ending-tag components treat content as raw HTML; REXML still parses
       # children structurally, so skip child validation for those tags.
@@ -130,6 +142,10 @@ module MjmlRb
       end.find { |klass| klass.tags.include?(tag_name) }
     end
 
+    def known_tag?(tag_name)
+      tag_name == "mjml" || !component_class_for_tag(tag_name).nil?
+    end
+
     def valid_attribute_value?(value, expected_type)
       return true if value.nil?
 

data/lib/mjml-rb/version.rb

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

metadata

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