mjml-premailer 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95877653a5a4ad8155f4e878171341e0c1d9ef6b43351fde6862504333900524
-  data.tar.gz: 26a8bafedb5064a49affa3fba245ffa8d02bc169c434d5b7ea3f9719f6a50188
+  metadata.gz: 2a358282013850d34f730c47e0fff480c6299e97a110f54f5bf2a0702bd5f86d
+  data.tar.gz: '038f27861c72bbdb7ad86e1630b9aeefca0c34b35ae9a31171003cbf73f4a96c'
 SHA512:
-  metadata.gz: 70fabf7df1c3158c83a8a80f7fead2db93cd7679e0b6b333d9a157e094963709412f31773620eb7192cf36179666eee99e459da3140576f0476f1801eb3e161a
-  data.tar.gz: f1bb3cf40bbe51b1880c82093b179a0bf3d5be61ebaeaadbbc2bd91e2badee137cb3e88045b8896c796892fd8fe90b1d9e1a4dce495b91bae2a96050a87b38af
+  metadata.gz: 9cd30f41124459faf0f58918893fa67268cdf0ec18d692216d8bdcc66cfa7f0fea2122352f51ac6feb5fecab63f53eb8e49f894961616d081c2e9899aad92879
+  data.tar.gz: 70caf40a5cdb125f6398986900861533f5f5725660ae3de954cf1cc40d5d82ff5de4a49da7af57d08780ae65967cda2f977144eb889327745f036a1994d14f36

data/Makefile

@@ -10,4 +10,7 @@ run_env:
 
 publish:
 	gem build mjml-premailer
-	gem push
+	gem push mjml-premailer-$$(cat VERSION).gem
+
+test:
+	bundle exec rspec

data/README.md

@@ -3,19 +3,64 @@
 Write your emails using [mjml framework](https://mjml.io) on rails, using any template language supported by Rails
 
 [![Travis](https://travis-ci.org/srghma/mjml-premailer.svg?branch=master)](https://travis-ci.org/srghma/mjml-premailer)
-[![GitHub version](https://badge.fury.io/gh/srghma%2Fmjml-premailer.svg)](https://badge.fury.io/gh/srghma%2Fmjml-premailer)
+[![Gem Version](https://badge.fury.io/rb/mjml-premailer.svg)](https://badge.fury.io/rb/mjml-premailer)
 [![Maintainability](https://api.codeclimate.com/v1/badges/87ecd26fdfceb00dacb6/maintainability)](https://codeclimate.com/github/srghma/mjml-premailer/maintainability)
 [![Coverage Status](https://coveralls.io/repos/github/srghma/mjml-premailer/badge.svg?branch=master)](https://coveralls.io/github/srghma/mjml-premailer?branch=master)
 
 ## How it works
-This gem will processes html part of your mail using `mjml` cli before delivery using rails ActionMailer hook
 
-Or you can process it yourself using
+This gem will processes html part of your mail using `mjml` cli before delivery, just use `mjml_mail` function for delivery instead of `mail`
+
+```rb
+class ApplicationMailer < ActionMailer::Base
+  include MjmlPremailer::MjmlMail # adds function `mjml_mail`
+
+  layout "mailer"
+end
+```
+
+```rb
+class WelcomeMailer < ApplicationMailer
+  def welcome(user)
+    @user = user
+    mjml_mail(to: @user.email, subject: 'Welcome')
+  end
+end
+```
+
+```erb
+<!-- app/views/layouts/mailer.html.erb -->
+
+<mjml>
+  <mj-head>
+    <mj-head>
+      My site
+    <mj-head>
+  <mj-head>
+  <mj-body>
+    <%= yield %>
+  <mj-body>
+</mjml>
+```
+
+
+```erb
+<!-- app/views/welcome_mailer/welcome.html.erb -->
+
+<mj-text>Hello, <%= @user.name %></mj-text>
+```
+
+Or you can transform mail object yourself using
 
 ```ruby
-MjmlPremailer::Hook.perform(mail)
+MjmlPremailer::TransformMail.transform_mail(mail)
 ```
 
+Example rails project you can find [here](example)
+
+Mjml documentation is [here](https://mjml.io/documentation)
+
+
 ## Installation
 
 Install `mjml` npm package (v4) globally
@@ -33,7 +78,7 @@ $ npm install --save-dev mjml@^4.0
 Add the gem to your `Gemfile`:
 
 ```ruby
-gem 'mjml-premailer'
+gem "mjml-premailer"
 ```
 
 ## Configuration options
@@ -42,54 +87,24 @@ In `/config/initializers/mjml_premailer.rb`
 
 ```ruby
 MjmlPremailer.config.merge!(
-  bin:              ...,   # by default found authomatically
-  debug:            false, # true/false
-  beautify:         true,  # true/false
-  minify:           false, # true/false
-  keep_comments:    false, # true/false
-  validation_level: :skip  # :strict/:soft/:skip
-)
-```
-
-## Usage
-
-```erb
-<!-- app/views/layouts/mailer.html.erb -->
-
-<mjml>
-  <mj-body>
-    <%= yield %>
-  <mj-body>
-</mjml>
-```
-
+  minify:        Rails.env.production?,  # default - false
+  beautify:      !Rails.env.production?, # default - true
+  keep_comments: !Rails.env.production?, # default - false
 
-```erb
-<!-- app/views/welcome_mailer/welcome.html.erb -->
-
-<mj-text>Hello, <%= @user.name %></mj-text>
+  ## other possible options
 
+  # debug: false,           # default - false
+  # bin:   ...,             # by default bin path is found authomatically, but you can specify it here
+  # validation_level: :skip # default - :skip, possible options - :strict/:soft/:skip
+)
 ```
 
-```
-class WelcomeMailer < ApplicationMailer
-  def welcome(user)
-    @user = user
-    mail(to: @user.email, subject: 'Welcome')
-  end
-end
-```
-
-Example rails project you can find [here](example)
-
-Mjml documentation is [here](https://mjml.io/documentation)
+More about options [here](https://mjml.io/documentation/#command-line-interface)
 
 
 ## Difference from other gems
 
 [sighmon/mjml-rails](https://github.com/sighmon/mjml-rails):
-- outdated
-- work on hacks
 - no support for `/app/views/layouts`
 
 [kolybasov/mjml-ruby](https://github.com/kolybasov/mjml-ruby/):

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/lib/mjml-premailer.rb

@@ -1,9 +1,12 @@
-require 'action_mailer'
-
 require 'mjml-premailer/version'
-require 'mjml-premailer/hook'
+require 'mjml-premailer/debug'
 require 'mjml-premailer/find_executable'
 
+require 'mjml-premailer/transform_html'
+require 'mjml-premailer/transform_mail'
+
+require 'mjml-premailer/mjml_mail'
+
 class MjmlPremailer
   # from https://github.com/kolybasov/mjml-ruby/blob/master/lib/mjml.rb#L33
   @config = {
@@ -18,14 +21,4 @@ class MjmlPremailer
   class << self
     attr_accessor :config
   end
-
-  def self.register_interceptors
-    ActionMailer::Base.register_interceptor(MjmlPremailer::Hook)
-
-    if ActionMailer::Base.respond_to?(:register_preview_interceptor)
-      ActionMailer::Base.register_preview_interceptor(MjmlPremailer::Hook)
-    end
-  end
 end
-
-require 'mjml-premailer/railtie' if defined?(Rails)

data/lib/mjml-premailer/debug.rb

@@ -0,0 +1,9 @@
+class MjmlPremailer
+  module Debug
+    extend self
+
+    def debug(str)
+      puts str if MjmlPremailer.config[:debug]
+    end
+  end
+end

data/lib/mjml-premailer/mjml_mail.rb

@@ -0,0 +1,9 @@
+class MjmlPremailer
+  module MjmlMail
+    def mjml_mail(*args, **kargs, &block)
+      this_mail = mail(*args, **kargs, &block)
+
+      MjmlPremailer::TransformMail.transform_mail(this_mail)
+    end
+  end
+end

data/lib/mjml-premailer/{hook.rb → transform_html.rb}

@@ -1,37 +1,13 @@
 require 'open3'
 
 class MjmlPremailer
-  module Hook
+  module TransformHtml
     extend self
 
-    def perform(mail)
-      html_part = mail.html_part || mail
-      html = html_part.body.to_s
+    def transform_html(html_body)
+      bin = MjmlPremailer.config[:bin]
 
-      debug '> MjmlPremailer template:'
-      debug html
-
-      parsed_html, error = parse(html)
-
-      error_ = error.strip.presence
-
-      raise error_ if error_
-
-      debug '> MjmlPremailer parsed template:'
-      debug parsed_html
-
-      html_part.body = parsed_html
-    end
-
-    alias delivering_email perform
-    alias previewing_email perform
-
-    private
-
-    def parse(html_body)
-      bin              = MjmlPremailer.config[:bin]
-
-      beautify         = MjmlPremailer.config[:beautify]
+      beautify = MjmlPremailer.config[:beautify]
       beautify_option = "--config.beautify #{beautify}"
 
       minify = MjmlPremailer.config[:minify]
@@ -68,7 +44,9 @@ class MjmlPremailer
         temp_file.rewind
         temp_file.unlink
 
-        [temp_file.read, err]
+        err_ = err.strip.presence
+
+        [temp_file.read, err_]
       else
         write_output_to_stdout_option = '-s'
 
@@ -82,16 +60,14 @@ class MjmlPremailer
           validation_level_option
         ].join(' ')
 
-        debug "> MjmlPremailer command: #{cmd}"
+        MjmlPremailer::Debug.debug "> MjmlPremailer command: #{cmd}"
 
         out, err, _sts = Open3.capture3(cmd, stdin_data: html_body)
 
-        [out, err]
-      end
-    end
+        err_ = err.strip.presence
 
-    def debug(str)
-      puts str if MjmlPremailer.config[:debug]
+        [out, err_]
+      end
     end
   end
 end

data/lib/mjml-premailer/transform_mail.rb

@@ -0,0 +1,24 @@
+class MjmlPremailer
+  module TransformMail
+    extend self
+
+    def transform_mail(mail)
+      mail.tap do
+        html_part = mail.html_part || mail
+        html = html_part.body.to_s
+
+        MjmlPremailer::Debug.debug '> MjmlPremailer template:'
+        MjmlPremailer::Debug.debug html
+
+        parsed_html, error = MjmlPremailer::TransformHtml.transform_html(html)
+
+        raise error if error
+
+        MjmlPremailer::Debug.debug '> MjmlPremailer parsed template:'
+        MjmlPremailer::Debug.debug parsed_html
+
+        html_part.body = parsed_html
+      end
+    end
+  end
+end

data/spec/rails_app/app/mailers/application_mailer.rb

@@ -1,4 +1,6 @@
 class ApplicationMailer < ActionMailer::Base
+  include MjmlPremailer::MjmlMail
+
   default from: 'from@example.com'
   layout 'mail'
 end

data/spec/rails_app/app/mailers/welcome_mailer.rb

@@ -1,6 +1,7 @@
 class WelcomeMailer < ApplicationMailer
   def welcome_email(greeting)
     @greeting = greeting
-    mail to: 'example@example.com'
+
+    mjml_mail(to: 'example@example.com')
   end
 end

data/spec/unit/config_spec.rb

@@ -3,6 +3,7 @@ require 'spec_helper'
 describe MjmlPremailer do
   describe '#config' do
     subject { MjmlPremailer.config }
+
     context 'when set' do
       around do |example|
         begin

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mjml-premailer
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Sergey Homa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-19 00:00:00.000000000 Z
+date: 2019-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
@@ -100,30 +100,12 @@ files:
 - README.md
 - Rakefile
 - VERSION
-- example/.gitignore
-- example/Gemfile
-- example/README.md
-- example/Rakefile
-- example/app/assets/stylesheets/email.css
-- example/app/mailers/example_mailer.rb
-- example/app/views/example_mailer/_wrapper.html.erb
-- example/app/views/example_mailer/test_message.html.erb
-- example/app/views/layout/mail.html.erb
-- example/bin/rails
-- example/config.ru
-- example/config/application.rb
-- example/config/boot.rb
-- example/config/environment.rb
-- example/config/environments/development.rb
-- example/config/environments/production.rb
-- example/config/initializers/assets.rb
-- example/config/routes.rb
-- example/config/secrets.yml
-- example/test/mailers/previews/example_mailer_preview.rb
 - lib/mjml-premailer.rb
+- lib/mjml-premailer/debug.rb
 - lib/mjml-premailer/find_executable.rb
-- lib/mjml-premailer/hook.rb
-- lib/mjml-premailer/railtie.rb
+- lib/mjml-premailer/mjml_mail.rb
+- lib/mjml-premailer/transform_html.rb
+- lib/mjml-premailer/transform_mail.rb
 - lib/mjml-premailer/version.rb
 - mjml-premailer.gemspec
 - spec/integration/delivery_spec.rb
@@ -161,42 +143,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Write your emails using mjml framework
-test_files:
-- example/Gemfile
-- example/README.md
-- example/Rakefile
-- example/app/assets/stylesheets/email.css
-- example/app/mailers/example_mailer.rb
-- example/app/views/example_mailer/_wrapper.html.erb
-- example/app/views/example_mailer/test_message.html.erb
-- example/app/views/layout/mail.html.erb
-- example/bin/rails
-- example/config.ru
-- example/config/application.rb
-- example/config/boot.rb
-- example/config/environment.rb
-- example/config/environments/development.rb
-- example/config/environments/production.rb
-- example/config/initializers/assets.rb
-- example/config/routes.rb
-- example/config/secrets.yml
-- example/test/mailers/previews/example_mailer_preview.rb
-- spec/integration/delivery_spec.rb
-- spec/rails_app/app/mailers/application_mailer.rb
-- spec/rails_app/app/mailers/welcome_mailer.rb
-- spec/rails_app/app/views/layouts/mail.html.erb
-- spec/rails_app/app/views/welcome_mailer/_wrapper.html.erb
-- spec/rails_app/app/views/welcome_mailer/welcome_email.html.erb
-- spec/rails_app/config.ru
-- spec/rails_app/config/application.rb
-- spec/rails_app/config/boot.rb
-- spec/rails_app/config/environment.rb
-- spec/rails_app/config/environments/test.rb
-- spec/rails_app/config/initializers/assets.rb
-- spec/rails_app/config/routes.rb
-- spec/spec_helper.rb
-- spec/unit/config_spec.rb
+test_files: []

data/example/.gitignore

@@ -1,16 +0,0 @@
-# See https://help.github.com/articles/ignoring-files for more about ignoring files.
-#
-# If you find yourself ignoring temporary files generated by your text editor
-# or operating system, you probably want to add a global ignore instead:
-#   git config --global core.excludesfile '~/.gitignore_global'
-
-# Ignore bundler config.
-/.bundle
-
-# Ignore the default SQLite database.
-/db/*.sqlite3
-/db/*.sqlite3-journal
-
-# Ignore all logfiles and tempfiles.
-/log/*.log
-/tmp

data/example/Gemfile

@@ -1,10 +0,0 @@
-source 'https://rubygems.org'
-
-gem 'mjml-premailer', path: '..'
-gem 'nokogiri'
-gem 'rails', '~> 5.0'
-
-platforms :rbx do
-  gem 'racc'
-  gem 'rubysl'
-end

data/example/README.md

@@ -1,10 +0,0 @@
-# Example Rails App
-
-To run this app, run:
-
-```shell
-bundle
-bundle exec rails s
-```
-
-Then point your browser at [http://localhost:3000/](http://localhost:3000/).

data/example/Rakefile

@@ -1,6 +0,0 @@
-# Add your own tasks in files placed in lib/tasks ending in .rake,
-# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
-
-require File.expand_path('../config/application', __FILE__)
-
-Rails.application.load_tasks

data/example/app/assets/stylesheets/email.css

@@ -1,32 +0,0 @@
-body {
-  background: #efefef;
-  font-family: "Helvetica Neue", Helvetica, Arial, sans-serif;
-}
-
-p {
-  line-height: 1.4;
-}
-
-.wrap {
-  max-width: 40em;
-  margin: 0 auto;
-  padding: 1em;
-  background: white;
-}
-
-.greeting {
-  text-align: center;
-  font-weight: bold;
-  font-size: 110%;
-}
-
-.footer {
-  font-size: 90%;
-  color: #666;
-}
-
-a {
-  color: green;
-  text-decoration: none;
-  border-bottom: 2px solid green;
-}

data/example/app/mailers/example_mailer.rb

@@ -1,9 +0,0 @@
-class ExampleMailer < ActionMailer::Base
-  default from: "from@example.com"
-
-  layout 'mail'
-
-  def test_message
-    mail to: 'to@example.org', subject: 'Test Message'
-  end
-end

data/example/app/views/example_mailer/_wrapper.html.erb

@@ -1,3 +0,0 @@
-<mj-text>Hello from wrapper</mj-text>
-
-<%= yield %>

data/example/app/views/example_mailer/test_message.html.erb

@@ -1,9 +0,0 @@
-<mj-section>
-  <mj-column>
-    <mj-text>Hello from test_message outside block</mj-text>
-
-    <%= render 'wrapper' do %>
-      <mj-text>Hello from test_message inside block</mj-text>
-    <% end %>
-  </mj-column>
-</mj-section>

data/example/app/views/layout/mail.html.erb

@@ -1,7 +0,0 @@
-<mjml>
-  <mj-body>
-    <mj-text>Hello from layout</mj-text>
-
-    <%= yield %>
-  </mj-body>
-</mjml>

data/example/bin/rails

@@ -1,4 +0,0 @@
-#!/usr/bin/env ruby
-APP_PATH = File.expand_path('../../config/application', __FILE__)
-require_relative '../config/boot'
-require 'rails/commands'

data/example/config.ru

@@ -1,4 +0,0 @@
-# This file is used by Rack-based servers to start the application.
-
-require ::File.expand_path('../config/environment', __FILE__)
-run Rails.application

data/example/config/application.rb

@@ -1,12 +0,0 @@
-require File.expand_path('../boot', __FILE__)
-
-require 'action_controller/railtie'
-require 'action_mailer/railtie'
-require 'sprockets/railtie'
-
-Bundler.require(*Rails.groups)
-
-module Example
-  class Application < Rails::Application
-  end
-end

data/example/config/boot.rb

@@ -1,3 +0,0 @@
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
-
-require 'bundler/setup' # Set up gems listed in the Gemfile.

data/example/config/environment.rb

@@ -1,5 +0,0 @@
-# Load the Rails application.
-require File.expand_path('../application', __FILE__)
-
-# Initialize the Rails application.
-Rails.application.initialize!

data/example/config/environments/development.rb

@@ -1,9 +0,0 @@
-Rails.application.configure do
-  config.cache_classes = false
-  config.eager_load = false
-  config.consider_all_requests_local = true
-  config.action_controller.perform_caching = false
-  config.assets.debug = true
-  config.assets.digest = true
-  config.assets.raise_runtime_errors = true
-end

data/example/config/environments/production.rb

@@ -1,9 +0,0 @@
-Rails.application.configure do
-  config.cache_classes = true
-  config.eager_load = true
-  config.consider_all_requests_local = false
-  config.action_controller.perform_caching = true
-  config.assets.compile = false
-  config.assets.digest = true
-  config.log_level = :info
-end

data/example/config/initializers/assets.rb

@@ -1,2 +0,0 @@
-Rails.application.config.assets.version = '1.0'
-Rails.application.config.assets.precompile += %w( email.css )

data/example/config/routes.rb

@@ -1,3 +0,0 @@
-Rails.application.routes.draw do
-  root to: redirect('rails/mailers/example_mailer/test_message')
-end

data/example/config/secrets.yml

@@ -1,2 +0,0 @@
-development:
-  secret_key_base: bc1d05753b1a42a7d983dcb4f998c433532ec8f91ab3842a36ed3d9072d143a2d9c05a6dc43a3d780a2ff3d8e7b75a1011ae2e0d13a022e98dc1f0299da5a5a0

data/example/test/mailers/previews/example_mailer_preview.rb

@@ -1,5 +0,0 @@
-class ExampleMailerPreview < ActionMailer::Preview
-  def test_message
-    ExampleMailer.test_message
-  end
-end

data/lib/mjml-premailer/railtie.rb

@@ -1,7 +0,0 @@
-class MjmlPremailer
-  class Railtie < ::Rails::Railtie
-    config.after_initialize do
-      ::MjmlPremailer.register_interceptors
-    end
-  end
-end