mjml-rails 4.3.1 → 4.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b02f5e2cbabe0dd1c593d09018c44e1a4476dd24e39841714a11ed817defdc64
-  data.tar.gz: c248937b61b38ec294fdeffe7bbbf41da470f3157b664697c9def79f543ecaad
+  metadata.gz: 128c814314ffe1c725a9d46d0537c161a45098650f67cf063cf0e27325cd11d2
+  data.tar.gz: b23564a1cf6b824359019f60bf08cb1f97d6d7584f1e58a2220fc672a4dea77c
 SHA512:
-  metadata.gz: c192ba7708cbf3ec3803bf01a402c576012440c9ab3db13eddf20474381b5c8441d03053ba21b521af053a9c193fc5b22eacfbc957f78771629fbf8a9ec99cdc
-  data.tar.gz: c541acdfc42a6f538d7a53a9409e88d4fa5a0241b94bd9969e1431450e573e349b4c4e82512c6d55768d9a142b238d5513cd5555c3b8ffa19b3b84ede3f532e4
+  metadata.gz: 9c56d2b1b80bcb2f7ef36cf8e927d135fbdc26fd67f7ac2db52ece28065d1cb98010c89f9abae9176c7861ef3ab65ae099c8cb98ecabf371d06c42cff53f141d
+  data.tar.gz: 1eea404a1e315166fd132ec37b76257d4789f030af4853992067230cda800875861b68fde85a358e803ff283d15cb1d14c88ae778dd49e5f27f01109faf0e787

data/README.md

@@ -34,7 +34,7 @@ And the partial:
 
 * Notice you can use ERB and partials inside the template.
 
-Your `user_mailer.rb` might look like this::
+Your `user_mailer.rb` might look like this:
 
 ```ruby
 # ./app/mailers/user_mailer.rb
@@ -48,6 +48,10 @@ class UserMailer < ActionMailer::Base
 end
 ```
 
+## Example application
+
+* [MJML with Rails 6](https://github.com/dyanagi/example_mjml_rails): Renders HTML emails with MJML layout, view, and partial.
+
 ## Installation
 
 Add it to your Gemfile.
@@ -62,13 +66,19 @@ Run the following command to install it:
 bundle install
 ```
 
-Install the MJML parser (optional -g to install it globally):
+Add the MJML parser to your project with your favourite package manager:
 
 ```console
-npm install -g mjml
+# with npm
+npm install mjml
+
+# with yarn
+yarn add mjml
 ```
 
-Note that you'll need at least Node.js version 6 for MJML to function properly.
+MJML-Rails falls back to a global installation of MJML but it is strongly recommended to add MJML directly to your project.
+
+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:
 
@@ -85,23 +95,29 @@ 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 `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
+
+  # render illformed MJML templates, not recommended
+  config.validation_level = "soft"
 end
 ```
 
 If you’d like to specify a different MJML binary to run other than `4.`:
 
 ```ruby
+# config/initializers/mjml.rb
 Mjml.setup do |config|
-  config.mjml_binary_version_supported = “3.3.5”
+  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
@@ -151,12 +167,14 @@ class MyMailer < ActionMailer::Base
     @recipient = user
 
     mail(to: user.email, from: "app@example.com") do |format|
-      format.html
+      format.html # This will look for "default.html.erb" and then "default.html.mjml"
     end
   end
 end
 ```
 
+Note: If `default.html.erb` exists, email will be rendered as ERB, and MJML tags will not be compiled.
+
 Email layout:
 ```html
 <!-- views/layouts/default.html.mjml -->
@@ -169,7 +187,7 @@ Email layout:
 
 Email view:
 ```html
-<!-- views/my_mailer/foo_bar.html.erb -->
+<!-- views/my_mailer/foo_bar.html.mjml (or foo_bar.html.erb) -->
 <%= render partial: "to" %>
 
 <mj-section>
@@ -183,7 +201,7 @@ Email view:
 
 Email partial:
 ```html
-<!-- views/my_mailer/_to.html.erb -->
+<!-- views/my_mailer/_to.html.mjml (or _to.html.erb) -->
 <mj-section>
   <mj-column>
     <mj-text>
@@ -251,7 +269,7 @@ Next you'll need to setup a `package.json` file in the root, something like this
     "test": "test"
   },
   "dependencies": {
-    "mjml": "^4.0.0",
+    "mjml": "^4.0.0"
   },
   "repository": {
     "type": "git",

data/lib/mjml.rb

@@ -4,9 +4,10 @@ require "action_view/template"
 require "mjml/mjmltemplate"
 require "mjml/railtie"
 require "rubygems"
+require "open3"
 
 module Mjml
-  mattr_accessor :template_language, :raise_render_exception, :mjml_binary_version_supported, :mjml_binary_error_string, :beautify, :minify
+  mattr_accessor :template_language, :raise_render_exception, :mjml_binary_version_supported, :mjml_binary_error_string, :beautify, :minify, :validation_level
 
   @@template_language = :erb
   @@raise_render_exception = true
@@ -14,34 +15,50 @@ 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 = "strict"
 
   def self.check_version(bin)
-    IO.popen([bin, '--version']) { |io| io.read.include?("mjml-core: #{Mjml.mjml_binary_version_supported}") }
-  rescue
+    stdout, _, status = run_mjml('--version', mjml_bin: bin)
+    status.success? && stdout.include?("mjml-core: #{Mjml.mjml_binary_version_supported}")
+  rescue StandardError
     false
   end
 
+  def self.run_mjml(args, mjml_bin: nil)
+    mjml_bin ||= BIN
+
+    Open3.capture3("#{mjml_bin} #{args}")
+  end
+
   def self.discover_mjml_bin
-    # Check for a global install of MJML binary
-    mjml_bin = 'mjml'
-    return mjml_bin if check_version(mjml_bin)
-
-    # Check for a local install of MJML binary
-    installer_path = bin_path_from('npm') || bin_path_from('yarn')
-    unless installer_path
-      puts Mjml.mjml_binary_error_string
-      return nil
+    # 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)
     end
 
-    mjml_bin = File.join(installer_path, 'mjml')
-    return mjml_bin if check_version(mjml_bin)
+    # Check for a local install of MJML with npm
+    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
+
+    # Check for a global install of MJML
+    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)
-    `#{package_manager} bin`.chomp
+    stdout, _, status = Open3.capture3("#{package_manager} bin")
+
+    return unless status.success?
+
+    stdout.chomp
   rescue Errno::ENOENT # package manager is not installed
     nil
   end

data/lib/mjml/parser.rb

@@ -1,5 +1,3 @@
-require 'open3'
-
 module Mjml
   class Parser
     class ParseError < StandardError; end
@@ -22,7 +20,7 @@ module Mjml
         file.write(input)
         file # return tempfile from block so #unlink works later
       end
-      run(in_tmp_file.path, Mjml.beautify, Mjml.minify)
+      run(in_tmp_file.path, Mjml.beautify, Mjml.minify, Mjml.validation_level)
     rescue
       raise if Mjml.raise_render_exception
       ""
@@ -33,11 +31,12 @@ module Mjml
     # Exec mjml command
     #
     # @return [String] The result as string
-    def run(in_tmp_file, beautify=true, minify=false)
+    def run(in_tmp_file, beautify=true, minify=false, validation_level="strict")
       Tempfile.create(["out", ".html"]) do |out_tmp_file|
-        command = "#{mjml_bin} -r #{in_tmp_file} -o #{out_tmp_file.path} --config.beautify #{beautify} --config.minify #{minify}"
-        _, _, stderr, _ = Open3.popen3(command)
-        raise ParseError.new(stderr.read.chomp) unless stderr.eof?
+        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.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.3.1"
+  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,58 +13,52 @@ 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
-          -> { parser.render }.must_raise(custom_error_class, error.message)
+      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
-          parser.render.must_equal ''
+      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 and minify configs' do
-      it 'use defaults if no config is set' do
-        expect(Mjml.beautify).equal?(true);
-        expect(Mjml.minify).equal?(false);
+    describe 'can read beautify, minify, and validation_level configs' 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('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 = 'soft'
         end
 
-        expect(Mjml.beautify).equal?(false);
-        expect(Mjml.minify).equal?(true);
+        expect(Mjml.beautify).must_equal(false)
+        expect(Mjml.minify).must_equal(true)
+        expect(Mjml.validation_level).must_equal('soft')
+
+        Mjml.setup do |config|
+          config.beautify = true
+          config.minify = false
+          config.validation_level = 'strict'
+        end
       end
     end
   end
 
   describe '#run' do
-    describe 'when shell command is failed' do
-      let(:error) { 'shell error' }
-      let(:stderr) { mock('stderr', eof?: false, read: error) }
-
-      before { Open3.stubs(popen3: [nil, nil, stderr, nil]) }
-
+    describe 'when shell command failed' do
       it 'raises exception' do
-        -> { parser.run "/tmp/input_file.mjml" }.must_raise(Mjml::Parser::ParseError, error)
+        err = expect { parser.run "/tmp/non_existent_file.mjml" }.must_raise(Mjml::Parser::ParseError)
+        expect(err.message).must_include 'Command line error'
       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,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: mjml-rails
 version: !ruby/object:Gem::Version
-  version: 4.3.1
+  version: 4.5.0
 platform: ruby
 authors:
 - Simon Loffler
 - Steven Pickles
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIEPDCCAqSgAwIBAgIBATANBgkqhkiG9w0BAQsFADAkMSIwIAYDVQQDDBlzaWdo
-  bW9uL0RDPXNpZ2htb24vREM9Y29tMB4XDTE5MDkwMzEwMjAzMFoXDTIwMDkwMjEw
-  MjAzMFowJDEiMCAGA1UEAwwZc2lnaG1vbi9EQz1zaWdobW9uL0RDPWNvbTCCAaIw
-  DQYJKoZIhvcNAQEBBQADggGPADCCAYoCggGBALePOldN5EpBHYLzEl03frx6qnNL
-  t7FR4L4E18C5nkYui//Qrk3PgIuOROzNYCn/DadpvfrJAXUD483+XZbwhwBKscx6
-  GPdoYotiH3R5BLvhfPQGI5yz4Dr3W8g5Z3vgtbL+4NS3XCGs3DjdmkLNBIjYJQC9
-  j8vP1+QChRUZAq7LRmwW4H39qJEEbGasmAfLZIAyzt+B0daUoVvEagOE94taAbYd
-  FzhBXn0Rkcs2GbCwv9oxbXlhO47wABLB0eOCL6VMZdwrfkML6agw81jnvzs2Dh1W
-  e2jUX57TpeXKZ6+2XHppKDaMjFLCkJ2Dgcw5TKiueoMduwUJBK/EDZmGXnLIcgey
-  WxP/DrZeiuWvF6P2C29w7qWIckrnmJ5ZVdNBfODgkIk4dQpo4iMBSI7D8DUIVdjV
-  idzSNN/0YR5bKqsWu6Vc/Rn0X5nj4ZKKFNHcDHdQ0vmegW6W2IEfz4tluaj/Musd
-  oNk6rqkL7wDA5MhxxCn7JoIheiZsQZsO+opciQIDAQABo3kwdzAJBgNVHRMEAjAA
-  MAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQUq7/KMLTxf/TCUbkl0NKtz21AfHEwHgYD
-  VR0RBBcwFYETc2lnaG1vbkBzaWdobW9uLmNvbTAeBgNVHRIEFzAVgRNzaWdobW9u
-  QHNpZ2htb24uY29tMA0GCSqGSIb3DQEBCwUAA4IBgQAa3BCcAy8V/qrjSt8dJjBJ
-  ijPJqbbUicwK2TlClSQh1HwbloPpVq8pRcXW4MZ/hQFDL5B4hHfAhr8vwPSFs6zk
-  XlAsWyOhNI6s2N7ojs/H3ky1PvrJEwPhn4LagsunTPS0HSDXdBfx3IYZMJkB910j
-  alxsWGeFcutKGWWkcbmZne4wB0usxzukKOwLzTcg48xG4tk5e/uV6ujlPdDx48+f
-  xNroJyE1NCb9ow5q9+vtFPqgXqm8pIocuBdBiPuJkZ2ChT07BAZSV3Ab8p+8Vm4I
-  g0+o9l7CF4YhHQrLFQc8KDVTKllHtr+NiJBUSpGEddXuMbLxxT37GibymLDRdKrX
-  DDHEzWaQtaK6EZv3Vhk46/slfn3LGdHpRNQEjSBlBHtH2w6S1qg0HmfKs7/w0oW5
-  HIqlmrbWgQA1FL8W9hf5pmQBhNu6zNDtZooPwDPGf0klvVt/Lkh4zjDHlO284UV5
-  Z3vePI5/udzlcrq80eIHh5Ch5NVPG8B7O1qMSwJo4to=
+  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
   -----END CERTIFICATE-----
-date: 2019-09-03 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
@@ -78,8 +78,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: MJML + ERb templates
 test_files: