mjml-rails 4.3.0 → 4.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a65c2ff3a407479d78f77b8d513813d0f854686c2f9714166352eedde66e79f
-  data.tar.gz: d8ae58fc1113e28391e18ba08c1f18c0de211ef86c205a3060bdec242a80717f
+  metadata.gz: a8610d3313ee8297b7ac411aa8f23b8c99a85cf41940db1798529d91193fb37d
+  data.tar.gz: c5099915099d3aeb6e050bf44b3cb81b8fe759686a06b85d61a197e65b7b4dfb
 SHA512:
-  metadata.gz: 9193f72b9fd381b1cc6f6e92d035ca71c0f0efac8109e0e0ccb53ebb00f1ed7fcec081b867c1eaf8276ddad14740b6ce599dc43a529b4d53ac7e61cf4c3d0a4f
-  data.tar.gz: 061b6315985c9e2e23fd1833a9ab2bf960842e01d4baaf24e1b502f7ad4411a6a5481ab71ef5aebc1fe73d535d022dd8d1c50f6939e47d06139b32837c34da99
+  metadata.gz: 717f6819381d9f925ce597f05288cfc6f3c07417e353de40561de9ddffc6ac48331e4877ed775818b7b3dbd3836c27e2347bafcbcc9c0247b467565e944911ab
+  data.tar.gz: ec6662022e6ed5f5e8b6732d61fa766de5af32dd57fcd43c508576bcb7f594b1f413b17452532fa4e7ee94b46d1c90427bb90e3cff1425ae39c05d46c38f371e

data.tar.gz.sig

@@ -1,3 +1,5 @@
-1��p��$91s=XsT>�Dۙ�j�Sl
-u�����}�:"h�:ƴ��r$��IĤN�f,��c|ԓ\��	ZG�����?`��x�I�)�B)����p$rb.>j��F�����t<�H���jk0��P�ڂ'	�ikYB݂�[�cuÐf�\7��>�Pl�V?ga37�?��>��F�nE�,]�J+z{�2T�{��d)��={�\a���|]Ѵ�jp�w��$��/P/�*��X2��y7��_}��Tv.���5&�KQ�O��P�/�����iJ�mz]fJ��E��Oҋ0m���1�F�M��(QƐWu$/D�ȭ�B�tIz�
-�c����m_��8u�B*�m�����]�
+&=V��߀��\�c�~ʻ�!_mAzߪϣRQ��!�bN�{8{Q�%����(���|�授2v
+���ZP������*��an����Nj��L�U
+���Y��QN\m5fm0��iw�����Ⱦ����a��Njg�G-=�Q�K=�.�W -r��`���aX��7>�z�wK~P.=i*��@A�E_���yoõ�
+\�$W�P���O�q����G�hމ�p�E��pn��v	f�m.�/|��
+��)|���f*��>�`k��"~v�u��e	�x�]EFC��B({*�w��Q,rE�*Kg�w3�Ft�p���'���?���'f��<�!�PZՃO"

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,8 +95,10 @@ 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
@@ -94,14 +106,16 @@ Mjml.setup do |config|
   # optimize the size of your email
   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.`:
 
 ```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 +165,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 +185,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 +199,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 +267,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,27 +15,54 @@ 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"
 
   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 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
+
+    # 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 local install of MJML binary
-    installer_path = (`npm bin` || `yarn bin`).chomp
-    mjml_bin = File.join(installer_path, 'mjml')
-    return mjml_bin if check_version(mjml_bin)
+    # 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)
+    stdout, _, status = Open3.capture3("#{package_manager} bin")
+
+    return unless status.success?
+
+    stdout.chomp
+  rescue Errno::ENOENT # package manager is not installed
+    nil
+  end
+
   BIN = discover_mjml_bin
 
   class Handler

data/lib/mjml/parser.rb

@@ -22,7 +22,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 +33,11 @@ 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="soft")
       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, _ = Mjml.run_mjml(command)
+        raise ParseError.new(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.0"
+  VERSION = "4.4.2"
 end

data/test/parser_test.rb

@@ -21,7 +21,8 @@ describe Mjml::Parser do
         end
 
         it 'raises exception' do
-          -> { parser.render }.must_raise(custom_error_class, error.message)
+          err = expect { parser.render }.must_raise(custom_error_class)
+          expect(err.message).must_equal error.message
         end
       end
 
@@ -33,38 +34,43 @@ describe Mjml::Parser do
         end
 
         it 'returns empty string' do
-          parser.render.must_equal ''
+          expect(parser.render).must_equal ''
         end
       end
     end
 
-    describe 'can read beautify and minify configs' do
+    describe 'can read beautify, minify, and validation_level configs' do
       it 'use defaults if no config is set' do
-        expect(Mjml.beautify).equal?(true);
-        expect(Mjml.minify).equal?(false);
+        expect(Mjml.beautify).must_equal(true)
+        expect(Mjml.minify).must_equal(false)
+        expect(Mjml.validation_level).must_equal('soft')
       end
 
       it 'use setup config' do
         Mjml.setup do |config|
           config.beautify = false
           config.minify = true
+          config.validation_level = 'strict'
         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('strict')
+
+        Mjml.setup do |config|
+          config.beautify = true
+          config.minify = false
+          config.validation_level = 'soft'
+        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

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: mjml-rails
 version: !ruby/object:Gem::Version
-  version: 4.3.0
+  version: 4.4.2
 platform: ruby
 authors:
 - Simon Loffler
 - Steven Pickles
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIEPDCCAqSgAwIBAgIBATANBgkqhkiG9w0BAQsFADAkMSIwIAYDVQQDDBlzaWdo
-  bW9uL0RDPXNpZ2htb24vREM9Y29tMB4XDTE4MDkwMTA4Mjc1NloXDTE5MDkwMTA4
-  Mjc1NlowJDEiMCAGA1UEAwwZc2lnaG1vbi9EQz1zaWdobW9uL0RDPWNvbTCCAaIw
-  DQYJKoZIhvcNAQEBBQADggGPADCCAYoCggGBAMHJycEbent4LeyZzcNxDkX8dXvi
-  NnKCjrZ6MeM29HPllRY+pEHMOF3P+SkRYZjEsw4U4hycUneTu8cT6eqDVkhqxuYu
-  uupKuZPoBHahZwz8lzuAOLFwuWNvuQVhCVGXni+OsR/kODQvDhWOJynqW3YKEnQE
-  npJWDkDx66B4A6iQcWPMCJMIFDStmb+1YP+5/ERVscixIoUPosWGGbIsEypvT4Wg
-  4BP8jY5eGPIkYJ8H71qReU6klbbl4MSZ78A9YY3atWT60R2LNop+/zc12be12FfZ
-  PYVi866w0ZnYC+hd9cljKWhoZE5LImqVGZ70GAcNqXF8pIC6stPWPlHacRftBvk4
-  Pval7Ldehj0tym8TbnHJp5M6jduHLroIHOtH6hLjfhPpvYHhwAKB8lsiH7nA7kKT
-  wi2BnJUjakKmqlXl/NZjnFMKf5jjd5IbkguxNT6Yaaxx18aVmIpnoLWC4Ufgfnno
-  n+TTW9lt+2XVf6BKw5A5HoKPy1YXkV5+ttaYRQIDAQABo3kwdzAJBgNVHRMEAjAA
-  MAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQU3EEsjak+bfbn6i5f4NTlk/QgP3cwHgYD
-  VR0RBBcwFYETc2lnaG1vbkBzaWdobW9uLmNvbTAeBgNVHRIEFzAVgRNzaWdobW9u
-  QHNpZ2htb24uY29tMA0GCSqGSIb3DQEBCwUAA4IBgQADbJLEnYWMNsHt8qgjOwoJ
-  au+cfFfXr80Fy0swXIsShtlWY4tO7g4kNmETmUIl/W0fmYAzB1nuHP+CEA2XCbT3
-  pOa2ditHojbGtvbpm/7PpsWkQnHNOvhwBulKr+HvW5XFF938BBdjiT0v6x8TPCds
-  ECuFmOLrr+W9sW+itf8xWB+KGWa+iiE4DGpBixiF/XEkjAXvFzi0/zCATJEvTJaA
-  znVJYgAW9T/EnrlgkFCl8QoNSvQv7s1YnQcCPa8LQssCcuxqrLaD9wU+Y0NLa+Cd
-  5QntiYOIOb2Jc2bReEey6GHqANo++hgpWHruQzrS9ESeXxlf8hjGAtJdFSkningS
-  hRvN1MDIRUxsBEqM853mlceiu6m9sd9nZSAPBIQiBDTTydue6lmA6tL/qLB62NBJ
-  2QfUTBQZBmdkzXtFEAAJQVPa0X6iKxer4Na0dbjQciqf+5FrNBrct94To8eEEgqJ
-  Yz5YuMu9yoVoBwOVkHs0NmbAKSv041eBwfQpzmm+reA=
+  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-04-07 00:00:00.000000000 Z
+date: 2020-11-27 00:00:00.000000000 Z
 dependencies: []
 description: Render MJML + ERb template views in Rails
 email: sighmon@sighmon.com
@@ -78,9 +78,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.9
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: MJML + ERb templates
 test_files: