multiparterb 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bc69aa4a1365d5167eaa5a564fecdcc2c1eb8ab9
-  data.tar.gz: 8903571b2e83db708a5178c9b050b355e305a465
+  metadata.gz: 12bde72054a4d9073d27de1b397a85e2320c3bd9
+  data.tar.gz: 7c88e13a2e99ec33c3ed02e89fc13c76ae0435d1
 SHA512:
-  metadata.gz: da2c4c6b126b50a5fb802064c3af747e70bd3d5e0cf16a7079fb2cd1bbd1029d4fdd55ab40b178b5e3381d2ca60f8341d075618cb4a323f3aa47ae9e3034180a
-  data.tar.gz: 6f1436773cc3e515a462153d94ca6ba6f576a3a210a916c3b6e217b033bdce410ade1b3a86d0170a18bab020eab84ee6740ecd26ccea68cd6b813e9c5c63734a
+  metadata.gz: f3d6e2fbaba5260d66584402bfc5069e5dff3ff5f3e808ed8f9a6736fa8502e2fadc9eba3d8d2a383d3e1a73cd813a76edea306f3a0e60640abfcb899618ba36
+  data.tar.gz: 6830c84ea752685c21733fe3dfa5d663877e777d8f63d97d32e54d283c9538d2c86cf95d0cd865dce19bad5d38807d0676657f489490e47e8f85c1d472163be7

data/README.md

@@ -1,4 +1,4 @@
-# MultipartErb
+# MultipartErb [![Build Status](https://travis-ci.org/econsultancy/multiparterb.svg?branch=master)](https://travis-ci.org/econsultancy/multiparterb) [![Gem Version](https://badge.fury.io/rb/multiparterb.svg)](http://badge.fury.io/rb/multiparterb)
 
 **MultipartErb** allows you to render multipart e-mails from a single template.
 
@@ -43,13 +43,13 @@ This is derived from a base class `BaseFormatter` provided by MultipartErb, any
 This example formats the elements as it finds them, standard HTML output. _(TODO: Maybe provide this as standard?)_
 
 ```ruby
-class MyHTMLFormatter < BaseFormatter
+class MyHTMLFormatter < MultipartErb::BaseFormatter
   def heading(text)
-    content_tag :h1, text
+    content_tag(:h1, text)
   end
 
-  def text(text=nil, &block)
-    content_tag :p, super
+  def paragraph(text)
+    content_tag(:p, text)
   end
 
   def anchor(text, href)
@@ -61,13 +61,13 @@ end
 And here is an example text formatter.
 
 ```ruby
-class MyTextFormatter < BaseFormatter
+class MyTextFormatter < MultipartErb::BaseFormatter
   def heading(text)
     "*** #{text} ***\n"
   end
 
-  def text(text=nil, &block)
-    text + "\n"
+  def paragraph(text)
+    text
   end
 
   def anchor(text, href)
@@ -79,6 +79,7 @@ end
 Then you need to tell MultipartErb which formatters you want it to use.
 
 ```ruby
+# ./config/initializers/multiparterb.rb
 MultipartErb.html_formatter = MyHTMLFormatter.new
 MultipartErb.text_formatter = MyTextFormatter.new
 ```
@@ -87,9 +88,12 @@ 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>` => `Formatter#heading`
-* `<p></p>` => `Formatter#htext`
-* `<a href="https://example.com">example</a>` => `Formatter#hanchor`
+* `<h1>text</h1>` => `Formatter#heading(text)`
+* `<p>text</p>` => `Formatter#paragraph(text)`
+* `<a href="https://example.com">text</a>` => `Formatter#anchor(text, href)`
+* `<ul>text</ul>` => `Formatter#unordered_list(text)`
+* `<li>text</li>` => `Formatter#list_item(text)`
+* `<strong>text</strong>` => `Formatter#strong(text)`
 
 ### Mailers
 
@@ -111,7 +115,6 @@ 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 :
@@ -136,10 +139,7 @@ Html version
 
 * 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.
-
+* You can use ERb inside the template, which gets parsed before the formatting occurs.
 
 ## Bug reports
 

data/lib/multiparterb/formatter.rb

@@ -3,6 +3,16 @@ module MultipartErb
   @@html_formatter = nil
   @@text_formatter = nil
 
+  SUPPORTED_TAG_METHODS = {
+    # HTML tag => method called
+    'h1' => :heading,
+    'p' => :paragraph,
+    'ul' => :unordered_list,
+    'li' => :list_item,
+    'strong' => :strong,
+    'a' => :anchor,
+  }
+
   class Formatter
     def self.parse(node, formatter)
       "".tap do |result|
@@ -13,19 +23,17 @@ module MultipartErb
     end
 
     def self.lookup(child, formatter)
-      case child.name
-      when 'h1'
-        formatter.heading(parse(child, formatter).html_safe)
-      when 'p'
-        formatter.text(parse(child, formatter).html_safe)
-      when 'a'
-        formatter.anchor(
-          parse(child, formatter).html_safe,
-          child.attributes['href'].content)
-      when 'text'
-        child.text
+      return child.text if child.name == 'text'
+      parsed_text = parse(child, formatter).html_safe
+
+      if SUPPORTED_TAG_METHODS.keys.include?(child.name)
+        if child.name == 'a'
+          formatter.public_send(SUPPORTED_TAG_METHODS[child.name], parsed_text, child.attributes['href'].content)
+        else
+          formatter.public_send(SUPPORTED_TAG_METHODS[child.name], parsed_text)
+        end
       else
-        parse(child, formatter)
+        parsed_text
       end
     end
 

data/lib/multiparterb/formatters/base_formatter.rb

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

data/lib/multiparterb/version.rb

@@ -1,3 +1,3 @@
 module MultipartErb
-  VERSION = "0.0.2"
+  VERSION = "0.0.4"
 end

data/test/base_formatter_test.rb

@@ -0,0 +1,19 @@
+require "test_helper"
+
+class BaseFormatterTest < ActiveSupport::TestCase
+  setup do
+    TestFormatter = Class.new(MultipartErb::BaseFormatter)
+    MultipartErb.html_formatter = TestFormatter.new
+  end
+
+  teardown do
+    MultipartErb.html_formatter = MyHTMLFormatter.new
+  end
+
+  test 'missing required formatter method' do
+    exception = assert_raises NoMethodError do
+      MultipartErb::Formatter.to_html('<h1>heading</h1>')
+    end
+    assert_equal "undefined method `heading' for #{MultipartErb.html_formatter}", exception.message
+  end
+end

data/test/formatter_test.rb

@@ -1,31 +1,17 @@
 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>
-    }
+    @template = File.read('./test/views/formatter/formatter.multipart')
   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
+    html = File.read('./test/views/formatter/formatter.html')
+    assert_equal html, MultipartErb::Formatter.to_html(@template)
   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
+    text = File.read('./test/views/formatter/formatter.text')
+    assert_equal text, MultipartErb::Formatter.to_text(@template)
   end
 end

data/test/formatters/my_html_formatter.rb

@@ -1,13 +1,21 @@
-class MyHTMLFormatter < BaseFormatter
+class MyHTMLFormatter < MultipartErb::BaseFormatter
   def heading(text)
-    content_tag :h1, text
+    content_tag(:h1, text)
   end
 
-  def text(text=nil, &block)
-    content_tag :p, super
+  def paragraph(text)
+    content_tag(:p, text)
   end
 
   def anchor(text, href)
     content_tag(:a, text, href: href)
   end
+
+  def unordered_list(text)
+    content_tag(:ul, text)
+  end
+
+  def list_item(text)
+    content_tag(:li, text)
+  end
 end

data/test/formatters/my_text_formatter.rb

@@ -1,13 +1,21 @@
-class MyTextFormatter < BaseFormatter
+class MyTextFormatter < MultipartErb::BaseFormatter
   def heading(text)
     text + "\n" + ("-" * text.length) + "\n"
   end
 
-  def text(text=nil, &block)
-    text + "\n"
+  def paragraph(text)
+    text
   end
 
   def anchor(text, href)
     text + ' (' + href + ')'
   end
+
+  def unordered_list(text)
+    text
+  end
+
+  def list_item(text)
+    "- #{text}"
+  end
 end

data/test/multiparterb_test.rb

@@ -70,10 +70,10 @@ class MultipartErbTest < ActiveSupport::TestCase
     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 "Welcome\n\n", email.parts[0].body.raw_source
-    assert_equal "text/html", email.parts[1].mime_type
-    assert_equal "<p>Welcome\r\n</p>", email.parts[1].body.encoded.strip
+    assert_equal "text/html", email.parts[0].mime_type
+    assert_equal "<p>Welcome\r\n</p>", email.parts[0].body.encoded.strip
+    assert_equal "text/plain", email.parts[1].mime_type
+    assert_equal "Welcome\n", email.parts[1].body.raw_source
   end
 
   test "with link" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: multiparterb
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Ian Vaughan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-01 00:00:00.000000000 Z
+date: 2014-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -24,22 +24,36 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.18
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.18
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.10
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.10
 description: Multipart templates made easy
-email: ian.vaughan@econsultancy.com
+email: tech@econsultancy.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -53,13 +67,14 @@ files:
 - lib/multiparterb/railtie.rb
 - lib/multiparterb/version.rb
 - lib/multiparterb.rb
+- test/base_formatter_test.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/
+homepage: http://github.com/econsultancy/multiparterb
 licenses:
 - MIT
 metadata: {}
@@ -84,6 +99,7 @@ signing_key:
 specification_version: 4
 summary: Multipart templates made easy
 test_files:
+- test/base_formatter_test.rb
 - test/formatter_test.rb
 - test/formatters/my_html_formatter.rb
 - test/formatters/my_text_formatter.rb