mjml-rb 0.2.39 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7864f17e62acc702b5da45e9ca4322bc5207d486190de2ae7bab1a19e5109be
-  data.tar.gz: 9a5587f0f059d2d422407d65ad149e0d1ba04b731409a42290d3b4aa2aa34fc3
+  metadata.gz: a5afc17046611848190458b50e1b7d0670011e8f1e32a6723b63c7e7ff76029c
+  data.tar.gz: ff832c4861cd1c28d76f47e0f66f257e8fa1c956dd6e0836826df83be3e4782d
 SHA512:
-  metadata.gz: a910ab3a64a41505e662a31c97ad11b29a72bee403c5e98b70a2abafa7fee0e056a173e55232bde1d8a5b765a524a6acf1a99d0536c0c74a49ef67dcaa17265b
-  data.tar.gz: 0d9e9e08cfc38bcde65ba9480ca5a10365b0ecc60a20695a57cbc027dbe4a86df6d92424d46597d2ae8c46c7e25f6e4ccb6575d6d43f0d4dd157c54939afec36
+  metadata.gz: e43bae28df235a80ad028bc43e37401c45c59c8e0d486f09e8d22faa786c1e18e62e696bde4cce668fcee4ea1c7d3d037cec3ec93d890b0e8e33404f98b776fe
+  data.tar.gz: c35f403ee71148fa10f6e9d794a61695f35f74201e561fba1afecb4686c71388c01f13bf69c19b799214102ad142a6f86281d922b3ed5eed2ed1e348b446f737

data/README.md

@@ -51,15 +51,18 @@ By default, `.mjml` files are treated as raw MJML/XML source.
 If you want Slim-backed MJML templates, configure it explicitly:
 
 ```ruby
-config.mjml_rb.template_language = :slim
+config.mjml_rb.rails_template_language = :slim
 ```
 
-Supported values are `:erb`, `:slim`, and `:haml`.
+Supported values are `:slim` and `:haml`.
 
-With a configured `template_language`, `.mjml` templates are rendered through
-that template engine first, so partials and embedded Ruby can assemble MJML
-before the outer template is compiled to HTML. Without that setting, non-XML
-MJML source is rejected instead of being guessed.
+With a configured `rails_template_language`, `.mjml` templates are rendered
+through that template engine first, so partials and embedded Ruby can assemble
+MJML before the outer template is compiled to HTML. Without that setting,
+non-XML MJML source is rejected instead of being guessed.
+
+For `:slim` or `:haml`, the matching Rails template handler must already be
+registered in `ActionView` by the corresponding gem or integration layer.
 
 Create a view such as `app/views/user_mailer/welcome.html.mjml`:
 

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

@@ -39,6 +39,7 @@ module MjmlRb
 
       def render(tag_name:, node:, context:, attrs:, parent:)
         width_pct = context.delete(:_column_width_pct) || 100.0
+        mobile_width = context.delete(:_column_mobile_width)
         css_class = attrs["css-class"]
         a = self.class.default_attributes.merge(attrs)
 
@@ -63,7 +64,7 @@ module MjmlRb
           "direction" => a["direction"],
           "display" => "inline-block",
           "vertical-align" => vertical_align,
-          "width" => "100%"
+          "width" => (mobile_width ? mobile_width_value(a, width_pct, context[:container_width]) : "100%")
         )
 
         column_markup =
@@ -168,6 +169,22 @@ module MjmlRb
         value && !value.empty?
       end
 
+      def mobile_width_value(attrs, width_pct, parent_width)
+        width = attrs["width"]
+
+        if present_attr?(width) && width.end_with?("%")
+          width
+        elsif present_attr?(width) && width.end_with?("px")
+          parent_width_px = parse_pixel_value(parent_width || "600px")
+          return "100%" if parent_width_px.zero?
+
+          percentage = (parse_pixel_value(width) / parent_width_px) * 100
+          "#{percentage.to_s.sub(/\.?0+$/, "")}%"
+        else
+          "#{width_pct.to_f.to_s.sub(/\.?0+$/, "")}%"
+        end
+      end
+
       def with_child_container_width(context, attrs, width_pct)
         previous_container_width = context[:container_width]
         context[:container_width] = child_container_width(context, attrs, width_pct)

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

@@ -77,6 +77,7 @@ module MjmlRb
               width_pct = widths[column_index] || 100.0
               column_index += 1
               context[:_column_width_pct] = width_pct
+              context[:_column_mobile_width] = true
               td_style = style_join(
                 "vertical-align" => resolved_attributes(child, context)["vertical-align"] || "top",
                 "width" => "#{(group_width_px * width_pct / 100.0).round}px"

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

@@ -238,11 +238,11 @@ module MjmlRb
       def hero_container_width(attrs, container_width)
         width = parse_unit_value(container_width)
         content_width = width - padding_side(attrs, "left") - padding_side(attrs, "right")
-        "#{[content_width, 0].max}px"
+        px_length([content_width, 0].max)
       end
 
       def normalize_container_width(value)
-        "#{parse_unit_value(value)}px"
+        px_length(parse_unit_value(value))
       end
 
       def padding_side(attrs, side)
@@ -280,6 +280,17 @@ module MjmlRb
       def blank?(value)
         value.nil? || value.to_s.empty?
       end
+
+      def px_length(value)
+        "#{format_number(value)}px"
+      end
+
+      def format_number(value)
+        number = value.to_f
+        return number.to_i.to_s if number == number.to_i
+
+        number.to_s.sub(/\.?0+$/, "")
+      end
     end
   end
 end

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

@@ -64,7 +64,7 @@ module MjmlRb
           render_wrapper(node, context, attrs)
         else
           a = self.class.default_attributes.merge(attrs)
-          if a["full-width"] == "full-width"
+          if a["full-width"] == "full-width" && !context[:_inside_full_width_wrapper]
             render_full_width_section(node, context, a)
           else
             render_section(node, context, a)
@@ -254,8 +254,8 @@ module MjmlRb
 
         # Build v:fill attributes
         fill_pairs = [
-          ["origin", "#{v_origin_x}, #{v_origin_y}"],
-          ["position", "#{v_pos_x}, #{v_pos_y}"],
+          ["origin", "#{format_vml_number(v_origin_x)}, #{format_vml_number(v_origin_y)}"],
+          ["position", "#{format_vml_number(v_pos_x)}, #{format_vml_number(v_pos_y)}"],
           ["src", bg_url],
           ["color", bg_color],
           ["type", vml_type]
@@ -287,6 +287,13 @@ module MjmlRb
         end
       end
 
+      def format_vml_number(value)
+        number = value.to_f
+        return number.to_i.to_s if number == number.to_i
+
+        number.to_s.sub(/\.?0+$/, "")
+      end
+
       def vml_size_attributes(bg_size)
         case bg_size
         when "cover"
@@ -639,7 +646,9 @@ module MjmlRb
         box_width    = container_px - pad_left - pad_right - border_left - border_right
 
         previous_container_width = context[:container_width]
+        previous_full_width_wrapper = context[:_inside_full_width_wrapper]
         context[:container_width] = "#{box_width}px"
+        context[:_inside_full_width_wrapper] = full_width
 
         div_attrs = {"class" => (full_width ? nil : css_class), "style" => div_style}
         inner = merge_outlook_conditionals(render_wrapped_children_wrapper(node, context, container_px, a["gap"]))
@@ -686,6 +695,7 @@ module MjmlRb
         end
       ensure
         context[:container_width] = previous_container_width if previous_container_width
+        context[:_inside_full_width_wrapper] = previous_full_width_wrapper
       end
 
       # Wrap each child mj-section/mj-wrapper in an Outlook conditional <tr><td>.
@@ -703,7 +713,7 @@ module MjmlRb
             child_attrs = resolved_attributes(child, context)
             child_css   = child_attrs["css-class"]
             outlook_class = suffix_css_classes(child_css)
-            td_open  = %(<!--[if mso | IE]><tr><td class="#{escape_attr(outlook_class)}" width="#{container_px}px" ><![endif]-->)
+            td_open  = %(<!--[if mso | IE]><tr><td class="#{escape_attr(outlook_class)}" width="#{container_px}" ><![endif]-->)
             td_close = %(<!--[if mso | IE]></td></tr><![endif]-->)
             child_html = with_wrapper_child_gap(context, index.zero? ? nil : gap) do
               render_node(child, context, parent: "mj-wrapper")

data/lib/mjml-rb/railtie.rb

@@ -1,17 +1,19 @@
-require_relative "template_handler"
+if defined?(Rails::Railtie)
+  require_relative "template_handler"
 
-module MjmlRb
-  class Railtie < Rails::Railtie
-    config.mjml_rb = ActiveSupport::OrderedOptions.new
-    config.mjml_rb.compiler_options = {validation_level: "strict"}
-    config.mjml_rb.template_language = nil
+  module MjmlRb
+    class Railtie < Rails::Railtie
+      config.mjml_rb = ActiveSupport::OrderedOptions.new
+      config.mjml_rb.compiler_options = {validation_level: "strict"}
+      config.mjml_rb.rails_template_language = nil
 
-    initializer "mjml_rb.action_view" do |app|
-      MjmlRb.rails_compiler_options = app.config.mjml_rb.compiler_options.to_h
-      MjmlRb.rails_template_language = app.config.mjml_rb.template_language
+      initializer "mjml_rb.action_view" do |app|
+        MjmlRb.rails_compiler_options = app.config.mjml_rb.compiler_options.to_h
+        MjmlRb.rails_template_language = app.config.mjml_rb.rails_template_language
 
-      ActiveSupport.on_load(:action_view) do
-        MjmlRb.register_action_view_template_handler!
+        ActiveSupport.on_load(:action_view) do
+          MjmlRb.register_action_view_template_handler!
+        end
       end
     end
   end

data/lib/mjml-rb/renderer.rb

@@ -113,6 +113,7 @@ module MjmlRb
 
     def build_html_document(content, context)
       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")
@@ -165,7 +166,6 @@ module MjmlRb
         </html>
       HTML
 
-      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}"
@@ -307,23 +307,33 @@ module MjmlRb
       end
     end
 
-    def apply_html_attributes(html, context)
+    def apply_html_attributes_to_content(content, context)
       rules = context[:html_attributes] || {}
-      return html if rules.empty?
+      return content if rules.empty?
 
-      document = Nokogiri::HTML(html)
+      root = html_attributes_fragment_root(content, context)
 
       rules.each do |selector, attrs|
         next if selector.empty? || attrs.empty?
 
-        select_nodes(document, selector).each do |node|
+        select_nodes(root, selector).each do |node|
           attrs.each do |name, value|
             node[name] = value.to_s
           end
         end
       end
 
-      document.to_html
+      root.inner_html
+    end
+
+    def html_attributes_fragment_root(content, context)
+      wrapper_attrs = {
+        "data-mjml-body-root" => "true",
+        "lang" => context[:lang],
+        "dir" => context[:dir]
+      }
+      fragment = Nokogiri::HTML::DocumentFragment.parse("<div#{html_attrs(wrapper_attrs)}>#{content}</div>")
+      fragment.at_css("div[data-mjml-body-root='true']")
     end
 
     def apply_inline_styles(html, context)

data/lib/mjml-rb/template_handler.rb

@@ -1,114 +1,65 @@
+require "action_view"
+require "action_view/template"
+
 module MjmlRb
   class TemplateHandler
-    MJML_CAPTURE_DEPTH_IVAR = :@_mjml_rb_capture_depth
-    TEMPLATE_ENGINES = {
-      slim: {
-        require: "slim",
-        gem_name: "slim"
-      },
-      haml: {
-        require: "haml",
-        gem_name: "haml"
-      }
-    }.freeze
-
-    class << self
-      def call(template, source = nil)
-        <<~RUBY
-          ::MjmlRb::TemplateHandler.render(self, #{template.source.inspect}, #{template.identifier.inspect}, local_assigns)
-        RUBY
-      end
+    SUPPORTED_TEMPLATE_LANGUAGES = %w[:slim :haml].freeze
 
-      def render(view_context, source, identifier, local_assigns = {})
-        if capture_mode?(view_context)
-          return mark_html_safe(render_source(view_context, source, local_assigns))
-        end
+    def call(template, source = nil)
+      compiled_source = compile_source(template, source)
+      template_path = template.respond_to?(:virtual_path) ? template.virtual_path : template.identifier
 
-        with_capture_mode(view_context) do
-          mjml_source = render_source(view_context, source, local_assigns).to_s
-          mjml_result = ::MjmlRb::Compiler.new(::MjmlRb.rails_compiler_options || {}).compile(mjml_source)
+      if /<mjml.*?>/i.match?(compiled_source)
+        "::MjmlRb::TemplateHandler.render_compiled_source(begin;#{compiled_source};end, #{template_path.inspect})"
+      else
+        "::MjmlRb::TemplateHandler.render_partial_source(begin;#{compiled_source};end)"
+      end
+    end
 
-          if mjml_result.errors.any?
-            raise "MJML compilation failed for #{identifier}: #{mjml_result.errors.map { |error| error[:formatted_message] || error[:message] }.join(', ')}"
-          end
+    def self.render_compiled_source(mjml_source, template_path)
+      mjml_result = ::MjmlRb::Compiler.new(::MjmlRb.rails_compiler_options || {}).compile(mjml_source.to_s)
 
-          mark_html_safe(mjml_result.html.to_s)
-        end
+      if mjml_result.errors.any?
+        raise "MJML compilation failed for #{template_path}: #{mjml_result.errors.map { |error| error[:formatted_message] || error[:message] }.join(', ')}"
       end
 
-      private
-
-      def render_source(view_context, source, local_assigns)
-        language = ::MjmlRb.rails_template_language
-        if language.nil?
-          stripped_source = source.to_s.lstrip
-          return source.to_s if stripped_source.start_with?("<")
-
-          raise "MJML Rails template_language is not configured for non-XML templates. Supported values: nil, :erb, :slim, :haml"
-        end
-
-        case language
-        when :erb
-          render_erb_source(view_context, source.to_s, local_assigns)
-        when :slim, :haml
-          render_template_language_source(view_context, source.to_s, local_assigns, language)
-        else
-          raise "Unsupported MJML Rails template_language `#{language}`. Supported values: nil, :erb, :slim, :haml"
-        end
-      end
+      html = mjml_result.html.to_s
+      html.respond_to?(:html_safe) ? html.html_safe : html
+    end
 
-      def render_erb_source(view_context, source, local_assigns)
-        require "erb"
+    def self.render_partial_source(compiled_source)
+      output = compiled_source.to_s
+      output.respond_to?(:html_safe) ? output.html_safe : output
+    end
 
-        local_assigns.each do |name, value|
-          define_local_reader(view_context, name, value)
-        end
+    private
 
-        erb = ::ERB.new(source)
-        erb.result(view_context.instance_eval { binding })
-      end
+    def template_handler
+      language = MjmlRb.rails_template_language
+      raise missing_rails_template_language_error if language.nil?
 
-      def render_template_language_source(view_context, source, local_assigns, language)
-        engine = TEMPLATE_ENGINES.fetch(language)
-        require engine[:require]
-
-        case language
-        when :slim
-          ::Slim::Template.new { source }.render(view_context, local_assigns.transform_keys(&:to_sym))
-        when :haml
-          if defined?(::Haml::Template)
-            ::Haml::Template.new { source }.render(view_context, local_assigns.transform_keys(&:to_sym))
-          else
-            raise "MJML Rails template_language is set to :haml, but this Haml version does not expose Haml::Template"
-          end
-        end
-      rescue LoadError
-        raise "MJML Rails template_language is set to :#{language}, but the `#{engine[:gem_name]}` gem is not available"
-      end
+      handler = ActionView::Template.registered_template_handler(language)
+      return handler if handler
 
-      def define_local_reader(view_context, name, value)
-        singleton_class = class << view_context; self; end
-        singleton_class.send(:define_method, name) do
-          value
-        end
-      end
+      raise "MJML Rails rails_template_language `#{language}` is not registered with ActionView. Make sure the matching Rails template handler is loaded."
+    end
 
-      def capture_mode?(view_context)
-        view_context.instance_variable_get(MJML_CAPTURE_DEPTH_IVAR).to_i.positive?
-      end
+    def compile_source(template, source)
+      return template.source.inspect if xml_source?(template.source)
 
-      def with_capture_mode(view_context)
-        depth = view_context.instance_variable_get(MJML_CAPTURE_DEPTH_IVAR).to_i
-        view_context.instance_variable_set(MJML_CAPTURE_DEPTH_IVAR, depth + 1)
-        yield
-      ensure
-        next_depth = view_context.instance_variable_get(MJML_CAPTURE_DEPTH_IVAR).to_i - 1
-        view_context.instance_variable_set(MJML_CAPTURE_DEPTH_IVAR, [next_depth, 0].max)
-      end
+      template_handler.call(template, source)
+    rescue RuntimeError => error
+      raise error unless error.message == missing_rails_template_language_error
 
-      def mark_html_safe(value)
-        value.respond_to?(:html_safe) ? value.html_safe : value
-      end
+      %(raise #{missing_rails_template_language_error.inspect})
+    end
+
+    def xml_source?(source)
+      source.to_s.lstrip.start_with?("<")
+    end
+
+    def missing_rails_template_language_error
+      "MJML Rails rails_template_language is not configured for non-XML templates. Configure it with one of: #{SUPPORTED_TEMPLATE_LANGUAGES.join(', ')}. Otherwise use raw XML MJML."
     end
   end
 end

data/lib/mjml-rb/version.rb

@@ -1,3 +1,3 @@
 module MjmlRb
-  VERSION = "0.2.39".freeze
+  VERSION = "0.3.1".freeze
 end

data/lib/mjml-rb.rb

@@ -40,7 +40,7 @@ module MjmlRb
       return unless defined?(ActionView::Template)
 
       require_relative "mjml-rb/template_handler"
-      ActionView::Template.register_template_handler(:mjml, TemplateHandler)
+      ActionView::Template.register_template_handler(:mjml, TemplateHandler.new)
     end
 
     def mjml2html(mjml, options = {})

metadata

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