sundawg_premailer 0.0.1

data/init.rb

@@ -0,0 +1 @@
+require 'premailer'

data/lib/premailer.rb

@@ -0,0 +1,8 @@
+# Premailer by Alex Dunae (dunae.ca, e-mail 'code' at the same domain), 2008-09
+require 'yaml'
+require 'open-uri'
+require 'hpricot'
+require 'css_parser'
+
+require File.dirname(__FILE__) + "/premailer/html_to_plain_text"
+require File.dirname(__FILE__) + "/premailer/premailer"

data/lib/premailer/html_to_plain_text.rb

@@ -0,0 +1,74 @@
+require 'text/reform'
+require 'htmlentities'
+
+# Support functions for Premailer
+module HtmlToPlainText
+
+  # Returns the text in UTF-8 format with all HTML tags removed
+  #
+  # TODO:
+  #  - add support for DL, OL
+  def convert_to_text(html, line_length = 65, from_charset = 'UTF-8')
+    r = Text::Reform.new(:trim => true, 
+                         :squeeze => false, 
+                         :break => Text::Reform.break_wrap)
+
+    txt = html
+    
+    # decode HTML entities
+    he = HTMLEntities.new
+    txt = he.decode(txt)
+
+    # handle headings (H1-H6)
+    txt.gsub!(/[ \t]*<h([0-9]+)[^>]*>(.*)<\/h[0-9]+>/i) do |s|
+      hlevel = $1.to_i
+      # cleanup text inside of headings
+      htext = $2.gsub(/<\/?[^>]*>/i, '').strip
+      hlength = (htext.length > line_length ? 
+                  line_length : 
+                  htext.length)
+
+      case hlevel
+        when 1   # H1, asterisks above and below
+          ('*' * hlength) + "\n" + htext + "\n" + ('*' * hlength) + "\n"
+        when 2   # H1, dashes above and below
+          ('-' * hlength) + "\n" + htext + "\n" + ('-' * hlength) + "\n"
+        else     # H3-H6, dashes below
+          htext + "\n" + ('-' * htext.length) + "\n"
+      end
+    end
+
+    # links
+    txt.gsub!(/<a.*href=\"([^\"]*)\"[^>]*>(.*)<\/a>/i) do |s|
+      $2.strip + ' ( ' + $1.strip + ' )'
+    end
+
+    # lists -- TODO: should handle ordered lists
+    txt.gsub!(/[\s]*(<li[^>]*>)[\s]*/i, '* ')
+    # list not followed by a newline
+    txt.gsub!(/<\/li>[\s]*(?![\n])/i, "\n")
+    
+    # paragraphs and line breaks
+    txt.gsub!(/<\/p>/i, "\n\n")
+    txt.gsub!(/<br[\/ ]*>/i, "\n")
+    
+    # strip remaining tags
+    txt.gsub!(/<\/?[^>]*>/, '')
+
+    # wrap text
+    txt = r.format(('[' * line_length), txt)
+    
+    # remove linefeeds (\r\n and \r -> \n)
+    txt.gsub!(/\r\n?/, "\n")
+    
+    # strip extra spaces
+    txt.gsub!(/\302\240+/, " ") # non-breaking spaces -> spaces
+    txt.gsub!(/\n[ \t]+/, "\n") # space at start of lines
+    txt.gsub!(/[ \t]+\n/, "\n") # space at end of lines
+
+    # no more than two consecutive newlines
+    txt.gsub!(/[\n]{3,}/, "\n\n")
+
+    txt.strip
+  end
+end

data/lib/premailer/premailer.rb

@@ -0,0 +1,481 @@
+#!/usr/bin/ruby
+#
+# Premailer by Alex Dunae (dunae.ca, e-mail 'code' at the same domain), 2008-09
+#
+# Premailer processes HTML and CSS to improve e-mail deliverability.
+#
+# Premailer's main function is to render all CSS as inline <tt>style</tt> 
+# attributes. It also converts relative links to absolute links and checks 
+# the 'safety' of CSS properties against a CSS support chart.
+#
+# = Example
+#  premailer = Premailer.new('http://example.com/myfile.html', :warn_level => Premailer::Warnings::SAFE)
+#
+#  # Write the HTML output
+#  fout = File.open("output.html", "w")
+#  fout.puts premailer.to_inline_css
+#  fout.close
+#
+#  # Write the plain-text output
+#  fout = File.open("ouput.txt", "w")
+#  fout.puts premailer.to_plain_text
+#  fout.close
+#
+#  # List any CSS warnings
+#  puts premailer.warnings.length.to_s + ' warnings found'
+#  premailer.warnings.each do |w|
+#    puts "#{w[:message]} (#{w[:level]}) may not render properly in #{w[:clients]}"
+#  end
+#
+#  premailer = Premailer.new(html_file, :warn_level => Premailer::Warnings::SAFE)
+#  puts premailer.to_inline_css
+class Premailer
+  include HtmlToPlainText
+  include CssParser
+
+  VERSION = '1.5.5'
+
+  CLIENT_SUPPORT_FILE = File.dirname(__FILE__) + '/../../misc/client_support.yaml'
+
+  RE_UNMERGABLE_SELECTORS = /(\:(visited|active|hover|focus|after|before|selection|target|first\-(line|letter))|^\@)/i
+  
+  # list of CSS attributes that can be rendered as HTML attributes
+  #
+  # TODO: too much repetition
+  # TODO: background=""
+  RELATED_ATTRIBUTES = { 
+    'h1' => {'text-align' => 'align'},
+    'h2' => {'text-align' => 'align'},
+    'h3' => {'text-align' => 'align'},
+    'h4' => {'text-align' => 'align'},
+    'h5' => {'text-align' => 'align'},
+    'h6' => {'text-align' => 'align'},
+    'p' => {'text-align' => 'align'},
+    'div' => {'text-align' => 'align'},
+    'blockquote' => {'text-align' => 'align'},
+    'body' => {'background-color' => 'bgcolor'},
+    'table' => {'background-color' => 'bgcolor'},
+    'tr' => {'text-align' => 'align', 'background-color' => 'bgcolor'},
+    'th' => {'text-align' => 'align', 'background-color' => 'bgcolor', 'vertical-align' => 'valign'},
+    'td' => {'text-align' => 'align', 'background-color' => 'bgcolor', 'vertical-align' => 'valign'},
+    'img' => {'float' => 'align'}
+  }
+
+  # URI of the HTML file used
+  attr_reader   :html_file
+  
+  # processed HTML document (Hpricot)
+  attr_reader   :processed_doc
+  
+  # source HTML document (Hpricot)
+  attr_reader   :doc
+
+  module Warnings
+    NONE = 0
+    SAFE = 1
+    POOR = 2
+    RISKY = 3
+  end
+  include Warnings
+
+  WARN_LABEL = %w(NONE SAFE POOR RISKY)
+
+  # Create a new Premailer object.
+  #
+  # +path+ is the path to the HTML file to process. Can be either the URL of a 
+  # remote file or a local path.
+  #
+  # ==== Options
+  # [+line_length+] Line length used by to_plain_text. Boolean, default is 65.
+  # [+warn_level+] What level of CSS compatibility warnings to show (see Warnings).
+  # [+link_query_string+] A string to append to every <a href=""> link. Do not include the initial +?+.
+  # [+base_url+] Used to calculate absolute URLs for local files.
+  # [+css+] Manually specify a CSS stylesheet.
+  # [+css_to_attributes+] Copy related CSS attributes into HTML attributes (e.g. +background-color+ to +bgcolor+)
+  # [+in_memory+] Informs premailer to parse an HTML String
+  def initialize(source, options = {})
+    @options = {:warn_level => Warnings::SAFE, 
+                :line_length => 65, 
+                :link_query_string => nil, 
+                :base_url => nil,
+                :remove_classes => false,
+                :in_memory => false,
+                :css => [],
+                :css_to_attributes => true}.merge(options)
+    @html_file = source 
+   
+    @is_local_file = local_uri?(source)
+
+    @is_in_memory = options[:in_memory]
+    @is_local_file = true if @is_in_memory
+
+    @css_files = @options[:css]
+
+    @css_warnings = []
+
+    @css_parser = CssParser::Parser.new({:absolute_paths => true,
+                                         :import => true,
+                                         :io_exceptions => false
+                                        })
+    
+    @doc, @html_charset = load_html(@html_file)
+    @processed_doc = @doc
+    
+    if @is_local_file and @options[:base_url]
+      @processed_doc = convert_inline_links(@processed_doc, @options[:base_url])
+    elsif not @is_local_file
+      @processed_doc = convert_inline_links(@processed_doc, @html_file)
+    end
+    load_css_from_options!
+    load_css_from_html!
+  end
+
+  def local_uri?(uri)
+    if uri =~ /^(http|https|ftp)\:\/\//i
+      return false
+    else
+      return true
+    end
+  end
+
+  # Array containing a hash of CSS warnings.
+  def warnings
+    return [] if @options[:warn_level] == Warnings::NONE
+    @css_warnings = check_client_support if @css_warnings.empty?
+    @css_warnings
+  end
+
+  # Returns the original HTML as a string.
+  def to_s
+    @doc.to_html
+  end
+
+  # Converts the HTML document to a format suitable for plain-text e-mail.
+  #
+  # Returns a string.
+  def to_plain_text
+    html_src = ''
+    begin
+      html_src = @doc.search("body").innerHTML
+    rescue
+      html_src = @doc.to_html
+    end
+    convert_to_text(html_src, @options[:line_length], @html_charset)
+  end
+
+  # Merge CSS into the HTML document.
+  #
+  # Returns a string.
+  def to_inline_css
+    doc = @processed_doc
+    unmergable_rules = CssParser::Parser.new
+    
+    # Give all styles already in style attributes a specificity of 1000 
+    # per http://www.w3.org/TR/CSS21/cascade.html#specificity
+    doc.search("*[@style]").each do |el| 
+      el['style'] = '[SPEC=1000[' + el.attributes['style'] + ']]'
+    end
+
+    # Iterate through the rules and merge them into the HTML
+    @css_parser.each_selector(:all) do |selector, declaration, specificity|
+      # Save un-mergable rules separately
+      selector.gsub!(/:link([\s]|$)+/i, '')
+
+      # Convert element names to lower case
+      selector.gsub!(/([\s]|^)([\w]+)/) {|m| $1.to_s + $2.to_s.downcase }
+
+      if selector =~ RE_UNMERGABLE_SELECTORS
+        unmergable_rules.add_rule_set!(RuleSet.new(selector, declaration))
+      else
+        
+        doc.search(selector) do |el|
+          if el.elem?
+            # Add a style attribute or append to the existing one  
+            block = "[SPEC=#{specificity}[#{declaration}]]"
+            el['style'] = (el.attributes['style'] ||= '') + ' ' + block
+          end
+        end
+      end
+    end
+
+    # Read STYLE attributes and perform folding
+    doc.search("*[@style]").each do |el|
+      style = el.attributes['style'].to_s
+      
+      declarations = []
+
+      style.scan(/\[SPEC\=([\d]+)\[(.[^\]\]]*)\]\]/).each do |declaration|
+        rs = RuleSet.new(nil, declaration[1].to_s, declaration[0].to_i)
+        declarations << rs
+      end
+
+      # Perform style folding
+      merged = CssParser.merge(declarations)
+      merged.expand_shorthand!
+      
+      #if @options[:prefer_cellpadding] and (el.name == 'td' or el.name == 'th') and el['cellpadding'].nil?
+      #  if cellpadding = equivalent_cellpadding(merged)
+      #    el['cellpadding'] = cellpadding
+      #    merged['padding-left'] = nil
+      #    merged['padding-right'] = nil
+      #    merged['padding-top'] = nil
+      #    merged['padding-bottom'] = nil
+      #  end
+      #end
+      
+      # Duplicate CSS attributes as HTML attributes
+      if RELATED_ATTRIBUTES.has_key?(el.name)       
+        RELATED_ATTRIBUTES[el.name].each do |css_att, html_att|
+          el[html_att] = merged[css_att].gsub(/;$/, '').strip if el[html_att].nil? and not merged[css_att].empty?
+        end
+      end
+      
+      merged.create_dimensions_shorthand!
+
+      # write the inline STYLE attribute
+      el['style'] = Premailer.escape_string(merged.declarations_to_s)
+    end
+
+    doc = write_unmergable_css_rules(doc, unmergable_rules)
+
+    doc.search('*').remove_class if @options[:remove_classes]  
+
+    @processed_doc = doc
+
+    doc.to_html
+  end
+
+
+protected  
+  # Load the HTML file and convert it into an Hpricot document.
+  #
+  # Returns an Hpricot document and a string with the HTML file's character set.
+  def load_html(path) # :nodoc:
+    if @is_in_memory
+      return Hpricot(path)
+    elsif @is_local_file
+      return Hpricot(File.open(path, "r") {|f| f.read })
+    else
+      return Hpricot(open(path))
+    end
+  end
+
+  def load_css_from_local_file!(path)
+    css_block = ''
+    begin
+      File.open(path, "r") do |file|
+        while line = file.gets
+          css_block << line
+        end
+      end
+      @css_parser.add_block!(css_block, {:base_uri => @html_file})
+    rescue; end
+  end
+
+  def load_css_from_options! # :nodoc:
+    @css_files.each do |css_file|
+      if local_uri?(css_file)
+        load_css_from_local_file!(css_file)
+      else
+        @css_parser.load_uri!(css_file)
+      end
+    end
+  end
+
+  # Load CSS included in <tt>style</tt> and <tt>link</tt> tags from an HTML document.
+  def load_css_from_html! # :nodoc:
+    if tags = @doc.search("link[@rel='stylesheet'], style")
+      tags.each do |tag|
+
+        if tag.to_s.strip =~ /^\<link/i and tag.attributes['href'] and media_type_ok?(tag.attributes['media'])
+
+          link_uri = Premailer.resolve_link(tag.attributes['href'].to_s, @html_file)
+          if @is_local_file
+            load_css_from_local_file!(link_uri)
+          else
+            @css_parser.load_uri!(link_uri)
+          end
+
+        elsif tag.to_s.strip =~ /^\<style/i          
+          if @is_in_memory
+            @css_parser.add_block!(tag.innerHTML)
+          else
+            @css_parser.add_block!(tag.innerHTML, :base_uri => URI.parse(@html_file))
+          end
+        end
+      end
+      tags.remove
+    end
+  end
+
+  def media_type_ok?(media_types) # :nodoc:
+    return true if media_types.nil? or media_types.empty?
+    return media_types.split(/[\s]+|,/).any? { |media_type| media_type.strip =~ /screen|handheld|all/i }
+  rescue
+    return true
+  end
+
+  # Create a <tt>style</tt> element with un-mergable rules (e.g. <tt>:hover</tt>) 
+  # and write it into the <tt>body</tt>.
+  #
+  # <tt>doc</tt> is an Hpricot document and <tt>unmergable_css_rules</tt> is a Css::RuleSet.
+  #
+  # Returns an Hpricot document.
+  def write_unmergable_css_rules(doc, unmergable_rules) # :nodoc:
+    styles = ''
+    unmergable_rules.each_selector(:all, :force_important => true) do |selector, declarations, specificity|
+      styles += "#{selector} { #{declarations} }\n"
+    end    
+
+    unless styles.empty?
+      style_tag = "\n<style type=\"text/css\">\n#{styles}</style>\n"
+      doc.search("head").append(style_tag)
+    end
+    doc
+  end
+
+  # Convert relative links to absolute links.
+  #
+  # Processes <tt>href</tt> <tt>src</tt> and <tt>background</tt> attributes 
+  # as well as CSS <tt>url()</tt> declarations found in inline <tt>style</tt> attributes.
+  #
+  # <tt>doc</tt> is an Hpricot document and <tt>base_uri</tt> is either a string or a URI.
+  #
+  # Returns an Hpricot document.
+  def convert_inline_links(doc, base_uri) # :nodoc:
+    base_uri = URI.parse(base_uri) unless base_uri.kind_of?(URI)
+
+    append_qs = @options[:link_query_string] ||= ''
+
+    ['href', 'src', 'background'].each do |attribute|
+      tags = doc.search("*[@#{attribute}]")
+
+      next if tags.empty?
+
+      tags.each do |tag|
+        # skip links that look like they have merge tags
+        # and mailto, ftp, etc...
+        if tag.attributes[attribute] =~ /^(\{|\[|<|\#|mailto:|ftp:|gopher:)/i
+          next
+        end
+
+        if tag.attributes[attribute] =~ /^http/i
+          begin
+            merged = URI.parse(tag.attributes[attribute])
+          rescue; next; end
+        else
+          begin
+            merged = Premailer.resolve_link(tag.attributes[attribute].to_s, base_uri)
+          rescue
+            begin
+              merged = Premailer.resolve_link(URI.escape(tag.attributes[attribute].to_s), base_uri)
+            rescue; end
+          end
+        end
+
+        # make sure 'merged' is a URI
+        merged = URI.parse(merged.to_s) unless merged.kind_of?(URI)
+
+        # only append a querystring to <a> tags
+        if tag.name =~ /^a$/i and not append_qs.empty?
+          if merged.query
+            merged.query = merged.query + '&' + append_qs
+          else
+            merged.query = append_qs
+          end
+        end
+        tag[attribute] = merged.to_s
+
+      end # end of each tag
+    end # end of each attrs
+
+    doc.search("*[@style]").each do |el|
+      el['style'] = CssParser.convert_uris(el.attributes['style'].to_s, base_uri)
+    end
+    doc
+  end
+
+  def self.escape_string(str) # :nodoc:
+    str.gsub(/"/, "'")
+  end
+  
+  def self.resolve_link(path, base_path) # :nodoc:
+    path.strip!
+    resolved = nil
+    if base_path.kind_of?(URI)
+      resolved = base_path.merge(path)
+      return Premailer.canonicalize(resolved)    
+    elsif base_path.kind_of?(String) and base_path =~ /^(http[s]?|ftp):\/\//i
+      resolved = URI.parse(base_path)
+      resolved = resolved.merge(path)
+      return Premailer.canonicalize(resolved)
+    else
+
+      return File.expand_path(path, File.dirname(base_path))
+    end
+  end
+
+  # from http://www.ruby-forum.com/topic/140101
+  def self.canonicalize(uri) # :nodoc:
+    u = uri.kind_of?(URI) ? uri : URI.parse(uri.to_s)
+    u.normalize!
+    newpath = u.path
+    while newpath.gsub!(%r{([^/]+)/\.\./?}) { |match|
+      $1 == '..' ? match : ''
+    } do end
+    newpath = newpath.gsub(%r{/\./}, '/').sub(%r{/\.\z}, '/')
+    u.path = newpath
+    u.to_s
+  end
+
+  # Check <tt>CLIENT_SUPPORT_FILE</tt> for any CSS warnings
+  def check_client_support # :nodoc:
+    @client_support = @client_support ||= YAML::load(File.open(CLIENT_SUPPORT_FILE))
+
+    warnings = []
+    properties = []
+    
+    # Get a list off CSS properties
+    @processed_doc.search("*[@style]").each do |el|
+      style_url = el.attributes['style'].gsub(/([\w\-]+)[\s]*\:/i) do |s|
+        properties.push($1)
+      end
+    end
+
+    properties.uniq!
+
+    property_support = @client_support['css_properties']
+    properties.each do |prop|
+      if property_support.include?(prop) and 
+         property_support[prop].include?('support') and 
+         property_support[prop]['support'] >= @options[:warn_level]
+        warnings.push({:message => "#{prop} CSS property", 
+                       :level => WARN_LABEL[property_support[prop]['support']], 
+                       :clients => property_support[prop]['unsupported_in'].join(', ')})
+      end
+    end
+
+    @client_support['attributes'].each do |attribute, data|
+      next unless data['support'] >= @options[:warn_level]
+      if @doc.search("*[@#{attribute}]").length > 0
+        warnings.push({:message => "#{attribute} HTML attribute", 
+                       :level => WARN_LABEL[property_support[prop]['support']], 
+                       :clients => property_support[prop]['unsupported_in'].join(', ')})
+      end
+    end
+
+    @client_support['elements'].each do |element, data|
+      next unless data['support'] >= @options[:warn_level]
+      if @doc.search("element").length > 0
+        warnings.push({:message => "#{element} HTML element", 
+                       :level => WARN_LABEL[property_support[prop]['support']], 
+                       :clients => property_support[prop]['unsupported_in'].join(', ')})
+      end
+    end
+
+    return warnings
+  end
+end
+
+
+