premailer 1.7.1 → 1.7.3

data/.gitignore

@@ -0,0 +1,7 @@
+.DS_Store
+*.gem
+Gemfile.lock
+bin/*.html
+html/
+vendor/
+rdoc/

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/LICENSE.rdoc

@@ -0,0 +1,11 @@
+= Premailer License
+
+Copyright (c) 2007-2011, Alex Dunae.  All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+* Neither the name of Premailer, Alex Dunae nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.rdoc

@@ -42,6 +42,26 @@ Download the Premailer gem from RubyGems.
   premailer.warnings.each do |w|
     puts "#{w[:message]} (#{w[:level]}) may not render properly in #{w[:clients]}"
   end
+  
+=== Premailer-specific CSS
+
+Premailer looks for a few CSS attributes that make working with tables a bit easier.
+
++-premailer-width+::        Available on <tt>table</tt>, <tt>th</tt> and <tt>td</tt> elements
++-premailer-height+::       Available on <tt>table</tt>, <tt>tr</tt>, <tt>th</tt> and <tt>td</tt> elements
++-premailer-cellpadding+::  Available on <tt>table</tt> elements
++-premailer-cellspacing+::  Available on <tt>table</tt> elements
+
+Each of these CSS declarations will be copied to appropriate element's attribute. 
+
+For example
+
+  table { -premailer-cellspacing: 5; -premailer-width: 500;}
+
+will result in 
+
+  <table cellspacing='5' width='500'>
+
 
 === Contributions
 

data/bin/premailer

@@ -1,99 +1,7 @@
 #!/usr/bin/env ruby
 
-require 'optparse'
-require 'rubygems'
-require File.expand_path(File.join(__FILE__) + '/../../lib/premailer.rb')
-
-# defaults
-options = {
-  :base_url => nil,
-  :link_query_string => nil,
-  :remove_classes => false,
-  :verbose => false,
-  :line_length => 65
-}
-
-mode = :html
-
-opts = OptionParser.new do |opts|
-  opts.banner = "Improve the rendering of HTML emails by making CSS inline among other things. Takes a path to a local file, a URL or a pipe as input.\n\n"
-  opts.define_head "Usage: premailer <optional uri|optional path> [options]"
-  opts.separator ""
-  opts.separator "Examples:"
-  opts.separator "  premailer http://example.com/ > out.html"
-  opts.separator "  premailer http://example.com/ --mode txt > out.txt"
-  opts.separator "  cat input.html | premailer -q src=email > out.html"
-  opts.separator "  premailer ./public/index.html"
-  opts.separator ""
-  opts.separator "Options:"
-
-  opts.on("--mode MODE", [:html, :txt], "Output: html or txt") do |v|
-    mode = v
-  end
-
-  opts.on("-b", "--base-url STRING", String, "Base URL, useful for local files") do |v|
-    options[:base_url] = v
-  end
-
-  opts.on("-q", "--query-string STRING", String, "Query string to append to links") do |v|
-    options[:link_query_string] = v
-  end
-
-  opts.on("--css FILE,FILE", Array, "Additional CSS stylesheets") do |v|
-    options[:css] = v
-  end
-
-  opts.on("-r", "--remove-classes", "Remove HTML classes") do |v|
-    options[:remove_classes] = v
-  end
-
-  opts.on("-l", "--line-length N", Integer, "Line length for plaintext (default: #{options[:line_length].to_s})") do |v|
-    options[:line_length] = v
-  end
+# This binary used in rubygems environment only as part of installed gem
 
-  opts.on("-d", "--io-exceptions", "Abort on I/O errors") do |v|
-    options[:io_exceptions] = v
-  end
-
-  opts.on("-v", "--verbose", "Print additional information at runtime") do |v|
-    options[:verbose] = v
-  end
-
-  opts.on_tail("-?", "--help", "Show this message") do
-    puts opts
-    exit
-  end
-
-  opts.on_tail("-V", "--version", "Show version") do
-    puts "Premailer #{Premailer::VERSION} (c) 2008-2010 Alex Dunae"
-    exit
-  end
-end
-opts.parse!
-
-$stderr.puts "Processing in #{mode} mode with options #{options.inspect}" if options[:verbose]
-
-premailer = nil
-input = nil
-
-if $stdin.tty?
-  input = ARGV.shift
-else
-  input = $stdin
-  options[:with_html_string] = true
-end
-
-if input
-  premailer = Premailer.new(input, options)
-else
-  puts opts
-  exit 1
-end
-
-if mode == :txt
-  print premailer.to_plain_text
-else
-  print premailer.to_inline_css
-end
+require 'rubygems'
+require 'premailer/executor'
 
-exit

data/lib/premailer.rb

@@ -3,6 +3,8 @@ require 'open-uri'
 require 'digest/md5'
 require 'cgi'
 require 'css_parser'
-require File.expand_path(File.dirname(__FILE__) + '/premailer/adapter')
-require File.expand_path(File.dirname(__FILE__) + '/premailer/html_to_plain_text')
-require File.expand_path(File.dirname(__FILE__) + '/premailer/premailer')
+
+require 'premailer/adapter'
+require 'premailer/html_to_plain_text'
+require 'premailer/premailer'
+

data/lib/premailer/adapter/hpricot.rb

@@ -29,9 +29,19 @@ class Premailer
             @unmergable_rules.add_rule_set!(CssParser::RuleSet.new(selector, declaration)) unless @options[:preserve_styles]
           else
             begin
+	            if selector =~ Premailer::RE_RESET_SELECTORS
+                # this is in place to preserve the MailChimp CSS reset: http://github.com/mailchimp/Email-Blueprints/
+                # however, this doesn't mean for testing pur
+	              @unmergable_rules.add_rule_set!(CssParser::RuleSet.new(selector, declaration))  unless !@options[:preserve_reset]
+              end
+
               # Change single ID CSS selectors into xpath so that we can match more
               # than one element.  Added to work around dodgy generated code.
               selector.gsub!(/\A\#([\w_\-]+)\Z/, '*[@id=\1]')
+              
+              # convert attribute selectors to hpricot's format
+              selector.gsub!(/\[([\w]+)\]/, '[@\1]')
+              selector.gsub!(/\[([\w]+)([\=\~\^\$\*]+)([\w\s]+)\]/, '[@\1\2\'\3\']')
 
               doc.search(selector).each do |el|
                 if el.elem? and (el.name != 'head' and el.parent.name != 'head')
@@ -57,7 +67,6 @@ class Premailer
             rs = CssParser::RuleSet.new(nil, declaration[1].to_s, declaration[0].to_i)
             declarations << rs
           end
-
           # Perform style folding
           merged = CssParser.merge(declarations)
           merged.expand_shorthand!
@@ -70,6 +79,7 @@ class Premailer
           end
 
           merged.create_dimensions_shorthand!
+          merged.create_border_shorthand!
 
           # write the inline STYLE attribute
           el['style'] = Premailer.escape_string(merged.declarations_to_s)
@@ -120,18 +130,18 @@ class Premailer
       #
       # Returns an Hpricot document.
       def write_unmergable_css_rules(doc, unmergable_rules) # :nodoc:
-        if head = doc.search('head')
-          styles = ''
-          unmergable_rules.each_selector(:all, :force_important => true) do |selector, declarations, specificity|
-            styles += "#{selector} { #{declarations} }\n"
-          end
+        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"
-            head.html.empty? ? head.inner_html(style_tag) : head.append(style_tag)
+        unless styles.empty?
+          style_tag = "\n<style type=\"text/css\">\n#{styles}</style>\n"
+          if body = doc.search('body')
+            body.append(style_tag)
+          else
+            doc.inner_html= doc.inner_html << style_tag
           end
-        else
-          $stderr.puts "Unable to write unmergable CSS rules: no <head> was found" if @options[:verbose]
         end
         doc
       end

data/lib/premailer/adapter/nokogiri.rb

@@ -52,7 +52,6 @@ class Premailer
           style = el.attributes['style'].to_s
 
           declarations = []
-
           style.scan(/\[SPEC\=([\d]+)\[(.[^\]\]]*)\]\]/).each do |declaration|
             rs = CssParser::RuleSet.new(nil, declaration[1].to_s, declaration[0].to_i)
             declarations << rs
@@ -70,6 +69,7 @@ class Premailer
           end
 
           merged.create_dimensions_shorthand!
+          merged.create_border_shorthand!
 
           # write the inline STYLE attribute
           el['style'] = Premailer.escape_string(merged.declarations_to_s)
@@ -108,7 +108,8 @@ class Premailer
 
         @processed_doc = doc
         if is_xhtml?
-          @processed_doc.to_xhtml
+          # we don't want to encode carriage returns
+          @processed_doc.to_xhtml(:encoding => nil).gsub(/&\#xD;/i, "\r")
         else
           @processed_doc.to_html
         end
@@ -121,20 +122,20 @@ class Premailer
       #
       # Returns an Nokogiri document.
       def write_unmergable_css_rules(doc, unmergable_rules) # :nodoc:
-        if head = doc.at('head')
-          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"
+        styles = ''
+        unmergable_rules.each_selector(:all, :force_important => true) do |selector, declarations, specificity|
+          styles += "#{selector} { #{declarations} }\n"
+        end
 
-            head.add_child(style_tag)
+        unless styles.empty?
+          style_tag = "<style type=\"text/css\">\n#{styles}></style>"
+          if body = doc.search('body')
+            doc.at_css('body').children.first.before(style_tag)            
+          else
+            doc.inner_html = style_tag += doc.inner_html
           end
-        else
-          $stderr.puts "Unable to write unmergable CSS rules: no <head> was found" if @options[:verbose]
         end
+
         doc
       end
 
@@ -157,9 +158,9 @@ class Premailer
       # Returns the original HTML as a string.
       def to_s
         if is_xhtml?
-          @doc.to_xhtml
+          @doc.to_xhtml(:encoding => nil)
         else
-          @doc.to_html
+          @doc.to_html(:encoding => nil)
         end
       end
 
@@ -190,9 +191,9 @@ class Premailer
         # Default encoding is ASCII-8BIT (binary) per http://groups.google.com/group/nokogiri-talk/msg/0b81ef0dc180dc74
         if thing.is_a?(String) and RUBY_VERSION =~ /1.9/
           thing = thing.force_encoding('ASCII-8BIT').encode!
-          doc = ::Nokogiri::HTML(thing) {|c| c.noent.recover }
+          doc = ::Nokogiri::HTML(thing) {|c| c.recover }
         else
-          doc = ::Nokogiri::HTML(thing, nil, 'ASCII-8BIT') {|c| c.noent.recover }
+          doc = ::Nokogiri::HTML(thing, nil, @options[:inputencoding] || 'BINARY') {|c| c.recover }
         end
 
         return doc

data/lib/premailer/executor.rb

@@ -0,0 +1,96 @@
+require 'optparse'
+require 'premailer'
+
+# defaults
+options = {
+  :base_url => nil,
+  :link_query_string => nil,
+  :remove_classes => false,
+  :verbose => false,
+  :line_length => 65
+}
+
+mode = :html
+
+opts = OptionParser.new do |opts|
+  opts.banner = "Improve the rendering of HTML emails by making CSS inline among other things. Takes a path to a local file, a URL or a pipe as input.\n\n"
+  opts.define_head "Usage: premailer <optional uri|optional path> [options]"
+  opts.separator ""
+  opts.separator "Examples:"
+  opts.separator "  premailer http://example.com/ > out.html"
+  opts.separator "  premailer http://example.com/ --mode txt > out.txt"
+  opts.separator "  cat input.html | premailer -q src=email > out.html"
+  opts.separator "  premailer ./public/index.html"
+  opts.separator ""
+  opts.separator "Options:"
+
+  opts.on("--mode MODE", [:html, :txt], "Output: html or txt") do |v|
+    mode = v
+  end
+
+  opts.on("-b", "--base-url STRING", String, "Base URL, useful for local files") do |v|
+    options[:base_url] = v
+  end
+
+  opts.on("-q", "--query-string STRING", String, "Query string to append to links") do |v|
+    options[:link_query_string] = v
+  end
+
+  opts.on("--css FILE,FILE", Array, "Additional CSS stylesheets") do |v|
+    options[:css] = v
+  end
+
+  opts.on("-r", "--remove-classes", "Remove HTML classes") do |v|
+    options[:remove_classes] = v
+  end
+
+  opts.on("-l", "--line-length N", Integer, "Line length for plaintext (default: #{options[:line_length].to_s})") do |v|
+    options[:line_length] = v
+  end
+
+  opts.on("-d", "--io-exceptions", "Abort on I/O errors") do |v|
+    options[:io_exceptions] = v
+  end
+
+  opts.on("-v", "--verbose", "Print additional information at runtime") do |v|
+    options[:verbose] = v
+  end
+
+  opts.on_tail("-?", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+
+  opts.on_tail("-V", "--version", "Show version") do
+    puts "Premailer #{Premailer::VERSION} (c) 2008-2010 Alex Dunae"
+    exit
+  end
+end
+opts.parse!
+
+$stderr.puts "Processing in #{mode} mode with options #{options.inspect}" if options[:verbose]
+
+premailer = nil
+input = nil
+
+if $stdin.tty? or STDIN.fcntl(Fcntl::F_GETFL, 0) == 0
+  input = ARGV.shift
+else
+  input = $stdin
+  options[:with_html_string] = true
+end
+
+if input
+  premailer = Premailer.new(input, options)
+else
+  puts opts
+  exit 1
+end
+
+if mode == :txt
+  print premailer.to_plain_text
+else
+  print premailer.to_inline_css
+end
+
+exit

data/lib/premailer/html_to_plain_text.rb

@@ -13,6 +13,23 @@ module HtmlToPlainText
     # decode HTML entities
     he = HTMLEntities.new
     txt = he.decode(txt)
+    
+    # replace image by their alt attribute
+    txt.gsub!(/<img.+?alt=\"([^\"]*)\"[^>]*\/>/i, '\1')
+
+    # replace image by their alt attribute
+    txt.gsub!(/<img.+?alt=\"([^\"]*)\"[^>]*\/>/i, '\1')
+    txt.gsub!(/<img.+?alt='([^\']*)\'[^>]*\/>/i, '\1')
+
+    # links
+    txt.gsub!(/<a.+?href=\"([^\"]*)\"[^>]*>(.+?)<\/a>/i) do |s|
+      $2.strip + ' ( ' + $1.strip + ' )'
+    end
+
+    txt.gsub!(/<a.+?href='([^\']*)\'[^>]*>(.+?)<\/a>/i) do |s|
+      $2.strip + ' ( ' + $1.strip + ' )'
+    end
+
 
     # handle headings (H1-H6)
     txt.gsub!(/(<\/h[1-6]>)/i, "\n\\1") # move closing tags to new lines
@@ -43,11 +60,6 @@ module HtmlToPlainText
     # wrap spans
     txt.gsub!(/(<\/span>)[\s]+(<span)/mi, '\1 \2')
 
-    # 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
@@ -61,7 +73,7 @@ module HtmlToPlainText
     txt.gsub!(/<\/?[^>]*>/, '')
 
     txt = word_wrap(txt, line_length)
-
+    
     # remove linefeeds (\r\n and \r -> \n)
     txt.gsub!(/\r\n?/, "\n")
 
@@ -73,6 +85,14 @@ module HtmlToPlainText
     # no more than two consecutive newlines
     txt.gsub!(/[\n]{3,}/, "\n\n")
 
+    # no more than two consecutive spaces
+    txt.gsub!(/ {2,}/, " ")
+    
+    # the word messes up the parens
+    txt.gsub!(/\([ \n](http[^)]+)[\n ]\)/) do |s|
+      "( " + $1 + " )"
+    end
+
     txt.strip
   end