mjml-rb 0.2.39 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7864f17e62acc702b5da45e9ca4322bc5207d486190de2ae7bab1a19e5109be
-  data.tar.gz: 9a5587f0f059d2d422407d65ad149e0d1ba04b731409a42290d3b4aa2aa34fc3
+  metadata.gz: cfa6cc54a797f8b4323003dbcfd92fa4ef02b1e0b118e58acd14bb8e901e502d
+  data.tar.gz: 12d0fb1d71e03a23811caac5b0417b7f32823b95870e47296ea51fd8bd713018
 SHA512:
-  metadata.gz: a910ab3a64a41505e662a31c97ad11b29a72bee403c5e98b70a2abafa7fee0e056a173e55232bde1d8a5b765a524a6acf1a99d0536c0c74a49ef67dcaa17265b
-  data.tar.gz: 0d9e9e08cfc38bcde65ba9480ca5a10365b0ecc60a20695a57cbc027dbe4a86df6d92424d46597d2ae8c46c7e25f6e4ccb6575d6d43f0d4dd157c54939afec36
+  metadata.gz: 689a1974e1c6e7477e202c3fb070c63eadf3b66617e2ea177feb6b45ae9d58cf9c1472dd7ddbe4e141d6583e67f83c93f76ca91c5f787d4a706241523c313361
+  data.tar.gz: ad73e16bd469bdfd98ccff031aca1796f99c460c87ab6435ba272492ffeb4ffff2b1e77f1019c368324286942cc561239e20b4219e6010efcac7d2066a945bb6

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/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/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.0".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.0
 platform: ruby
 authors:
 - Andrei Andriichuk