multiparterb 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 251b6ea729b75bd4bf083c6c5f25e84ed0d40ed4
+  data.tar.gz: 87ccb68f99ac3df5071dc7fbcf145174eafbdd97
+SHA512:
+  metadata.gz: 0c36a217f12d60c582e9cd4db64c48bbc7e5c6aa9fa253c7aa086976ff33a28f4ea0f0ff84f899bbd1227b5afab3dc278a9378765145aa44aedeb9fdfb65f9c9
+  data.tar.gz: b24e28a6fb3116f3a816d3cf1999d792fb362b1e7486e33665e9ceaf0a4975c13e2f413e49d2508e66b12fd6c57a7f7722d085d5df4fb93ae5d3bdc5b2f97715

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011-2014 Econsultancy
+
+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,162 @@
+# MultipartErb
+
+**MultipartErb** allows you to render multipart e-mails from a single template.
+
+The template is written in HTML with a reduced set of HTML elements,
+which is then parsed and formatted through user provided formatters,
+which then renders and delivers as both text and HTML parts.
+
+## Installation
+
+Add it into your `Gemfile`
+
+```ruby
+gem 'multiparterb'
+```
+
+Install it
+
+```console
+bundle install
+```
+
+## Usage
+
+### Templates
+
+You create one erb template file written in HTML with a reduced set of elements.
+
+Example `app/views/notifier/contact.multipart` :
+
+```erb
+<h1>Heading with a link to <a href="https://example.com">Example</a></h1>
+<p>body with a link to <a href="https://econsultancy.com">Econsultancy</a></p>
+<a href="http://example.com">a link with a <h1>heading</h1> in</a>
+```
+
+### Formatters
+
+You then have to create and provide one or more formatters for MultipartErb to call on each element it finds.
+
+This is derived from a base class `BaseFormatter` provided by MultipartErb, any undefined methods that get called will raise a `NotImplementedError`.
+
+This example formats the elements as it finds them, standard HTML output. _(TODO: Maybe provide this as standard?)_
+
+```ruby
+class MyHTMLFormatter < BaseFormatter
+  def email_heading(text)
+    content_tag :h1, text
+  end
+
+  def email_text(text=nil, &block)
+    content_tag :p, super
+  end
+
+  def anchor(text, href)
+    content_tag(:a, text, href: href)
+  end
+end
+```
+
+And here is an example text formatter.
+
+```ruby
+class MyTextFormatter < BaseFormatter
+  def email_heading(text)
+    "*** #{text} ***\n"
+  end
+
+  def email_text(text=nil, &block)
+    text + "\n"
+  end
+
+  def anchor(text, href)
+    text + ' (' + href + ')'
+  end
+end
+```
+
+Then you need to tell MultipartErb which formatters you want it to use.
+
+```ruby
+MultipartErb.html_formatter = MyHTMLFormatter.new
+MultipartErb.text_formatter = MyTextFormatter.new
+```
+
+It will then call the relevent method for each element it finds in the template.
+
+The set of elements this currently supports, and the method that will get called are :
+
+* `<h1></h1>` => `email_heading`
+* `<p></p>` => `email_text`
+* `<a href="https://example.com">example</a>` => `anchor`
+
+### Mailers
+
+Then your mailers work as normal, and you still get control over which parts you want generated :
+
+```ruby
+class Notifier < ActionMailer::Base
+  def contact(recipient)
+    @recipient = recipient
+    mail(:to => @recipient, :from => "john.doe@example.com") do |format|
+      format.text
+      format.html
+    end
+  end
+end
+```
+
+It will generate two parts, one in text and another in html when delivered.
+
+If you only wanted to text or html part, then just remove the `format` you don't want.
+
+
+### Output
+
+For the above given example, the resulted output would be as such :
+
+Text version
+
+```
+*** Heading with a link to Econsultancy (https://econsultancy.com) ***
+body with a link to Econsultancy (https://econsultancy.com)
+a link with a *** heading *** in (http://example.com)"
+```
+
+Html version
+
+```
+<h1>Heading with a link to <a href=\"https://econsultancy.com\">Econsultancy</a></h1>
+<p>body with a link to <a href=\"https://econsultancy.com\">Econsultancy</a></p>
+<a href=\"http://example.com\">a link with a <h1>heading</h1> in</a>
+```
+
+## Notes
+
+* The `contact.multipart` template should not have a format in its name. Adding a format would make it unavailable to be rendered in different formats;
+
+* The order of the parts matter. It is important for e-mail clients that you call `format.text` before you call `format.html`;
+
+* you can normally use ERb inside the template.
+
+
+## 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.
+
+https://github.com/econsultancy/multiparterb/issues
+
+## Maintainers
+
+* Ian Vaughan (https://github.com/IanVaughan)
+
+## Thanks
+
+This gem was derived from [Markerb](https://github.com/plataformatec/markerb).
+
+## License
+
+MIT License. Copyright 2011-2014 Econsultancy

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

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

data/lib/generators/multiparterb/mailer/templates/view.multipart

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

data/lib/multiparterb.rb

@@ -0,0 +1,27 @@
+require "action_view"
+require "action_view/template"
+require "multiparterb/formatter"
+require "multiparterb/railtie"
+require "multiparterb/formatters/base_formatter"
+
+require 'nokogiri'
+
+module MultipartErb
+  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?(:html)
+        "MultipartErb::Formatter.to_html(begin;#{compiled_source};end).html_safe"
+      else
+        "MultipartErb::Formatter.to_text(begin;#{compiled_source};end).html_safe"
+      end
+    end
+  end
+end
+
+ActionView::Template.register_template_handler(:multipart, MultipartErb::Handler.new)

data/lib/multiparterb/formatter.rb

@@ -0,0 +1,40 @@
+module MultipartErb
+  mattr_accessor :html_formatter, :text_formatter
+  @@html_formatter = nil
+  @@text_formatter = nil
+
+  class Formatter
+    def self.parse(node, formatter)
+      result = ""
+
+      node.children.each do |child|
+        result << case child.name
+                  when 'h1'
+                    formatter.email_heading(parse(child, formatter).html_safe)
+                  when 'p'
+                    formatter.email_text(parse(child, formatter).html_safe)
+                  when 'a'
+                    formatter.anchor(
+                      parse(child, formatter).html_safe,
+                      child.attributes['href'].content)
+                  when 'text'
+                    child.text
+                  else
+                    parse(child, formatter)
+                  end
+      end
+
+      result
+    end
+
+    def self.to_html(compiled_source)
+      html_doc = Nokogiri::HTML compiled_source
+      parse html_doc, MultipartErb.html_formatter
+    end
+
+    def self.to_text(compiled_source)
+      html_doc = Nokogiri::HTML compiled_source
+      parse html_doc, MultipartErb.text_formatter
+    end
+  end
+end

data/lib/multiparterb/formatters/base_formatter.rb

@@ -0,0 +1,20 @@
+class BaseFormatter
+  include ActionView::Helpers::TagHelper
+  include ActionView::Context
+
+  def email_heading(text)
+    raise NotImplementedError
+  end
+
+  def email_text(text=nil, &block)
+    text || capture(&block)
+  end
+
+  def anchor(text, href)
+    raise NotImplementedError
+  end
+
+  def unordered_list(text)
+    raise NotImplementedError
+  end
+end

data/lib/multiparterb/railtie.rb

@@ -0,0 +1,5 @@
+module MultipartErb
+  class Railtie < ::Rails::Railtie
+    config.app_generators.mailer :template_engine => :multipart
+  end
+end

data/lib/multiparterb/version.rb

@@ -0,0 +1,3 @@
+module MultipartErb
+  VERSION = "0.0.1"
+end

data/test/formatter_test.rb

@@ -0,0 +1,31 @@
+require "test_helper"
+
+# TODO: The idea will be to require the user to provide this as a callback
+class FormatterTest < ActiveSupport::TestCase
+  setup do
+    @template = formatted_html_output %{
+      <h1>Heading with a link to <a href="https://econsultancy.com">Econsultancy</a></h1>
+      <p>body with a link to <a href="https://econsultancy.com">Econsultancy</a></p>
+      <a href="http://example.com">a link with a <h1>heading</h1> in</a>
+    }
+  end
+
+  test 'formatted html output' do
+    html = formatted_html_output %{
+      <h1>Heading with a link to <a href=\"https://econsultancy.com\">Econsultancy</a></h1>
+      <p>body with a link to <a href=\"https://econsultancy.com\">Econsultancy</a></p>
+      <a href=\"http://example.com\">a link with a <h1>heading</h1> in</a>
+    }
+    assert_equal html, MultipartErb::Formatter.to_html(@template).strip
+  end
+
+  test 'formatted text output' do
+    text = "Heading with a link to Econsultancy (https://econsultancy.com)
+--------------------------------------------------------------
+body with a link to Econsultancy (https://econsultancy.com)
+a link with a heading
+-------
+ in (http://example.com)"
+    assert_equal text, MultipartErb::Formatter.to_text(@template).strip
+  end
+end

data/test/formatters/my_html_formatter.rb

@@ -0,0 +1,13 @@
+class MyHTMLFormatter < BaseFormatter
+  def email_heading(text)
+    content_tag :h1, text
+  end
+
+  def email_text(text=nil, &block)
+    content_tag :p, super
+  end
+
+  def anchor(text, href)
+    content_tag(:a, text, href: href)
+  end
+end

data/test/formatters/my_text_formatter.rb

@@ -0,0 +1,13 @@
+class MyTextFormatter < BaseFormatter
+  def email_heading(text)
+    text + "\n" + ("-" * text.length) + "\n"
+  end
+
+  def email_text(text=nil, &block)
+    text + "\n"
+  end
+
+  def anchor(text, href)
+    text + ' (' + href + ')'
+  end
+end

data/test/generator_test.rb

@@ -0,0 +1,18 @@
+require "test_helper"
+require "generators/multiparterb/mailer/mailer_generator"
+
+class GeneratorTest < Rails::Generators::TestCase
+  tests MultipartErb::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)
+
+    # TODO: would be nice to have .erb as the pre-processor in the file name
+    # assert_file "app/views/notifier/foo.multipart.erb"
+    assert_file "app/views/notifier/foo.multipart"
+    assert_file "app/views/notifier/bar.multipart"
+    assert_file "app/views/notifier/baz.multipart"
+  end
+end

data/test/multiparterb_test.rb

@@ -0,0 +1,78 @@
+require "test_helper"
+
+class Notifier < ActionMailer::Base
+  self.view_paths = File.expand_path("../views", __FILE__)
+
+  layout false
+
+  # TODO: want this to output both html and text, unless gem option given to give preferance
+  # mail(:to => @recipient, :from => "john.doe@example.com")
+
+  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 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 MultipartErbTest < ActiveSupport::TestCase
+  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 false, email.multipart?
+    #assert_equal "Contact Heading\r\n---------------\r\n\r\n", email.body.encoded.strip
+    assert_equal "Contact Heading\n---------------\n\n", email.body.raw_source
+  end
+
+  test "html should be sent as html" do
+    email = Notifier.contact("you@example.com", :html)
+    assert_equal "text/html", email.mime_type
+    assert_equal false, email.multipart?
+    #assert_equal "Contact Heading\r\n---------------\r\n\r\n", email.body.encoded.strip
+    assert_equal "<h1>Contact Heading</h1>", 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 true, email.multipart?
+    assert_equal "multipart/alternative", email.mime_type
+    assert_equal "text/plain", email.parts[0].mime_type
+    assert_equal "Contact Heading\n---------------\n\n", email.parts[0].body.raw_source
+    assert_equal "text/html", email.parts[1].mime_type
+    assert_equal "<h1>Contact Heading</h1>", email.parts[1].body.encoded.strip
+  end
+
+  test 'with link' do
+    email = Notifier.link(:html)
+    assert_equal "text/html", email.mime_type
+    assert_equal "<p>A link to <a href=\"https://econsultancy.com\">Econsultancy</a></p>", email.body.encoded.strip
+  end
+
+  test 'with partial' do
+    email = Notifier.user(:html)
+    assert_equal "text/html", email.mime_type
+    #assert_equal '<p>User template rendering a partial User Info Partial</p>', email.body.encoded.strip
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,24 @@
+require 'pry'
+
+require "minitest/autorun"
+require "active_support/test_case"
+
+require "action_mailer"
+require "rails/railtie"
+require "rails/generators"
+require "rails/generators/test_case"
+
+$:.unshift File.expand_path("../../lib", __FILE__)
+require "multiparterb"
+require "formatters/my_text_formatter"
+require "formatters/my_html_formatter"
+
+# Avoid annoying warning from I18n.
+I18n.enforce_available_locales = false
+
+def formatted_html_output(text)
+  text.gsub(/\n +/, '')
+end
+
+MultipartErb.html_formatter = MyHTMLFormatter.new
+MultipartErb.text_formatter = MyTextFormatter.new

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: multiparterb
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ian Vaughan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Multipart templates made easy
+email: ian.vaughan@econsultancy.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- lib/generators/multiparterb/mailer/mailer_generator.rb
+- lib/generators/multiparterb/mailer/templates/view.multipart
+- lib/multiparterb/formatter.rb
+- lib/multiparterb/formatters/base_formatter.rb
+- lib/multiparterb/railtie.rb
+- lib/multiparterb/version.rb
+- lib/multiparterb.rb
+- test/formatter_test.rb
+- test/formatters/my_html_formatter.rb
+- test/formatters/my_text_formatter.rb
+- test/generator_test.rb
+- test/multiparterb_test.rb
+- test/test_helper.rb
+homepage: http://github.com/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Multipart templates made easy
+test_files:
+- test/formatter_test.rb
+- test/formatters/my_html_formatter.rb
+- test/formatters/my_text_formatter.rb
+- test/generator_test.rb
+- test/multiparterb_test.rb
+- test/test_helper.rb