mjml-rails 4.9.0 → 4.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63fb17f29c1ab7539b3b53470787d35246e9536ee960a1493c02806c8119de75
-  data.tar.gz: 50fd2491ce1bdef74e0eaf080687ef7e5ce5c23a423f8748eba62e27dcc3dfae
+  metadata.gz: 321f6e1eaed15dffa0b3c65283a095a92ac80cae3b3d3df4f395d446fbc4e490
+  data.tar.gz: 96cce85167d65a6c20cc62ad3d5690ed7e4c166af37311190a0729f33b6a315d
 SHA512:
-  metadata.gz: 9cb24065a5430452f98fffbcc54c81da74dfb97c91ba85f64d4f16ceb8fbd302bb0483bc2705ce03027a22ce026f8f852d0a3274b0905c53f1ce94d485c6fab7
-  data.tar.gz: 91ffeea703562d051c68dbabaad228efd2f6b07daa4cb750625727332363f95a184b42b500501c23e90a6714ca48eb6e3d63fbd7c90f58cf93ec8eaf4c2fb479
+  metadata.gz: fc6708c231290dea0a14a04c03d977f58dd34c5d64116c7aba01601191ebbda08642cf0039bc2ab060b7174a5e8f5fa728dae2da14bceeaa3351f8bb4073b721
+  data.tar.gz: 6f32e5c076fac3d45c69c2e8dfcc6880ef8d73dbf32e1c87dfb51442f466b90917d9591c08fa5bbfd7f748845d2672b35befa3ea8210c6edec104f56398dd5b5

data/README.md

@@ -54,6 +54,8 @@ end
 
 ## Installation
 
+### Using MJML NPM package
+
 Add it to your Gemfile.
 
 ```ruby
@@ -83,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:
@@ -115,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
@@ -136,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.9.0'
+  VERSION = '4.10.1'
 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)
@@ -46,7 +48,8 @@ module Mjml
                              check_for_custom_mjml_binary ||
                              check_for_yarn_mjml_binary ||
                              check_for_npm_mjml_binary ||
-                             check_for_global_mjml_binary
+                             check_for_global_mjml_binary ||
+                             check_for_mrml_binary
 
     return @@valid_mjml_binary if @@valid_mjml_binary
 
@@ -100,6 +103,13 @@ module Mjml
     return mjml_bin if mjml_bin.present? && check_version(mjml_bin)
   end
 
+  def self.check_for_mrml_binary
+    MRML.present?
+  rescue NameError
+    Mjml.mjml_binary_error_string = 'Couldn\'t find MRML - did you add \'mrml\' to your Gemfile?'
+    false
+  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/mjml_test.rb

@@ -119,11 +119,13 @@ describe Mjml do
     before do
       Mjml.mjml_binary = nil
       Mjml.valid_mjml_binary = nil
+      Mjml.use_mrml = nil
     end
 
     after do
       Mjml.mjml_binary = nil
       Mjml.valid_mjml_binary = nil
+      Mjml.use_mrml = nil
     end
 
     it 'can be set to a custom value with mjml_binary if version is correct' do
@@ -156,5 +158,19 @@ describe Mjml do
       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
+
+    it 'can use MRML and check for a valid binary' do
+      Mjml.use_mrml = true
+      Mjml.stubs(:check_for_custom_mjml_binary).returns(false)
+      Mjml.stubs(:check_for_yarn_mjml_binary).returns(false)
+      Mjml.stubs(:check_for_npm_mjml_binary).returns(false)
+      Mjml.stubs(:check_for_global_mjml_binary).returns(false)
+      expect(Mjml.valid_mjml_binary).must_equal(true)
+
+      Mjml.valid_mjml_binary = nil
+      MRML.stubs(:present?).raises(NameError)
+      assert_nil(Mjml.valid_mjml_binary)
+      expect(Mjml.mjml_binary_error_string).must_equal 'Couldn\'t find MRML - did you add \'mrml\' to your Gemfile?'
+    end
   end
 end

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.9.0
+  version: 4.10.1
 platform: ruby
 authors:
 - Simon Loffler
@@ -36,7 +36,7 @@ cert_chain:
   RhdbGYd5Hku1QRVeQ+tN2OYG1/vZeRTqZ4MGLdl6r4iO5XGtWWoR2alg8kKc6yLx
   P5J+9tLKId50fAv4voQg//wRwePPNiWIXsLUa1LPYWTAznKTvi3dAQ==
   -----END CERTIFICATE-----
-date: 2023-05-12 00:00:00.000000000 Z
+date: 2024-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -58,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
@@ -150,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
@@ -176,12 +192,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: MJML + ERb templates
 test_files:
 - test/generator_test.rb
 - test/mjml_test.rb
+- test/mrml_parser_test.rb
 - test/parser_test.rb
 - test/test_helper.rb