mjml-rails 4.4.2 → 4.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8610d3313ee8297b7ac411aa8f23b8c99a85cf41940db1798529d91193fb37d
-  data.tar.gz: c5099915099d3aeb6e050bf44b3cb81b8fe759686a06b85d61a197e65b7b4dfb
+  metadata.gz: 128c814314ffe1c725a9d46d0537c161a45098650f67cf063cf0e27325cd11d2
+  data.tar.gz: b23564a1cf6b824359019f60bf08cb1f97d6d7584f1e58a2220fc672a4dea77c
 SHA512:
-  metadata.gz: 717f6819381d9f925ce597f05288cfc6f3c07417e353de40561de9ddffc6ac48331e4877ed775818b7b3dbd3836c27e2347bafcbcc9c0247b467565e944911ab
-  data.tar.gz: ec6662022e6ed5f5e8b6732d61fa766de5af32dd57fcd43c508576bcb7f594b1f413b17452532fa4e7ee94b46d1c90427bb90e3cff1425ae39c05d46c38f371e
+  metadata.gz: 9c56d2b1b80bcb2f7ef36cf8e927d135fbdc26fd67f7ac2db52ece28065d1cb98010c89f9abae9176c7861ef3ab65ae099c8cb98ecabf371d06c42cff53f141d
+  data.tar.gz: 1eea404a1e315166fd132ec37b76257d4789f030af4853992067230cda800875861b68fde85a358e803ff283d15cb1d14c88ae778dd49e5f27f01109faf0e787

data/README.md

@@ -95,18 +95,20 @@ 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)
+- validation_level: defaults to `strict` (abort on any template error, see [MJML validation documentation](https://github.com/mjmlio/mjml/tree/master/packages/mjml-validator#validating-mjml) for possible values)
 
 ```ruby
 # config/initializers/mjml.rb
 Mjml.setup do |config|
-  # set to `false` to ignore errors silently
-  config.raise_render_exception = true
+  # ignore errors silently
+  config.raise_render_exception = false
 
   # optimize the size of your email
   config.beautify = false
   config.minify = true
-  config.validation_level = "strict"
+
+  # render illformed MJML templates, not recommended
+  config.validation_level = "soft"
 end
 ```
 

data/lib/mjml.rb

@@ -15,7 +15,7 @@ module Mjml
   @@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"
+  @@validation_level = "strict"
 
   def self.check_version(bin)
     stdout, _, status = run_mjml('--version', mjml_bin: bin)

data/lib/mjml/parser.rb

@@ -1,5 +1,3 @@
-require 'open3'
-
 module Mjml
   class Parser
     class ParseError < StandardError; end
@@ -33,11 +31,12 @@ module Mjml
     # Exec mjml command
     #
     # @return [String] The result as string
-    def run(in_tmp_file, beautify=true, minify=false, validation_level="soft")
+    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, _ = Mjml.run_mjml(command)
-        raise ParseError.new(stderr.chomp) unless stderr.blank?
+        _, stderr, status = Mjml.run_mjml(command)
+        raise ParseError.new(stderr.chomp) unless status.success?
+        Mjml.logger.warn(stderr.chomp) unless stderr.blank?
         out_tmp_file.read
       end
     end

data/lib/mjml/version.rb

@@ -1,4 +1,4 @@
 module Mjml
 	# Version number no longer matches MJML.io version
-  VERSION = "4.4.2"
+  VERSION = "4.5.0"
 end

data/test/mjml_test.rb

@@ -13,6 +13,15 @@ class NotifierMailer < ActionMailer::Base
       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
@@ -58,6 +67,22 @@ class NotifierMailerTest < ActiveSupport::TestCase
     assert email.text_part.body.match(/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
+    with_settings(validation_level: 'soft') do
+      email = NotifierMailer.invalid_template("user@example.com")
+      assert email.text_part.body.match(/This is valid/)
+      assert email.html_part.body.match(/This is valid/)
+      refute email.html_part.body.match(/This is invalid/)
+    end
+  end
 end
 
 class NotifierMailerTest < ActiveSupport::TestCase

data/test/parser_test.rb

@@ -13,54 +13,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

data/test/test_helper.rb

@@ -25,3 +25,20 @@ 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({}) do |(key, _), agg|
+      agg[key] = Mjml.public_send(key)
+    end
+
+  settings.each do |key, value|
+    Mjml.public_send("#{key}=", value)
+  end
+
+  yield
+ensure
+  original_settings.each do |key, value|
+    Mjml.public_send("#{key}=", value)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mjml-rails
 version: !ruby/object:Gem::Version
-  version: 4.4.2
+  version: 4.5.0
 platform: ruby
 authors:
 - Simon Loffler
@@ -35,7 +35,7 @@ cert_chain:
   lsAqKbu4nrHhtGhkwdYbflf2URJTUxXGptrnPYV7okmEg4rsykK3RAsZ6kMNdKmx
   DcQ7RSt1TU5eck6c
   -----END CERTIFICATE-----
-date: 2020-11-27 00:00:00.000000000 Z
+date: 2020-11-29 00:00:00.000000000 Z
 dependencies: []
 description: Render MJML + ERb template views in Rails
 email: sighmon@sighmon.com
@@ -63,7 +63,7 @@ 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