premailer 1.5.6 → 1.5.7

data/bin/premailer

@@ -1,76 +1,100 @@
 #!/usr/bin/env ruby
-#
-# = Premailer
+
+require 'optparse'
 require 'rubygems'
-require File.join(File.dirname(__FILE__), 'trollop')
-require File.join(File.dirname(__FILE__), '../lib/premailer')
-
-opts = Trollop::options do
-  version "Premailer #{Premailer::VERSION} (c) 2008-2009 Alex Dunae"
-  banner <<-EOS
-Improve the rendering of HTML emails by making CSS inline, converting links and warning about unsupported code.
-
-Usage:
-  premailer [options] inputfile [outputfile] [warningsfile]
-
-Example
-  premailer http://example.com/
-  premailer http://example.com/ out.html out.txt warnings.txt
-  premailer --base-url=http://example.com/ src.html out.html
-
-Options:
-EOS
-  opt :base_url, "Manually set the base URL, useful for local files", :type => String
-  opt :query_string, "Query string to append to links", :type => String, :short => 'q'
-  opt :line_length, "Length of lines when creating plaintext version", :type => :int, :default => 65, :short => 'l'
-  opt :remove_classes, "Remove classes from the HTML document?", :default => false
-  opt :css, "Manually specify css stylesheets", :type => String, :multi => true
-  opt :verbose, '', :default => false, :short => 'v'
-  opt :io_exceptions, "Abort on I/O errors loading style resources", :default => false, :short => 'e'
-end
+require 'premailer'
+require 'fcntl'
 
-inputfile    = ARGV.shift
-outfile      = ARGV.shift
-txtfile      = ARGV.shift
-warningsfile = ARGV.shift
-
-Trollop::die "inputfile is missing" if inputfile.nil?
-
-premailer_opts = {
-  :base_url => opts[:base_url],
-  :query_string => opts[:query_string],
-  :show_warnings => opts[:show_warnings] ? Premailer::Warnings::SAFE : Premailer::Warnings::NONE,
-  :line_length => opts[:line_length],
-  :remove_classes => opts[:remove_classes],
-  :css => opts[:css],
-  :verbose => opts[:verbose],
-  :io_exceptions => opts[:io_exceptions],
+# defaults
+options = {
+  :base_url => nil,
+  :link_query_string => nil,
+  :remove_classes => false,
+  :verbose => false,
+  :line_length => 65
 }
 
-premailer = Premailer.new(inputfile, premailer_opts)
+mode = :html
 
-# html output
-if outfile
-  fout = File.open(outfile, 'w')
-  fout.puts premailer.to_inline_css
-  fout.close
-else
-  p premailer.to_inline_css
-  exit
-end
+opts = OptionParser.new do |opts|
+  opts.banner = "Improve the rendering of HTML emails by making CSS inline, converting links and warning about unsupported code."
+  opts.define_head "Usage: premailer <uri|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 type: either html or txt") do |v|
+    mode = v
+  end
+
+  opts.on("-b", "--base-url", String, "Manually set the 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 not include the ?)") 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 classes from the HTML document?") do |v|
+    options[:remove_classes] = v
+  end
+
+  opts.on("-l", "--line-length N", Integer, "Length of lines when creating plaintext version (default: #{options[:line_length].to_s})") do |v|
+    options[:line_length] = v
+  end
 
-# plaintext output
-if txtfile
-  fout = File.open(txtfile, 'w')
-  fout.puts premailer.to_plain_text
-  fout.close
+  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
 
-# warnings output
-if warningsfile
-  fout = File.open(warningsfile, 'w')
-  premailer.warnings.each do |w|
-    fout.puts "- #{w[:message]} (#{w[:level]}) may not render properly in #{w[:clients]}"
+# check for input from STDIN
+if STDIN.fcntl(Fcntl::F_GETFL, 0) == 0
+  io = STDIN.to_io
+  premailer = Premailer.new(io, options)
+else
+  uri = ARGV.shift
+
+  if uri.to_s.strip.empty?
+    puts opts
+    exit 1
   end
-  fout.close
+
+  premailer = Premailer.new(uri, options)
+end
+
+if mode == :txt
+  p premailer.to_plain_text
+else
+  p premailer.to_inline_css
 end
+
+exit

data/lib/premailer/premailer.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/ruby
 #
-# Premailer by Alex Dunae (dunae.ca, e-mail 'code' at the same domain), 2008-09
+# Premailer by Alex Dunae (dunae.ca, e-mail 'code' at the same domain), 2008-10
 #
 # Premailer processes HTML and CSS to improve e-mail deliverability.
 #
@@ -33,7 +33,7 @@ class Premailer
   include HtmlToPlainText
   include CssParser
 
-  VERSION = '1.5.6'
+  VERSION = '1.5.7'
 
   CLIENT_SUPPORT_FILE = File.dirname(__FILE__) + '/../../misc/client_support.yaml'
 
@@ -96,11 +96,12 @@ class Premailer
   # ==== 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 +?+.
+  # [+link_query_string+] A string to append to every <tt>a href=""</tt> link. Do not include the initial <tt>?</tt>.
   # [+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+)
   # [+with_html_string+] Whether the +html+ param should be treated as a raw string.
+  # [+verbose+] Whether to print errors and warnings to <tt>$stderr</tt>.  Default is +false+.
   def initialize(html, options = {})
     @options = {:warn_level => Warnings::SAFE, 
                 :line_length => 65, 
@@ -153,10 +154,10 @@ class Premailer
     @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
+    is_xhtml? ? @doc.to_xhtml : @doc.to_html
   end
 
   # Converts the HTML document to a format suitable for plain-text e-mail.
@@ -188,21 +189,24 @@ class Premailer
     # 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, '')
+      selector.gsub!(/:link([\s]*)+/i) {|m| $1 }
 
       # 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.css(selector).each do |el|
-          if el.elem?
-            # Add a style attribute or append to the existing one  
-            block = "[SPEC=#{specificity}[#{declaration}]]"
-            el['style'] = (el.attributes['style'].to_s ||= '') + ' ' + block
+        begin
+          doc.css(selector).each do |el|
+            if el.elem?
+              # Add a style attribute or append to the existing one  
+              block = "[SPEC=#{specificity}[#{declaration}]]"
+              el['style'] = (el.attributes['style'].to_s ||= '') + ' ' + block
+            end
           end
+        rescue Nokogiri::SyntaxError, RuntimeError
+          $stderr.puts "CSS syntax error with selector: #{selector}" if @options[:verbose]
         end
       end
     end
@@ -254,28 +258,30 @@ class Premailer
     doc.to_html
   end
 
+  # Check for an XHTML doctype
+  def is_xhtml?
+    intro = @doc.to_s.strip.split("\n")[0..2].join(' ')
+    intro =~ /w3c\/\/[\s]*dtd[\s]+xhtml/i
+  end
 
 protected  
   # Load the HTML file and convert it into an Nokogiri document.
   #
   # Returns an Nokogiri document.
-  def load_html(path) # :nodoc:
-    if @options[:with_html_string]
-      Nokogiri::HTML.parse(path)
-    elsif @options[:inline]
-      Nokogiri::HTML(path)
+  def load_html(input) # :nodoc:
+    thing = nil
+
+    # TODO: duplicate options
+    if @options[:with_html_string] or @options[:inline] or input.respond_to?(:read)
+      thing = input
+    elsif @is_local_file
+      @base_dir = File.dirname(input)
+      thing = File.open(input, 'r')
     else
-      if @is_local_file
-        if path.is_a?(IO) || path.is_a?(StringIO)
-          Nokogiri::HTML(path.read)
-        else
-          @base_dir = File.dirname(path)
-          Nokogiri::HTML(File.open(path, "r") {|f| f.read })
-        end
-      else
-        Nokogiri::HTML(open(path))
-      end
+      thing = open(input)
     end
+    
+    thing ? Nokogiri::HTML(thing) : nil  
   end
 
   def load_css_from_local_file!(path)
@@ -308,10 +314,10 @@ protected
 
           link_uri = Premailer.resolve_link(tag.attributes['href'].to_s, @html_file)
           if Premailer.local_data?(link_uri)
-            puts "Loading css from local file: " + link_uri if @options[:verbose]
+            $stderr.puts "Loading css from local file: " + link_uri if @options[:verbose]
             load_css_from_local_file!(link_uri)
           else
-            puts "Loading css from uri: " + link_uri if @options[:verbose]
+            $stderr.puts "Loading css from uri: " + link_uri if @options[:verbose]
             @css_parser.load_uri!(link_uri)
           end
 
@@ -350,19 +356,30 @@ protected
   end
 
   def append_query_string(doc, qs)
+    return doc if qs.nil?
+
+    qs.to_s.strip!
+    return doc if qs.empty?
+
+    $stderr.puts "Attempting to append_query_string: #{qs}" if @options[:verbose]
+    
     doc.search('a').each do|el|
-      href = el.attributes['href'].to_s
-      next if href.nil? or href.empty?
-      
-      href = URI.parse(href)
+      href = el.attributes['href'].to_s.strip
+      next if href.nil? or href.empty?      
+
+      begin
+        href = URI.parse(href)
+        if href.query
+          href.query = href.query + '&amp' + qs
+        else
+          href.query = qs
+        end
     
-      if href.query
-        href.query = href.query + '&amp' + qs
-      else
-        href.query = qs
+        el['href'] = href.to_s
+      rescue URI::Error => e
+        $stderr.puts "Skipping append_query_string for: #{href.to_s} (#{e.message})" if @options[:verbose]
+        next
       end
-    
-      el['href'] = href.to_s
 
     end
     doc

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: premailer
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 13
   prerelease: false
   segments: 
   - 1
   - 5
-  - 6
-  version: 1.5.6
+  - 7
+  version: 1.5.7
 platform: ruby
 authors: 
 - Alex Dunae
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-03 00:00:00 -07:00
+date: 2010-11-05 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency