mjml-rails 4.4.2 → 4.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8610d3313ee8297b7ac411aa8f23b8c99a85cf41940db1798529d91193fb37d
-  data.tar.gz: c5099915099d3aeb6e050bf44b3cb81b8fe759686a06b85d61a197e65b7b4dfb
+  metadata.gz: 7b9582e0d35041cd78aa95808af7d2808ce467eb1b70eb511b57f39679b661af
+  data.tar.gz: 402a1cf82168f58d8abde20ad280473e897eb0d0489d88281c72d52e830c71c8
 SHA512:
-  metadata.gz: 717f6819381d9f925ce597f05288cfc6f3c07417e353de40561de9ddffc6ac48331e4877ed775818b7b3dbd3836c27e2347bafcbcc9c0247b467565e944911ab
-  data.tar.gz: ec6662022e6ed5f5e8b6732d61fa766de5af32dd57fcd43c508576bcb7f594b1f413b17452532fa4e7ee94b46d1c90427bb90e3cff1425ae39c05d46c38f371e
+  metadata.gz: 31edb6ed2fbfaa8e1888a97e6a07334e0551b67ab1ed66153445be516ca2f916b76e4cf0d378915d7ee3cb5082cdd307570bfc1191760bb19243472e4758b757
+  data.tar.gz: 85be7ae9d1be8adeac4020cfed26e9a30fa917bb7c051b88b3c9c14a1a204b9ad64d37c3a5920d72a9593fc6389fd71cad59ae0baf3b0bdc5f9cb7892c8501c6

data/README.md

@@ -1,15 +1,15 @@
 # MJML-Rails
 
-[![Build Status](https://api.travis-ci.org/sighmon/mjml-rails.svg?branch=master)](http://travis-ci.org/sighmon/mjml-rails) [![Gem Version](https://badge.fury.io/rb/mjml-rails.svg)](https://badge.fury.io/rb/mjml-rails)
+[![Build Status](https://github.com/sighmon/mjml-rails/workflows/test/badge.svg?branch=master)](https://github.com/sighmon/mjml-rails/actions?query=workflow%3Atest+branch%3Amaster) [![Gem Version](https://badge.fury.io/rb/mjml-rails.svg)](https://badge.fury.io/rb/mjml-rails)
 
-**MJML-Rails** allows you to render HTML e-mails from an [MJML](https://mjml.io) template.
+**MJML-Rails** allows you to render HTML emails from an [MJML](https://mjml.io) template.
 
 **Note**: As of MJML 4.3.0 you can no longer use `<mj-text>` directly inside an `<mj-body>`, wrap it in `<mj-section><mj-column>`.
 
 An example template might look like:
 
 ```erb
-<!-- ./app/views/user_mailer/email.html.mjml -->
+<!-- ./app/views/user_mailer/user_signup_confirmation.mjml -->
 <mjml>
   <mj-head>
     <mj-preview>Hello World</mj-preview>
@@ -18,7 +18,7 @@ An example template might look like:
     <mj-section>
       <mj-column>
         <mj-text>Hello World</mj-text>
-        <%= render partial: "info" %>
+        <%= render partial: "info", formats: [:html] %>
       </mj-column>
     </mj-section>
   </mj-body>
@@ -80,49 +80,65 @@ MJML-Rails falls back to a global installation of MJML but it is strongly recomm
 
 You'll need at least Node.js version 6 for MJML to function properly.
 
-If you're using ```:haml``` or any other Rails template language, create an initializer to set it up:
+## Configuration
 
-```ruby
-# config/initializers/mjml.rb
-Mjml.setup do |config|
-  config.template_language = :erb # :erb (default), :slim, :haml, or any other you are using
-end
-```
+MJML-Rails has the following settings with defaults:
+
+- `template_language: :erb`
+
+   ERB can be used inside MJML templates by default. Possible values are all template languages that you have installed, e.g. `:haml` or `:slim`.
+
+   **Note:** If you’re using Haml/Slim layouts, please don’t put `<mjml>` in comments in your partial. Read more at [#34](https://github.com/sighmon/mjml-rails/issues/34).
+
+- `raise_render_exception: true`
+
+   Exceptions will be raised and passed to your application by default.
+
+   Beware that setting it to `false` leads to an empty html email when an exception is raised, so only set this to `false` if you do not rely on html (e.g. you have a text fallback for your emails).
+
+- `minify: false`
+
+- `beautify: true`
+
+- `validation_level: "strict"`
 
-**Note:** If you’re using Haml/Slim layouts, please don’t put `<mjml>` in comments in your partial. Read more: [#34](https://github.com/sighmon/mjml-rails/issues/34).
+   MJML-Rails will raise an exception on any template error by default.
+
+   If set to `soft`, MJML will render invalid templates and ignore invalid parts. This means in case of an invalid template those invalid parts will be missing from the output.
+
+   See [MJML validation documentation](https://github.com/mjmlio/mjml/tree/master/packages/mjml-validator#validating-mjml) for all possible values.
+
+- `mjml_binary: nil`
+
+   This can be used to specify the path to a custom MJML binary if it is not detected automatically (shouldn't be needed).
+
+- `mjml_binary_version_support: "4."`
+
+   MJML-Rails checks the version of the MJML binary and fails if it does not start with this version, e.g. if an old version is installed by accident.
 
-If there are configurations you'd like change:
-- render errors: defaults to `true` (errors raised)
-- minify: defaults to `false` (not minified)
-- beautify: defaults to `true` (beautified)
-- validation_level: defaults to `soft` (MJML syntax validation)
 
 ```ruby
 # config/initializers/mjml.rb
 Mjml.setup do |config|
-  # set to `false` to ignore errors silently
-  config.raise_render_exception = true
+  # Use :haml as a template language
+  config.template_language = :haml
+
+  # Ignore errors silently
+  config.raise_render_exception = false
 
-  # optimize the size of your email
+  # Optimize the size of your emails
   config.beautify = false
   config.minify = true
-  config.validation_level = "strict"
-end
-```
 
-If you’d like to specify a different MJML binary to run other than `4.`:
+  # Render MJML templates with errors
+  config.validation_level = "soft"
 
-```ruby
-# config/initializers/mjml.rb
-Mjml.setup do |config|
+  # Use custom MJML binary with custom version
+  config.mjml_binary = "/path/to/custom/mjml"
   config.mjml_binary_version_supported = "3.3.5"
 end
-# If you set a different MJML binary version, you need to re-discover the binary
-Mjml::BIN = Mjml.discover_mjml_bin
 ```
 
-**Note:** If you set a different MJML binary you’ll see warnings in your logs of `already initialized constant Mjml::BIN`. Read more: [#39](https://github.com/sighmon/mjml-rails/issues/39#issuecomment-429151908)
-
 ### MJML v3.x & v4.x support
 
 Version 4.x of this gem brings support for MJML 4.x

data/lib/generators/mjml/mailer/mailer_generator.rb

@@ -1,9 +1,11 @@
-require "rails/generators/erb/mailer/mailer_generator"
+# frozen_string_literal: true
+
+require 'rails/generators/erb/mailer/mailer_generator'
 
 module Mjml
   module Generators
     class MailerGenerator < Erb::Generators::MailerGenerator
-      source_root File.expand_path("../templates", __FILE__)
+      source_root File.expand_path('templates', __dir__)
 
       private
 
@@ -26,8 +28,8 @@ module Mjml
       def filename_with_extensions(name, file_format = format)
         # Due to MJML single-pass processing nature
         # layout files MUST have .mjml extension, but views/templates cannot
-        is_layout_file = name.in?([:layout, "mailer"])
-        [name, file_format, is_layout_file ? handler : view_handler].compact.join(".")
+        is_layout_file = name.in?([:layout, 'mailer'])
+        [name, file_format, is_layout_file ? handler : view_handler].compact.join('.')
       end
     end
   end

data/lib/mjml/handler.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'action_view'
+require 'action_view/template'
+require 'rails/version'
+
+module Mjml
+  class Handler
+    def template_handler
+      @template_handler ||= ActionView::Template.registered_template_handler(Mjml.template_language)
+    end
+
+    # Optional second source parameter to make it work with Rails >= 6:
+    # Beginning with Rails 6 template handlers get the source of the template as the second
+    # parameter.
+    def call(template, source = nil)
+      compiled_source = compile_source(source, template)
+
+      # Per MJML v4 syntax documentation[0] valid/render'able document MUST start with <mjml> root tag
+      # If we get here and template source doesn't start with one it means
+      # that we are rendering partial named according to legacy naming convention (partials ending with '.mjml')
+      # Therefore we skip MJML processing and return raw compiled source. It will be processed
+      # by MJML library when top-level layout/template is rendered
+      #
+      # [0] - https://github.com/mjmlio/mjml/blob/master/doc/components_1.md#mjml
+      if /<mjml.*?>/i.match?(compiled_source)
+        "Mjml::Parser.new(begin;#{compiled_source};end).render.html_safe"
+      else
+        compiled_source
+      end
+    end
+
+    private
+
+    def compile_source(source, template)
+      if Rails::VERSION::MAJOR >= 6
+        template_handler.call(template, source)
+      else
+        template_handler.call(template)
+      end
+    end
+  end
+end

data/lib/mjml/parser.rb

@@ -1,4 +1,4 @@
-require 'open3'
+# frozen_string_literal: true
 
 module Mjml
   class Parser
@@ -9,8 +9,9 @@ module Mjml
     # Create new parser
     #
     # @param input [String] The string to transform in html
-    def initialize input
-      raise Mjml.mjml_binary_error_string unless mjml_bin
+    def initialize(input)
+      raise Mjml.mjml_binary_error_string unless Mjml.valid_mjml_binary
+
       @input = input
     end
 
@@ -18,14 +19,15 @@ module Mjml
     #
     # @return [String]
     def render
-      in_tmp_file = Tempfile.open(["in", ".mjml"]) do |file|
+      in_tmp_file = Tempfile.open(['in', '.mjml']) do |file|
         file.write(input)
         file # return tempfile from block so #unlink works later
       end
       run(in_tmp_file.path, Mjml.beautify, Mjml.minify, Mjml.validation_level)
-    rescue
+    rescue StandardError
       raise if Mjml.raise_render_exception
-      ""
+
+      ''
     ensure
       in_tmp_file.unlink
     end
@@ -33,22 +35,18 @@ module Mjml
     # Exec mjml command
     #
     # @return [String] The result as string
-    def run(in_tmp_file, beautify=true, minify=false, validation_level="soft")
-      Tempfile.create(["out", ".html"]) do |out_tmp_file|
-        command = "-r #{in_tmp_file} -o #{out_tmp_file.path} --config.beautify #{beautify} --config.minify #{minify} --config.validationLevel #{validation_level}"
-        _, stderr, _ = Mjml.run_mjml(command)
-        raise ParseError.new(stderr.chomp) unless stderr.blank?
+    # rubocop:disable Style/OptionalBooleanParameter: Fixing this offense would imply a change in the public API.
+    def run(in_tmp_file, beautify = true, minify = false, validation_level = 'strict')
+      Tempfile.create(['out', '.html']) do |out_tmp_file|
+        command = "-r #{in_tmp_file} -o #{out_tmp_file.path} " \
+                  "--config.beautify #{beautify} --config.minify #{minify} --config.validationLevel #{validation_level}"
+        _, stderr, status = Mjml.run_mjml(command)
+        raise ParseError, stderr.chomp unless status.success?
+
+        Mjml.logger.warn(stderr.chomp) if stderr.present?
         out_tmp_file.read
       end
     end
-
-    private
-
-      # Get mjml bin path
-      #
-      # @return [String]
-      def mjml_bin
-        Mjml::BIN
-      end
+    # rubocop:enable Style/OptionalBooleanParameter
   end
 end

data/lib/mjml/railtie.rb

@@ -1,11 +1,18 @@
+# frozen_string_literal: true
+
 module Mjml
   class Railtie < Rails::Railtie
     config.mjml = Mjml
-    config.app_generators.mailer :template_engine => :mjml
+    config.app_generators.mailer template_engine: :mjml
 
-    initializer "mjml-rails.register_template_handler" do
+    initializer 'mjml-rails.register_template_handler' do
       ActionView::Template.register_template_handler :mjml, Mjml::Handler.new
-      Mime::Type.register_alias "text/html", :mjml
+      Mime::Type.register_alias 'text/html', :mjml
+    end
+
+    config.to_prepare do
+      # make sure we have a valid mjml binary
+      Mjml.valid_mjml_binary
     end
   end
 end

data/lib/mjml/version.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 module Mjml
-	# Version number no longer matches MJML.io version
-  VERSION = "4.4.2"
+  # Version number no longer matches MJML.io version
+  VERSION = '4.7.0'
 end

data/lib/mjml-rails.rb

@@ -1 +1,5 @@
-require "mjml"
+# rubocop:disable Naming/FileName
+# frozen_string_literal: true
+
+require 'mjml'
+# rubocop:enable Naming/FileName

data/lib/mjml.rb

@@ -1,21 +1,34 @@
-require "rails/version"
-require "action_view"
-require "action_view/template"
-require "mjml/mjmltemplate"
-require "mjml/railtie"
-require "rubygems"
-require "open3"
+# frozen_string_literal: true
 
-module Mjml
-  mattr_accessor :template_language, :raise_render_exception, :mjml_binary_version_supported, :mjml_binary_error_string, :beautify, :minify, :validation_level
+require 'rubygems'
+require 'open3'
+
+require 'mjml/handler'
+require 'mjml/parser'
 
-  @@template_language = :erb
-  @@raise_render_exception = true
-  @@mjml_binary_version_supported = "4."
-  @@mjml_binary_error_string = "Couldn't find the MJML #{Mjml.mjml_binary_version_supported} binary.. have you run $ npm install mjml?"
-  @@beautify = true
-  @@minify = false
-  @@validation_level = "soft"
+require 'mjml/railtie' if defined?(Rails)
+
+module Mjml
+  mattr_accessor \
+    :beautify,
+    :minify,
+    :mjml_binary,
+    :mjml_binary_error_string,
+    :mjml_binary_version_supported,
+    :raise_render_exception,
+    :template_language,
+    :validation_level
+
+  mattr_writer :valid_mjml_binary
+
+  self.template_language = :erb
+  self.raise_render_exception = true
+  self.mjml_binary_version_supported = '4.'
+  self.mjml_binary_error_string = "Couldn't find the MJML #{Mjml.mjml_binary_version_supported} binary.." \
+                                  ' have you run $ npm install mjml?'
+  self.beautify = true
+  self.minify = false
+  self.validation_level = 'strict'
 
   def self.check_version(bin)
     stdout, _, status = run_mjml('--version', mjml_bin: bin)
@@ -24,33 +37,57 @@ module Mjml
     false
   end
 
-  def self.run_mjml(args, mjml_bin: nil)
-    mjml_bin ||= BIN
-
+  def self.run_mjml(args, mjml_bin: valid_mjml_binary)
     Open3.capture3("#{mjml_bin} #{args}")
   end
 
-  def self.discover_mjml_bin
-    # Check for local install of MJML with yarn
-    yarn_bin = `which yarn`.chomp
-    if yarn_bin.present?
-      mjml_bin = "#{yarn_bin} run mjml"
-      return mjml_bin if check_version(mjml_bin)
+  def self.valid_mjml_binary
+    self.valid_mjml_binary = @@valid_mjml_binary ||
+                             check_for_custom_mjml_binary ||
+                             check_for_yarn_mjml_binary ||
+                             check_for_npm_mjml_binary ||
+                             check_for_global_mjml_binary
+
+    return @@valid_mjml_binary if @@valid_mjml_binary
+
+    puts Mjml.mjml_binary_error_string
+  end
+
+  def self.check_for_custom_mjml_binary
+    if const_defined?('BIN') && Mjml::BIN.present?
+      logger.warn('Setting `Mjml::BIN` is deprecated and will be removed in a future version! ' \
+                  'Please use `Mjml.mjml_binary=` instead.')
+      self.mjml_binary = Mjml::BIN
+      remove_const 'BIN'
     end
 
-    # Check for a local install of MJML with npm
+    return if mjml_binary.blank?
+
+    return mjml_binary if check_version(mjml_binary)
+
+    raise "MJML.mjml_binary is set to '#{mjml_binary}' but MJML-Rails could not validate that " \
+          'it is a valid MJML binary. Please check your configuration.'
+  end
+
+  def self.check_for_yarn_mjml_binary
+    yarn_bin = `which yarn`.chomp
+    return if yarn_bin.blank?
+
+    mjml_bin = "#{yarn_bin} run mjml"
+    return mjml_bin if check_version(mjml_bin)
+  end
+
+  def self.check_for_npm_mjml_binary
     npm_bin = `which npm`.chomp
-    if npm_bin.present? && (installer_path = bin_path_from(npm_bin)).present?
-      mjml_bin = File.join(installer_path, 'mjml')
-      return mjml_bin if check_version(mjml_bin)
-    end
+    return unless npm_bin.present? && (installer_path = bin_path_from(npm_bin)).present?
+
+    mjml_bin = File.join(installer_path, 'mjml')
+    return mjml_bin if check_version(mjml_bin)
+  end
 
-    # Check for a global install of MJML
+  def self.check_for_global_mjml_binary
     mjml_bin = `which mjml`.chomp
     return mjml_bin if mjml_bin.present? && check_version(mjml_bin)
-
-    puts Mjml.mjml_binary_error_string
-    nil
   end
 
   def self.bin_path_from(package_manager)
@@ -63,37 +100,9 @@ module Mjml
     nil
   end
 
-  BIN = discover_mjml_bin
-
-  class Handler
-    def template_handler
-      @_template_handler ||= ActionView::Template.registered_template_handler(Mjml.template_language)
-    end
-
-    # Optional second source parameter to make it work with Rails >= 6:
-    # Beginning with Rails 6 template handlers get the source of the template as the second
-    # parameter.
-    def call(template, source = nil)
-      compiled_source =
-        if Rails::VERSION::MAJOR >= 6
-          template_handler.call(template, source)
-        else
-          template_handler.call(template)
-        end
-
-      # Per MJML v4 syntax documentation[0] valid/render'able document MUST start with <mjml> root tag
-      # If we get here and template source doesn't start with one it means
-      # that we are rendering partial named according to legacy naming convention (partials ending with '.mjml')
-      # Therefore we skip MJML processing and return raw compiled source. It will be processed
-      # by MJML library when top-level layout/template is rendered
-      #
-      # [0] - https://github.com/mjmlio/mjml/blob/master/doc/guide.md#mjml
-      if compiled_source =~ /<mjml(.+)?>/i
-        "Mjml::Mjmltemplate.to_html(begin;#{compiled_source};end).html_safe"
-      else
-        compiled_source
-      end
-    end
+  def self.discover_mjml_bin
+    logger.warn('`Mjml.discover_mjml_bin` is deprecated and has no effect anymore! ' \
+                'Please use `Mjml.mjml_binary=` to set a custom MJML binary.')
   end
 
   def self.setup
@@ -105,7 +114,7 @@ module Mjml
 
     def logger
       @logger ||= Logger.new($stdout).tap do |log|
-        log.progname = self.name
+        log.progname = name
       end
     end
   end

data/test/generator_test.rb

@@ -1,26 +1,28 @@
-require "test_helper"
-require "generators/mjml/mailer/mailer_generator"
+# frozen_string_literal: true
+
+require 'test_helper'
+require 'generators/mjml/mailer/mailer_generator'
 
 class GeneratorTest < Rails::Generators::TestCase
   tests Mjml::Generators::MailerGenerator
-  destination File.expand_path("../tmp", __FILE__)
+  destination File.expand_path('tmp', __dir__)
   setup :prepare_destination
 
-  test "assert all views are properly created with given name" do
-    run_generator %w(notifier foo bar baz)
+  test 'assert all views are properly created with given name' do
+    run_generator %w[notifier foo bar baz]
 
-    assert_file "app/views/layouts/mailer.html.mjml" do |mailer|
-      assert_match "<mjml>", mailer
-      assert_match "<mj-body>", mailer
-      assert_match "<%= yield %>", mailer
+    assert_file 'app/views/layouts/mailer.html.mjml' do |mailer|
+      assert_match '<mjml>', mailer
+      assert_match '<mj-body>', mailer
+      assert_match '<%= yield %>', mailer
     end
 
-    assert_file "app/views/notifier_mailer/foo.html.erb" do |template|
-      assert_match "<%= @greeting %>", template
-      assert_match "app/views/notifier_mailer/foo.html.erb", template
+    assert_file 'app/views/notifier_mailer/foo.html.erb' do |template|
+      assert_match '<%= @greeting %>', template
+      assert_match 'app/views/notifier_mailer/foo.html.erb', template
     end
 
-    assert_file "app/views/notifier_mailer/bar.html.erb"
-    assert_file "app/views/notifier_mailer/baz.html.erb"
+    assert_file 'app/views/notifier_mailer/bar.html.erb'
+    assert_file 'app/views/notifier_mailer/baz.html.erb'
   end
 end

data/test/mjml_test.rb

@@ -1,89 +1,160 @@
-require "test_helper"
+# frozen_string_literal: true
+
+require 'test_helper'
 
 class NotifierMailer < ActionMailer::Base
-  self.view_paths = File.expand_path("../views", __FILE__)
+  self.view_paths = File.expand_path('views', __dir__)
 
-  layout "default"
+  layout 'default'
 
   def inform_contact(recipient)
     @recipient = recipient
 
-    mail(to: @recipient, from: "app@example.com") do |format|
+    mail(to: @recipient, from: 'app@example.com') do |format|
       format.text
       format.html
     end
   end
+
+  def invalid_template(recipient)
+    @recipient = recipient
+
+    mail(to: @recipient, from: 'app@example.com') do |format|
+      format.html
+      format.text
+    end
+  end
 end
 
 class NoLayoutMailer < ActionMailer::Base
-  self.view_paths = File.expand_path("../views", __FILE__)
+  self.view_paths = File.expand_path('views', __dir__)
 
   layout nil
 
   def inform_contact(recipient)
     @recipient = recipient
 
-    mail(to: @recipient, from: "app@example.com") do |format|
-      format.mjml
-    end
+    mail(to: @recipient, from: 'app@example.com', &:mjml)
   end
 
   def with_owa(recipient)
     @recipient = recipient
 
-    mail(to: @recipient, from: "app@example.com") do |format|
-      format.mjml
-    end
+    mail(to: @recipient, from: 'app@example.com', &:mjml)
   end
 end
 
 class NotifierMailerTest < ActiveSupport::TestCase
-  test "MJML layout based multipart email is generated correctly" do
-    email = NotifierMailer.inform_contact("user@example.com")
+  test 'MJML layout based multipart email is generated correctly' do
+    email = NotifierMailer.inform_contact('user@example.com')
 
-    assert_equal "multipart/alternative", email.mime_type
+    assert_equal 'multipart/alternative', email.mime_type
 
     # To debug tests:
     # Mjml.logger.info email.mime_type
     # Mjml.logger.info email.to_s
     # Mjml.logger.info email.html_part.body
 
-    refute email.html_part.body.match(%r{</?mj.+?>})
-    assert email.html_part.body.match(/<body>/)
+    assert_not email.html_part.body.match(%r{</?mj.+?>})
+    assert email.html_part.body.include?('<body')
     assert email.html_part.body.match(/Hello, user@example.com!/)
-    assert email.html_part.body.match(%r{<h2>We inform you about something</h2>})
+    assert email.html_part.body.include?('<h2>We inform you about something</h2>')
     assert email.html_part.body.match(%r{<a href="https://www.example.com">this link</a>})
-    assert email.html_part.body.match(/tracking-code-123/)
+    assert email.html_part.body.include?('tracking-code-123')
 
-    assert email.text_part.body.match(/We inform you about something/)
+    assert email.text_part.body.include?('We inform you about something')
     assert email.text_part.body.match(%r{Please visit https://www.example.com})
   end
+
+  test 'Invalid template raises error with validation level strict' do
+    with_settings(validation_level: 'strict') do
+      email = NotifierMailer.invalid_template('user@example.com')
+      assert_raise(ActionView::Template::Error) { email.html_part.body.to_s }
+    end
+  end
+
+  test 'Invalid template gets compiled with validation level soft' do
+    # suppress warning of MJML binary
+    Mjml.logger.stubs(:warn)
+
+    with_settings(validation_level: 'soft') do
+      email = NotifierMailer.invalid_template('user@example.com')
+      assert email.text_part.body.include?('This is valid')
+      assert email.html_part.body.include?('This is valid')
+      assert_not email.html_part.body.include?('This is invalid')
+    end
+  end
 end
 
 class NotifierMailerTest < ActiveSupport::TestCase
-  test "old mjml-rails configuration style MJML template is rendered correctly" do
-    email = NoLayoutMailer.inform_contact("user@example.com")
+  test 'old mjml-rails configuration style MJML template is rendered correctly' do
+    email = NoLayoutMailer.inform_contact('user@example.com')
 
-    assert_equal "text/html", email.mime_type
+    assert_equal 'text/html', email.mime_type
 
-    refute email.body.match(%r{</?mj.+?>})
-    assert email.body.match(/<body>/)
+    assert_not email.body.match(%r{</?mj.+?>})
+    assert email.body.include?('<body')
     assert email.body.match(/Welcome, user@example.com!/)
-    assert email.body.match(%r{<h2>We inform you about something</h2>})
+    assert email.body.include?('<h2>We inform you about something</h2>')
     assert email.body.match(%r{<a href="https://www.example.com">this link</a>})
-    refute email.body.match(/tracking-code-123/)
+    assert_not email.body.include?('tracking-code-123')
   end
 
-  test "old mjml-rails MJML template with owa is rendered correctly" do
-    email = NoLayoutMailer.with_owa("user@example.com")
+  test 'old mjml-rails MJML template with owa is rendered correctly' do
+    email = NoLayoutMailer.with_owa('user@example.com')
 
-    assert_equal "text/html", email.mime_type
+    assert_equal 'text/html', email.mime_type
 
-    refute email.body.match(%r{</?mj.+?>})
-    assert email.body.match(/<body>/)
+    assert_not email.body.match(%r{</?mj.+?>})
+    assert email.body.include?('<body')
     assert email.body.match(/Welcome, user@example.com!/)
-    assert email.body.match(%r{<h2>We inform you about something</h2>})
+    assert email.body.include?('<h2>We inform you about something</h2>')
     assert email.body.match(%r{<a href="https://www.example.com">this link</a>})
-    refute email.body.match(/tracking-code-123/)
+    assert_not email.body.include?('tracking-code-123')
+  end
+end
+
+describe Mjml do
+  describe '#valid_mjml_binary' do
+    before do
+      Mjml.mjml_binary = nil
+      Mjml.valid_mjml_binary = nil
+    end
+
+    after do
+      Mjml.mjml_binary = nil
+      Mjml.valid_mjml_binary = nil
+    end
+
+    it 'can be set to a custom value with mjml_binary if version is correct' do
+      Mjml.mjml_binary = 'some custom value'
+      Mjml.stub :check_version, true do
+        expect(Mjml.valid_mjml_binary).must_equal 'some custom value'
+      end
+    end
+
+    it 'raises an error if mjml_binary is invalid' do
+      Mjml.mjml_binary = 'some custom value'
+      err = expect { Mjml.valid_mjml_binary }.must_raise(StandardError)
+      assert(err.message.start_with?("MJML.mjml_binary is set to 'some custom value' " \
+                                     'but MJML-Rails could not validate that it is a valid MJML binary'))
+    end
+
+    it 'honors old Mjml::BIN way of setting custom binary' do
+      silence_warnings { Mjml::BIN = 'set by old way' }
+      Mjml.logger.expects(:warn).with(regexp_matches(/Setting `Mjml::BIN` is deprecated/))
+      err = expect { Mjml.valid_mjml_binary }.must_raise(StandardError)
+      assert(err.message.start_with?("MJML.mjml_binary is set to 'set by old way' " \
+                                     'but MJML-Rails could not validate that it is a valid MJML binary'))
+    end
+
+    it 'ignores empty Mjml::BIN' do
+      Mjml::BIN = ''
+      Mjml.mjml_binary = 'set by mjml_binary'
+
+      err = expect { Mjml.valid_mjml_binary }.must_raise(StandardError)
+      assert(err.message.start_with?("MJML.mjml_binary is set to 'set by mjml_binary' " \
+                                     'but MJML-Rails could not validate that it is a valid MJML binary'))
+    end
   end
 end

data/test/parser_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 describe Mjml::Parser do
@@ -13,54 +15,42 @@ describe Mjml::Parser do
         parser.stubs(:run).raises(error)
       end
 
-      describe 'when render exception raising is enabled' do
-        before do
-          Mjml.setup do |config|
-            config.raise_render_exception = true
-          end
-        end
-
-        it 'raises exception' do
+      it 'raises exception with render exception enabled' do
+        with_settings(raise_render_exception: true) do
           err = expect { parser.render }.must_raise(custom_error_class)
           expect(err.message).must_equal error.message
         end
       end
 
-      describe 'when render exception raising is disabled' do
-        before do
-          Mjml.setup do |config|
-            config.raise_render_exception = false
-          end
-        end
-
-        it 'returns empty string' do
+      it 'returns empty string with exception raising disabled' do
+        with_settings(raise_render_exception: false) do
           expect(parser.render).must_equal ''
         end
       end
     end
 
     describe 'can read beautify, minify, and validation_level configs' do
-      it 'use defaults if no config is set' do
+      it 'uses defaults if no config is set' do
         expect(Mjml.beautify).must_equal(true)
         expect(Mjml.minify).must_equal(false)
-        expect(Mjml.validation_level).must_equal('soft')
+        expect(Mjml.validation_level).must_equal('strict')
       end
 
-      it 'use setup config' do
+      it 'uses setup config' do
         Mjml.setup do |config|
           config.beautify = false
           config.minify = true
-          config.validation_level = 'strict'
+          config.validation_level = 'soft'
         end
 
         expect(Mjml.beautify).must_equal(false)
         expect(Mjml.minify).must_equal(true)
-        expect(Mjml.validation_level).must_equal('strict')
+        expect(Mjml.validation_level).must_equal('soft')
 
         Mjml.setup do |config|
           config.beautify = true
           config.minify = false
-          config.validation_level = 'soft'
+          config.validation_level = 'strict'
         end
       end
     end
@@ -69,7 +59,7 @@ describe Mjml::Parser do
   describe '#run' do
     describe 'when shell command failed' do
       it 'raises exception' do
-        err = expect { parser.run "/tmp/non_existent_file.mjml" }.must_raise(Mjml::Parser::ParseError)
+        err = expect { parser.run '/tmp/non_existent_file.mjml' }.must_raise(Mjml::Parser::ParseError)
         expect(err.message).must_include 'Command line error'
       end
     end

data/test/test_helper.rb

@@ -1,21 +1,24 @@
-require "rubygems"
-require "bundler"
+# frozen_string_literal: true
+
+require 'rubygems'
+require 'bundler'
 Bundler.setup
 
-require "minitest/autorun"
-require "active_support/test_case"
+require 'minitest/autorun'
+require 'active_support/test_case'
 
-require "action_mailer"
-require "rails/railtie"
-require "rails/generators"
-require "rails/generators/test_case"
+require 'action_mailer'
+require 'rails/railtie'
+require 'rails/generators'
+require 'rails/generators/test_case'
 require 'mocha/minitest'
+require 'byebug'
 
 # require "minitest/reporters"
 # Minitest::Reporters.use!
 
-$:.unshift File.expand_path("../../lib", __FILE__)
-require "mjml"
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
+require 'mjml'
 Mjml::Railtie.run_initializers
 
 ActiveSupport::TestCase.test_order = :sorted if ActiveSupport::TestCase.respond_to? :test_order=
@@ -25,3 +28,18 @@ I18n.enforce_available_locales = false
 
 ActionMailer::Base.delivery_method = :test
 ActionMailer::Base.perform_deliveries = true
+
+def with_settings(settings)
+  original_settings = settings.each_with_object({}) { |(key, _), agg| agg[key] = Mjml.public_send(key) }
+  settings.each { |key, value| Mjml.public_send("#{key}=", value) }
+  yield
+ensure
+  original_settings.each { |key, value| Mjml.public_send("#{key}=", value) }
+end
+
+# Suppress all ruby warnings of the mail gem, see:
+# * https://github.com/mikel/mail/issues/1424
+# * https://github.com/mikel/mail/issues/1384
+# * https://github.com/mikel/mail/pull/1162
+require 'warning'
+Warning.ignore(//, %r{.*gems/mail.*/lib/mail/})

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mjml-rails
 version: !ruby/object:Gem::Version
-  version: 4.4.2
+  version: 4.7.0
 platform: ruby
 authors:
 - Simon Loffler
@@ -11,32 +11,130 @@ bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIEKDCCApCgAwIBAgIBATANBgkqhkiG9w0BAQsFADAfMR0wGwYDVQQDDBR5b3Vy
-  L0RDPWVtYWlsL0RDPWNvbTAeFw0yMDExMjIwNTA5MjJaFw0yMTExMjIwNTA5MjJa
-  MB8xHTAbBgNVBAMMFHlvdXIvREM9ZW1haWwvREM9Y29tMIIBojANBgkqhkiG9w0B
-  AQEFAAOCAY8AMIIBigKCAYEAmYphpc2KJNqmKAAKTE53F59mnVv2aW8r5NFDZqG0
-  DF6V8N5rdWanaMLlo1HyU9r7D1f/h7O/LnjZemvgH6MROd19Qe64GIdIPRXC/ZxM
-  cTBNC7GMoZf9LomBmg8sXnoL0Z2enUP6BV716I00EecxrEb8drtvZlRwjUgRcZrv
-  iEaanYYp1Sw3+koyOsof/xYb3Pn2TAh9UE58lbVDpf88zc74ij3Vs3+LW/k+jZzh
-  pzo7qq47XeVNGWtVDGm3dk8QLrIyQdk28B2ZRJ+HeuLEgx7ASDYFVZc05QlAjehS
-  4k37CIgF0ODDnscoSNNb6toFzaiD/kU9+ManRj871qOAMDlcX6cM4Wl08xfXZsxh
-  VgmIv7vFoSkBDw6t3xrHGD1HiYYQl2tFQsS9D/X9I+1ArChtUTSxEyN6VGP1YVd6
-  jsf4A/eMNRO6+udEQjYHontemi1xFeeyb6PDbP14oLMOls73fKvGZ3eW5uO3qCOb
-  tKhPFou/w1GgU3vR3O26Q3EZAgMBAAGjbzBtMAkGA1UdEwQCMAAwCwYDVR0PBAQD
-  AgSwMB0GA1UdDgQWBBTx6I3ZLm1G7VCtTJWWSKR2qv6x7TAZBgNVHREEEjAQgQ55
-  b3VyQGVtYWlsLmNvbTAZBgNVHRIEEjAQgQ55b3VyQGVtYWlsLmNvbTANBgkqhkiG
-  9w0BAQsFAAOCAYEAKCpNu5+MmYNrb+oOws9m8mghO4KDO53EQsfHtRcpsBxzwzV3
-  MLO4el5fMiAiv2PrULEWVyEoe3k65bEiSEQP7m7w02B02OGugXNzwbetG56gogFy
-  aJ4VJ95aiPEwDmGORLg7RmZcL/07ikDfb96ebPn3v2REYN2lWrqu4fT1MdTmA+hZ
-  vhfqJeSuWM5wNsWxA66SgbQe8BMHcsqV1CTG+Ir8FIAHzfa+c7CNke/28htRKYJV
-  6+lk55Ueov5TjjgLTUvjdqbAEtyCZpgxe2e0o3xqKh5d5YjWVQ4mSNvBsqK7UXOx
-  MGsePVBV9lnSFEJkGB3iOvavQSVUvqybF+yk6DrJR9iZtKCvAqd96PjkcFoM19dG
-  5ofv88TRZwXM9lWn4UKuekSSF1ElH3UBVDbH4zEHaOzrOvgfnZw3VteDigwfmmwF
-  lsAqKbu4nrHhtGhkwdYbflf2URJTUxXGptrnPYV7okmEg4rsykK3RAsZ6kMNdKmx
-  DcQ7RSt1TU5eck6c
+  MIIEPDCCAqSgAwIBAgIBATANBgkqhkiG9w0BAQsFADAkMSIwIAYDVQQDDBlzaWdo
+  bW9uL0RDPXNpZ2htb24vREM9Y29tMB4XDTIxMTIxODA1MDcyM1oXDTIyMTIxODA1
+  MDcyM1owJDEiMCAGA1UEAwwZc2lnaG1vbi9EQz1zaWdobW9uL0RDPWNvbTCCAaIw
+  DQYJKoZIhvcNAQEBBQADggGPADCCAYoCggGBALvTbM9xGlGQ9pByLEAJjAqc6U76
+  64uCOSIkgIFbC4iQdU5vzB/w4Y+mjgkH4oMsuW2NQfFBV+xI3jxQA0dN4qMgHooB
+  AWT/CSk0AAqTY1qCfCSASHLUWb5ZxURvsHmlXX/HCLX9bPcaYB0nQ+VT/u0lCicZ
+  beXMczHsNAj8f3ZJWDR9mw5OYc6cdGHM7Se3sqrmEsMYL9s8d08tChDcllxKV7cE
+  r2zb0oPrRFoYpakOIz1ViCl4KqBpQsDqXbwEw1kDCkKMXGHCsmDKML55kXsVVu4Q
+  9vqGvtEuvseWsDpKb6Psy4nJoktswhotUf21dNVM9k8ufXNaWvZed+cYnBFPLdQV
+  daaEqh6hIC/yUP98D5u+xmTYLRQQEsjhkbdfoLmB8UOwrsEZu79TXN6Iq4MZqmBe
+  qkCTlXOMaO/EbWVRRvs64iibC/boVVlXu6RZCVNyzXEvYxg/zyl0zjS8KPR8Vf4f
+  RKOUVKJCcL/nW4VZ1mvmJtiXI3eARaJdrBEjjQIDAQABo3kwdzAJBgNVHRMEAjAA
+  MAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQUC9Ln2Rotb61VZFq2rxBPP7sJIiUwHgYD
+  VR0RBBcwFYETc2lnaG1vbkBzaWdobW9uLmNvbTAeBgNVHRIEFzAVgRNzaWdobW9u
+  QHNpZ2htb24uY29tMA0GCSqGSIb3DQEBCwUAA4IBgQBN7i1ChHKDNa5ceCXUXdJ/
+  ZQnVQTx2KMvWwZ6qpkIWFbzwwL5w/xQdhQbLMjuaie5X1ZYOB9753ipw3tvl7iJz
+  vHEdTcOWAzMzHytySVcSa2DhanDopC+hrO5N+GoQ+5X9CN+xKG1Png4ho4FsuUtI
+  fESG8Kb48iNlpLGbfcM8Nqm/mYk/Xwqh3aSVb2E1NVUNr3QW84xB/xmzy2d9qNBm
+  0GecfnBmH+ARmR9Qk9H7YjtnhQv1W2wOBiz1k6GeO8wMLKRRHVI2TGcPR8AqhQGd
+  ejWL8tjMzIw5ggxro3WDklV1hn0iFSeWXNWd9tN40PjLYZqZ3krQ2wWgcgw/9eC9
+  yVr+12iQ7XbbPqlveO/FhP4gLa8e2q1TgWjYAXIaM61em83Dlm/3p75ch0YCB3X5
+  R9NsaxhBfawJEJcYoPZflGkLjJU8pjSuvIW5+rNgAiqY8D37hTtZMu/n2Fz8Qp24
+  7EZetZmcvBzARf8vQSJjga3y0Bftk8u7LmblOEWddzE=
   -----END CERTIFICATE-----
-date: 2020-11-27 00:00:00.000000000 Z
-dependencies: []
+date: 2021-12-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.23.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.23.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.12.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.12.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.12.4
+- !ruby/object:Gem::Dependency
+  name: warning
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.1
 description: Render MJML + ERb template views in Rails
 email: sighmon@sighmon.com
 executables: []
@@ -50,20 +148,19 @@ files:
 - lib/generators/mjml/mailer/templates/view.html.erb
 - lib/mjml-rails.rb
 - lib/mjml.rb
-- lib/mjml/mjmltemplate.rb
+- lib/mjml/handler.rb
 - lib/mjml/parser.rb
 - lib/mjml/railtie.rb
 - lib/mjml/version.rb
 - test/generator_test.rb
 - test/mjml_test.rb
 - test/parser_test.rb
-- test/template_test.rb
 - test/test_helper.rb
 homepage: https://github.com/sighmon/mjml-rails
 licenses:
 - MIT
 metadata: {}
-post_install_message: "Don't forget to install MJML e.g. \n$ npm install -g mjml"
+post_install_message: "Don't forget to install MJML e.g. \n$ npm install mjml"
 rdoc_options: []
 require_paths:
 - lib
@@ -71,14 +168,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: MJML + ERb templates
@@ -86,5 +183,4 @@ test_files:
 - test/generator_test.rb
 - test/parser_test.rb
 - test/mjml_test.rb
-- test/template_test.rb
 - test/test_helper.rb

data/lib/mjml/mjmltemplate.rb

@@ -1,12 +0,0 @@
-require "mjml/parser"
-
-module Mjml
-  mattr_accessor :processing_options, :renderer
-  @@processing_options = {}
-
-  class Mjmltemplate
-    def self.to_html(compiled_source)
-      Mjml::Parser.new(compiled_source).render.html_safe
-    end
-  end
-end

data/test/template_test.rb

@@ -1,9 +0,0 @@
-require "test_helper"
-
-class MjmlTest < ActiveSupport::TestCase
-
-  test 'with Mjmltemplate processor' do
-    assert_not_equal "<mj-body></mj-body>", Mjml::Mjmltemplate.to_html("<mjml><mj-body><mj-section><mj-column></mj-column></mj-section></mj-body></mjml>").strip
-  end
-
-end