mjml-rails 2.4.1 → 2.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a036ea2c3f5d353750684e8cbcee10d832456db6
-  data.tar.gz: 04e57f9864cc36334caa09c9462c9ddc337cf7e6
+  metadata.gz: 8e77f052d7e2a3b95f8fa4a8968e90aac1a44d6c
+  data.tar.gz: c0779f30b21ec71d46ceee38db0ed65562e3df65
 SHA512:
-  metadata.gz: a601a9bf334433d410615ce01180c596556a736a37b96a3aa633a41844890f8f5f953f7e34064b2591e66afdeb783f6c8eba23e28da2e1b14a732e5c896c042d
-  data.tar.gz: f86192ecbd69adfd2d50d537002742c9da97be51e8d578d09e331af7b1b4de7e1bda701fe66c5b4a0f08f0f39e74cb4c61457f92ee913e78ae423b6dd33b238a
+  metadata.gz: e8bca5a52f8d01ea38f7044c59b6b2a1d8f4ceef3b4d305a5c60bc25198267d2e579142718203afcf4bc36ae9987a24e8bf4cc9af7c1eb251aeb8042dbbfe968
+  data.tar.gz: 4bf757fd433358cda8ee79f33588d7297009565276ced1c01cb13f684ddfd2156ce51c9b408b6c2bf95647f10535c1cac3b1dbcf3326014997f118dd3ba63ab6

data/README.md

@@ -65,7 +65,7 @@ Install the MJML parser (optional -g to install it globally):
 npm install -g mjml@^3.0
 ```
 
-NOTE: there seems to be a [path related bug](https://github.com/mjmlio/mjml/issues/501) with ```mjml 3.2.0```, so perhaps use ```npm install -g mjml@3.1.1```.
+Note that 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:
 
@@ -90,6 +90,74 @@ gem 'mjml-rails', '2.2.0'
 
 [Hugo Giraudel](https://twitter.com/hugogiraudel) wrote a post on [using MJML in Rails](http://dev.edenspiekermann.com/2016/06/02/using-mjml-in-rails/).
 
+## Using Email Layouts
+
+Mailer:
+```ruby
+# mailers/foo_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
+
+  # this function is called to send the email
+  def foo(item, user)
+    mail_template(
+      "foo_bar",
+      user,
+      "email subject",
+      request: item
+    )
+  end
+end
+```
+
+Email layout:
+```html
+<!-- views/layouts/default.mjml -->
+<mjml>
+	<mj-body>
+		<mj-container>
+			<%= yield %>
+		</mj-container>
+	</mj-body>
+</mjml>
+```
+
+Email view:
+```html
+<!-- views/my_mailer/foo_bar.mjml.erb -->
+<%= render partial: "to", formats: [:html], locals: { name: recipient.name } %>
+
+<mj-section>
+	<mj-column>
+		<mj-text>
+			Hello <%= recipient.name %>!
+		</mj-text>
+	</mj-column>
+</mj-section>
+```
+
+Email partial:
+```html
+<!-- views/my_mailer/_to.mjml -->
+<mj-section>
+	<mj-column>
+		<mj-text>
+			<%= name %>,
+		</mj-text>
+	</mj-column>
+</mj-section>
+```
+
 ## 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):

data/lib/mjml.rb

@@ -25,7 +25,8 @@ module Mjml
     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?"
+    puts "Couldn't find the MJML binary.. have you run $ npm install mjml?"
+    nil
   end
 
   BIN = discover_mjml_bin

data/lib/mjml/parser.rb

@@ -5,6 +5,7 @@ module Mjml
     #
     # @param input [String] The string to transform in html
     def initialize input
+      raise "Couldn't find the MJML binary.. have you run $ npm install mjml?" unless mjml_bin
       file = File.open(in_tmp_file, 'w')
       file.write(input)
       file.close
@@ -78,4 +79,4 @@ module Mjml
         Mjml::BIN
       end
   end
-end
+end

data/lib/mjml/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mjml-rails
 version: !ruby/object:Gem::Version
-  version: 2.4.1
+  version: 2.4.2
 platform: ruby
 authors:
 - Simon Loffler
@@ -31,7 +31,7 @@ cert_chain:
   5hPZOkUdP3egZ1xAHeFIOhTIaOJezjUEDQVattPkgwl25+Q2EXJ+5ehDU86v+lxH
   E9hMwkxwQntg0fKVFbnVMOg2itaj8fJ7
   -----END CERTIFICATE-----
-date: 2017-01-19 00:00:00.000000000 Z
+date: 2017-05-02 00:00:00.000000000 Z
 dependencies: []
 description: Render MJML + ERb template views in Rails
 email: sighmon@sighmon.com