mjml-rails 2.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9204547c6624e463ff1082518b9952f7583235ce
+  data.tar.gz: 0d8da054e7c4741edcb3f0c89568c2d9c2365a5d
+SHA512:
+  metadata.gz: db387778f72d62202acf4e3f17b68b24e552b7c16b12dc2fd2b2e973211a6634615e32ab9c38b9d36c5e350a5ec7fa4bf845ae10c99d2ec2f4d0388f91813e6e
+  data.tar.gz: 9c8bcb710f5b7ff0ca65c105369c221dbb80cc087641ea76c986ebb2ee0c4a1c73f516317b6b87c09980ea7a42cda99e9c1c02e3e815bb71bc42363cc2b09582

data.tar.gz.sig

@@ -0,0 +1 @@
+-�4�M��:���Q�4�DԂv)���^.��MG��.Q�K|���u�+�3x(��R�Y�V�ܪQdH���"p�&��T�Z�L)3j��E
@�@��!��$R	'�(^�L��SE�l�V��d\;И��(�Zc�<�J�P�@u�w��Ԑ��`��):�13UJ�%g"

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011-2015 Plataformatec (http://blog.plataformatec.com.br)
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,67 @@
+# MJML-Rails
+
+[![Build Status](https://api.travis-ci.org/sighmon/mjml-rails.png?branch=master)](http://travis-ci.org/sighmon/mjml-rails)
+
+**MJML-Rails** allows you to render HTML e-mails from an [MJML](https://mjml.io) template.
+
+An example template might look like `app/views/user_mailer/email.mjml`:
+
+```erb
+<mjml>
+  <mj-body>
+    <mj-container>
+      <mj-section>
+        <mj-column>
+          <mj-text>Hello World</mj-text>
+          <%= render :partial => 'info', :formats => [:html] %>
+        </mj-column>
+      </mj-section>
+    </mj-container>
+  </mj-body>
+</mjml>
+```
+
+And the partial `_info.mjml`:
+
+```erb
+<mj-text>This is <%= @user.username %></mj-text>
+```
+
+* Notice you can use ERb and partials inside the template.
+
+## Installation
+
+Add it to your Gemfile.
+
+```ruby
+gem 'mjml-rails', git: 'https://github.com/sighmon/mjml-rails.git', require: 'mjml'
+```
+
+Run the following command to install it:
+
+```console
+bundle install
+```
+
+Install the MJML parser
+
+```console
+npm install -g mjml@2.1.1
+```
+
+## Bug reports
+
+If you discover any bugs, feel free to create an issue on GitHub. Please add as much information as possible to help us fixing the possible bug. We also encourage you to help even more by forking and sending us a pull request.
+
+[github.com/sighmon/mjml-rails/issues](https://github.com/sighmon/mjml-rails/issues)
+
+## Maintainers
+
+* Simon Loffler [github.com/sighmon](https://github.com/sighmon)
+* Steven Pickles [github.com/thatpixguy](https://github.com/thatpixguy)
+
+## License
+
+MIT License. Copyright 2016 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

@@ -0,0 +1,23 @@
+require "rails/generators/erb/mailer/mailer_generator"
+
+module Mjml
+  module Generators
+    class MailerGenerator < Erb::Generators::MailerGenerator
+      source_root File.expand_path("../templates", __FILE__)
+
+      protected
+
+      def format
+        nil # Our templates have no format
+      end
+
+      def formats
+        [format]
+      end
+
+      def handler
+        :mjml
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,3 @@
+<%= class_name %>#<%= @action %>
+
+<%%= @greeting %>, find me in app/views/<%= @path %>

data/lib/mjml.rb

@@ -0,0 +1,21 @@
+require "action_view"
+require "action_view/template"
+require "mjml/mjmltemplate"
+require "mjml/railtie"
+
+module Mjml
+  class Handler
+    def erb_handler
+      @erb_handler ||= ActionView::Template.registered_template_handler(:erb)
+    end
+
+    def call(template)
+      compiled_source = erb_handler.call(template)
+      if template.formats.include?(:mjml)
+        "Mjml::Mjmltemplate.to_html(begin;#{compiled_source};end).html_safe"
+      else
+        compiled_source
+      end
+    end
+  end
+end

data/lib/mjml/mjmltemplate.rb

@@ -0,0 +1,12 @@
+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/lib/mjml/parser.rb

@@ -0,0 +1,81 @@
+module Mjml
+  class Parser
+
+    # Create new parser
+    #
+    # @param input [String] The string to transform in html
+    def initialize input
+      file = File.open(in_tmp_file, 'w')
+      file.write(input)
+      file.close
+    end
+
+    # Render mjml template
+    #
+    # @return [String]
+    def render
+      result = run
+      remove_tmp_files
+      result
+    rescue
+
+      ""
+    end
+
+    # Exec mjml command
+    #
+    # @return [String] The result as string
+    def run
+      command = "#{mjml_bin} -r #{in_tmp_file} -o #{out_tmp_file}"
+      # puts command
+      `#{command}`
+      file = File.open(out_tmp_file, 'r')
+      str  = file.read
+      file.close
+      str
+    end
+
+    private
+
+      # Remove tmp files
+      #
+      # @return nil
+      def remove_tmp_files
+        FileUtils.rm(in_tmp_file)
+        FileUtils.rm(out_tmp_file)
+        nil
+      end
+
+      # Return tmp dir
+      #
+      # @return [String]
+      def tmp_dir
+        "/tmp"
+      end
+
+      # Get parser tpm file to store result
+      #
+      # @return [String]
+      def out_tmp_file
+
+        @_out_tmp_file ||= "#{tmp_dir}/out_#{(0...8).map { (65 + rand(26)).chr }.join}.html"
+      end
+
+      # Get parser tpm file to get result
+      #
+      # @return [String]
+      def in_tmp_file
+
+        @_in_tmp_file ||= "#{tmp_dir}/in_#{(0...8).map { (65 + rand(26)).chr }.join}.mjml"
+        # puts @_in_tmp_file
+        return @_in_tmp_file
+      end
+
+      # Get mjml bin path
+      #
+      # @return [String]
+      def mjml_bin
+        `/usr/bin/which mjml`.chomp
+      end
+  end
+end

data/lib/mjml/railtie.rb

@@ -0,0 +1,11 @@
+module Mjml
+  class Railtie < Rails::Railtie
+    config.mjml = Mjml
+    config.app_generators.mailer :template_engine => :mjml
+
+    initializer "mjml-rails.register_template_handler" do
+    	ActionView::Template.register_template_handler :mjml, Mjml::Handler.new
+    	Mime::Type.register "text/html", :mjml
+    end
+  end
+end

data/lib/mjml/version.rb

@@ -0,0 +1,4 @@
+module Mjml
+	# Version number matches MJML.io version
+  VERSION = "2.1.1"
+end

data/test/generator_test.rb

@@ -0,0 +1,16 @@
+require "test_helper"
+require "generators/mjml/mailer/mailer_generator"
+
+class GeneratorTest < Rails::Generators::TestCase
+  tests Mjml::Generators::MailerGenerator
+  destination File.expand_path("../tmp", __FILE__)
+  setup :prepare_destination
+
+  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"
+  end
+end

data/test/mjml_test.rb

@@ -0,0 +1,127 @@
+require "test_helper"
+
+class Notifier < ActionMailer::Base
+  self.view_paths = File.expand_path("../views", __FILE__)
+
+  layout false
+
+  def contact(recipient, format_type)
+    @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)
+    end
+  end
+
+  def user(format_type)
+    mail(:to => 'foo@bar.com', :from => "john.doe@example.com") do |format|
+      format.send(format_type)
+    end
+  end
+
+  def no_partial(format_type)
+    mail(:to => 'foo@bar.com', :from => "john.doe@example.com") do |format|
+      format.send(format_type)
+    end
+  end
+
+  def multiple_format_contact(recipient)
+    @recipient = recipient
+    mail(:to => @recipient, :from => "john.doe@example.com", :template => "contact") do |format|
+      format.text  { render 'contact' }
+      format.html  { render 'contact' }
+    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
+
+#   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 "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
+
+  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)
+  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

data/test/template_test.rb

@@ -0,0 +1,9 @@
+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-container><mj-section><mj-column></mj-column></mj-section></mj-container></mj-body></mjml>").strip
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,26 @@
+require "rubygems"
+require "bundler"
+Bundler.setup
+
+require "minitest/autorun"
+require "active_support/test_case"
+
+require "action_mailer"
+require "rails/railtie"
+require "rails/generators"
+require "rails/generators/test_case"
+
+# require "minitest/reporters"
+# Minitest::Reporters.use!
+
+$:.unshift File.expand_path("../../lib", __FILE__)
+require "mjml"
+Mjml::Railtie.run_initializers
+
+ActiveSupport::TestCase.test_order = :sorted if ActiveSupport::TestCase.respond_to? :test_order=
+
+# Avoid annoying warning from I18n.
+I18n.enforce_available_locales = false
+
+ActionMailer::Base.delivery_method = :test
+ActionMailer::Base.perform_deliveries = true

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: mjml-rails
+version: !ruby/object:Gem::Version
+  version: 2.1.1
+platform: ruby
+authors:
+- Simon Loffler
+autorequire: 
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDdDCCAlygAwIBAgIBATANBgkqhkiG9w0BAQUFADBAMRAwDgYDVQQDDAdzaWdo
+  bW9uMRcwFQYKCZImiZPyLGQBGRYHc2lnaG1vbjETMBEGCgmSJomT8ixkARkWA2Nv
+  bTAeFw0xNjA1MzAwNzQzMjFaFw0xNzA1MzAwNzQzMjFaMEAxEDAOBgNVBAMMB3Np
+  Z2htb24xFzAVBgoJkiaJk/IsZAEZFgdzaWdobW9uMRMwEQYKCZImiZPyLGQBGRYD
+  Y29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA5NPPme/xXWWsnBPf
+  nMZ7IgZVrYxJmztef4+YP85wmmwxle5M8z70KE8zym/6FwuEtmI41t+wUIMRTfuv
+  +cvtvJqfVdGJxix528WXfeaezEK3ScsO24CeTBOqiuWbO8uMoNS0k0dg3+O02U9z
+  ntAiK1QN0TFQ1iu+fWW5N1GMu03BZHX+bBknsosSSA6Mnc1uyetm58qE8UV6Q8Mw
+  BpnsJ35D9uFLyKostYl64WJoAM9XM+xKfkgsCO8obz1lhl0RB0Sl9uI0aD484dYM
+  9WnsdG9DugdECIIXwcz67vGYYln4g3+8hsvnVxKPxVT8liHo1b/rIP7NQMli2aTd
+  0kLBqQIDAQABo3kwdzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQU
+  veuvCzX+SffuzZn/PYtOpj0ni/0wHgYDVR0RBBcwFYETc2lnaG1vbkBzaWdobW9u
+  LmNvbTAeBgNVHRIEFzAVgRNzaWdobW9uQHNpZ2htb24uY29tMA0GCSqGSIb3DQEB
+  BQUAA4IBAQBgWEQGX1nB32sNYp1vB1CIBuT3twVkvAss4Vu/rAHyGHM/MLhcCiqD
+  Je/5hq3oRy+o8BToILpVV8DZdZLtWVaX42qL/cuWHZqfFhoPbLIjcBphAurOTCmN
+  yzGuPoqkEF8moN0hNqY7nNYIf4SLjal/9AJMUlrUuQyK8UaxqOg76fz7XGgJQmbH
+  duxe+YhT4pdcfPUw7JXf9NtdyTpaC07r2c1TIn54Q7dEGI2eKby8xvOsWAxa9rfJ
+  5hPZOkUdP3egZ1xAHeFIOhTIaOJezjUEDQVattPkgwl25+Q2EXJ+5ehDU86v+lxH
+  E9hMwkxwQntg0fKVFbnVMOg2itaj8fJ7
+  -----END CERTIFICATE-----
+date: 2016-05-30 00:00:00.000000000 Z
+dependencies: []
+description: Render MJML + ERb template views in Rails
+email: sighmon@sighmon.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+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/mjml.rb
+- lib/mjml/mjmltemplate.rb
+- lib/mjml/parser.rb
+- lib/mjml/railtie.rb
+- lib/mjml/version.rb
+- test/generator_test.rb
+- test/mjml_test.rb
+- test/template_test.rb
+- test/test_helper.rb
+homepage: https://github.com/sighmon/mjml-rails
+licenses:
+- MIT
+metadata: {}
+post_install_message: "Don't forget to install MJML e.g. \n$ npm install -g mjml"
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: MJML + ERb templates
+test_files:
+- test/generator_test.rb
+- test/mjml_test.rb
+- test/template_test.rb
+- test/test_helper.rb