mjml-rails 4.8.0 → 4.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79d635939113a77bdcfa96934cafa71e52a13c71171eb36c138250952e0df2de
-  data.tar.gz: 5943d70d89ef0d1ce8ba63c32dd72e6837982938b4fbe59e6e4cf5088f04b16b
+  metadata.gz: e787307cfcd482f30208f9e38c0ec246b1670ef56bd36fd158d1c84f9b05430a
+  data.tar.gz: 7cc87eadbc13039cf2348cc3e5dc08313a751bf6360c403bfa4b545d628864c7
 SHA512:
-  metadata.gz: 00a5e9270464c12f16f0b7b8f3e32dc9c0c20413d34063c33c4b86bec08eb7df1c2d5ae20beb61d9f708242203c6c33b663652a207e135ef658cc6636497dcec
-  data.tar.gz: bab11c714982bca667864e180e9c6066c4a22221dff010a19ffd179b25f79dff8a9de4809af5217ec82d62291835aecf231d79b6ecd255f5bd71e4ba3829365e
+  metadata.gz: 38927fca73bc05d06f51a749176b1d8a93e9f08d30ebecd7b1a904f10093111d8239f368cd4ae0c428a15aaad4412f09442767bb60c621b6508917620f3c2d3a
+  data.tar.gz: 05cf3a1528c6375c7dd526d1952b589625af2b1a9c974d35a067f64a54bab3bd8eb3f9cbb8ae0bee17411a53e9c0efc83d08999e7c28f0d8dd3807ec3e149543

data/README.md

@@ -54,6 +54,8 @@ end
 
 ## Installation
 
+### Using MJML NPM package
+
 Add it to your Gemfile.
 
 ```ruby
@@ -72,6 +74,9 @@ Add the MJML parser to your project with your favourite package manager:
 # with npm
 npm install mjml
 
+# or install it globally (The best way for Rails 7.x.x with importmaps)
+npm install -g mjml
+
 # with yarn
 yarn add mjml
 ```
@@ -80,6 +85,34 @@ 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.
 
+### Using MRML with included binaries
+
+If for some reason you can't or don't want to run JS code in your production environment, you can use [MRML](https://github.com/hardpixel/mrml-ruby). It ships with already compiled binaries for Rust implementation of MJML so it has no external dependencies.
+
+Add `mjml-rails` and `mrml` to your Gemfile.
+
+```ruby
+gem 'mjml-rails'
+gem 'mrml'
+```
+
+Run the following command to install it:
+
+```console
+bundle install
+```
+
+Set `use_mrml` option to `true` in your initializer:
+
+```ruby
+# config/initializers/mjml.rb
+Mjml.setup do |config|
+  config.use_mrml = true
+end
+```
+
+**Note**: MRML does not fully support all MJML functionalities, see [Missing implementations](https://github.com/jdrouet/mrml#missing-implementations)
+
 ## Configuration
 
 MJML-Rails has the following settings with defaults:
@@ -112,10 +145,12 @@ MJML-Rails has the following settings with defaults:
 
    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_binary_version_supported: "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.
 
+- `use_mrml: false`
+  Enabling this will allow you to use Rust implementation of MJML via the `mrml` gem. It comes with prebuilt binaries instead of having to install MJML along with Node. When enabled the options `mjml_binary_version_supported`, `mjml_binary`, `minify`, `beautify` and `validation_level` are ignored.
 
 ```ruby
 # config/initializers/mjml.rb
@@ -133,6 +168,9 @@ Mjml.setup do |config|
   # Render MJML templates with errors
   config.validation_level = "soft"
 
+  # Use MRML instead of MJML, false by default
+  config.use_mrml = false
+
   # Use custom MJML binary with custom version
   config.mjml_binary = "/path/to/custom/mjml"
   config.mjml_binary_version_supported = "3.3.5"

data/lib/mjml/handler.rb

@@ -16,6 +16,7 @@ module Mjml
     def call(template, source = nil)
       compiled_source = compile_source(source, template)
 
+      parser_class = Mjml.use_mrml ? 'MrmlParser' : 'Parser'
       # 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')
@@ -24,7 +25,7 @@ module Mjml
       #
       # [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"
+        "Mjml::#{parser_class}.new(begin;#{compiled_source};end).render.html_safe"
       else
         compiled_source
       end

data/lib/mjml/mrml_parser.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Mjml
+  class MrmlParser
+    attr_reader :input
+
+    # Create new parser
+    #
+    # @param input [String] The string to transform in html
+    def initialize(input)
+      @input = input
+    end
+
+    # Render mjml template
+    #
+    # @return [String]
+    def render
+      MRML.to_html(input)
+    rescue NameError
+      Mjml.logger.fatal('MRML is not installed. Please add `gem "mrml"` to your Gemfile.')
+      raise
+    rescue StandardError
+      raise if Mjml.raise_render_exception
+
+      ''
+    end
+  end
+end

data/lib/mjml/version.rb

@@ -2,5 +2,5 @@
 
 module Mjml
   # Version number no longer matches MJML.io version
-  VERSION = '4.8.0'
+  VERSION = '4.10.0'
 end

data/lib/mjml.rb

@@ -5,7 +5,7 @@ require 'open3'
 
 require 'mjml/handler'
 require 'mjml/parser'
-
+require 'mjml/mrml_parser'
 require 'mjml/railtie' if defined?(Rails)
 
 module Mjml
@@ -17,7 +17,8 @@ module Mjml
     :mjml_binary_version_supported,
     :raise_render_exception,
     :template_language,
-    :validation_level
+    :validation_level,
+    :use_mrml
 
   mattr_writer :valid_mjml_binary
 
@@ -29,6 +30,7 @@ module Mjml
   self.beautify = true
   self.minify = false
   self.validation_level = 'strict'
+  self.use_mrml = false
 
   def self.check_version(bin)
     stdout, _, status = run_mjml('--version', mjml_bin: bin)
@@ -71,18 +73,28 @@ module Mjml
 
   def self.check_for_yarn_mjml_binary
     yarn_bin = `which yarn`.chomp
-    return unless yarn_bin.present? && (installer_path = bin_path_from(yarn_bin)).present?
+    return if yarn_bin.blank?
+
+    stdout, _, status = Open3.capture3("#{yarn_bin} bin mjml")
+    return unless status.success?
 
-    mjml_bin = File.join(installer_path, 'mjml')
+    mjml_bin = stdout.chomp
     return mjml_bin if check_version(mjml_bin)
+  rescue Errno::ENOENT # package manager is not installed
+    nil
   end
 
   def self.check_for_npm_mjml_binary
     npm_bin = `which npm`.chomp
-    return unless npm_bin.present? && (installer_path = bin_path_from(npm_bin)).present?
+    return if npm_bin.blank?
+
+    stdout, _, status = Open3.capture3("#{npm_bin} root")
+    return unless status.success?
 
-    mjml_bin = File.join(installer_path, 'mjml')
+    mjml_bin = File.join(stdout.chomp, '.bin', 'mjml')
     return mjml_bin if check_version(mjml_bin)
+  rescue Errno::ENOENT # package manager is not installed
+    nil
   end
 
   def self.check_for_global_mjml_binary
@@ -90,16 +102,6 @@ module Mjml
     return mjml_bin if mjml_bin.present? && check_version(mjml_bin)
   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
-
   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.')

data/test/mrml_parser_test.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+describe Mjml::MrmlParser do
+  let(:parser) { Mjml::MrmlParser.new(input) }
+
+  describe '#render' do
+    describe 'when input is valid' do
+      let(:input) { '<mjml><mj-body><mj-text>Hello World</mj-text></mj-body></mjml>' }
+
+      it 'returns html' do
+        expect(parser.render).must_include 'Hello World</div>'
+      end
+    end
+
+    describe 'when exception is raised' do
+      let(:input) { '<mjml><body><mj-text>Hello World</mj-text></body></mjml>' }
+
+      it 'raises exception with render exception enabled' do
+        with_settings(raise_render_exception: true) do
+          expect { parser.render }.must_raise(MRML::Error)
+        end
+      end
+
+      it 'returns empty string with exception raising disabled' do
+        with_settings(raise_render_exception: false) do
+          expect(parser.render).must_equal ''
+        end
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -5,6 +5,7 @@ require 'bundler'
 Bundler.setup
 
 require 'minitest/autorun'
+require 'active_support'
 require 'active_support/test_case'
 
 require 'action_mailer'
@@ -13,6 +14,7 @@ require 'rails/generators'
 require 'rails/generators/test_case'
 require 'mocha/minitest'
 require 'byebug'
+require 'mrml'
 
 # require "minitest/reporters"
 # Minitest::Reporters.use!

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mjml-rails
 version: !ruby/object:Gem::Version
-  version: 4.8.0
+  version: 4.10.0
 platform: ruby
 authors:
 - Simon Loffler
@@ -11,31 +11,32 @@ bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  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=
+  MIIEdDCCAtygAwIBAgIBATANBgkqhkiG9w0BAQsFADBAMRAwDgYDVQQDDAdzaWdo
+  bW9uMRcwFQYKCZImiZPyLGQBGRYHc2lnaG1vbjETMBEGCgmSJomT8ixkARkWA2Nv
+  bTAeFw0yMzA1MTIwNzA2MTJaFw0yNDA1MTEwNzA2MTJaMEAxEDAOBgNVBAMMB3Np
+  Z2htb24xFzAVBgoJkiaJk/IsZAEZFgdzaWdobW9uMRMwEQYKCZImiZPyLGQBGRYD
+  Y29tMIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIBigKCAYEAxHOFY9hovaIfd7wX
+  qSZuDoM5hmYVr6NlNl3/BaaAOXY48vSMIFDbLw0XbG7u9yT6LZhK6g8jnFpgXNMP
+  GfJn0wVC3vZn3kQtcpCG5udPUVJnMsRXD/uJV/XSDwJ9FWb6VBvFSW3iQ3B0LfdL
+  RT0kKBfik0bppwCgPGUuIPDsrMlNt0p8Bs1gIWkZm/C1bZDSa91OrJQPcSmBGVda
+  xdxbUzNrn7k9oWEa0g4iGimtargl+OW7mxWm28QrIYCv/DyqgvwB+jce3Yzk/qK/
+  tBFFCHiU3cJ10dOy4QKJn72pw9TiER9yRsfmucAyMFv9KOM3C2L5ZYhr2TgA4p49
+  oFJFOi78UvRkB8v9LQD+vq9yEZifAAUZ3rEh0OAupxhPmgAYkV7H86aV9x4hSEei
+  Hi0SrrKxbjjdE6n+1lFPGoqJVQa8SeZiLdlFSfp5vpUnegg0QNnvS1Ov1GwcwabT
+  Ukfs5RzhEQcabQcL0lequhZFQMliQCTgolTIgsrN7JjCkqXLAgMBAAGjeTB3MAkG
+  A1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQWBBT3ovS4QF/lG/VvSbueQWRi
+  dNVOszAeBgNVHREEFzAVgRNzaWdobW9uQHNpZ2htb24uY29tMB4GA1UdEgQXMBWB
+  E3NpZ2htb25Ac2lnaG1vbi5jb20wDQYJKoZIhvcNAQELBQADggGBAA62EngIqmTY
+  f79wEueZU4P8o10SelwvawXFUkPrOyvDoGx/ZmZ7vpo3STuTN7ywS4h+P3V8t9Zt
+  e8eQ7Slk99lFuRbDoMaX3ARnB3EMjbpNbh3H+8xo5CrzJpklmU5BV6B91Clz3Bou
+  3vdY9D4lZ01s0LgMQsfLwOsKyHeWCEPVwkGdXl4bb/FKpsm0veicKxW3+3F5J+nB
+  zGDjFWsrjpgaq1wYzfO79NEmqrJwZFQM8SoOG89Jwo3iPzJ1mC0UlQx1E+wDakRQ
+  fjE20735cJoU1+WIKO6DLH/mHXDQ+Nrw+9zOWTizoV6at1QSvR1r4cM3u8TQGpIv
+  yjLIXbfSrriclRt4wg6Xlra1F3Jlm3DJMp9w5cRT+knQdTprNEft1lA2cVjczatt
+  RhdbGYd5Hku1QRVeQ+tN2OYG1/vZeRTqZ4MGLdl6r4iO5XGtWWoR2alg8kKc6yLx
+  P5J+9tLKId50fAv4voQg//wRwePPNiWIXsLUa1LPYWTAznKTvi3dAQ==
   -----END CERTIFICATE-----
-date: 2022-10-02 00:00:00.000000000 Z
+date: 2024-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -57,14 +58,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 2.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: mrml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.2
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -149,11 +164,13 @@ files:
 - lib/mjml-rails.rb
 - lib/mjml.rb
 - lib/mjml/handler.rb
+- lib/mjml/mrml_parser.rb
 - lib/mjml/parser.rb
 - lib/mjml/railtie.rb
 - lib/mjml/version.rb
 - test/generator_test.rb
 - test/mjml_test.rb
+- test/mrml_parser_test.rb
 - test/parser_test.rb
 - test/test_helper.rb
 homepage: https://github.com/sighmon/mjml-rails
@@ -175,12 +192,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: MJML + ERb templates
 test_files:
 - test/generator_test.rb
-- test/parser_test.rb
 - test/mjml_test.rb
+- test/mrml_parser_test.rb
+- test/parser_test.rb
 - test/test_helper.rb