mjml-rb 0.3.6 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8416ab91e9a9d1c4addbbed2368136715d3726b5524e3cce2f27865c5522b6f2
-  data.tar.gz: 576c18c2307ca32b30012e2e91450b2888e1f6cf13c9398bd0c7da7ef616bb7d
+  metadata.gz: c9cdaa07e2f84c880f1c3a4ae1594a32ec0d49436d6bf2fe83ee7d1738628fdf
+  data.tar.gz: 4b8576742cd05906ad3bf2bf8ef184dcf0eb6e4a7a7a19ca701e7a84c5ad3939
 SHA512:
-  metadata.gz: c3ed81729d5550ae8611f0b4fd17545373b8c4041fc286f655c6c975be42182aab441a8c11d07e7a15578a55a6d83849e33e4507f99f45d925ea81212e04607c
-  data.tar.gz: e407a972325006108bce56759035dfa0b00f93d1917c162d04c2c2ad3d299c0bb03f15a36d3f49c6a26d3d3e2ee058f45fbf29c96a016034c85372af87db4404
+  metadata.gz: 10f9d9c51871108519184113747abbee99c6c9b58e4f9a95161756296c4c97b64bf136cf969980ad99b00eb12ba505871a6efaa6b5ec1524f1ec14375e9030a1
+  data.tar.gz: f2af62cc6cb8f43f6fbd4e7aa6feb20ec7326b1069c52ee46d807ce7d4e134b3f1b931a03dc78c03108328621c322764ab70b14bf3d6e84c52940661ad6d2c09

data/README.md

@@ -1,16 +1,13 @@
 # MJML Ruby Implementation
 
-> **⚠️ EXPERIMENTAL — USE AT YOUR OWN RISK**
->
-> This is an **unofficial, experimental** Ruby port of the MJML email framework.
-> It is **not affiliated with or endorsed by the MJML team**.
-> The output HTML may differ from the reference `mjml` npm package in subtle ways,
-> 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.
+> **Note:** This is an unofficial Ruby port of the MJML email framework,
+> not affiliated with or endorsed by the MJML team.
+> All 22 MJML v4 components are implemented and tested against npm MJML v4.18.0.
+> Output may differ from the npm renderer in cosmetic ways (whitespace, attribute ordering)
+> but renders identically across email clients.
+> We recommend testing your templates when migrating from the npm renderer.
+> This is a **fully open source project** — feedback, bug reports, test cases,
+> and pull requests are welcome!
 
 This gem provides a Ruby-first implementation of the main MJML tooling:
 

data/lib/mjml-rb/ast_node.rb

@@ -25,11 +25,13 @@ module MjmlRb
 
     def text_content
       return @content.to_s if text?
-      @children.map(&:text_content).join
+      result = +""
+      @children.each { |child| result << child.text_content }
+      result
     end
 
     def element_children
-      @children.select(&:element?)
+      @element_children ||= @children.select(&:element?)
     end
   end
 end

data/lib/mjml-rb/component_registry.rb

@@ -17,33 +17,49 @@ module MjmlRb
         @custom_dependencies[parent] = ((@custom_dependencies[parent] || []) + Array(children)).uniq
       end
       @custom_ending_tags.merge(Array(ending_tags))
+      invalidate_caches!
     end
 
     def component_class_for_tag(tag_name)
-      all_component_classes.find { |klass| klass.tags.include?(tag_name) }
+      tag_class_cache[tag_name]
     end
 
     def dependency_rules
-      merged = {}
-      Dependencies::RULES.each { |k, v| merged[k] = v.dup }
-      @custom_dependencies.each do |parent, children|
-        merged[parent] = ((merged[parent] || []) + Array(children)).uniq
+      @dependency_rules_cache ||= begin
+        merged = {}
+        Dependencies::RULES.each { |k, v| merged[k] = v.dup }
+        @custom_dependencies.each do |parent, children|
+          merged[parent] = ((merged[parent] || []) + Array(children)).uniq
+        end
+        merged
       end
-      merged
     end
 
     def ending_tags
-      Dependencies::ENDING_TAGS | @custom_ending_tags
+      @ending_tags_cache ||= (Dependencies::ENDING_TAGS | @custom_ending_tags)
     end
 
     def reset!
       @custom_components.clear
       @custom_dependencies.clear
       @custom_ending_tags.clear
+      invalidate_caches!
     end
 
     private
 
+    def invalidate_caches!
+      @tag_class_cache = nil
+      @dependency_rules_cache = nil
+      @ending_tags_cache = nil
+    end
+
+    def tag_class_cache
+      @tag_class_cache ||= all_component_classes.each_with_object({}) do |klass, h|
+        klass.tags.each { |tag| h[tag] ||= klass }
+      end
+    end
+
     def all_component_classes
       builtin = MjmlRb::Components.constants.filter_map do |name|
         value = MjmlRb::Components.const_get(name)

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

@@ -305,39 +305,43 @@ module MjmlRb
       def component_head_style(carousel_id, length, attrs)
         return "" if length.zero?
 
-        hide_non_selected = (0...length).map do |index|
-          ".mj-carousel-#{carousel_id}-radio:checked #{adjacent_siblings(index)}+ .mj-carousel-content .mj-carousel-image"
-        end.join(",\n")
-
-        show_selected = (0...length).map do |index|
-          ".mj-carousel-#{carousel_id}-radio-#{index + 1}:checked #{adjacent_siblings(length - index - 1)}+ .mj-carousel-content .mj-carousel-image-#{index + 1}"
-        end.join(",\n")
-
-        next_icons = (0...length).map do |index|
-          target = ((index + 1) % length) + 1
-          ".mj-carousel-#{carousel_id}-radio-#{index + 1}:checked #{adjacent_siblings(length - index - 1)}+ .mj-carousel-content .mj-carousel-next-#{target}"
-        end.join(",\n")
-
-        previous_icons = (0...length).map do |index|
-          target = ((index - 1) % length) + 1
-          ".mj-carousel-#{carousel_id}-radio-#{index + 1}:checked #{adjacent_siblings(length - index - 1)}+ .mj-carousel-content .mj-carousel-previous-#{target}"
-        end.join(",\n")
-
-        selected_thumbnail = (0...length).map do |index|
-          ".mj-carousel-#{carousel_id}-radio-#{index + 1}:checked #{adjacent_siblings(length - index - 1)}+ .mj-carousel-content .mj-carousel-#{carousel_id}-thumbnail-#{index + 1}"
-        end.join(",\n")
-
-        show_thumbnails = (0...length).map do |index|
-          ".mj-carousel-#{carousel_id}-radio-#{index + 1}:checked #{adjacent_siblings(length - index - 1)}+ .mj-carousel-content .mj-carousel-#{carousel_id}-thumbnail"
-        end.join(",\n")
-
-        hide_on_hover = (0...length).map do |index|
-          ".mj-carousel-#{carousel_id}-thumbnail:hover #{adjacent_siblings(length - index - 1)}+ .mj-carousel-main .mj-carousel-image"
-        end.join(",\n")
-
-        show_on_hover = (0...length).map do |index|
-          ".mj-carousel-#{carousel_id}-thumbnail-#{index + 1}:hover #{adjacent_siblings(length - index - 1)}+ .mj-carousel-main .mj-carousel-image-#{index + 1}"
-        end.join(",\n")
+        hide_non_selected = []
+        show_selected = []
+        next_icons = []
+        previous_icons = []
+        selected_thumbnail = []
+        show_thumbnails = []
+        hide_on_hover = []
+        show_on_hover = []
+
+        # Pre-compute adjacent sibling strings to avoid repeated "+" * count" allocations
+        sibling_cache = Array.new(length) { |i| adjacent_siblings(i) }
+
+        length.times do |index|
+          siblings_index = sibling_cache[index]
+          siblings_reverse = sibling_cache[length - index - 1]
+          idx1 = index + 1
+          next_target = ((index + 1) % length) + 1
+          prev_target = ((index - 1) % length) + 1
+
+          hide_non_selected << ".mj-carousel-#{carousel_id}-radio:checked #{siblings_index}+ .mj-carousel-content .mj-carousel-image"
+          show_selected << ".mj-carousel-#{carousel_id}-radio-#{idx1}:checked #{siblings_reverse}+ .mj-carousel-content .mj-carousel-image-#{idx1}"
+          next_icons << ".mj-carousel-#{carousel_id}-radio-#{idx1}:checked #{siblings_reverse}+ .mj-carousel-content .mj-carousel-next-#{next_target}"
+          previous_icons << ".mj-carousel-#{carousel_id}-radio-#{idx1}:checked #{siblings_reverse}+ .mj-carousel-content .mj-carousel-previous-#{prev_target}"
+          selected_thumbnail << ".mj-carousel-#{carousel_id}-radio-#{idx1}:checked #{siblings_reverse}+ .mj-carousel-content .mj-carousel-#{carousel_id}-thumbnail-#{idx1}"
+          show_thumbnails << ".mj-carousel-#{carousel_id}-radio-#{idx1}:checked #{siblings_reverse}+ .mj-carousel-content .mj-carousel-#{carousel_id}-thumbnail"
+          hide_on_hover << ".mj-carousel-#{carousel_id}-thumbnail:hover #{siblings_reverse}+ .mj-carousel-main .mj-carousel-image"
+          show_on_hover << ".mj-carousel-#{carousel_id}-thumbnail-#{idx1}:hover #{siblings_reverse}+ .mj-carousel-main .mj-carousel-image-#{idx1}"
+        end
+
+        hide_non_selected = hide_non_selected.join(",\n")
+        show_selected = show_selected.join(",\n")
+        next_icons = next_icons.join(",\n")
+        previous_icons = previous_icons.join(",\n")
+        selected_thumbnail = selected_thumbnail.join(",\n")
+        show_thumbnails = show_thumbnails.join(",\n")
+        hide_on_hover = hide_on_hover.join(",\n")
+        show_on_hover = show_on_hover.join(",\n")
 
         <<~CSS
           .mj-carousel {

data/lib/mjml-rb/parser.rb

@@ -17,6 +17,15 @@ module MjmlRb
       mj-navbar-link mj-raw mj-text
     ].freeze
 
+    # Pre-compiled regex patterns to avoid rebuilding on every call
+    ENDING_TAGS_CDATA_RE = /<(#{ENDING_TAGS_FOR_CDATA.map { |t| Regexp.escape(t) }.join("|")})(\s[^<>]*?)?(?<!\/)>(.*?)<\/\1>/mi.freeze
+
+    VOID_TAG_CLOSING_BR_RE = %r{</br\s*>}i.freeze
+    VOID_TAG_CLOSING_OTHER_RE = /<\/(#{(HTML_VOID_TAGS - ["br"]).join("|")})\s*>/i.freeze
+    VOID_TAG_OPEN_RE = /<(#{HTML_VOID_TAGS.join("|")})(\s[^<>]*?)?>/i.freeze
+    LINE_ANNOTATION_RE = /(\n)|(<!\[CDATA\[.*?\]\]>)|(<(?:mj-[\w-]+|mjml)(?=[\s\/>]))/m.freeze
+    BARE_AMPERSAND_RE = /&(?!(?:#[0-9]+|#x[0-9a-fA-F]+|[a-zA-Z][a-zA-Z0-9]*);)/.freeze
+
     class ParseError < StandardError
       attr_reader :line
 
@@ -212,23 +221,21 @@ module MjmlRb
     def normalize_html_void_tags(content)
       # Legacy mail templates sometimes emit invalid closing </br> tags.
       # Browser-style recovery treats them as actual line breaks, so preserve that.
-      content = content.gsub(%r{</br\s*>}i, "<br />")
+      content = content.gsub(VOID_TAG_CLOSING_BR_RE, "<br />")
 
       # Remove other closing tags for void elements (e.g. </hr>, </img>).
       # These are invalid in both HTML and XML and HTML5 recovery drops them.
-      content = content.gsub(/<\/(#{(HTML_VOID_TAGS - ["br"]).join("|")})\s*>/i, "")
+      content = content.gsub(VOID_TAG_CLOSING_OTHER_RE, "")
 
       # Self-close opening void tags that aren't already self-closed.
-      pattern = /<(#{HTML_VOID_TAGS.join("|")})(\s[^<>]*?)?>/i
-      content.gsub(pattern) do |tag|
+      content.gsub(VOID_TAG_OPEN_RE) do |tag|
         tag.end_with?("/>") ? tag : tag.sub(/>$/, " />")
       end
     end
 
     def wrap_ending_tags_in_cdata(content)
-      tag_pattern = ENDING_TAGS_FOR_CDATA.map { |t| Regexp.escape(t) }.join("|")
       # Negative lookbehind (?<!\/) ensures self-closing tags like <mj-text ... /> are skipped
-      content.gsub(/<(#{tag_pattern})(\s[^<>]*?)?(?<!\/)>(.*?)<\/\1>/mi) do
+      content.gsub(ENDING_TAGS_CDATA_RE) do
         tag = Regexp.last_match(1)
         attrs = Regexp.last_match(2).to_s
         inner = Regexp.last_match(3).to_s
@@ -251,7 +258,7 @@ module MjmlRb
     # (e.g. &amp; &#123; &#x1F;).  This lets REXML parse HTML-ish content
     # such as "Terms & Conditions" which is common in email templates.
     def sanitize_bare_ampersands(content)
-      content.gsub(/&(?!(?:#[0-9]+|#x[0-9a-fA-F]+|[a-zA-Z][a-zA-Z0-9]*);)/, "&amp;")
+      content.gsub(BARE_AMPERSAND_RE, "&amp;")
     end
 
     # Adds data-mjml-line attributes to MJML tags so line numbers survive
@@ -259,7 +266,7 @@ module MjmlRb
     # 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
+      xml.gsub(LINE_ANNOTATION_RE) do
         if Regexp.last_match(1) # newline
           line += 1
           "\n"

data/lib/mjml-rb/renderer.rb

@@ -25,7 +25,7 @@ require_relative "components/spacer"
 
 module MjmlRb
   class Renderer
-    HTML_VOID_TAGS = %w[area base br col embed hr img input link meta param source track wbr].freeze
+    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",
@@ -647,6 +647,8 @@ module MjmlRb
     end
 
     def append_component_head_styles(document, context)
+      all_tags = collect_tag_names(document)
+
       component_registry.each_value.uniq.each do |component|
         next unless component.respond_to?(:head_style)
 
@@ -662,7 +664,7 @@ module MjmlRb
                else
                  component.tags
                end
-        next unless Array(tags).any? { |tag| contains_tag?(document, tag) }
+        next unless Array(tags).any? { |tag| all_tags.include?(tag) }
 
         context[:component_head_styles] << style
       end
@@ -815,11 +817,12 @@ module MjmlRb
       end.join("\n")
     end
 
-    def contains_tag?(node, tag_name)
-      return false unless node.respond_to?(:tag_name)
-      return true if node.tag_name == tag_name
+    def collect_tag_names(node, result = Set.new)
+      return result unless node.respond_to?(:tag_name)
 
-      node.children.any? { |child| child.respond_to?(:children) && contains_tag?(child, tag_name) }
+      result << node.tag_name
+      node.children.each { |child| collect_tag_names(child, result) if child.respond_to?(:children) }
+      result
     end
 
     def escape_html(value)
@@ -845,9 +848,10 @@ module MjmlRb
     end
 
     def unique_strings(values)
+      seen = Set.new
       Array(values).each_with_object([]) do |value, memo|
         next if value.nil? || value.empty?
-        next if memo.include?(value)
+        next unless seen.add?(value)
 
         memo << value
       end

data/lib/mjml-rb/version.rb

@@ -1,3 +1,3 @@
 module MjmlRb
-  VERSION = "0.3.6".freeze
+  VERSION = "0.4.0".freeze
 end

data/mjml-rb.gemspec

@@ -18,6 +18,6 @@ Gem::Specification.new do |spec|
   spec.bindir = "bin"
   spec.executables = ["mjml"]
   spec.require_paths = ["lib"]
-  spec.add_dependency "nokogiri"
-  spec.add_dependency "rexml"
+  spec.add_dependency "nokogiri", ">= 1.13"
+  spec.add_dependency "rexml", ">= 3.2.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mjml-rb
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.4.0
 platform: ruby
 authors:
 - Andrei Andriichuk
@@ -15,28 +15,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.13'
 - !ruby/object:Gem::Dependency
   name: rexml
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.2.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.2.5
 description: Ruby-first MJML compiler API and CLI with compatibility-focused behavior.
 email:
 - andreiandriichuk@gmail.com