inky-rails 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c8f0d12f941bb56b5bab40e1e446b47be95f605c
+  data.tar.gz: 6ed2012d1cd83af8cc4f8d32780f56fa03ef9832
+SHA512:
+  metadata.gz: e1861dea45d4140cd39ec3ec8cc20040e6652e55eaf7051854cc5cbbd4038c813f3791e17c9fc0197938151706a5589bf0b9e95c35d2d17aa73d01d64340be56
+  data.tar.gz: 8d7d957ffafb1829f4214ac1a39db4adbb3a2761c16c60c8a5c935b0ac8f1579d9d9caf854ec24f72b6dba6bfb8b54951bca9ead289f4c34803c307f359628ee

data/MIT-LICENSE

@@ -0,0 +1,28 @@
+Copyright 2016 Whitesmith (https://whitesmith.co)
+
+Based on Mjml-Rails gem:
+
+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,67 @@
+# Inky-Rails
+
+**Inky-Rails** allows you to render HTML e-mails from an
+[Inky]https://github.com/zurb/inky) template.
+
+An example template might look like:
+
+```erb
+<!-- TODO -->
+```
+
+And the partial `_info.inky`:
+
+```erb
+<!-- TODO -->
+```
+
+* Notice you can use ERb 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.inky
+    end
+  end
+end
+```
+
+## Installation
+
+Add it to your Gemfile.
+
+```ruby
+gem 'inky-rails'
+```
+
+Run the following command to install it:
+
+```console
+bundle install
+```
+
+Install the Inky CLI parser (optional -g to install it globally):
+
+```console
+npm install -g inky-cli@^1.0
+```
+
+## 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/whitesmith/inky-rails/issues](https://github.com/whitesmith/inky-rails/issues)
+
+## License
+
+MIT License. Copyright 2016 Whitesmith. [whitesmith.co](http://www.whitesmith.co)
+
+Lovingly built on [github.com/sighmon/mjml-rails](https://github.com/sighmon/mjml-rails)
+which was previously based on [github.com/plataformatec/markerb](https://github.com/plataformatec/markerb)

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

@@ -0,0 +1,23 @@
+require 'rails/generators/erb/mailer/mailer_generator'
+
+module Inky
+  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
+        :inky
+      end
+    end
+  end
+end

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

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

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

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

data/lib/inky-rails.rb

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

data/lib/inky.rb

@@ -0,0 +1,47 @@
+require "action_view"
+require "action_view/template"
+require "inky/inky_template"
+require "inky/railtie"
+require "rubygems"
+
+module Inky
+
+  def self.check_version(bin)
+    begin
+      # TODO: Extract inky-cli version to an explicit constant
+      Gem::Dependency.new('','~> 1.0.1').match?('',`#{bin} --version`)
+    rescue
+      false
+    end
+  end
+
+  def self.discover_inky_bin
+    default_bin_name = 'inky'
+    inky_bin = default_bin_name
+    # Check for a global install of MJML binary
+    return inky_bin if check_version(default_bin_name)
+
+    # Check for a local install of MJML binary
+    inky_bin = File.join(`npm bin`.chomp, default_bin_name)
+    return inky_bin if check_version(inky_bin)
+
+    raise RuntimeError, "Couldn't find the MJML binary.. have you run $ npm install #{default_bin_name}?"
+  end
+
+  BIN = discover_inky_bin
+
+  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?(:inky)
+        "Inky::InkyTemplate.to_html(begin;#{compiled_source};end).html_safe"
+      else
+        compiled_source
+      end
+    end
+  end
+end

data/lib/inky/inky_template.rb

@@ -0,0 +1,13 @@
+require 'inky/parser'
+
+module Inky
+  mattr_accessor :processing_options, :renderer
+  @@processing_options = {}
+
+  class InkyTemplate
+    def self.to_html(compiled_source)
+
+      Inky::Parser.new(compiled_source).render.html_safe
+    end
+  end
+end

data/lib/inky/parser.rb

@@ -0,0 +1,80 @@
+module Inky
+  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 inky template
+    #
+    # @return [String]
+    def render
+      result = run
+      remove_tmp_files
+      result
+    rescue => error
+      ""
+    end
+
+    # Exec inky command
+    #
+    # @return [String] The result as string
+    def run
+      # TODO: Refactor this
+      command = "#{inky_bin} #{in_tmp_file} #{out_tmp_file}"
+      `#{command}`
+      file = File.open("#{out_tmp_file}/#{in_tmp_file.split('/').last}", 'r')
+      str  = file.read
+      file.close
+      str
+    end
+
+    private
+
+      # Remove tmp files
+      #
+      # @return nil
+      def remove_tmp_files
+        FileUtils.rm(in_tmp_file)
+        FileUtils.rmdir(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}"
+      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}.inky"
+        # puts @_in_tmp_file
+        return @_in_tmp_file
+      end
+
+      # Get inky-cli bin path
+      #
+      # @return [String]
+      def inky_bin
+        Inky::BIN
+      end
+  end
+end

data/lib/inky/railtie.rb

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

data/lib/inky/version.rb

@@ -0,0 +1,4 @@
+module Inky
+	# Version number matches inky-cli version
+  VERSION = '1.0.1'
+end

data/test/generator_test.rb

@@ -0,0 +1,16 @@
+require 'test_helper'
+require 'generators/inky/mailer/mailer_generator'
+
+class GeneratorTest < Rails::Generators::TestCase
+  tests Inky::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.inky'
+    assert_file 'app/views/notifier/bar.inky'
+    assert_file 'app/views/notifier/baz.inky'
+  end
+end

data/test/inky_test.rb

@@ -0,0 +1,63 @@
+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 InkyTest < ActiveSupport::TestCase
+  test 'html should be sent as html' do
+    email = Notifier.contact('you@example.com', :inky)
+    assert_equal 'text/html', email.mime_type
+    assert_no_match(/<row>/, email.body.encoded.strip)
+    assert_no_match(/<columns>/, email.body.encoded.strip)
+    assert_match(/<table/, email.body.encoded.strip)
+    assert_match(/This is a number: \d\.\d/, email.body.encoded.strip)
+  end
+
+  test 'with partial' do
+    email = Notifier.user(:inky)
+    assert_equal 'text/html', email.mime_type
+    assert_match(/Hello Partial/, email.body.encoded.strip)
+  end
+
+  test 'without a partial' do
+    email = Notifier.no_partial(:inky)
+    assert_equal 'text/html', email.mime_type
+    assert_match(/Hello World/, email.body.encoded.strip)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,30 @@
+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 'inky'
+
+Inky::Railtie.run_initializers
+
+if ActiveSupport::TestCase.respond_to? :test_order=
+  ActiveSupport::TestCase.test_order = :sorted
+end
+
+# Avoid annoying warning from I18n.
+I18n.enforce_available_locales = false
+
+ActionMailer::Base.delivery_method = :test
+ActionMailer::Base.perform_deliveries = true

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: inky-rails
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Rafael Jegundo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-17 00:00:00.000000000 Z
+dependencies: []
+description: Render Inky + ERb template views in Rails
+email: rafael@whitesmith.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- lib/generators/inky/mailer/mailer_generator.rb
+- lib/generators/inky/mailer/templates/layout.inky
+- lib/generators/inky/mailer/templates/view.inky
+- lib/inky-rails.rb
+- lib/inky.rb
+- lib/inky/inky_template.rb
+- lib/inky/parser.rb
+- lib/inky/railtie.rb
+- lib/inky/version.rb
+- test/generator_test.rb
+- test/inky_test.rb
+- test/test_helper.rb
+homepage: https://github.com/whitesmith/inky-rails
+licenses:
+- MIT
+metadata: {}
+post_install_message: "Don't forget to install Inky e.g. \n                            $
+  npm install -g inky-cli"
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Inky + ERb templates
+test_files:
+- test/generator_test.rb
+- test/inky_test.rb
+- test/test_helper.rb