mjml-rails 4.6.0 → 4.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e001eb3b8f9abfa49b6fbf3e0e10d655fdeb38e68da79f55b348977f4a7082b8
-  data.tar.gz: 7d78f4466486513af5d364c7ca3e5146724a6e9fc785b26cdf66ae5c626138fb
+  metadata.gz: 0a845d39f307dd7d452b0766805154e622aecaed3bbb3b4d392ead880939dc04
+  data.tar.gz: 13a7793222a8253ce62dd97f2a225379615515225e7f987deb23f5a93d6dbbfd
 SHA512:
-  metadata.gz: 534c1c2975ff87a7e5bfed79bcbf19ec0d00ca16cf4a871faac3c9c89a348452aed2afb6197629598f473fd84943d67b64581a75139ca7e608ebcf4878004615
-  data.tar.gz: 6b58532184a1d750fc2d4ae76508a52a3b86578b82fa501a6c4a01c7e9f03856fa2ac48522b0744536e573468233e7f6f54e6a8bd234dff6b58f58e02879ebd5
+  metadata.gz: f05c5580304ececa283ea79e17b61c7a281ce9b327d8aa3c73bacbdeaa8873049f3491243f03964e8fe0bf33f4c4e9ff2c0c70c2424100ae23f7d1a26d3322da
+  data.tar.gz: 111b70710d670a442564aa877652f3711c0ad9c934e1be8edd24a6fc0011f7019c3c9aaa58abec7cfcc338b7ca5ecac2aa6c3e3bd9af30cbb68402dcfa5a3165

checksums.yaml.gz.sig

@@ -1,2 +1,2 @@
-<K㠊l)L�sօ\i �|8�'�1'}��T֑�
��`�k	�B�O+���PDJ��Z��n�Q�VE�}�(!�z�4u�Є�Ы�K�tfd�61�k)�XH9�Lz�t�
���+�y�r�(��C�BB6�Y��tSJA�{��ku������c"*A����'�.u��%s��֝�m���5E���u�O�4��ٴ�`<��sg]B�N>@�I��Z�uG��捤�S���'s��Vfq
�am�!C�nU��r��
��1�ǁ	>|�L�s.���7�-������,�(��r��1�,a�a����Qg�_H/եǷ��"Z���x���ʺA�G�
-e[:��\�3�]UTj��~@P�fz�Cq�f��a�
+7�9�o0U@�[�?,}Zw�����J�/͙�I��K�Ja3
���x�97�2h;�_��wK���'}
+S��j�y'2�N���

data/README.md

@@ -2,7 +2,7 @@
 
 [![Build Status](https://github.com/sighmon/mjml-rails/workflows/test/badge.svg?branch=master)](https://github.com/sighmon/mjml-rails/actions?query=workflow%3Atest+branch%3Amaster) [![Gem Version](https://badge.fury.io/rb/mjml-rails.svg)](https://badge.fury.io/rb/mjml-rails)
 
-**MJML-Rails** allows you to render HTML e-mails from an [MJML](https://mjml.io) template.
+**MJML-Rails** allows you to render HTML emails from an [MJML](https://mjml.io) template.
 
 **Note**: As of MJML 4.3.0 you can no longer use `<mj-text>` directly inside an `<mj-body>`, wrap it in `<mj-section><mj-column>`.
 
@@ -80,52 +80,61 @@ 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.
 
-If you're using ```:haml``` or any other Rails template language, create an initializer to set it up:
+## Configuration
 
-```ruby
-# config/initializers/mjml.rb
-Mjml.setup do |config|
-  config.template_language = :erb # :erb (default), :slim, :haml, or any other you are using
-end
-```
+MJML-Rails has the following settings with defaults:
+
+- `template_language: :erb`
+
+   ERB can be used inside MJML templates by default. Possible values are all template languages that you have installed, e.g. `:haml` or `:slim`.
+
+   **Note:** If you’re using Haml/Slim layouts, please don’t put `<mjml>` in comments in your partial. Read more at [#34](https://github.com/sighmon/mjml-rails/issues/34).
+
+- `raise_render_exception: true`
+
+   Exceptions will be raised and passed to your application by default.
+
+   Beware that setting it to `false` leads to an empty html email when an exception is raised, so only set this to `false` if you do not rely on html (e.g. you have a text fallback for your emails).
+
+- `minify: false`
+
+- `beautify: true`
+
+- `validation_level: "strict"`
+
+   MJML-Rails will raise an exception on any template error by default.
+
+   If set to `soft`, MJML will render invalid templates and ignore invalid parts. This means in case of an invalid template those invalid parts will be missing from the output.
+
+   See [MJML validation documentation](https://github.com/mjmlio/mjml/tree/master/packages/mjml-validator#validating-mjml) for all possible values.
 
-**Note:** If you’re using Haml/Slim layouts, please don’t put `<mjml>` in comments in your partial. Read more: [#34](https://github.com/sighmon/mjml-rails/issues/34).
+- `mjml_binary: nil`
+
+   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-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.
 
-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|
-  # ignore errors silently
+  # Use :haml as a template language
+  config.template_language = :haml
+
+  # Ignore errors silently
   config.raise_render_exception = false
 
-  # optimize the size of your email
+  # Optimize the size of your emails
   config.beautify = false
   config.minify = true
 
-  # render illformed MJML templates, not recommended
+  # Render MJML templates with errors
   config.validation_level = "soft"
-end
-```
-
-You can optionally provide a custom MJML binary if MJML-Rails cannot find it:
 
-```ruby
-# config/initializers/mjml.rb
-Mjml.setup do |config|
+  # Use custom MJML binary with custom version
   config.mjml_binary = "/path/to/custom/mjml"
-end
-```
-
-If you’d like to specify a different MJML version, set it like this:
-
-```ruby
-# config/initializers/mjml.rb
-Mjml.setup do |config|
   config.mjml_binary_version_supported = "3.3.5"
 end
 ```

data/lib/mjml.rb

@@ -1,11 +1,11 @@
-require "rails/version"
-require "action_view"
-require "action_view/template"
-require "mjml/mjmltemplate"
-require "mjml/railtie"
 require "rubygems"
 require "open3"
 
+require "mjml/handler"
+require "mjml/parser"
+
+require "mjml/railtie" if defined?(Rails)
+
 module Mjml
   mattr_accessor \
     :beautify,
@@ -99,37 +99,6 @@ module Mjml
     logger.warn('`Mjml.discover_mjml_bin` is deprecated and has no effect anymore! Please use `Mjml.mjml_binary=` to set a custom MJML binary.')
   end
 
-  class Handler
-    def template_handler
-      @_template_handler ||= ActionView::Template.registered_template_handler(Mjml.template_language)
-    end
-
-    # Optional second source parameter to make it work with Rails >= 6:
-    # Beginning with Rails 6 template handlers get the source of the template as the second
-    # parameter.
-    def call(template, source = nil)
-      compiled_source =
-        if Rails::VERSION::MAJOR >= 6
-          template_handler.call(template, source)
-        else
-          template_handler.call(template)
-        end
-
-      # 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')
-      # Therefore we skip MJML processing and return raw compiled source. It will be processed
-      # by MJML library when top-level layout/template is rendered
-      #
-      # [0] - https://github.com/mjmlio/mjml/blob/master/doc/guide.md#mjml
-      if compiled_source =~ /<mjml(.+)?>/i
-        "Mjml::Mjmltemplate.to_html(begin;#{compiled_source};end).html_safe"
-      else
-        compiled_source
-      end
-    end
-  end
-
   def self.setup
     yield self if block_given?
   end

data/lib/mjml/handler.rb

@@ -0,0 +1,36 @@
+require 'action_view'
+require 'action_view/template'
+require 'rails/version'
+
+module Mjml
+  class Handler
+    def template_handler
+      @template_handler ||= ActionView::Template.registered_template_handler(Mjml.template_language)
+    end
+
+    # Optional second source parameter to make it work with Rails >= 6:
+    # Beginning with Rails 6 template handlers get the source of the template as the second
+    # parameter.
+    def call(template, source = nil)
+      compiled_source =
+        if Rails::VERSION::MAJOR >= 6
+          template_handler.call(template, source)
+        else
+          template_handler.call(template)
+        end
+
+      # 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')
+      # Therefore we skip MJML processing and return raw compiled source. It will be processed
+      # by MJML library when top-level layout/template is rendered
+      #
+      # [0] - https://github.com/mjmlio/mjml/blob/master/doc/guide.md#mjml
+      if compiled_source =~ /<mjml.*?>/i
+        "Mjml::Parser.new(begin;#{compiled_source};end).render.html_safe"
+      else
+        compiled_source
+      end
+    end
+  end
+end

data/lib/mjml/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mjml-rails
 version: !ruby/object:Gem::Version
-  version: 4.6.0
+  version: 4.6.1
 platform: ruby
 authors:
 - Simon Loffler
@@ -35,7 +35,7 @@ cert_chain:
   lsAqKbu4nrHhtGhkwdYbflf2URJTUxXGptrnPYV7okmEg4rsykK3RAsZ6kMNdKmx
   DcQ7RSt1TU5eck6c
   -----END CERTIFICATE-----
-date: 2020-11-29 00:00:00.000000000 Z
+date: 2020-12-19 00:00:00.000000000 Z
 dependencies: []
 description: Render MJML + ERb template views in Rails
 email: sighmon@sighmon.com
@@ -50,14 +50,13 @@ files:
 - lib/generators/mjml/mailer/templates/view.html.erb
 - lib/mjml-rails.rb
 - lib/mjml.rb
-- lib/mjml/mjmltemplate.rb
+- lib/mjml/handler.rb
 - lib/mjml/parser.rb
 - lib/mjml/railtie.rb
 - lib/mjml/version.rb
 - test/generator_test.rb
 - test/mjml_test.rb
 - test/parser_test.rb
-- test/template_test.rb
 - test/test_helper.rb
 homepage: https://github.com/sighmon/mjml-rails
 licenses:
@@ -86,5 +85,4 @@ test_files:
 - test/generator_test.rb
 - test/parser_test.rb
 - test/mjml_test.rb
-- test/template_test.rb
 - test/test_helper.rb

data/lib/mjml/mjmltemplate.rb

@@ -1,12 +0,0 @@
-require "mjml/parser"
-
-module Mjml
-  mattr_accessor :processing_options, :renderer
-  @@processing_options = {}
-
-  class Mjmltemplate
-    def self.to_html(compiled_source)
-      Mjml::Parser.new(compiled_source).render.html_safe
-    end
-  end
-end

data/test/template_test.rb

@@ -1,9 +0,0 @@
-require "test_helper"
-
-class MjmlTest < ActiveSupport::TestCase
-
-  test 'with Mjmltemplate processor' do
-    assert_not_equal "<mj-body></mj-body>", Mjml::Mjmltemplate.to_html("<mjml><mj-body><mj-section><mj-column></mj-column></mj-section></mj-body></mjml>").strip
-  end
-
-end