mjml-haml 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d6e55d749e51a70017144ea604268d8fab1d689c
+  data.tar.gz: bd27dbbbd4cea54aa1316e79f8cff2f7796f6281
+SHA512:
+  metadata.gz: 042d35675cf1759cd37ba0d348cd1bb23735a4f5a6f0e0dd738bcd8fb4809d6ed34b2f4f2886fd3dd910fe02477d03555577a7600d319113c8194f7cc7b1af0f
+  data.tar.gz: 842e03283cb44f4b91694b16e373e6538e8dc63d34e0c76259f73264ee8eb2b0f4211c01f5bc7c0b7653132c723b32bbb161fab4f9057086272d771f93d838ac

data/MIT-LICENSE

@@ -0,0 +1,24 @@
+Copyright 2016 Simon Loffler (https://sighmon.com)
+
+Based on Markerb Gem:
+
+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,155 @@
+# MJML-Haml
+
+[![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.
+
+An example template might look like:
+
+```haml
+/ ./app/views/user_mailer/email.mjml
+%mjml
+  %mj-body
+    %mj-container
+      %mj-section
+        %mj-column
+          %mj-text
+          = render :partial => 'info', :formats => [:html]
+```
+
+And the partial `_info.mjml`:
+
+```haml
+/ ./app/views/user_mailer/_info.mjml
+%mj-text= "This is #{@user.username}"
+```
+
+* Notice you can use Haml 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|
+      format.text
+      format.mjml
+    end
+  end
+end
+```
+
+## Installation
+
+Add it to your Gemfile.
+
+```ruby
+gem 'mjml-haml'
+```
+
+Run the following command to install it:
+
+```console
+bundle install
+```
+
+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.
+
+Once you've installed the [Heroku Toolbelt](https://toolbelt.heroku.com/) you can setup the buildpacks from the commandline:
+
+`$ heroku buildpacks:set heroku/ruby`
+
+And then add the Node buildpack to index 1 so it's run first:
+
+`$ heroku buildpacks:add --index 1 heroku/nodejs`
+
+Check that's all setup by running:
+
+`$ heroku buildpacks`
+
+Next you'll need to setup a `package.json` file in the root, something like this:
+
+```json
+{
+  "name": "your-site",
+  "version": "1.0.0",
+  "description": "Now with MJML email templates!",
+  "main": "index.js",
+  "directories": {
+    "doc": "doc",
+    "test": "test"
+  },
+  "dependencies": {
+    "mjml": "^2.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/your-repo/your-site.git"
+  },
+  "keywords": [
+    "mailer"
+  ],
+  "author": "Your Name",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/fnix/mjml-haml/issues"
+  },
+  "homepage": "https://github.com/fnix/mjml-haml"
+}
+```
+
+Then `$ git push heroku master` and it should Just WorkTM.
+
+## 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/fnix/mjml-haml/issues](https://github.com/fnix/mjml-haml/issues)
+
+## Maintainers
+
+* Kadu Diógenes [github.com/cerdiogenes](https://github.com/cerdiogenes)
+
+## License
+
+MIT License. Copyright 2016 Kadu Diógenes.
+
+Lovingly built on [github.com/sighmon/mjml-rails](https://github.com/sighmon/mjml-rails)

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

@@ -0,0 +1,23 @@
+require 'generators/haml/mailer/mailer_generator'
+
+module Mjml
+  module Generators
+    class MailerGenerator < Haml::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 %>
+
+Find me in <%= @path %>

data/lib/mjml-haml.rb

@@ -0,0 +1 @@
+require "mjml"

data/lib/mjml.rb

@@ -0,0 +1,46 @@
+require "action_view"
+require "haml"
+require "haml/template/plugin"
+require "mjml/mjmltemplate"
+require "mjml/railtie"
+require "rubygems"
+
+module Mjml
+
+  def self.check_version(bin)
+    begin
+      Gem::Dependency.new('','~> 2.0').match?('',`#{bin} --version`)
+    rescue
+      false
+    end
+  end
+
+  def self.discover_mjml_bin
+    # 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
+
+  BIN = discover_mjml_bin
+
+  class Handler
+    def haml_handler
+      @haml_handler ||= ActionView::Template.registered_template_handler(:haml)
+    end
+
+    def call(template)
+      compiled_source = haml_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
+        Mjml::BIN
+      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-haml.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,3 @@
+module Mjml
+  VERSION = "0.1.0"
+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_subdir_test.rb

@@ -0,0 +1,76 @@
+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

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="https://github.com/fnix/mjml-haml">haml-rails</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,78 @@
+--- !ruby/object:Gem::Specification
+name: mjml-haml
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kadu Diógenes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-12 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Render MJML + Haml template views in Rails
+email: kadu@fnix.com.br
+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-haml.rb
+- 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_subdir_test.rb
+- test/mjml_test.rb
+- test/template_test.rb
+- test/test_helper.rb
+homepage: https://github.com/fnix/mjml-haml
+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.4.8
+signing_key: 
+specification_version: 4
+summary: MJML + Haml templates
+test_files:
+- test/mjml_subdir_test.rb
+- test/template_test.rb
+- test/mjml_test.rb
+- test/test_helper.rb
+- test/generator_test.rb