mjml-rb 0.2.2 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8065e65f3045ffc642525cb247d79591a4c1c2cd3d57541ec768dc2d0fec6ef9
-  data.tar.gz: 304dc0c8474a87438378344264bcc4e56e27052ea9e09d6003352a3c94f3dd4e
+  metadata.gz: 4bb6667d87d9376e60199a47e987e10cfb496be78c4bd549f71fa049c2618aff
+  data.tar.gz: 98f63a171ea6a2d5b1dd6212c86a13cdd2eabf71c1ab9f12d15f8c83a04e30d2
 SHA512:
-  metadata.gz: a9bc2dd17fe59a21d311aca96332ba32a5c09222641bf566518e9aa856f5a9f45121d72ed6b53f74217cf26b61a3378d2f800abe482a772585e0353eb8b5627b
-  data.tar.gz: 90991a406d6ecc5ed614d0a12a6bba3094bb0c72535407fcf709e5e5d9bceab802d137e85e319ac47aa57ad3c5ab4bf58fddbd8524996468cdeb18ebb521d30e
+  metadata.gz: 33c9d050ef8ebd560b92a513391957c9fd2ebea43023d3977c5c06fe154bc7eef1bf6646abbf555dcbf6f53d4900461cceb89daaf0e3b2be36d3e08cec445b38
+  data.tar.gz: 839a5ddbe4448b2c86b9b015d59468e8f2553a78432cf6371bdb6d061c850568850bde0316fd9be6ac548a0bc17715900d233cd1538cff03785383f29d960240

data/README.md

@@ -8,6 +8,8 @@
 > and not all components or attributes are fully implemented yet.
 > **Do not use in production without thorough testing of every template against
 > the official npm renderer.** API and output format may change without notice.
+> This is a **fully open source project**, and help is welcome:
+> feedback, bug reports, test cases, optimizations, proposals, and pull requests.
 > No warranty of any kind is provided.
 
 This directory contains a Ruby-first implementation of the main MJML user-facing tooling:
@@ -60,9 +62,9 @@ The table below tracks current JS-to-Ruby migration status for MJML components i
 | `mj-navbar-link` | migrated | Implemented in `navbar.rb` as an ending-tag navbar child component. |
 | `mj-raw` | migrated | Implemented in `raw.rb`, including head insertion and top-level `position="file-start"` output before the doctype. |
 | `mj-head` | partial | Core tags such as `mj-title`, `mj-preview`, `mj-style`, `mj-font`, and `mj-attributes` are supported. |
-| `mj-attributes` | partial | `mj-all`, `mj-class`, and per-tag defaults are supported. |
+| `mj-attributes` | migrated | Implemented in `attributes.rb`, including npm-style `mj-class` descendant defaults. |
 | `mj-all` | partial | Supported through `mj-attributes`. |
-| `mj-class` | partial | Supported through `mj-attributes`. |
+| `mj-class` | migrated | Supported through `attributes.rb`, including nested per-tag descendant defaults. |
 | `mj-title` | partial | Supported through head context. |
 | `mj-preview` | partial | Supported through head context. |
 | `mj-style` | partial | Supported, including inline CSS application. |

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

@@ -94,16 +94,18 @@ module MjmlRb
           "border-bottom" => "none",
           "font-family" => accordion_attrs["font-family"]
         )
-        inner = node.element_children.map do |child|
-          case child.tag_name
-          when "mj-accordion-element"
-            render_accordion_element(child, context, accordion_attrs)
-          when "mj-raw"
-            raw_inner(child)
-          else
-            render_node(child, context, parent: "mj-accordion")
-          end
-        end.join
+        inner = with_inherited_mj_class(context, node) do
+          node.element_children.map do |child|
+            case child.tag_name
+            when "mj-accordion-element"
+              render_accordion_element(child, context, accordion_attrs)
+            when "mj-raw"
+              raw_inner(child)
+            else
+              render_node(child, context, parent: "mj-accordion")
+            end
+          end.join
+        end
 
         %(<tr><td style="#{outer_style}"><table role="presentation" width="100%" cellspacing="0" cellpadding="0" class="mj-accordion" style="#{table_style}"><tbody>#{inner}</tbody></table></td></tr>)
       end
@@ -125,16 +127,18 @@ module MjmlRb
         content = []
         content << render_accordion_title(nil, attrs) unless has_title
 
-        children.each do |child|
-          case child.tag_name
-          when "mj-accordion-title"
-            child_attrs = attrs.merge(resolved_attributes(child, context))
-            content << render_accordion_title(child, child_attrs)
-          when "mj-accordion-text"
-            child_attrs = attrs.merge(resolved_attributes(child, context))
-            content << render_accordion_text(child, child_attrs)
-          when "mj-raw"
-            content << raw_inner(child)
+        with_inherited_mj_class(context, node) do
+          children.each do |child|
+            case child.tag_name
+            when "mj-accordion-title"
+              child_attrs = attrs.merge(resolved_attributes(child, context))
+              content << render_accordion_title(child, child_attrs)
+            when "mj-accordion-text"
+              child_attrs = attrs.merge(resolved_attributes(child, context))
+              content << render_accordion_text(child, child_attrs)
+            when "mj-raw"
+              content << raw_inner(child)
+            end
           end
         end
         content << render_accordion_text(nil, attrs) unless has_text

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

@@ -0,0 +1,53 @@
+require_relative "base"
+
+module MjmlRb
+  module Components
+    class Attributes < Base
+      TAGS = %w[mj-attributes mj-all mj-class].freeze
+
+      class << self
+        def allowed_attributes_for(tag_name)
+          {}
+        end
+
+        def allowed_attributes
+          {}
+        end
+      end
+
+      def tags
+        TAGS
+      end
+
+      def render(tag_name:, node:, context:, attrs:, parent:)
+        ""
+      end
+
+      def handle_head(attributes_node, context)
+        attributes_node.element_children.each do |child|
+          case child.tag_name
+          when "mj-all"
+            context[:global_defaults].merge!(child.attributes)
+          when "mj-class"
+            name = child.attributes["name"]
+            next unless name
+
+            context[:classes][name] ||= {}
+            context[:classes][name].merge!(child.attributes.reject { |key, _| key == "name" })
+
+            defaults = child.element_children.each_with_object({}) do |class_child, memo|
+              memo[class_child.tag_name] = class_child.attributes
+            end
+            next if defaults.empty?
+
+            context[:classes_default][name] ||= {}
+            context[:classes_default][name].merge!(defaults)
+          else
+            context[:tag_defaults][child.tag_name] ||= {}
+            context[:tag_defaults][child.tag_name].merge!(child.attributes)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -45,6 +45,10 @@ module MjmlRb
         renderer.send(:resolved_attributes, node, context)
       end
 
+      def with_inherited_mj_class(context, node, &block)
+        renderer.send(:with_inherited_mj_class, context, node, &block)
+      end
+
       def raw_inner(node)
         renderer.send(:raw_inner, node)
       end

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

@@ -164,14 +164,16 @@ module MjmlRb
       end
 
       def render_navbar_children(node, context)
-        node.element_children.map do |child|
-          case child.tag_name
-          when "mj-navbar-link", "mj-raw"
-            render_node(child, context, parent: "mj-navbar")
-          else
-            ""
-          end
-        end.join
+        with_inherited_mj_class(context, node) do
+          node.element_children.map do |child|
+            case child.tag_name
+            when "mj-navbar-link", "mj-raw"
+              render_node(child, context, parent: "mj-navbar")
+            else
+              ""
+            end
+          end.join
+        end
       end
 
       def render_navbar_link(node, context, attrs, parent:)

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

@@ -224,22 +224,24 @@ module MjmlRb
         close_tr    = %(<!--[if mso | IE]></tr><![endif]-->)
         close_table = %(<!--[if mso | IE]></table><![endif]-->)
 
-        col_parts = columns.each_with_index.map do |col, i|
-          col_attrs = resolved_attributes(col, context)
-          v_align   = col_attrs["vertical-align"] || "top"
-          col_px    = (box_width.to_f * widths[i] / 100.0).round
-
-          td_open  = %(<!--[if mso | IE]><td class="" style="vertical-align:#{v_align};width:#{col_px}px;" ><![endif]-->)
-          td_close = %(<!--[if mso | IE]></td><![endif]-->)
-
-          col_html = if col.tag_name == "mj-group"
-                       renderer.send(:render_group, col, context, widths[i])
-                     else
-                       context[:_column_width_pct] = widths[i]
-                       render_node(col, context, parent: "mj-section")
-                     end
-
-          "#{td_open}\n#{col_html}\n#{td_close}"
+        col_parts = with_inherited_mj_class(context, node) do
+          columns.each_with_index.map do |col, i|
+            col_attrs = resolved_attributes(col, context)
+            v_align   = col_attrs["vertical-align"] || "top"
+            col_px    = (box_width.to_f * widths[i] / 100.0).round
+
+            td_open  = %(<!--[if mso | IE]><td class="" style="vertical-align:#{v_align};width:#{col_px}px;" ><![endif]-->)
+            td_close = %(<!--[if mso | IE]></td><![endif]-->)
+
+            col_html = if col.tag_name == "mj-group"
+                         renderer.send(:render_group, col, context, widths[i])
+                       else
+                         context[:_column_width_pct] = widths[i]
+                         render_node(col, context, parent: "mj-section")
+                       end
+
+            "#{td_open}\n#{col_html}\n#{td_close}"
+          end
         end
 
         ([open_table, open_tr] + col_parts + [close_tr, close_table]).join("\n")
@@ -317,11 +319,13 @@ module MjmlRb
         close_tr    = %(<!--[if mso | IE]></tr><![endif]-->)
         close_table = %(<!--[if mso | IE]></table><![endif]-->)
 
-        section_parts = children.map do |child|
-          td_open  = %(<!--[if mso | IE]><td class="" width="#{container_px}px" ><![endif]-->)
-          td_close = %(<!--[if mso | IE]></td><![endif]-->)
-          child_html = render_node(child, context, parent: "mj-wrapper")
-          "#{td_open}\n#{child_html}\n#{td_close}"
+        section_parts = with_inherited_mj_class(context, node) do
+          children.map do |child|
+            td_open  = %(<!--[if mso | IE]><td class="" width="#{container_px}px" ><![endif]-->)
+            td_close = %(<!--[if mso | IE]></td><![endif]-->)
+            child_html = render_node(child, context, parent: "mj-wrapper")
+            "#{td_open}\n#{child_html}\n#{td_close}"
+          end
         end
 
         ([open_table, open_tr] + section_parts + [close_tr, close_table]).join("\n")

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

@@ -139,14 +139,16 @@ module MjmlRb
         outlook_open  = %(<!--[if mso | IE]><table align="#{escape_attr(align)}" border="0" cellpadding="0" cellspacing="0" role="presentation" ><tr>)
         outlook_close = %(</tr></table><![endif]-->)
 
-        children_html = elements.map.with_index do |child, idx|
-          child_attrs  = resolved_attributes(child, context)
-          merged_attrs = ELEMENT_DEFAULTS.merge(inherited).merge(child_attrs)
-          el_html      = render_social_element(child, merged_attrs)
-
-          outlook_td_open  = idx == 0 ? "<td>" : "</td><td>"
-          %(#{outlook_td_open}<![endif]--><table align="#{escape_attr(align)}" border="0" cellpadding="0" cellspacing="0" role="presentation" style="float:none;display:inline-table;"><tbody>#{el_html}</tbody></table><!--[if mso | IE]>)
-        end.join
+        children_html = with_inherited_mj_class(context, node) do
+          elements.map.with_index do |child, idx|
+            child_attrs  = resolved_attributes(child, context)
+            merged_attrs = ELEMENT_DEFAULTS.merge(inherited).merge(child_attrs)
+            el_html      = render_social_element(child, merged_attrs)
+
+            outlook_td_open  = idx == 0 ? "<td>" : "</td><td>"
+            %(#{outlook_td_open}<![endif]--><table align="#{escape_attr(align)}" border="0" cellpadding="0" cellspacing="0" role="presentation" style="float:none;display:inline-table;"><tbody>#{el_html}</tbody></table><!--[if mso | IE]>)
+          end.join
+        end
 
         %(#{outlook_open}#{children_html}</td>#{outlook_close})
       end
@@ -155,11 +157,13 @@ module MjmlRb
         inherited = inherited_attrs(social_attrs)
         elements  = social_element_children(node)
 
-        children_html = elements.map do |child|
-          child_attrs  = resolved_attributes(child, context)
-          merged_attrs = ELEMENT_DEFAULTS.merge(inherited).merge(child_attrs)
-          render_social_element(child, merged_attrs)
-        end.join
+        children_html = with_inherited_mj_class(context, node) do
+          elements.map do |child|
+            child_attrs  = resolved_attributes(child, context)
+            merged_attrs = ELEMENT_DEFAULTS.merge(inherited).merge(child_attrs)
+            render_social_element(child, merged_attrs)
+          end.join
+        end
 
         %(<table border="0" cellpadding="0" cellspacing="0" role="presentation" style="margin:0px;"><tbody>#{children_html}</tbody></table>)
       end

data/lib/mjml-rb/parser.rb

@@ -20,6 +20,7 @@ module MjmlRb
     def parse(mjml, options = {})
       opts = normalize_options(options)
       xml = apply_preprocessors(mjml.to_s, opts[:preprocessors])
+      xml = wrap_raw_tags_in_cdata(xml)
       xml = normalize_html_void_tags(xml)
       xml = expand_includes(xml, opts) unless opts[:ignore_includes]
 
@@ -48,6 +49,7 @@ module MjmlRb
     end
 
     def expand_includes(xml, options)
+      xml = wrap_raw_tags_in_cdata(xml)
       xml = normalize_html_void_tags(xml)
       doc = Document.new(sanitize_bare_ampersands(xml))
       includes = XPath.match(doc, "//mj-include")
@@ -64,7 +66,7 @@ module MjmlRb
         replacement = if include_type == "html"
                         %(<mj-raw><![CDATA[#{escape_cdata(include_content)}]]></mj-raw>)
                       else
-                        normalize_html_void_tags(strip_xml_declaration(include_content))
+                        wrap_raw_tags_in_cdata(normalize_html_void_tags(strip_xml_declaration(include_content)))
                       end
 
         fragment = Document.new(sanitize_bare_ampersands("<include-root>#{replacement}</include-root>"))
@@ -101,6 +103,18 @@ module MjmlRb
       end
     end
 
+    def wrap_raw_tags_in_cdata(content)
+      content.gsub(/<mj-raw(\s[^<>]*?)?>(.*?)<\/mj-raw>/mi) do
+        attrs = Regexp.last_match(1).to_s
+        inner = Regexp.last_match(2).to_s
+        if inner.include?("<![CDATA[")
+          "<mj-raw#{attrs}>#{inner}</mj-raw>"
+        else
+          "<mj-raw#{attrs}><![CDATA[#{escape_cdata(inner)}]]></mj-raw>"
+        end
+      end
+    end
+
     def escape_cdata(content)
       content.to_s.gsub("]]>", "]]]]><![CDATA[>")
     end

data/lib/mjml-rb/renderer.rb

@@ -1,6 +1,7 @@
 require "cgi"
 require "nokogiri"
 require_relative "components/accordion"
+require_relative "components/attributes"
 require_relative "components/body"
 require_relative "components/breakpoint"
 require_relative "components/button"
@@ -62,7 +63,9 @@ module MjmlRb
         fonts: DEFAULT_FONTS.merge(hash_or_empty(options[:fonts])),
         global_defaults: {},
         tag_defaults: {},
-        classes: {}
+        classes: {},
+        classes_default: {},
+        inherited_mj_class: ""
       }
 
       return context unless head
@@ -84,7 +87,11 @@ module MjmlRb
           width = node.attributes["width"].to_s.strip
           context[:breakpoint] = width unless width.empty?
         when "mj-attributes"
-          absorb_attribute_node(node, context)
+          if (component = component_for(node.tag_name)) && component.respond_to?(:handle_head)
+            component.handle_head(node, context)
+          else
+            absorb_attribute_node(node, context)
+          end
         when "mj-html-attributes"
           absorb_html_attributes_node(node, context)
         when "mj-raw"
@@ -173,7 +180,9 @@ module MjmlRb
     end
 
     def render_children(node, context, parent:)
-      node.children.map { |child| render_node(child, context, parent: parent) }.join("\n")
+      with_inherited_mj_class(context, node) do
+        node.children.map { |child| render_node(child, context, parent: parent) }.join("\n")
+      end
     end
 
     def render_node(node, context, parent:)
@@ -196,10 +205,12 @@ module MjmlRb
     def render_group(node, context, width_pct = 100)
       items = node.element_children.select { |e| e.tag_name == "mj-column" }
       widths = compute_column_widths(items, context)
-      items.each_with_index.map do |item, i|
-        context[:_column_width_pct] = widths[i]
-        render_node(item, context, parent: "mj-group")
-      end.join("\n")
+      with_inherited_mj_class(context, node) do
+        items.each_with_index.map do |item, i|
+          context[:_column_width_pct] = widths[i]
+          render_node(item, context, parent: "mj-group")
+        end.join("\n")
+      end
     end
 
     def compute_column_widths(columns, context)
@@ -260,14 +271,10 @@ module MjmlRb
       rules.each do |selector, attrs|
         next if selector.empty? || attrs.empty?
 
-        begin
-          document.css(selector).each do |node|
-            attrs.each do |name, value|
-              node[name] = value.to_s
-            end
+        select_nodes(document, selector).each do |node|
+          attrs.each do |name, value|
+            node[name] = value.to_s
           end
-        rescue Nokogiri::CSS::SyntaxError
-          next
         end
       end
 
@@ -282,18 +289,53 @@ module MjmlRb
       parse_inline_css_rules(css_blocks.join("\n")).each do |selector, declarations|
         next if selector.empty? || declarations.empty?
 
-        begin
-          document.css(selector).each do |node|
-            merge_inline_style!(node, declarations)
-          end
-        rescue Nokogiri::CSS::SyntaxError
-          next
+        select_nodes(document, selector).each do |node|
+          merge_inline_style!(node, declarations)
         end
       end
 
       document.to_html
     end
 
+    def select_nodes(document, selector)
+      document.css(selector)
+    rescue Nokogiri::CSS::SyntaxError, Nokogiri::XML::XPath::SyntaxError
+      fallback_select_nodes(document, selector)
+    end
+
+    def fallback_select_nodes(document, selector)
+      return [] unless selector.include?(":lang(")
+
+      lang_values = selector.scan(/:lang\(([^)]+)\)/).flatten.map do |value|
+        value.to_s.strip.gsub(/\A['"]|['"]\z/, "").downcase
+      end.reject(&:empty?)
+      return [] if lang_values.empty?
+
+      base_selector = selector.gsub(/:lang\(([^)]+)\)/, "").strip
+      base_selector = "*" if base_selector.empty?
+
+      document.css(base_selector).select do |node|
+        lang_values.all? { |lang| lang_matches?(node, lang) }
+      end
+    rescue Nokogiri::CSS::SyntaxError, Nokogiri::XML::XPath::SyntaxError
+      []
+    end
+
+    def lang_matches?(node, lang)
+      current = node
+
+      while current
+        value = current["lang"]
+        if value && !value.empty?
+          normalized = value.downcase
+          return normalized == lang || normalized.start_with?("#{lang}-")
+        end
+        current = current.parent
+      end
+
+      false
+    end
+
     def parse_inline_css_rules(css)
       stripped_css = strip_css_comments(css.to_s)
       plain_css = strip_css_at_rules(stripped_css)
@@ -391,6 +433,7 @@ module MjmlRb
         registry = {}
         # Register component classes here as they are implemented.
         register_component(registry, Components::Body.new(self))
+        register_component(registry, Components::Attributes.new(self))
         register_component(registry, Components::Breakpoint.new(self))
         register_component(registry, Components::Accordion.new(self))
         register_component(registry, Components::Button.new(self))
@@ -419,8 +462,18 @@ module MjmlRb
       attrs.merge!(context[:tag_defaults][node.tag_name] || {})
 
       node_classes = node.attributes["mj-class"].to_s.split(/\s+/).reject(&:empty?)
-      node_classes.each do |klass|
-        attrs.merge!(context[:classes][klass] || {})
+      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"]
+          memo["css-class"] = "#{memo["css-class"]} #{mj_class_attrs["css-class"]}"
+        end
+        memo.merge!(mj_class_attrs)
+      end
+      attrs.merge!(class_attrs)
+
+      inherited_classes = context[:inherited_mj_class].to_s.split(/\s+/).reject(&:empty?)
+      inherited_classes.each do |klass|
+        attrs.merge!(((context[:classes_default] || {})[klass] || {})[node.tag_name] || {})
       end
 
       attrs.merge!(node.attributes)
@@ -482,6 +535,15 @@ module MjmlRb
       node.element_children.find { |child| child.tag_name == tag_name }
     end
 
+    def with_inherited_mj_class(context, node)
+      previous = context[:inherited_mj_class]
+      current = node.attributes["mj-class"]
+      context[:inherited_mj_class] = (current && !current.empty?) ? current : previous
+      yield
+    ensure
+      context[:inherited_mj_class] = previous
+    end
+
     def root_file_start_raw(document)
       document.element_children.filter_map do |child|
         next unless child.tag_name == "mj-raw"

data/lib/mjml-rb/version.rb

@@ -1,3 +1,3 @@
 module MjmlRb
-  VERSION = "0.2.2".freeze
+  VERSION = "0.2.4".freeze
 end

data/mjml-rb.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.license = "MIT"
   spec.required_ruby_version = ">= 3.0"
 
-  spec.homepage = "https://github.com/faraquet/mjml-rails"
+  spec.homepage = "https://github.com/faraquet/mjml-rb"
   spec.files = Dir.chdir(__dir__) do
     Dir.glob("{bin,lib}/**/*") + ["Gemfile", "LICENSE", "mjml-rb.gemspec", "README.md"]
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mjml-rb
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.4
 platform: ruby
 authors:
 - Andrei Andriichuk
@@ -54,6 +54,7 @@ files:
 - lib/mjml-rb/cli.rb
 - lib/mjml-rb/compiler.rb
 - lib/mjml-rb/components/accordion.rb
+- lib/mjml-rb/components/attributes.rb
 - lib/mjml-rb/components/base.rb
 - lib/mjml-rb/components/body.rb
 - lib/mjml-rb/components/breakpoint.rb
@@ -78,7 +79,7 @@ files:
 - lib/mjml-rb/validator.rb
 - lib/mjml-rb/version.rb
 - mjml-rb.gemspec
-homepage: https://github.com/faraquet/mjml-rails
+homepage: https://github.com/faraquet/mjml-rb
 licenses:
 - MIT
 metadata: {}