RubyGems - mail_style - Versions diffs - 0.1.1 - Mend

mail_style 0.1.1

Files changed (9) hide show

data/Rakefile +75 -0
data/lib/mail_style.rb +6 -0
data/lib/mail_style/inline_styles.rb +167 -0
data/lib/mail_style/sass_support.rb +15 -0
data/readme.textile +82 -0
data/spec/inline_styles_spec.rb +190 -0
data/spec/spec.opts +4 -0
data/spec/spec_helper.rb +30 -0
metadata +109 -0

data/Rakefile ADDED

@@ -0,0 +1,75 @@
+# encoding: utf-8
+require 'rake'
+require 'rake/rdoctask'
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  begin
+    gem 'rspec-rails', '>= 1.0.0'
+    require 'spec/rake/spectask'
+  rescue LoadError
+    puts "RSpec - or one of its dependencies - is not available. Install it with: sudo gem install rspec-rails"
+  end
+end
+NAME = "mail_style"
+SUMMARY = %{Making HTML emails a little less painful. Writes css inline and corrects image urls.}
+HOMEPAGE = "http://github.com/purify/mail_style"
+AUTHOR = "Jim Neath"
+EMAIL = "jimneath@googlemail.com"
+SUPPORT_FILES = %w(readme.textile)
+begin
+  gem 'jeweler', '>= 1.0.0'
+  require 'jeweler'
+  Jeweler::Tasks.new do |t|
+    t.name = NAME
+    t.summary = SUMMARY
+    t.email = EMAIL
+    t.homepage = HOMEPAGE
+    t.description = SUMMARY
+    t.author = AUTHOR
+    t.require_path = 'lib'
+    t.files = SUPPORT_FILES << %w(Rakefile) << Dir.glob(File.join(*%w[{lib,spec} ** *]).to_s)
+    t.extra_rdoc_files = SUPPORT_FILES
+    t.add_dependency 'action_mailer', '>= 1.2.3'
+    t.add_dependency 'nokogiri', '>= 1.0.0'
+    t.add_dependency 'css_parser', '>= 1.0.0'
+    t.add_development_dependency 'rspec-rails', '>= 1.2.6'
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler - or one of its dependencies - is not available. Install it with: sudo gem install jeweler -s http://gemcutter.org"
+end
+desc "Default: Run specs."
+task :default => :spec
+desc "Generate documentation for the #{NAME} plugin."
+Rake::RDocTask.new(:rdoc) do |t|
+  t.rdoc_dir = 'rdoc'
+  t.title    = NAME
+  t.options << '--line-numbers' << '--inline-source'
+  t.rdoc_files.include(SUPPORT_FILES)
+  t.rdoc_files.include('lib/**/*.rb')
+end
+if defined?(Spec)
+  desc "Run plugin specs for #{NAME}."
+  Spec::Rake::SpecTask.new('spec') do |t|
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.spec_opts = ["-c"]
+  end
+  desc "Run plugin specs for #{NAME} with specdoc formatting and colors"
+  Spec::Rake::SpecTask.new('specdoc') do |t|
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.spec_opts = ["--format specdoc", "-c"]
+  end
+end

data/lib/mail_style.rb ADDED

@@ -0,0 +1,6 @@
+require 'mail_style/inline_styles'
+require 'mail_style/sass_support' if defined?(Sass)
+module MailStyle
+  class CSSFileNotFound < StandardError; end
+end

data/lib/mail_style/inline_styles.rb ADDED

@@ -0,0 +1,167 @@
+require 'uri'
+require 'nokogiri'
+require 'css_parser'
+module MailStyle
+  module InlineStyles
+    DOCTYPE = '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
+    module InstanceMethods
+      def create_mail_with_inline_styles
+        write_inline_styles if @css.present?
+        create_mail_without_inline_styles
+      end
+      protected
+      def write_inline_styles
+        # Parse only text/html parts
+        @parts.select{|p| p.content_type == 'text/html'}.each do |part|
+          part.body = parse_html(part.body)
+        end
+        # Parse single part emails if the body is html
+        real_content_type, ctype_attrs = parse_content_type
+        self.body = parse_html(body) if body.is_a?(String) && real_content_type == 'text/html'
+      end
+      def parse_html(html)
+        # Parse original html
+        html_document = create_html_document(html)
+        html_document = absolutize_image_sources(html_document)
+        # Write inline styles
+        element_styles = {}
+        css_parser.each_selector do |selector, declaration, specificity|
+          html_document.css(selector).each do |element|
+            declaration.to_s.split(';').each do |style|
+              # Split style in attribute and value
+              attribute, value = style.split(':').map(&:strip)
+              # Set element style defaults
+              element_styles[element] ||= {}
+              element_styles[element][attribute] ||= { :specificity => 0, :value => '' }
+              # Update attribute value if specificity is higher than previous values
+              if element_styles[element][attribute][:specificity] <= specificity
+                element_styles[element][attribute] = { :specificity => specificity, :value => value }
+              end
+            end
+          end
+        end
+        # Loop through element styles
+        element_styles.each_pair do |element, attributes|
+          # Elements current styles
+          current_style = element['style'].to_s.split(';').sort
+          # Elements new styles
+          new_style = attributes.map{|attribute, style| "#{attribute}: #{update_image_urls(style[:value])}"}
+          # Concat styles
+          style = (current_style + new_style).compact.uniq.map(&:strip).sort
+          # Set new styles
+          element['style'] = style.join(';')
+        end
+        # Strip all references to classes.
+        html_document.css('*').remove_class
+        html_document.to_html
+      end
+      def absolutize_image_sources(document)
+        document.css('img').each do |img|
+          src = img['src']
+          img['src'] = src.gsub(src, absolutize_url(src))
+        end
+        document
+      end
+      # Create Nokogiri html document from part contents and add/amend certain elements.
+      # Reference: http://www.creativeglo.co.uk/email-design/html-email-design-and-coding-tips-part-2/
+      def create_html_document(body)
+        # Add doctype to html along with body
+        document = Nokogiri::HTML.parse(DOCTYPE + body)
+        # Set some meta stuff
+        html = document.at_css('html')
+        html['xmlns'] = 'http://www.w3.org/1999/xhtml'
+        # Create <head> element if missing
+        head = document.at_css('head')
+        unless head.present?
+          head = Nokogiri::XML::Node.new('head', document)
+          document.at_css('body').add_previous_sibling(head)
+        end
+        # Add utf-8 content type meta tag
+        meta = Nokogiri::XML::Node.new('meta', document)
+        meta['http-equiv'] = 'Content-Type'
+        meta['content'] = 'text/html; charset=utf-8'
+        head.add_child(meta)
+        # Return document
+        document
+      end
+      # Update image urls
+      def update_image_urls(style)
+        if default_url_options[:host].present?
+          # Replace urls in stylesheets
+          style.gsub!($1, absolutize_url($1, 'stylesheets')) if style[/url\(['"]?(.*)['"]?\)/i]
+        end
+        style
+      end
+      # Absolutize URL (Absolutize? Seriously?)
+      def absolutize_url(url, base_path = '')
+        original_url = url
+        unless original_url[URI::regexp(%w[http https])]
+          # Calculate new path
+          host = default_url_options[:host]
+          url = URI.join("http://#{host}/", File.join(base_path, original_url)).to_s
+        end
+        url
+      end
+      # Css Parser
+      def css_parser
+        parser = CssParser::Parser.new
+        parser.add_block!(css_rules)
+        parser
+      end
+      # Css Rules
+      def css_rules
+        File.read(css_file)
+      end
+      # Find the css file
+      def css_file
+        if @css.present?
+          css = @css.to_s
+          css = css[/\.css$/] ? css : "#{css}.css"
+          path = File.join(RAILS_ROOT, 'public', 'stylesheets', css)
+          File.exist?(path) ? path : raise(CSSFileNotFound)
+        end
+      end
+    end
+    def self.included(receiver)
+      receiver.send :include, InstanceMethods
+      receiver.class_eval do
+        adv_attr_accessor :css
+        alias_method_chain :create_mail, :inline_styles
+      end
+    end
+  end
+end
+ActionMailer::Base.send :include, MailStyle::InlineStyles

data/lib/mail_style/sass_support.rb ADDED

@@ -0,0 +1,15 @@
+module MailStyle
+  module InlineStyles
+    module InstanceMethods
+      def css_file_with_sass
+        if !Sass::Plugin.checked_for_updates || Sass::Plugin.options[:always_update] || Sass::Plugin.options[:always_check]
+          Sass::Plugin.update_stylesheets
+        end
+        css_file_without_sass
+      end
+      alias_method_chain :css_file, :sass
+    end
+  end
+end

data/readme.textile ADDED

@@ -0,0 +1,82 @@
+h1. MailStyle
+MailStyle tries to make sending HTML emails a little less painful.
+For a more in depth introduction check out the "Blog Post":http://blog.purifyapp.com/2009/12/30/mailstyle-a-html-email-plugin-for-ruby-on-rails/
+It was developed for use on "Purify: Awesome Bug & Issue Tracking":http://purifyapp.com
+h2. Install
+First install the dependencies:
+<pre><code>sudo gem install nokogiri css_parser</code></pre>
+Then install MailStyle to your rails app, either as a plugin:
+<pre><code>script/plugin install http://github.com/purify/mail_style</code></pre>
+Or you can install the gem:
+<pre><code>sudo gem install mail_style</code></pre>
+Then in your <code>environment.rb</code> file add:
+<pre><code>config.gem "mail_style"</code></pre>
+h2. Usage
+Simply add the <code>css</code> method to your deliver actions:
+<pre><code>class Notifier < ActionMailer::Base
+  def welcome_email
+    css :email
+    subject 'Welcome Aboard'
+    recipients 'someone@example.com'
+    from 'jimneath@googlemail.com'
+    sent_on Time.now
+  end
+end</code></pre>
+This will look for a css file called _email.css_ in your _public/stylesheets_ folder. The <code>css</code> method can take either a string or a symbol. You can also pass the css file name with or without the .css extension.
+h2. Image URL Correcting
+If you have _default_url_options[:host]_ set in your mailer, then MailStyle will do it's best to make the urls of images absolute.
+h4. In your mailer
+<pre><code>ActionMailer::Base.default_url_options[:host] = "example.com"</code></pre>
+h2. Features
+* Write CSS styles inline
+* Corrects image urls
+* SASS Support
+h2. Bugs / Todo
+* Improve overall performance
+* Add support for less
+* Allow users to swap between css_parser and csspool
+h2. Contributors
+* "Jim Neath":http://jimneath.org
+* "Lars Klevans":http://tastybyte.blogspot.com/
+* "Jonas Grimfelt":http://github.com/grimen
+h2. License
+(The MIT License)
+Copyright &copy; 2009-2010
+* "Jim Neath":http://jimneath.org
+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/spec/inline_styles_spec.rb ADDED

@@ -0,0 +1,190 @@
+# coding: utf-8
+require File.dirname(__FILE__) + '/spec_helper'
+RAILS_ROOT = File.join(File.dirname(__FILE__), '../../../../')
+# Set ActionMailer stuff
+ActionMailer::Base.template_root = '.'
+ActionMailer::Base.delivery_method = :test
+ActionMailer::Base.perform_deliveries = true
+ActionMailer::Base.deliveries = []
+ActionMailer::Base.default_url_options[:host] = "example.com"
+# Test Mailer
+class TestMailer < ActionMailer::Base
+  def test_multipart(css_file = nil)
+    setup_email(css_file)
+    content_type 'multipart/alternative'
+    part :content_type => 'text/html', :body => '<p class="text">Hello World</p>'
+    part :content_type => 'text/plain', :body => 'Hello World'
+  end
+  def test_singlepart_html(css_file = nil)
+    setup_email(css_file)
+    content_type 'text/html'
+    body '<p class="text">Hello World</p>'
+  end
+  def test_singlepart_plain(css_file = nil)
+    setup_email(css_file)
+    content_type 'text/plain'
+    body '<p class="text">Hello World</p>'
+  end
+  def test_image_urls(css_file = nil)
+    setup_email(css_file)
+    content_type 'multipart/alternative'
+    part :content_type => 'text/html', :body => '<p id="image">Hello World</p><img src="/images/test.jpg" />'
+    part :content_type => 'text/plain', :body => 'Hello World'
+  end
+  protected
+  def setup_email(css_file = nil)
+    css css_file unless css_file.nil?
+    subject 'Test Multipart Email'
+    recipients 'jimneath@googlemail.com'
+    from 'jimneath@googlemail.com'
+    sent_on Time.now
+  end
+end
+describe 'Inline styles' do
+  describe 'singlepart' do
+    before(:each) do
+      css_rules <<-EOF
+        body { background: #000 }
+        p { color: #f00; line-height: 1.5 }
+        .text { font-size: 14px }
+      EOF
+    end
+    it "should apply styles for text/html" do
+      @email = TestMailer.deliver_test_singlepart_html(:real)
+      @email.body.should match(/<body style="background: #000">/)
+    end
+    it "should do nothing for text/plain" do
+      @email = TestMailer.deliver_test_singlepart_plain(:real)
+      @email.body.should eql('<p class="text">Hello World</p>')
+    end
+  end
+  describe 'multipart' do
+    describe 'image urls' do
+      before(:each) do
+        # CSS rules
+        css_rules <<-EOF
+          p#image { background: url(../images/test-image.png)}
+        EOF
+        # Generate email
+        @email = TestMailer.deliver_test_image_urls(:real)
+        @html = html_part(@email)
+      end
+      it "should make the css urls absolute" do
+        @html.should match(/<p.*style="background: url\(http:\/\/example\.com\/images\/test\-image\.png\)">/)
+      end
+      it "should make image sources absolute" do
+        # Note: Nokogiri loses the closing slash from the <img> tag for some reason.
+        @html.should match(/<img src="http:\/\/example\.com\/images\/test\.jpg\">/)
+      end
+    end
+    describe 'rendering inline styles' do
+      before(:each) do
+        css_rules <<-EOF
+          body { background: #000 }
+          .text { color: #0f0; font-size: 14px }
+          p { color: #f00; line-height: 1.5 }
+        EOF
+        # Generate email
+        @email = TestMailer.deliver_test_multipart(:real)
+        @html = html_part(@email)
+      end
+      it "should add the correct xml namespace" do
+        @html.should match(/<html xmlns="http:\/\/www\.w3\.org\/1999\/xhtml">/)
+      end
+      it "should write the xhtml 1.0 doctype" do
+        @html.should match(/<!DOCTYPE html PUBLIC "-\/\/W3C\/\/DTD XHTML 1\.0 Transitional\/\/EN" "http:\/\/www.w3.org\/TR\/xhtml1\/DTD\/xhtml1-transitional\.dtd">/mi)
+      end
+      it "should write utf-8 content type meta tag" do
+        @html.should match(/<head>.*<meta http\-equiv="Content\-Type" content="text\/html; charset=utf\-8">.*<\/head>/mi)
+      end
+      it "should wrap with html and body tag if missing" do
+        @html.should match(/<html.*>.*<body.*>.*<\/body>.*<\/html>/m)
+      end
+      it "should add style to body" do
+        @html.should match(/<body style="background: #000">/)
+      end
+      it "should remove classes from html" do
+        @html.should_not match(/<p.*class="text".*>/)
+      end
+      it "should add both styles to paragraph" do
+        @html.should match(/<p style="color: #0f0;font-size: 14px;line-height: 1.5">/)
+      end
+    end
+    describe 'combining styles' do
+      it "should select the most specific style" do
+        css_rules <<-EOF
+          .text { color: #0f0; }
+          p { color: #f00; }
+        EOF
+        @email = TestMailer.deliver_test_multipart(:real)
+        @html = html_part(@email)
+        @html.should match(/<p style="color: #0f0">/)
+      end
+      it "should combine different properties for one element" do
+        css_rules <<-EOF
+          .text { font-size: 14px; }
+          p { color: #f00; }
+        EOF
+        @email = TestMailer.deliver_test_multipart(:real)
+        @html = html_part(@email)
+        @html.should match(/<p style="color: #f00;font-size: 14px">/)
+      end
+    end
+    describe 'css file' do
+      it "should do nothing if no css file is set" do
+        @email = TestMailer.deliver_test_multipart(nil)
+        html_part(@email).should eql('<p class="text">Hello World</p>')
+      end
+      it "should raise MailStyle::CSSFileNotFound if css file does not exist" do
+        lambda {
+          TestMailer.deliver_test_multipart(:fake)
+        }.should raise_error(MailStyle::CSSFileNotFound)
+      end
+    end
+    it 'should support inline styles without deliver' do
+      css_rules <<-EOF
+        body { background: #000 }
+        p { color: #f00; line-height: 1.5 }
+        .text { font-size: 14px }
+      EOF
+      # Generate email
+      @email = TestMailer.create_test_multipart(:real)
+      html_part(@email).should match(/<body style="background: #000">/)
+    end
+    it "should have two parts" do
+      @email = TestMailer.deliver_test_multipart
+      @email.parts.length.should eql(2)
+    end
+  end
+end

data/spec/spec.opts ADDED

@@ -0,0 +1,4 @@
+--colour
+--format s
+--loadby mtime
+--reverse

data/spec/spec_helper.rb ADDED

@@ -0,0 +1,30 @@
+$: << File.dirname(__FILE__) + '/../lib'
+require 'rubygems'
+require 'spec'
+require 'action_mailer'
+require 'mail_style'
+# Extract HTML Part
+def html_part(email)
+  email.parts.select{|part| part.content_type == 'text/html'}.first.body
+end
+def css_rules(css)
+  @css_rules = css
+  # Stubs
+  File.stub(:exist?).and_return(true)
+  File.stub(:read).and_return(@css_rules)
+end
+# Debugging helper
+module Kernel
+  if ENV.keys.find {|env_var| env_var.match(/^TM_/)}
+    def rputs(*args)
+      puts( *["<pre>", args.collect {|a| CGI.escapeHTML(a.to_s)}, "</pre>"])
+    end
+  else
+    alias_method :rputs, :puts
+  end
+end

metadata ADDED

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: mail_style
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Jim Neath
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2010-01-02 00:00:00 +00:00
+default_executable:
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: action_mailer
+  type: :runtime
+  version_requirement:
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.3
+    version:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  type: :runtime
+  version_requirement:
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+    version:
+- !ruby/object:Gem::Dependency
+  name: css_parser
+  type: :runtime
+  version_requirement:
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+    version:
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  type: :development
+  version_requirement:
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.6
+    version:
+description: Making HTML emails a little less painful. Writes css inline and corrects image urls.
+email: jimneath@googlemail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- Rakefile
+- lib/mail_style.rb
+- lib/mail_style/inline_styles.rb
+- lib/mail_style/sass_support.rb
+- readme.textile
+- spec/inline_styles_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+files:
+- Rakefile
+- lib/mail_style.rb
+- lib/mail_style/inline_styles.rb
+- lib/mail_style/sass_support.rb
+- readme.textile
+- spec/inline_styles_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/purify/mail_style
+licenses: []
+post_install_message:
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: "0"
+  version:
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: "0"
+  version:
+requirements: []
+rubyforge_project:
+rubygems_version: 1.3.5
+signing_key:
+specification_version: 3
+summary: Making HTML emails a little less painful. Writes css inline and corrects image urls.
+test_files:
+- spec/inline_styles_spec.rb
+- spec/spec_helper.rb