fotonauts-premailer 1.7.3

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,8 @@
+notifications:
+  disabled: true
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - jruby
+  - ree

data/Gemfile

@@ -0,0 +1,9 @@
+source :rubygems
+gem 'css_parser', :git => 'git://github.com/alexdunae/css_parser.git'
+gem 'webmock', :group => [:development, :test]
+
+platforms :jruby do
+  gem 'jruby-openssl'
+end
+
+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

@@ -0,0 +1,89 @@
+= Premailer README
+
+=== What is this?
+
+For the best HTML e-mail delivery results, CSS should be inline. This is a 
+huge pain and a simple newsletter becomes un-managable very quickly. This 
+script is my solution.
+
+* CSS styles are converted to inline style attributes
+  Checks <tt>style</tt> and <tt>link[rel=stylesheet]</tt> tags and preserves existing inline attributes
+* Relative paths are converted to absolute paths
+  Checks links in <tt>href</tt>, <tt>src</tt> and CSS <tt>url('')</tt>
+* CSS properties are checked against e-mail client capabilities
+  Based on the Email Standards Project's guides
+* A plain text version is created
+  Optional
+
+=== Premailer 2.0 is coming
+
+I'm looking for input on a version 2.0 update to Premailer.  PLease visit the {Premailer 2.0 Planning Page}[https://github.com/alexdunae/premailer/wiki/Premailer-2.0-Planning] and give me your feedback.
+
+=== Installation
+
+Download the Premailer gem from RubyGems.
+
+    sudo gem install premailer
+
+=== 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
+
+  # Output any CSS warnings
+  premailer.warnings.each do |w|
+    puts "#{w[:message]} (#{w[:level]}) may not render properly in #{w[:clients]}"
+  end
+
+=== Ruby Compatibility
+
+Premailer is tested on Ruby 1.8.7, Ruby 1.9.2 and Ruby 1.9.3 (preview 1). It also works on REE. JRuby support is close; contributors are welcome.  Checkout the latest build status on the {Travis CI dashboard}[http://travis-ci.org/#!/alexdunae/premailer].
+  
+=== 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
+
+Contributions are most welcome.  Premailer was rotting away in a private SVN repository for too long and could use some TLC.  Fork and patch to your heart's content.  Please don't increment the version numbers, though.
+
+A few areas that are particularly in need of love:
+* Improved test coverage
+* Move un-repeated background images defined in CSS to <tt><td background=""></tt> for Outlook
+
+=== Credits and code
+
+Thanks to {all the wonderful contributors}[https://github.com/alexdunae/premailer/contributors] for their updates.
+
+Thanks to {Greenhood + Company}[http://www.greenhood.com/] for sponsoring some of the 1.5.6 updates, 
+and to {Campaign Monitor}[http://www.campaignmonitor.com] for supporting the web interface.
+
+The web interface can be found at {premailer.dialect.ca}[http://premailer.dialect.ca].
+
+The source code can be found on {GitHub}[https://github.com/alexdunae/premailer].
+
+Copyright by Alex Dunae (dunae.ca, e-mail 'code' at the same domain), 2007-2011.  See LICENSE.rdoc for license details.

data/bin/premailer

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+# This binary used in rubygems environment only as part of installed gem
+
+require 'rubygems'
+require 'premailer/executor'
+

data/init.rb

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

data/lib/premailer.rb

@@ -0,0 +1,10 @@
+require 'yaml'
+require 'open-uri'
+require 'digest/md5'
+require 'cgi'
+require 'css_parser'
+
+require 'premailer/adapter'
+require 'premailer/html_to_plain_text'
+require 'premailer/premailer'
+

data/lib/premailer/adapter.rb

@@ -0,0 +1,59 @@
+# = HTTPI::Adapter
+#
+# Manages the adapter classes. Currently supports:
+#
+# * nokogiri
+# * hpricot
+class Premailer
+  module Adapter
+
+    autoload :Hpricot, 'premailer/adapter/hpricot'
+    autoload :Nokogiri, 'premailer/adapter/nokogiri'
+
+    REQUIREMENT_MAP = [
+      ["hpricot",  :hpricot],
+      ["nokogiri", :nokogiri],
+    ]
+
+    # Returns the adapter to use.
+    def self.use
+      return @use if @use
+      self.use = self.default
+      @use
+    end
+
+    # The default adapter based on what you currently have loaded and
+    # installed. First checks to see if any adapters are already loaded,
+    # then ckecks to see which are installed if none are loaded.
+    def self.default
+      return :hpricot  if defined?(::Hpricot)
+      return :nokogiri if defined?(::Nokogiri)
+
+      REQUIREMENT_MAP.each do |(library, adapter)|
+        begin
+          require library
+          return adapter
+        rescue LoadError
+          next
+        end
+      end
+
+      raise "No suitable adapter for Premailer was found, please install hpricot or nokogiri"
+    end
+
+    # Sets the +adapter+ to use. Raises an +ArgumentError+ unless the +adapter+ exists.
+    def self.use=(new_adapter)
+      @use = find(new_adapter)
+    end
+
+    # Returns an +adapter+. Raises an +ArgumentError+ unless the +adapter+ exists.
+    def self.find(adapter)
+      return adapter if adapter.is_a?(Module)
+
+      Premailer::Adapter.const_get("#{adapter.to_s.split('_').map{|s| s.capitalize}.join('')}")
+    rescue NameError
+      raise ArgumentError, "Invalid adapter: #{adapter}"
+    end
+
+  end
+end

data/lib/premailer/adapter/hpricot.rb

@@ -0,0 +1,193 @@
+require 'hpricot'
+
+class Premailer
+  module Adapter
+    module Hpricot
+
+      # 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) {|m| $1 }
+
+          # Convert element names to lower case
+          selector.gsub!(/([\s]|^)([\w]+)/) {|m| $1.to_s + $2.to_s.downcase }
+
+          if selector =~ Premailer::RE_UNMERGABLE_SELECTORS
+            @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')
+                  # 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 ::Hpricot::Error, RuntimeError, ArgumentError
+              $stderr.puts "CSS syntax error with selector: #{selector}" if @options[:verbose]
+              next
+            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 = 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!
+
+          # Duplicate CSS attributes as HTML attributes
+          if Premailer::RELATED_ATTRIBUTES.has_key?(el.name)
+            Premailer::RELATED_ATTRIBUTES[el.name].each do |css_att, html_att|
+              el[html_att] = merged[css_att].gsub(/url\('(.*)'\)/,'\1').gsub(/;$/, '').strip if el[html_att].nil? and not merged[css_att].empty?
+            end
+          end
+
+          merged.create_dimensions_shorthand!
+          merged.create_border_shorthand!
+
+          # write the inline STYLE attribute
+          el['style'] = Premailer.escape_string(merged.declarations_to_s)
+        end
+
+        doc = write_unmergable_css_rules(doc, @unmergable_rules)
+
+        if @options[:remove_classes] or @options[:remove_comments]
+          doc.search('*').each do |el|
+            if el.comment? and @options[:remove_comments]
+              lst = el.parent.children
+              el.parent = nil
+              lst.delete(el)
+            elsif el.elem?
+              el.remove_attribute('class') if @options[:remove_classes]
+            end
+          end
+        end
+
+        if @options[:remove_ids]
+          # find all anchor's targets and hash them
+          targets = []
+          doc.search("a[@href^='#']").each do |el|
+            target = el.get_attribute('href')[1..-1]
+            targets << target
+            el.set_attribute('href', "#" + Digest::MD5.hexdigest(target))
+          end
+          # hash ids that are links target, delete others
+          doc.search("*[@id]").each do |el|
+            id = el.get_attribute('id')
+            if targets.include?(id)
+              el.set_attribute('id', Digest::MD5.hexdigest(id))
+            else
+              el.remove_attribute('id')
+            end
+          end
+        end
+
+        @processed_doc = doc
+
+        @processed_doc.to_original_html
+      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"
+          if body = doc.search('body')
+            body.append(style_tag)
+          else
+            doc.inner_html= doc.inner_html << style_tag
+          end
+        end
+        doc
+      end
+
+
+      # Converts the HTML document to a format suitable for plain-text e-mail.
+      #
+      # If present, uses the <body> element as its base; otherwise uses the whole document.
+      #
+      # Returns a string.
+      def to_plain_text
+        html_src = ''
+        begin
+          html_src = @doc.search("body").inner_html
+        rescue; end
+
+        html_src = @doc.to_html unless html_src and not html_src.empty?
+        convert_to_text(html_src, @options[:line_length], @html_encoding)
+      end
+
+
+      # Returns the original HTML as a string.
+      def to_s
+        @doc.to_original_html
+      end
+
+      # Load the HTML file and convert it into an Hpricot document.
+      #
+      # Returns an Hpricot document.
+      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
+          thing = open(input)
+        end
+
+        # TODO: deal with Hpricot seg faults on empty input
+        thing ? Hpricot(thing) : nil
+      end
+
+    end
+  end
+end

data/lib/premailer/adapter/nokogiri.rb

@@ -0,0 +1,203 @@
+require 'nokogiri'
+
+class Premailer
+  module Adapter
+    module Nokogiri
+
+      # 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) {|m| $1 }
+
+          # Convert element names to lower case
+          selector.gsub!(/([\s]|^)([\w]+)/) {|m| $1.to_s + $2.to_s.downcase }
+
+          if selector =~ Premailer::RE_UNMERGABLE_SELECTORS
+            @unmergable_rules.add_rule_set!(CssParser::RuleSet.new(selector, declaration)) unless @options[:preserve_styles]
+          else
+            begin
+              # 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]')
+
+              doc.search(selector).each do |el|
+                if el.elem? and (el.name != 'head' and el.parent.name != 'head')
+                  # 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, ArgumentError
+              $stderr.puts "CSS syntax error with selector: #{selector}" if @options[:verbose]
+              next
+            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 = 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!
+
+          # Duplicate CSS attributes as HTML attributes
+          if Premailer::RELATED_ATTRIBUTES.has_key?(el.name)
+            Premailer::RELATED_ATTRIBUTES[el.name].each do |css_att, html_att|
+              el[html_att] = merged[css_att].gsub(/url\('(.*)'\)/,'\1').gsub(/;$/, '').strip if el[html_att].nil? and not merged[css_att].empty?
+            end
+          end
+
+          merged.create_dimensions_shorthand!
+          merged.create_border_shorthand!
+
+          # write the inline STYLE attribute
+          el['style'] = Premailer.escape_string(merged.declarations_to_s)
+        end
+
+        doc = write_unmergable_css_rules(doc, @unmergable_rules)
+
+        if @options[:remove_classes] or @options[:remove_comments]
+          doc.traverse do |el|
+            if el.comment? and @options[:remove_comments]
+              el.remove
+            elsif el.element?
+              el.remove_attribute('class') if @options[:remove_classes]
+            end
+          end
+        end
+
+        if @options[:remove_ids]
+          # find all anchor's targets and hash them
+          targets = []
+          doc.search("a[@href^='#']").each do |el|
+            target = el.get_attribute('href')[1..-1]
+            targets << target
+            el.set_attribute('href', "#" + Digest::MD5.hexdigest(target))
+          end
+          # hash ids that are links target, delete others
+          doc.search("*[@id]").each do |el|
+            id = el.get_attribute('id')
+            if targets.include?(id)
+              el.set_attribute('id', Digest::MD5.hexdigest(id))
+            else
+              el.remove_attribute('id')
+            end
+          end
+        end
+
+        @processed_doc = doc
+        if is_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
+      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 Nokogiri document and <tt>unmergable_css_rules</tt> is a Css::RuleSet.
+      #
+      # Returns an Nokogiri 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 = "<style type=\"text/css\">\n#{styles}></style>"
+          if body = doc.search('body')
+            doc.at_css('body').children.before(::Nokogiri::XML.fragment(style_tag))            
+          else
+            doc.inner_html = style_tag += doc.inner_html
+          end
+        end
+        doc
+      end
+
+
+      # Converts the HTML document to a format suitable for plain-text e-mail.
+      #
+      # If present, uses the <body> element as its base; otherwise uses the whole document.
+      #
+      # Returns a string.
+      def to_plain_text
+        html_src = ''
+        begin
+          html_src = @doc.at("body").inner_html
+        rescue; end
+
+        html_src = @doc.to_html unless html_src and not html_src.empty?
+        convert_to_text(html_src, @options[:line_length], @html_encoding)
+      end
+
+      # Returns the original HTML as a string.
+      def to_s
+        if is_xhtml?
+          @doc.to_xhtml(:encoding => nil)
+        else
+          @doc.to_html(:encoding => nil)
+        end
+      end
+
+      # Load the HTML file and convert it into an Nokogiri document.
+      #
+      # Returns an Nokogiri document.
+      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
+          thing = open(input)
+        end
+
+        if thing.respond_to?(:read)
+          thing = thing.read
+        end
+
+        return nil unless thing
+        doc = nil
+
+        # 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.recover }
+        else
+          default_encoding = RUBY_PLATFORM == 'java' ? nil : 'BINARY'
+          doc = ::Nokogiri::HTML(thing, nil, @options[:inputencoding] || default_encoding) {|c| c.recover }
+        end
+
+        return doc
+      end
+
+    end
+  end
+end