email_boilerplate 0.9.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,2 @@
+source 'http://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Earlydoc
+
+MIT License
+
+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,35 @@
+# Email Boilerplate
+
+This Gem provides email templates and view helpers for normalizing HTML emails in common clients based on the work of the HTML Email Boilerplate: 
+
+http://htmlemailboilerplate.com/
+
+Mailer Class
+=============
+
+Inherit from the mailer class to use the boilerplate layout and give your mailer views access to additional helpers.
+
+    class SomeMailer < ActionMailer::EmailBoilerplate
+      ...
+    end
+
+Mailer Layout
+=============    
+
+The boilerplate providers an html email template that will be used as the default layout whenever a mailer inherits from `ActionMailer::EmailBoilerplate`. 
+
+This template also exposes an optional pattern for nesting an application's secondary email layout. To nest a custom layout, (1) set the layout in the mailer class, and (2) wrap the layout's content and `yield` statement in a `content_for` key for `:body`.
+
+**some_mailer.rb  
+    class SomeMailer < ActionMailer::EmailBoilerplate
+      layout 'some/custom/layout'  
+    end
+
+**some/custom/layout.html.erb  
+    <% content_for :body do %>
+      <h1>title</h1>
+      <p>email body</p>
+      <%= yield %>
+    <% end %>
+    <%= render :template => 'boilerplate' %> 
+

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+desc "Run tests"
+task :default => :test

data/email_boilerplate.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'email_boilerplate/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "email_boilerplate"
+  spec.version       = EmailBoilerplate::VERSION
+  spec.summary       = "Earlydoc Email Boilerplate"
+  spec.description   = "Email templates and view helpers for normalizing HTML emails in common clients"
+  spec.authors       = ['Earlydoc', 'Travis Dunn']
+  spec.email         = 'developer@earlydoc.com'
+  spec.homepage      = 'https://www.earlydoc.com'
+  spec.license       = "MIT"
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency 'activesupport', '~> 4.0.0.rc1'
+end

data/lib/email_boilerplate.rb

@@ -0,0 +1,10 @@
+require "action_mailer"
+
+module EmailBoilerplate
+end
+
+ActionMailer::Base.append_view_path(File.expand_path("../views", __FILE__))
+
+require_relative "email_boilerplate/action_mailer/helper"
+require_relative "email_boilerplate/action_mailer/mailer"
+require_relative "email_boilerplate/rails/railtie"

data/lib/email_boilerplate/action_mailer/helper.rb

@@ -0,0 +1,47 @@
+module ActionMailer
+  module EmailBoilerplate
+    module Helper
+      def mail_table_tag(options={}, &block)
+        content_tag :table, options.merge(normal_table_options), &block
+      end
+
+      def mail_table_cell_tag(options={}, &block)
+        content_tag :td, normal_table_cell_options, &block
+      end
+
+      def mail_image_tag(source, options = {})
+        image_tag source, options.merge(normal_image_options)
+      end
+
+      def mail_link_to(body, url, options = {})
+        link_to body, url, options.merge(normal_link_options)
+      end
+
+      def mail_paragraph(&block)
+        content_tag :p, normal_paragraph_options, &block
+      end
+
+      private
+
+        def normal_paragraph_options
+          {:style => { :margin => '1em 0'} }
+        end
+
+        def normal_table_options
+          {:cellpadding => 0, :cellspacing => 0, :border => 0, :width => '100%'}
+        end
+
+        def normal_table_cell_options
+          {:style => { 'border-collapse' => 'collapse'} }
+        end
+
+        def normal_image_options
+          {:border => 0}
+        end
+
+        def normal_link_options
+          {:style => 'color:inherit'}
+        end
+    end
+  end
+end

data/lib/email_boilerplate/action_mailer/mailer.rb

@@ -0,0 +1,32 @@
+module ActionMailer
+  module EmailBoilerplate
+    class Mailer < ActionMailer::Base
+      helper ActionMailer::EmailBoilerplate::Helper
+
+      self.append_view_path File.join(__FILE__, '../../views')
+
+      def default_sender(email=nil)
+        from = config.email_from_address
+        "#{email || from} <#{from}>"
+      end
+
+      def default_recipient
+        config.email_to_address
+      end
+
+      def mail(locale, opts)
+        ActionMailer::Base.default_url_options[:locale] = locale
+
+        I18n.with_locale(locale) do   
+          super opts
+        end
+      end
+
+      private    
+
+        def config
+          @config ||= Rails.application.config
+        end
+    end
+  end
+end

data/lib/email_boilerplate/rails/railtie.rb

@@ -0,0 +1,8 @@
+require 'rails/railtie'
+
+module EmailBoilerplate
+  class Railtie < Rails::Railtie
+    initializer 'email_boilerplate.append_template_paths' do |app|
+    end
+  end
+end

data/lib/email_boilerplate/version.rb

@@ -0,0 +1,3 @@
+module EmailBoilerplate
+  VERSION = "0.9.0"
+end

data/lib/email_boilerplate/views/boilerplate.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=0" />
+    <title><%= content_for :title %></title>
+  </head>
+  <body style='margin:0;padding:0'>
+    <div style='width:100% !important; min-height:1000px; font-size:13px; line-height:1.4;'>
+      <%= content_for?(:body) ? yield(:body) : yield %>
+    </div>
+  </body>
+</html>

data/lib/email_boilerplate/views/boilerplate.text.erb

@@ -0,0 +1,3 @@
+<%= content_for?(:title) ? "##{content_for(:title)}" : nil %>
+
+<%= content_for?(:body) ? yield(:body) : yield %>

data/test/helper_test.rb

@@ -0,0 +1,29 @@
+require_relative 'test_helper'
+
+class HelperTest < MiniTest::Unit::TestCase
+  include ActionMailer::EmailBoilerplate::Helper
+
+  def test_normal_link_options
+    assert normal_link_options.has_key? :style
+  end
+
+  def test_normal_image_options
+    assert normal_image_options.has_key? :border
+  end
+
+  def test_normal_table_cell_options
+    assert normal_table_cell_options.has_key? :style
+  end  
+
+  def test_normal_table_options
+    assert normal_table_options.has_key? :cellpadding
+    assert normal_table_options.has_key? :cellspacing
+    assert normal_table_options.has_key? :border
+    assert normal_table_options.has_key? :width
+  end    
+
+  def test_normal_paragraph_options
+    assert normal_paragraph_options.has_key? :style
+    assert normal_paragraph_options[:style].has_key? :margin
+  end   
+end

data/test/mailer_test.rb

@@ -0,0 +1,44 @@
+require_relative 'test_helper'
+
+class MailerTest < MiniTest::Unit::TestCase
+  def setup
+    @mailer = MockMailer.send :new
+
+    @config ||= OpenStruct.new :email_from_address => 'from@example.com',
+                               :email_to_address => 'to@example.com'
+    @mailer.instance_variable_set('@config', @config)
+  end
+
+  def teardown
+    ActionMailer::Base.deliveries.clear
+  end
+
+  def test_default_recipient
+    assert_equal @config.email_to_address, @mailer.default_recipient
+  end  
+
+  def test_default_sender
+    from = @config.email_from_address
+    assert_equal "#{from} <#{from}>", @mailer.default_sender
+  end  
+
+  def test_default_sender_with_email_address
+    email = 'test@example.com'
+    from = @config.email_from_address
+    assert_equal "#{email} <#{from}>", @mailer.default_sender(email)
+  end  
+
+  def test_that_mail_is_sent
+    mail = MockMailer.example_email 'en', @config
+    mail.deliver
+    assert !ActionMailer::Base.deliveries.empty?
+  end
+
+  def test_that_boilerplate_layout_is_used
+    mail = MockMailer.example_email 'en', @config
+    delivery = mail.deliver
+
+    assert_match /<h1>test<\/h1>/, delivery.encoded
+    assert_match /<body style='margin:0;padding:0'>/, delivery.encoded
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,24 @@
+require 'ansi/code'
+require 'turn'
+require 'minitest/autorun'
+require 'ostruct'
+require_relative '../lib/email_boilerplate'
+
+class MockMailer < ActionMailer::EmailBoilerplate::Mailer
+  def example_email(locale, config)
+    @config = config
+
+    mail locale, :to => default_recipient,
+                 :from => default_sender,
+                 :subject => 'test',
+                 :template_name => 'example_email'
+  end
+end
+MockMailer.append_view_path(File.expand_path("../views", __FILE__))
+
+module ActionMailer
+  class Base
+    def default_url_options; {}; end
+  end
+end
+ActionMailer::Base.delivery_method = :test

data/test/views/mock_mailer/example_email.html.erb

@@ -0,0 +1,4 @@
+<% content_for :body do %>
+  <h1>test</h1>
+<% end %>
+<%= render :template => 'boilerplate' %> 

data/test/views/mock_mailer/example_email.text.erb

@@ -0,0 +1 @@
+test

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: email_boilerplate
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+  prerelease: 
+platform: ruby
+authors:
+- Earlydoc
+- Travis Dunn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0.rc1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0.rc1
+description: Email templates and view helpers for normalizing HTML emails in common
+  clients
+email: developer@earlydoc.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- email_boilerplate.gemspec
+- lib/email_boilerplate.rb
+- lib/email_boilerplate/action_mailer/helper.rb
+- lib/email_boilerplate/action_mailer/mailer.rb
+- lib/email_boilerplate/rails/railtie.rb
+- lib/email_boilerplate/version.rb
+- lib/email_boilerplate/views/boilerplate.html.erb
+- lib/email_boilerplate/views/boilerplate.text.erb
+- test/helper_test.rb
+- test/mailer_test.rb
+- test/test_helper.rb
+- test/views/mock_mailer/example_email.html.erb
+- test/views/mock_mailer/example_email.text.erb
+homepage: https://www.earlydoc.com
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Earlydoc Email Boilerplate
+test_files:
+- test/helper_test.rb
+- test/mailer_test.rb
+- test/test_helper.rb
+- test/views/mock_mailer/example_email.html.erb
+- test/views/mock_mailer/example_email.text.erb