mjml-rails 4.1.0 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bf24f6bc544ed49f738f3afb6dd288be522a8eac
-  data.tar.gz: 0e4f7e9b607039a2619c12f34202e3c63be9ec91
+  metadata.gz: 8cc88d6b14f96fbfe78ac00b83250ab72a874d6a
+  data.tar.gz: 2fcde96e13cabd54474394cbca661c2936f03750
 SHA512:
-  metadata.gz: 169a7f232e534cbcb29a660ea166b0b7c54eee8f2c327b611131996ae9747f2a6c2617be96d02b62bb8d7e5181c5307f50c7bc933015c02eb8d343822bb53e7c
-  data.tar.gz: 7e679743fb0053909d30237d31ca300258b4114679eb39cf107b778f2477b272d077cfb65e3b8ff77ff6797a27f2bfa8499e87c873abc8b3e5c3c5d20d1d3467
+  metadata.gz: 18b50259d07cc0ef7b1d4c15b4d587a5c3379ea859b9468de54222e562a0c86c83b468be2b4160c36695b1d2ce42cd2454e9145fbbf632bed6207d522810913c
+  data.tar.gz: 51dcfa5a5d08b911bb3ad2ab276c52edbc39510f184d84562f672d27c19454677b32b55a65680bd4acd7c35421d25cf81287a19378e102bf33c71cb01b8beec8

checksums.yaml.gz.sig

@@ -1 +1,2 @@
-���‘y�l��ga�.���~p�v���2�xR#�t6����0<ۏi���_���;�����
+����	��K��9H�@�$��-�tE������e��������"�bl�
+�'N�mQӇ�]��2�-������ԵZ�V�`�}��,�iZ@\��,� &�
�J������X�� V{w��0�`�&�����[*>K����w���H�G	�\��FY>�w�c�ɬ��<~�9e��\�{��y�$��Wu�B�	..���Z��8�?�=حÏ����H9�`DSO�x8(ꚁ`
0�Mܚ��)

data/README.md

@@ -7,7 +7,7 @@
 An example template might look like:
 
 ```erb
-<!-- ./app/views/user_mailer/email.mjml -->
+<!-- ./app/views/user_mailer/email.html.mjml -->
 <mjml>
   <mj-head>
     <mj-preview>Hello World</mj-preview>
@@ -16,7 +16,7 @@ An example template might look like:
     <mj-section>
       <mj-column>
         <mj-text>Hello World</mj-text>
-        <%= render :partial => 'info', :formats => [:html] %>
+        <%= render partial: "info" %>
       </mj-column>
     </mj-section>
   </mj-body>
@@ -26,19 +26,19 @@ An example template might look like:
 And the partial `_info.mjml`:
 
 ```erb
-<!-- ./app/views/user_mailer/_info.mjml -->
+<!-- ./app/views/user_mailer/_info.html.erb -->
 <mj-text>This is <%= @user.username %></mj-text>
 ```
 
-* Notice you can use ERb and partials inside the template.
+* Notice you can use ERB and partials inside the template.
 
 Your `user_mailer.rb` might look like this::
 
 ```ruby
 # ./app/mailers/user_mailer.rb
 class UserMailer < ActionMailer::Base
-  def user_signup_confirmation()
-    mail(to: 'test@example.com', subject: 'test') do |format|
+  def user_signup_confirmation
+    mail(to: "user@example.com", from: "app@example.com") do |format|
       format.text
       format.mjml
     end
@@ -86,9 +86,9 @@ Mjml.setup do |config|
 end
 ```
 
-### MJML v3.x & v4.0.x support
+### MJML v3.x & v4.x support
 
-Version 4.0.x of this gem brings support for MJML 4.0.x
+Version 4.x of this gem brings support for MJML 4.x
 
 Version 2.3.x and 2.4.x of this gem brings support for MJML 3.x
 
@@ -116,67 +116,57 @@ npm install -g mjml@3.3.5
 
 ## Using Email Layouts
 
+*Note*: [Aleksandrs Ļedovskis](https://github.com/aleksandrs-ledovskis) kindly updated the gem for better Rails Email Layouts support - it should be a non-breaking change, but check the updated file naming below if you experience problems.
+
 Mailer:
 ```ruby
-# mailers/foo_mailer.rb
+# mailers/my_mailer.rb
 class MyMailer < ActionMailer::Base
   layout "default"
 
-  def mail_template(template_name, recipient, subject, **params)
-    mail(
-      to: recipient.email,
-      from: ENV["MAILER_FROM"],
-      subject: subject
-    ) do |format|
-      format.mjml { render template_name, locals: { recipient: recipient }.merge(params) }
-    end
-  end
+  def foo_bar(user)
+    @recipient = user
 
-  # this function is called to send the email
-  def foo(item, user)
-    mail_template(
-      "foo_bar",
-      user,
-      "email subject",
-      request: item
-    )
+    mail(to: user.email, from: "app@example.com") do |format|
+      format.html
+    end
   end
 end
 ```
 
 Email layout:
 ```html
-<!-- views/layouts/default.mjml -->
+<!-- views/layouts/default.html.mjml -->
 <mjml>
-	<mj-body>
-		<%= yield %>
-	</mj-body>
+  <mj-body>
+    <%= yield %>
+  </mj-body>
 </mjml>
 ```
 
 Email view:
 ```html
-<!-- views/my_mailer/foo_bar.mjml.erb -->
-<%= render partial: "to", formats: [:html], locals: { name: recipient.name } %>
+<!-- views/my_mailer/foo_bar.html.erb -->
+<%= render partial: "to" %>
 
 <mj-section>
-	<mj-column>
-		<mj-text>
-			Hello <%= recipient.name %>!
-		</mj-text>
-	</mj-column>
+  <mj-column>
+    <mj-text>
+      Something foo regarding bar!
+    </mj-text>
+  </mj-column>
 </mj-section>
 ```
 
 Email partial:
 ```html
-<!-- views/my_mailer/_to.mjml -->
+<!-- views/my_mailer/_to.html.erb -->
 <mj-section>
-	<mj-column>
-		<mj-text>
-			<%= name %>,
-		</mj-text>
-	</mj-column>
+  <mj-column>
+    <mj-text>
+      Hello <%= @recipient.name %>,
+    </mj-text>
+  </mj-column>
 </mj-section>
 ```
 
@@ -268,14 +258,15 @@ If you discover any bugs, feel free to create an issue on GitHub. Please add as
 
 * Simon Loffler [github.com/sighmon](https://github.com/sighmon)
 * Steven Pickles [github.com/thatpixguy](https://github.com/thatpixguy)
+* [The Rails community](https://github.com/sighmon/mjml-rails/pulls?q=is%3Apr+is%3Aclosed). :-)
 
 ## Other similar gems
 
-* [srghma/mjml-premailer](https://github.com/srghma/mjml-premailer) - supports `/app/views/layouts`
+* [srghma/mjml-premailer](https://github.com/srghma/mjml-premailer)
 * [kolybasov/mjml-ruby/](https://github.com/kolybasov/mjml-ruby/)
 
 ## License
 
-MIT License. Copyright 2016 Simon Loffler. [sighmon.com](http://sighmon.com)
+MIT License. Copyright 2018 Simon Loffler. [sighmon.com](http://sighmon.com)
 
 Lovingly built on [github.com/plataformatec/markerb](https://github.com/plataformatec/markerb)

data/lib/generators/mjml/mailer/mailer_generator.rb

@@ -5,10 +5,10 @@ module Mjml
     class MailerGenerator < Erb::Generators::MailerGenerator
       source_root File.expand_path("../templates", __FILE__)
 
-      protected
+      private
 
       def format
-        nil # Our templates have no format
+        :html
       end
 
       def formats
@@ -18,6 +18,17 @@ module Mjml
       def handler
         :mjml
       end
+
+      def view_handler
+        Mjml.template_language
+      end
+
+      def filename_with_extensions(name, file_format = format)
+        # Due to MJML single-pass processing nature
+        # layout files MUST have .mjml extension, but views/templates cannot
+        is_layout_file = name.in?([:layout, "mailer"])
+        [name, file_format, is_layout_file ? handler : view_handler].compact.join(".")
+      end
     end
   end
 end

data/lib/generators/mjml/mailer/templates/layout.html.mjml

@@ -0,0 +1,5 @@
+<mjml>
+  <mj-body>
+    <%%= yield %>
+  </mj-body>
+</mjml>

data/lib/mjml.rb

@@ -41,7 +41,15 @@ module Mjml
 
     def call(template)
       compiled_source = template_handler.call(template)
-      if template.formats.include?(:mjml)
+
+      # 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 template.source =~ /<mjml>/
         "Mjml::Mjmltemplate.to_html(begin;#{compiled_source};end).html_safe"
       else
         compiled_source

data/lib/mjml/version.rb

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

data/test/generator_test.rb

@@ -9,8 +9,18 @@ class GeneratorTest < Rails::Generators::TestCase
   test "assert all views are properly created with given name" do
     run_generator %w(notifier foo bar baz)
 
-    assert_file "app/views/notifier/foo.mjml"
-    assert_file "app/views/notifier/bar.mjml"
-    assert_file "app/views/notifier/baz.mjml"
+    assert_file "app/views/layouts/mailer.html.mjml" do |mailer|
+      assert_match "<mjml>", mailer
+      assert_match "<mj-body>", mailer
+      assert_match "<%= yield %>", mailer
+    end
+
+    assert_file "app/views/notifier_mailer/foo.html.erb" do |template|
+      assert_match "<%= @greeting %>", template
+      assert_match "app/views/notifier_mailer/foo.html.erb", template
+    end
+
+    assert_file "app/views/notifier_mailer/bar.html.erb"
+    assert_file "app/views/notifier_mailer/baz.html.erb"
   end
 end

data/test/mjml_test.rb

@@ -1,127 +1,63 @@
 require "test_helper"
 
-class Notifier < ActionMailer::Base
+class NotifierMailer < ActionMailer::Base
   self.view_paths = File.expand_path("../views", __FILE__)
 
-  layout false
+  layout "default"
 
-  def contact(recipient, format_type)
+  def inform_contact(recipient)
     @recipient = recipient
-    mail(:to => @recipient, :from => "john.doe@example.com") do |format|
-      format.send(format_type)
-    end
-  end
 
-  def link(format_type)
-    mail(:to => 'foo@bar.com', :from => "john.doe@example.com") do |format|
-      format.send(format_type)
+    mail(to: @recipient, from: "app@example.com") do |format|
+      format.text
+      format.html
     end
   end
+end
 
-  def user(format_type)
-    mail(:to => 'foo@bar.com', :from => "john.doe@example.com") do |format|
-      format.send(format_type)
-    end
-  end
+class NoLayoutMailer < ActionMailer::Base
+  self.view_paths = File.expand_path("../views", __FILE__)
 
-  def no_partial(format_type)
-    mail(:to => 'foo@bar.com', :from => "john.doe@example.com") do |format|
-      format.send(format_type)
-    end
-  end
+  layout nil
 
-  def multiple_format_contact(recipient)
+  def inform_contact(recipient)
     @recipient = recipient
-    mail(:to => @recipient, :from => "john.doe@example.com", :template => "contact") do |format|
-      format.text  { render 'contact' }
-      format.html  { render 'contact' }
+
+    mail(to: @recipient, from: "app@example.com") do |format|
+      format.mjml
     end
   end
 end
 
-# class TestRenderer < ActionView::PartialRenderer
-#   attr_accessor :show_text
-#   def initialize(render_options = {})
-#     @show_text = render_options.delete(:show_text)
-#     super(render_options)
-#   end
+class NotifierMailerTest < ActiveSupport::TestCase
+  test "MJML layout based multipart email is generated correctly" do
+    email = NotifierMailer.inform_contact("user@example.com")
 
-#   def normal_text(text)
-#     show_text ? "TEST #{text}" : "TEST"
-#   end
-# end
+    assert_equal "multipart/alternative", email.mime_type
 
-class MjmlTest < ActiveSupport::TestCase
-
-  setup do
-    @original_renderer = Mjml.renderer
-    @original_processing_options = Mjml.processing_options
-  end
+    refute email.html_part.body.match(%r{</?mj.+?>})
+    assert email.html_part.body.match(/<body>/)
+    assert email.html_part.body.match(/Hello, user@example.com!/)
+    assert email.html_part.body.match(%r{<h2>We inform you about something</h2>})
+    assert email.html_part.body.match(%r{<a href="https://www.example.com">this link</a>})
+    assert email.html_part.body.match(/tracking-code-123/)
 
-  teardown do
-    Mjml.renderer = @original_renderer
-    Mjml.processing_options = @original_processing_options
+    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
+end
 
-  test "html should be sent as html" do
-    email = Notifier.contact("you@example.com", :mjml)
-    assert_equal "text/html", email.mime_type
-    assert_no_match(/<mj-body>/, email.body.encoded.strip)
-    assert_match(/<body/, email.body.encoded.strip)
-    assert_match('<p>Hello from <a href="http://www.sighmon.com">sighmon.com</a></p>', email.body.encoded.strip)
-  end
+class NotifierMailerTest < ActiveSupport::TestCase
+  test "old mjml-rails configuration style MJML template is rendered correctly" do
+    email = NoLayoutMailer.inform_contact("user@example.com")
 
-  test 'with partial' do
-    email = Notifier.user(:mjml)
     assert_equal "text/html", email.mime_type
-    assert_match(/Hello Partial/, email.body.encoded.strip)
-    assert_no_match(/mj-text/, email.body.encoded.strip)
-  end
 
-  test 'without a partial' do
-    email = Notifier.no_partial(:mjml)
-    assert_equal "text/html", email.mime_type
-    assert_match(/Hello World/, email.body.encoded.strip)
-    assert_no_match(/mj-text/, email.body.encoded.strip)
+    refute email.body.match(%r{</?mj.+?>})
+    assert email.body.match(/<body>/)
+    assert email.body.match(/Welcome, user@example.com!/)
+    assert email.body.match(%r{<h2>We inform you about something</h2>})
+    assert email.body.match(%r{<a href="https://www.example.com">this link</a>})
+    refute email.body.match(/tracking-code-123/)
   end
-
-  # test "plain text should be sent as a plain text" do
-  #   email = Notifier.contact("you@example.com", :text)
-  #   assert_equal "text/plain", email.mime_type
-  #   assert_equal "<mj-body></mj-body>", email.body.encoded.strip
-  # end
-
-  # test 'dealing with multipart e-mails' do
-  #   email = Notifier.multiple_format_contact("you@example.com")
-  #   assert_equal 2, email.parts.size
-  #   assert_equal "multipart/alternative", email.mime_type
-  #   assert_equal "text/plain", email.parts[0].mime_type
-  #   assert_equal "<mj-body></mj-body>",
-  #     email.parts[0].body.encoded.strip
-  #   assert_equal "text/html", email.parts[1].mime_type
-  #   assert_not_equal "<mj-body></mj-body>",
-  #     email.parts[1].body.encoded.strip
-  # end
-
-  # test "with a custom renderer" do
-  #   Mjml.renderer = TestRenderer
-  #   email = Notifier.contact("you@example.com", :html)
-  #   assert_equal "text/html", email.mime_type
-  #   assert_equal "<p>TEST<strong>TEST</strong>TEST</p>", email.body.encoded.strip
-  # end
-
-  # test "with a custom renderer and options" do
-  #   Mjml.renderer = TestRenderer.new(:show_text => true)
-  #   email = Notifier.contact("you@example.com", :html)
-  #   assert_equal "text/html", email.mime_type
-  #   assert_equal "<p>TEST Dual templates <strong>TEST rocks</strong>TEST !</p>", email.body.encoded.strip
-  # end
-
-  # test 'with custom mjml processing options' do
-  #   Mjml.processing_options = {:autolink => true}
-  #   email = Notifier.link(:html)
-  #   assert_equal "text/html", email.mime_type
-  #   assert_equal '<p>Hello from <a href="http://www.sighmon.com">http://www.sighmon.com</a></p>', email.body.encoded.strip
-  # end
-
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mjml-rails
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.2.0
 platform: ruby
 authors:
 - Simon Loffler
@@ -31,7 +31,7 @@ cert_chain:
   IUdCp7zF7QpeLz6cgerOpdG0NLHQOEPcWqHpt4yM++TieNrYOuJlkkSd11Ypvgsc
   RRE0kJj2aO7haTBQ7uQl3cTv2c1s4bLu
   -----END CERTIFICATE-----
-date: 2018-06-29 00:00:00.000000000 Z
+date: 2018-07-08 00:00:00.000000000 Z
 dependencies: []
 description: Render MJML + ERb template views in Rails
 email: sighmon@sighmon.com
@@ -42,8 +42,8 @@ files:
 - MIT-LICENSE
 - README.md
 - lib/generators/mjml/mailer/mailer_generator.rb
-- lib/generators/mjml/mailer/templates/layout.mjml
-- lib/generators/mjml/mailer/templates/view.mjml
+- lib/generators/mjml/mailer/templates/layout.html.mjml
+- lib/generators/mjml/mailer/templates/view.html.erb
 - lib/mjml-rails.rb
 - lib/mjml.rb
 - lib/mjml/mjmltemplate.rb
@@ -51,7 +51,6 @@ files:
 - lib/mjml/railtie.rb
 - lib/mjml/version.rb
 - test/generator_test.rb
-- test/mjml_subdir_test.rb
 - test/mjml_test.rb
 - test/parser_test.rb
 - test/template_test.rb
@@ -82,7 +81,6 @@ specification_version: 4
 summary: MJML + ERb templates
 test_files:
 - test/generator_test.rb
-- test/mjml_subdir_test.rb
 - test/parser_test.rb
 - test/mjml_test.rb
 - test/template_test.rb

metadata.gz.sig

@@ -1 +1,3 @@
-hð�I� dy��/;�y;w���^����h�����L.�Gt���r8�A �밍�7�漑�ל���i�r-Hh����@%��N�l�Tзw��VdL�UV�˶I��ʹtq��f#`p��p~Q��b��o�r^R���k�BM*`�ʂy{��1V%�:��3�Pu��#��r��	t��c�t�	���]t�Ԓ�d��[<)l<�R�B��=���V+D�-*�}F�f�0�����.�8�<�-��R�g�
+L���8
Z����s.���9�W��tc1ʵ����a��5���D
+��m����)��1�{�y���$}�^+�2�&��ԉ`�uT�H��)q:>�Hm>jB��ŽŅ�^�y�wӽhp�p���2���F"�i��d����y"-&���}8vB�r�k�BK������9$[�\*���kf�x��8��B�-+q@��8��5����oz�R�8}J�;=�-#H�q{�<&lZᚄʙ�`,~�+
+6~��NR���5

data/lib/generators/mjml/mailer/templates/layout.mjml

@@ -1 +0,0 @@
-<%%= yield %>

data/test/mjml_subdir_test.rb

@@ -1,76 +0,0 @@
-require "test_helper"
-
-class SubdirNotifier < ActionMailer::Base
-  self.view_paths = File.expand_path("../views", __FILE__)
-
-  layout false
-
-  def simple_block(format_type)
-    mail(:to => 'foo@bar.com', :from => "john.doe@example.com") do |format|
-      format.send(format_type)
-    end
-  end
-
-  def simple_block_and_path(format_type)
-    mail(:template_path => 'template_subdir',:to => 'foo@bar.com', :from => "john.doe@example.com") do |format|
-      format.send(format_type)
-    end
-  end
-
-  def simple_with_path(format_type)
-    mail(:template_path => 'template_subdir',:to => 'foo@bar.com', :from => "john.doe@example.com")
-  end
-
-end
-
-# class TestRenderer < ActionView::PartialRenderer
-#   attr_accessor :show_text
-#   def initialize(render_options = {})
-#     @show_text = render_options.delete(:show_text)
-#     super(render_options)
-#   end
-
-#   def normal_text(text)
-#     show_text ? "TEST #{text}" : "TEST"
-#   end
-# end
-
-class MjmlTest < ActiveSupport::TestCase
-
-  setup do
-    @original_renderer = Mjml.renderer
-    @original_processing_options = Mjml.processing_options
-  end
-
-  teardown do
-    Mjml.renderer = @original_renderer
-    Mjml.processing_options = @original_processing_options
-  end
-
-
-  test 'in a subdir with a block fails' do
-    assert_raises(ActionView::MissingTemplate) do
-      email = SubdirNotifier.simple_block(:mjml)
-      assert_equal "text/html", email.mime_type
-      assert_match(/alternate sub-directory/, email.body.encoded.strip)
-      assert_no_match(/mj-text/, email.body.encoded.strip)
-    end
-  end
-
-  test 'in a subdir with a block and template_path option fails' do
-    assert_raises(ActionView::MissingTemplate) do
-      email = SubdirNotifier.simple_block_and_path(:mjml)
-      assert_equal "text/html", email.mime_type
-      assert_match(/alternate sub-directory/, email.body.encoded.strip)
-      assert_no_match(/mj-text/, email.body.encoded.strip)
-    end
-  end
-
-  test 'in a subdir with path' do
-    email = SubdirNotifier.simple_with_path(:mjml)
-    assert_equal "text/html", email.mime_type
-    assert_match(/alternate sub-directory/, email.body.encoded.strip)
-    assert_no_match(/mj-text/, email.body.encoded.strip)
-  end
-
-end