mjml-haml 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1bcfcdb446ab96a8360f4216a3c1e2b0a1fd4dc4
-  data.tar.gz: 8424cb964a54196407230b66d64ad7e450305627
+  metadata.gz: 67291cbd028813753e240a9ced2a3eacb45930cd
+  data.tar.gz: b1dcfb0646657a4a42a108732627485b6670bd23
 SHA512:
-  metadata.gz: 32613e9ee60ce6048dbd905f2cb838ac5696ba09cd2b8e6b2cadc2638a4f87c707cf9d6816a811330744508b5f7776af97256c64aae5cb5aab4de3071f0867a2
-  data.tar.gz: fa1f0ad48ba3ad91afffaed96c93c9679c5131a50f2c21be0d5a64c6823ee31983bab43d5048654191dc66456178c0361d0ac912b0399d9b80f621087e904e56
+  metadata.gz: 60feae028d0336f22ebc7cf05d064fce1ac4da23291988fb64423af8e20357947a5bca166333b3b311ad23d48a644d0cc5c3ed8dd64ebf398b00e6a52abc7d7d
+  data.tar.gz: b684bc293222f73212e9446c42f3c6159f7f6f07e21da02d47074daf467d8e34c9340999e039f735a735c94351b3ad670707b3cc4b1ed28e45fe19bc68a95d21

data/README.md

@@ -2,40 +2,72 @@
 
 [![Build Status](https://api.travis-ci.org/fnix/mjml-haml.svg?branch=master)](http://travis-ci.org/fnix/mjml-haml) [![Gem Version](https://badge.fury.io/rb/mjml-haml.svg)](https://badge.fury.io/rb/mjml-haml)
 
-**MJML-Haml** allows you to render HTML e-mails from an [MJML](https://mjml.io) template.
+**MJML-Haml** allows you to render HTML e-mails from a [MJML](https://mjml.io) template.
 
-An example template might look like:
+An example layout might look like:
 
 ```haml
-/ ./app/views/user_mailer/email.mjml
+/ app/views/layouts/user_mailer.html.mjml
 %mjml
   %mj-body
     %mj-container
-      %mj-section
-        %mj-column
-          %mj-text
-          = render :partial => 'info', :formats => [:html]
+      %mj-section{ background: { color: '#222' }, padding: '10px' }
+        %mj-column{ width: '30%' }
+          %mj-image{ alt: 'fnix', href: root_url, src: image_url('my-logo.png') }
+        %mj-column{ width: '30%' }
+        %mj-column{ width: '40%' }
+          %mj-social{ 'base-url': '/images/mailer/', display: 'facebook:url google:url linkedin:url twitter:url',
+            'facebook-content': '', 'facebook-href': 'https://www.facebook.com/Fnix-804357709655741/',
+            'facebook-icon-color': 'transparent', 'google-content': '',
+            'google-href': 'https://plus.google.com/+FnixBr', 'google-icon-color': 'transparent', 'icon-size': '32px',
+            'linkedin-content': '', 'linkedin-href': 'https://www.linkedin.com/company/fnix',
+            'linkedin-icon-color': 'transparent', 'twitter-content': '', 'twitter-href': 'https://twitter.com/fnixbr',
+            'twitter-icon-color': 'transparent' }
+      %mj-section{ 'text-align': 'left' }
+        = yield
+      %mj-section{ 'background-color': '#E5E5E5', padding: '10px 0' }
+        %mj-text{ 'font-size': '11px', 'line-height': '15px' }
+          My awesome footer
 ```
 
-And the partial `_info.mjml`:
+And the template for an action:
 
 ```haml
-/ ./app/views/user_mailer/_info.mjml
-%mj-text= "This is #{@user.username}"
+/ app/views/user_mailer/password.html.haml
+%mj-text
+  %h2 Password
+%mj-text
+  %p{style: 'text-align: justify;'}
+    == You sign up with #{provider_to_name @user.identities.first.try(:provider)}, so we generate a password for you:
+%mj-button= @password
+%mj-text
+  %p
+    == You need this password to change your #{link_to 'account', edit_user_registration_url} details. Do you want to
+    change this cryptic password, no problem::
+%mj-button{ href: edit_user_registration_url } Change Password
+
+```
+
+Note that the layout is named `.html.mjml` and the template `.html.haml`. Why? mjml only output content that are wrapped
+by:
+
+```html
+<mjml>
+  <mj-body>
+    ...
+  </mj-body>
+</mjml>
 ```
 
-* Notice you can use Haml and partials inside the template.
+So, for the template we just want to use HAML and for the layout + template we use mjml + haml.
 
-Your `user_mailer.rb` might look like this::
+You write your mailer as usual:
 
 ```ruby
-# ./app/mailers/user_mailer.rb
+# app/mailers/user_mailer.rb
 class UserMailer < ActionMailer::Base
-  def user_signup_confirmation()
-    mail(to: 'test@example.com', subject: 'test') do |format|
-      format.text
-      format.mjml
-    end
+  def password()
+    mail(to: 'test@example.com', subject: 'test')
   end
 end
 ```
@@ -59,36 +91,6 @@ Install the MJML parser (optional -g to install it globally):
 ```console
 npm install -g mjml@^2.0
 ```
-
-## Sending Devise user emails
-
-If you use [Devise](https://github.com/plataformatec/devise) for user authentication and want to send user emails with MJML templates, here's how to override the [devise mailer](https://github.com/plataformatec/devise/blob/master/app/mailers/devise/mailer.rb):
-```ruby
-# app/mailers/devise_mailer.rb
-class DeviseMailer < Devise::Mailer
-  def reset_password_instructions(record, token, opts={})
-    @token = token
-    @resource = record
-    # Custom logic to send the email with MJML
-    mail(
-      template_path: 'devise/mailer',
-      from: "some@email.com", 
-      to: record.email, 
-      subject: "Custom subject"
-    ) do |format|
-      format.mjml
-      format.text
-    end
-  end
-end
-```
-
-Now tell devise to user your mailer in `config/initializers/devise.rb` by setting `config.mailer = 'DeviseMailer'` or whatever name you called yours.
-
-And then your MJML template goes here: `app/views/devise/mailer/reset_password_instructions.mjml`
-
-Devise also have [more instructions](https://github.com/plataformatec/devise/wiki/How-To:-Use-custom-mailer) if you need them.
-
 ## Deploying with Heroku
 
 To deploy with [Heroku](https://heroku.com) you'll need to setup [multiple buildpacks](https://devcenter.heroku.com/articles/using-multiple-buildpacks-for-an-app) so that Heroku first builds Node for MJML and then the Ruby environment for your app.

data/lib/mjml.rb

@@ -19,11 +19,11 @@ module Mjml
     # Check for a global install of MJML binary
     mjml_bin = 'mjml'
     return mjml_bin if check_version(mjml_bin)
-    
+
     # Check for a local install of MJML binary
     mjml_bin = File.join(`npm bin`.chomp, 'mjml')
     return mjml_bin if check_version(mjml_bin)
-    
+
     raise RuntimeError, "Couldn't find the MJML binary.. have you run $ npm install mjml?"
   end
 
@@ -36,7 +36,7 @@ module Mjml
 
     def call(template)
       compiled_source = haml_handler.call(template)
-      if template.formats.include?(:mjml)
+      if template.formats.include?(:html)
         "Mjml::Mjmltemplate.to_html(begin;#{compiled_source};end).html_safe"
       else
         compiled_source

data/lib/mjml/railtie.rb

@@ -5,7 +5,6 @@ module Mjml
 
     initializer "mjml-haml.register_template_handler" do
       ActionView::Template.register_template_handler :mjml, Mjml::Handler.new
-      Mime::Type.register "text/html", :mjml
     end
   end
-end
+end

data/lib/mjml/version.rb

@@ -1,3 +1,3 @@
 module Mjml
-  VERSION = "0.1.1"
+  VERSION = '0.2.0'.freeze
 end

data/test/mjml_subdir_test.rb

@@ -5,36 +5,22 @@ class SubdirNotifier < ActionMailer::Base
 
   layout false
 
-  def simple_block(format_type)
-    mail(:to => 'foo@bar.com', :from => "john.doe@example.com") do |format|
-      format.send(format_type)
-    end
+  def simple_block
+    mail(:to => 'foo@bar.com', :from => "john.doe@example.com")
   end
 
-  def simple_block_and_path(format_type)
+  def simple_block_and_path
     mail(:template_path => 'template_subdir',:to => 'foo@bar.com', :from => "john.doe@example.com") do |format|
-      format.send(format_type)
+      format.html
     end
   end
 
-  def simple_with_path(format_type)
+  def simple_with_path
     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
@@ -50,7 +36,7 @@ class MjmlTest < ActiveSupport::TestCase
 
   test 'in a subdir with a block fails' do
     assert_raises(ActionView::MissingTemplate) do
-      email = SubdirNotifier.simple_block(:mjml)
+      email = SubdirNotifier.simple_block
       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)
@@ -59,7 +45,7 @@ class MjmlTest < ActiveSupport::TestCase
 
   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)
+      email = SubdirNotifier.simple_block_and_path
       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)
@@ -67,7 +53,7 @@ class MjmlTest < ActiveSupport::TestCase
   end
 
   test 'in a subdir with path' do
-    email = SubdirNotifier.simple_with_path(:mjml)
+    email = SubdirNotifier.simple_with_path
     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)

data/test/mjml_test.rb

@@ -5,29 +5,21 @@ class Notifier < ActionMailer::Base
 
   layout false
 
-  def contact(recipient, format_type)
+  def contact(recipient)
     @recipient = recipient
-    mail(:to => @recipient, :from => "john.doe@example.com") do |format|
-      format.send(format_type)
-    end
+    mail(:to => @recipient, :from => "john.doe@example.com")
   end
 
-  def link(format_type)
-    mail(:to => 'foo@bar.com', :from => "john.doe@example.com") do |format|
-      format.send(format_type)
-    end
+  def link
+    mail(:to => 'foo@bar.com', :from => "john.doe@example.com")
   end
 
-  def user(format_type)
-    mail(:to => 'foo@bar.com', :from => "john.doe@example.com") do |format|
-      format.send(format_type)
-    end
+  def user
+    mail(:to => 'foo@bar.com', :from => "john.doe@example.com")
   end
 
-  def no_partial(format_type)
-    mail(:to => 'foo@bar.com', :from => "john.doe@example.com") do |format|
-      format.send(format_type)
-    end
+  def no_partial
+    mail(:to => 'foo@bar.com', :from => "john.doe@example.com")
   end
 
   def multiple_format_contact(recipient)
@@ -64,7 +56,7 @@ class MjmlTest < ActiveSupport::TestCase
   end
 
   test "html should be sent as html" do
-    email = Notifier.contact("you@example.com", :mjml)
+    email = Notifier.contact("you@example.com")
     assert_equal "text/html", email.mime_type
     assert_no_match(/<mj-body>/, email.body.encoded.strip)
     assert_match(/<body/, email.body.encoded.strip)
@@ -72,56 +64,16 @@ class MjmlTest < ActiveSupport::TestCase
   end
 
   test 'with partial' do
-    email = Notifier.user(:mjml)
+    email = Notifier.user
     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)
+    email = Notifier.no_partial
     assert_equal "text/html", email.mime_type
     assert_match(/Hello World/, email.body.encoded.strip)
     assert_no_match(/mj-text/, email.body.encoded.strip)
   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,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: mjml-haml
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Kadu Diógenes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-12 00:00:00.000000000 Z
+date: 2016-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: haml-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.0
 description: Render MJML + Haml template views in Rails
 email: kadu@fnix.com.br
 executables: []