mjml-rb 0.2.38 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 556f39bab241ad23362562a49530aa44547347cdadb66a72f80acdff43533814
-  data.tar.gz: f1fd9bde9c1bfde3d041ef67c4b61837e82612fc51a39feaa4fc4c88e75f7464
+  metadata.gz: cfa6cc54a797f8b4323003dbcfd92fa4ef02b1e0b118e58acd14bb8e901e502d
+  data.tar.gz: 12d0fb1d71e03a23811caac5b0417b7f32823b95870e47296ea51fd8bd713018
 SHA512:
-  metadata.gz: 1061b94568afb17dd9734b397871d383890e624fcc44dd430708ce0194d370bad171a08fdba62c4e0ebb14250024b7e6003c071c8ac72d5401e9ec8b4229c28b
-  data.tar.gz: 1c7529382d699d2893ed2a99236d03cb58f9fa0792574cd45d13d64a4e7e911ca5c01fbd332ead728de4a54721cc8002293030badd99b1256b07e8da154a6124
+  metadata.gz: 689a1974e1c6e7477e202c3fb070c63eadf3b66617e2ea177feb6b45ae9d58cf9c1472dd7ddbe4e141d6583e67f83c93f76ca91c5f787d4a706241523c313361
+  data.tar.gz: ad73e16bd469bdfd98ccff031aca1796f99c460c87ab6435ba272492ffeb4ffff2b1e77f1019c368324286942cc561239e20b4219e6010efcac7d2066a945bb6

data/README.md

@@ -46,6 +46,24 @@ bundle exec bin/mjml --validate example.mjml
 In a Rails app, requiring the gem registers an `ActionView` template handler for
 `.mjml` templates through a `Railtie`.
 
+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.rails_template_language = :slim
+```
+
+Supported values are `:slim` and `:haml`.
+
+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`:
 
 ```mjml

data/lib/mjml-rb/railtie.rb

@@ -1,15 +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"}
+  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
+      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,17 +1,65 @@
+require "action_view"
+require "action_view/template"
+
 module MjmlRb
   class TemplateHandler
-    class << self
-      def call(template, source = nil)
-        <<~RUBY
-          mjml_compiler_options = (::MjmlRb.rails_compiler_options || {}).dup
-          mjml_result = ::MjmlRb::Compiler.new(mjml_compiler_options).compile(#{template.source.inspect})
-          if mjml_result.errors.any?
-            raise "MJML compilation failed for #{template.identifier}: \#{mjml_result.errors.map { |error| error[:formatted_message] || error[:message] }.join(', ')}"
-          end
-          mjml_html = mjml_result.html.to_s
-          mjml_html.respond_to?(:html_safe) ? mjml_html.html_safe : mjml_html
-        RUBY
+    SUPPORTED_TEMPLATE_LANGUAGES = %w[:slim :haml].freeze
+
+    def call(template, source = nil)
+      compiled_source = compile_source(template, source)
+      template_path = template.respond_to?(:virtual_path) ? template.virtual_path : template.identifier
+
+      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
+
+    def self.render_compiled_source(mjml_source, template_path)
+      mjml_result = ::MjmlRb::Compiler.new(::MjmlRb.rails_compiler_options || {}).compile(mjml_source.to_s)
+
+      if mjml_result.errors.any?
+        raise "MJML compilation failed for #{template_path}: #{mjml_result.errors.map { |error| error[:formatted_message] || error[:message] }.join(', ')}"
+      end
+
+      html = mjml_result.html.to_s
+      html.respond_to?(:html_safe) ? html.html_safe : html
+    end
+
+    def self.render_partial_source(compiled_source)
+      output = compiled_source.to_s
+      output.respond_to?(:html_safe) ? output.html_safe : output
+    end
+
+    private
+
+    def template_handler
+      language = MjmlRb.rails_template_language
+      raise missing_rails_template_language_error if language.nil?
+
+      handler = ActionView::Template.registered_template_handler(language)
+      return handler if handler
+
+      raise "MJML Rails rails_template_language `#{language}` is not registered with ActionView. Make sure the matching Rails template handler is loaded."
+    end
+
+    def compile_source(template, source)
+      return template.source.inspect if xml_source?(template.source)
+
+      template_handler.call(template, source)
+    rescue RuntimeError => error
+      raise error unless error.message == missing_rails_template_language_error
+
+      %(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.38".freeze
+  VERSION = "0.3.0".freeze
 end

data/lib/mjml-rb.rb

@@ -28,11 +28,19 @@ module MjmlRb
       @rails_compiler_options = options || {}
     end
 
+    def rails_template_language
+      @rails_template_language
+    end
+
+    def rails_template_language=(language)
+      @rails_template_language = language&.to_sym
+    end
+
     def register_action_view_template_handler!
       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.38
+  version: 0.3.0
 platform: ruby
 authors:
 - Andrei Andriichuk