mjml-rb 0.5.1 → 0.6.0

data/lib/mjml-rb/renderer.rb

@@ -64,15 +64,16 @@ module MjmlRb
     HTML
 
     def render(document, options = {})
+      @formatting = options[:minify] || options[:beautify]
       head = find_child(document, "mj-head")
       body = find_child(document, "mj-body")
       raise ArgumentError, "Missing <mj-body>" unless body
 
       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)
@@ -84,6 +85,8 @@ module MjmlRb
 
     def build_context(head, options)
       context = {
+        sanitize_styles: options[:sanitize_styles],
+        template_syntax: options[:template_syntax] || Options::DEFAULTS[:template_syntax],
         title: "",
         preview: "",
         breakpoint: "480px",
@@ -115,7 +118,6 @@ module MjmlRb
       content = minify_outlook_conditionals(content)
       content = apply_html_attributes_to_content(content, context)
       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])
@@ -127,7 +129,6 @@ module MjmlRb
       )
       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;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],
@@ -135,10 +136,6 @@ module MjmlRb
         "xmlns:v" => "urn:schemas-microsoft-com:vml",
         "xmlns:o" => "urn:schemas-microsoft-com:office:office"
       }
-      body_style = style_join(
-        "word-spacing" => "normal",
-        "background-color" => context[:background_color]
-      )
 
       html = <<~HTML
         <!doctype html>
@@ -159,10 +156,7 @@ module MjmlRb
             #{user_styles_tag}
             #{head_raw}
           </head>
-          <body style="#{body_style}">
-            #{preview_block}
-            #{content}
-          </body>
+          #{content}
         </html>
       HTML
 
@@ -170,7 +164,8 @@ module MjmlRb
       html = preserve_raw_tag_spacing(html)
       html = strip_internal_raw_markers(html)
       html = merge_outlook_conditionals(html)
-      before_doctype.empty? ? html : "#{before_doctype}\n#{html}"
+      html = before_doctype.empty? ? html : "#{before_doctype}\n#{html}"
+      @formatting ? html : html.gsub(/<!--mjml-rb:raw-(?:start|end)-->/, "")
     end
 
     def build_font_tags(content, inline_styles, fonts)
@@ -225,7 +220,7 @@ module MjmlRb
       return [100] if total == 0
 
       widths = columns.map do |col|
-        w = col.attributes["width"]
+        w = resolved_attributes(col, context)["width"]
         if w && w.to_s =~ /(\d+(?:\.\d+)?)\s*%/
           $1.to_f
         elsif w && w.to_s =~ /(\d+(?:\.\d+)?)\s*px/
@@ -236,16 +231,7 @@ module MjmlRb
         end
       end
 
-      specified = widths.compact.sum
-      unset_count = widths.count(&:nil?)
-
-      if unset_count > 0
-        remaining = [100.0 - specified, 0.0].max
-        each_unset = remaining / unset_count
-        widths.map { |w| w || each_unset }
-      else
-        widths
-      end
+      widths.map { |width| width || 100.0 / total }
     end
 
     def build_media_queries_tags(breakpoint, column_widths, force_owa_desktop: false, printer_support: false)
@@ -253,13 +239,13 @@ module MjmlRb
       return "" if widths.empty?
 
       base_rules = widths.map do |class_name, width_str|
-        ".#{class_name} { width:#{width_str} !important; max-width: #{width_str}; }"
+        ".#{class_name} { #{media_query_declarations(width_str)} }"
       end
       moz_rules = widths.map do |class_name, width_str|
-        ".moz-text-html .#{class_name} { width:#{width_str} !important; max-width: #{width_str}; }"
+        ".moz-text-html .#{class_name} { #{media_query_declarations(width_str)} }"
       end
       owa_rules = widths.map do |class_name, width_str|
-        "[owa] .#{class_name} { width:#{width_str} !important; max-width: #{width_str}; }"
+        "[owa] .#{class_name} { #{media_query_declarations(width_str)} }"
       end
 
       bp = breakpoint.to_s.strip
@@ -283,29 +269,36 @@ module MjmlRb
       parts.join("\n")
     end
 
+    def media_query_declarations(value)
+      return "padding: #{value[:padding]} !important;" if value.is_a?(Hash)
+      "width:#{value} !important; max-width: #{value};"
+    end
+
     def build_style_tag(styles)
       return "" if styles.empty?
 
       "<style type=\"text/css\">#{styles.join("\n")}</style>"
     end
 
+    def outside_raw_regions(html)
+      html.split(/(<!--mjml-rb:raw-start-->.*?<!--mjml-rb:raw-end-->)/m).map do |part|
+        part.start_with?("<!--mjml-rb:raw-start-->") ? part : yield(part)
+      end.join
+    end
+
     def merge_outlook_conditionals(html)
-      # MJML post-processes the HTML to merge adjacent Outlook conditional comments.
-      # e.g. <![endif]-->\n<!--[if mso | IE]> become a single conditional block.
-      html.gsub(/<!\[endif\]-->\s*<!--\[if mso \| IE\]>/m, "")
+      outside_raw_regions(html) do |part|
+        part.gsub(/<!\[endif\]-->\s*<!--\[if mso \| IE\]>/m, "")
+      end
     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}"
+      outside_raw_regions(html) do |part|
+        part.gsub(/(<!--\[if\s[^\]]+\]>)([\s\S]*?)(<!\[endif\]-->)/m) do
+          prefix, content, suffix = Regexp.last_match.captures
+          processed = content.gsub(/(^|>)(\s+)(<|$)/m, '\\1\\3').gsub(/\s{2,}/m, " ")
+          "#{prefix}#{processed}#{suffix}"
+        end
       end
     end
 
@@ -313,7 +306,7 @@ module MjmlRb
       rules = context[:html_attributes] || {}
       return content if rules.empty?
 
-      root = html_attributes_fragment_root(content, context)
+      root = Nokogiri::HTML("<html>#{content}</html>")
 
       rules.each do |selector, attrs|
         next if selector.empty? || attrs.empty?
@@ -325,7 +318,7 @@ module MjmlRb
         end
       end
 
-      root.inner_html
+      root.at_css("body").to_html
     end
 
     def html_attributes_fragment_root(content, context)
@@ -341,6 +334,9 @@ module MjmlRb
     def apply_inline_styles(html, context)
       css_blocks = unique_strings(context[:inline_styles]).reject { |css| css.nil? || css.strip.empty? }
       return html if css_blocks.empty?
+      if context[:sanitize_styles] && css_blocks.any? { |css| context[:template_syntax].any? { |syntax| css.include?(syntax[:prefix] || syntax["prefix"]) } }
+        raise ArgumentError, "Template syntax in inline MJML CSS is unsupported; use non-inline mj-style or raw styles"
+      end
 
       document = parse_html_document(html)
       rules, = parse_inline_css_rules(css_blocks.join("\n"))
@@ -626,41 +622,13 @@ module MjmlRb
     end
 
     def component_registry
-      @component_registry ||= begin
-        registry = {}
-        # Register component classes here as they are implemented.
-        register_component(registry, Components::Body.new(self))
-        register_component(registry, Components::Head.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))
-        register_component(registry, Components::Carousel.new(self))
-        register_component(registry, Components::CarouselImage.new(self))
-        register_component(registry, Components::Group.new(self))
-        register_component(registry, Components::Hero.new(self))
-        register_component(registry, Components::Image.new(self))
-        register_component(registry, Components::Navbar.new(self))
-        register_component(registry, Components::Raw.new(self))
-        register_component(registry, Components::Text.new(self))
-        register_component(registry, Components::Divider.new(self))
-        register_component(registry, Components::HtmlAttributes.new(self))
-        register_component(registry, Components::Table.new(self))
-        register_component(registry, Components::Social.new(self))
-        register_component(registry, Components::Section.new(self))
-        register_component(registry, Components::Column.new(self))
-        register_component(registry, Components::Spacer.new(self))
-
-        MjmlRb.component_registry.custom_components.each do |klass|
-          register_component(registry, klass.new(self))
-        end
-
-        registry
+      registry = MjmlRb.component_registry
+      if @registry_revision != registry.revision
+        instances = {}
+        @component_registry = registry.components.transform_values { |klass| instances[klass] ||= klass.new(self) }
+        @registry_revision = registry.revision
       end
-    end
-
-    def register_component(registry, component)
-      component.tags.each { |tag| registry[tag] = component }
+      @component_registry
     end
 
     def resolved_attributes(node, context)
@@ -668,7 +636,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"]
@@ -683,33 +651,35 @@ 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?(:inner_html)
-        node.inner_html
-      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?
-            child.content.to_s
-          else
-            child.to_html
-          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 protect_raw_html(content)
+      return content if content.empty? || (!@formatting && !content.include?("<!--[if"))
+      # Use separate markers so source htmlmin:ignore regions can be nested.
+      "<!--mjml-rb:raw-start-->#{content}<!--mjml-rb:raw-end-->"
     end
 
     def annotate_raw_html(content)
@@ -755,7 +725,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
@@ -765,9 +735,9 @@ 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)
+        protect_raw_html(raw_inner(child))
       end.join("\n")
     end
 
@@ -779,6 +749,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-line 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/result.rb

@@ -1,11 +1,12 @@
 module MjmlRb
   class Result
-    attr_reader :html, :errors, :warnings
+    attr_reader :html, :errors, :warnings, :dependencies
 
-    def initialize(html: "", errors: [], warnings: [])
+    def initialize(html: "", errors: [], warnings: [], dependencies: [])
       @html = html.to_s
       @errors = Array(errors)
       @warnings = Array(warnings)
+      @dependencies = Array(dependencies).freeze
     end
 
     def success?

data/lib/mjml-rb/validator.rb

@@ -5,28 +5,31 @@ module MjmlRb
   class Validator
     GLOBAL_ALLOWED_ATTRIBUTES = %w[css-class mj-class].freeze
 
-    REQUIRED_BY_TAG = {
-      "mj-image" => %w[src],
-      "mj-font" => %w[name href],
-      "mj-include" => %w[path]
-    }.freeze
-
     def initialize(parser: Parser.new)
       @parser = parser
     end
 
     def validate(mjml_or_ast, options = {})
-      root = mjml_or_ast.is_a?(AstNode) ? mjml_or_ast : parse_ast(mjml_or_ast, options)
+      options = Options::DEFAULTS.merge(Options.normalize(options))
+      parsed = if mjml_or_ast.is_a?(Parser::ParseResult)
+                 mjml_or_ast
+               elsif mjml_or_ast.is_a?(Nokogiri::XML::Node)
+                 Parser::ParseResult.new(ast: mjml_or_ast, diagnostics: [])
+               else
+                 @parser.parse_result(mjml_or_ast, options)
+               end
+      root = parsed.ast
       unless root&.tag_name == "mjml"
         return { errors: [error("Root element must be <mjml>", tag_name: root&.tag_name)], warnings: [] }
       end
 
-      issues = []
+      issues = parsed.diagnostics.dup
+      return classify_issues(issues, options) if options[:validation_level].to_s == "skip"
       issues << error("Missing <mj-body>", tag_name: "mjml") unless root.element_children.any? { |c| c.tag_name == "mj-body" }
       walk(root, issues)
       classify_issues(issues, options)
     rescue Parser::ParseError => e
-      { errors: [error(e.message, line: e.line)], warnings: [] }
+      { errors: [error(e.message, line: e.line, file: e.file)], warnings: [] }
     end
 
     private
@@ -42,23 +45,11 @@ module MjmlRb
       end
     end
 
-    def parse_ast(mjml, options)
-      @parser.parse(
-        mjml,
-        keep_comments: options.fetch(:keep_comments, false),
-        preprocessors: options.fetch(:preprocessors, []),
-        ignore_includes: options.fetch(:ignore_includes, false),
-        file_path: options.fetch(:file_path, "."),
-        actual_path: options.fetch(:actual_path, ".")
-      )
-    end
-
     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)
 
@@ -94,21 +85,11 @@ module MjmlRb
       end
     end
 
-    def validate_required_attributes(node, errors)
-      required = REQUIRED_BY_TAG[node.tag_name] || []
-      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, line: node.line, file: node.file)
-      end
-    end
-
     def validate_supported_attributes(node, errors)
       allowed_attributes = allowed_attributes_for(node.tag_name)
-      return if allowed_attributes.empty?
+      return if node.tag_name == "mjml" || node.parent&.name == "mj-attributes"
 
-      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 +102,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 +199,17 @@ module MjmlRb
       end
     end
 
+    INTERNAL_ATTRIBUTES = %w[data-mjml-file data-mjml-line 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,4 @@
 module MjmlRb
-  VERSION = "0.5.1".freeze
+  MJML_COMPATIBILITY_VERSION = "5.4.1".freeze
+  VERSION = "0.6.0".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"
@@ -16,8 +16,8 @@ module MjmlRb
   warn <<~WARNING unless ENV["MJML_RB_NO_WARN"] == "1"
     WARNING: mjml-rb #{VERSION} is EXPERIMENTAL software.
     It is an unofficial Ruby port of MJML, not affiliated with or endorsed by
-    the MJML team. Output may differ from the reference npm renderer. Not all
-    components are fully implemented. Use in production at your own risk.
+    the MJML team. It targets MJML #{MJML_COMPATIBILITY_VERSION}; parser, formatter
+    and CSS inliner behavior may differ. Use in production at your own risk.
     Set MJML_RB_NO_WARN=1 to suppress this message.
   WARNING
 

data/mjml-rb.gemspec

@@ -13,11 +13,11 @@ Gem::Specification.new do |spec|
 
   spec.homepage = "https://github.com/faraquet/mjml-rb"
   spec.files = Dir.chdir(__dir__) do
-    Dir.glob("{bin,lib}/**/*") + ["Gemfile", "LICENSE", "Rakefile", "mjml-rb.gemspec", "README.md"]
+    Dir.glob("{bin,lib}/**/*") + Dir.glob("docs/**/*.md") + ["Gemfile", "LICENSE", "THIRD_PARTY_LICENSES.md", "Rakefile", "mjml-rb.gemspec", "README.md", "CHANGELOG.md"]
   end
   spec.bindir = "bin"
   spec.executables = ["mjml"]
   spec.require_paths = ["lib"]
-  spec.add_dependency "css_parser", ">= 1.17"
+  spec.add_dependency "css_parser", ">= 1.17", "< 4"
   spec.add_dependency "nokogiri", ">= 1.13"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mjml-rb
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Andrei Andriichuk
@@ -16,6 +16,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.17'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -23,6 +26,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.17'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -45,14 +51,23 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
+- THIRD_PARTY_LICENSES.md
 - bin/mjml
+- docs/ARCHITECTURE.md
+- docs/MIGRATING_TO_V5.md
+- docs/MJML_V5_SUPPORT_PLAN.md
+- docs/PARITY_AUDIT.md
+- docs/RELEASING.md
+- docs/USAGE.md
+- docs/releases/v0.6.0.md
 - lib/mjml-rb.rb
-- lib/mjml-rb/ast_node.rb
 - lib/mjml-rb/cli.rb
+- lib/mjml-rb/column_gutter.rb
 - lib/mjml-rb/compiler.rb
 - lib/mjml-rb/component_registry.rb
 - lib/mjml-rb/components/accordion.rb
@@ -80,6 +95,9 @@ files:
 - lib/mjml-rb/components/text.rb
 - lib/mjml-rb/config_file.rb
 - lib/mjml-rb/dependencies.rb
+- lib/mjml-rb/formatter.rb
+- lib/mjml-rb/node_compat.rb
+- lib/mjml-rb/options.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