premailer 1.7.3 → 1.7.8

data/.gitignore

@@ -4,4 +4,8 @@ Gemfile.lock
 bin/*.html
 html/
 vendor/
-rdoc/
+doc/
+.yardoc/
+*.sw?
+pkg/
+*.sublime-*

data/.jrubyrc

@@ -0,0 +1 @@
+cext.enabled=true

data/.travis.yml

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

data/.yardopts

@@ -0,0 +1,10 @@
+--markup markdown
+--markup-provider redcarpet
+--charset utf-8
+--no-private
+--readme README.md
+--title "Premailer Documentation"
+--plugin redcarpet-ext
+-
+README.md
+LICENSE.md

data/Gemfile

@@ -1,3 +1,14 @@
-source :rubygems
+source "https://rubygems.org"
+
+gem 'css_parser', :git => 'git://github.com/alexdunae/css_parser.git'
+gem 'webmock', :group => [:development, :test]
+
+platforms :jruby do
+  gem 'jruby-openssl'
+end
 
 gemspec
+
+gem "ripper", :group => :development, :platforms => :mri_18
+
+gem "coveralls", :require => false, :platforms => [:mri_19, :mri_20], :group => :development

data/{LICENSE.rdoc → LICENSE.md}

@@ -1,6 +1,6 @@
-= Premailer License
+# Premailer License
 
-Copyright (c) 2007-2011, Alex Dunae.  All rights reserved.
+Copyright (c) 2007-2012, 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:
 

data/README.md

@@ -0,0 +1,100 @@
+# 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 `style` and `link[rel=stylesheet]` tags and preserves existing inline attributes
+* Relative paths are converted to absolute paths
+  - Checks links in `href`, `src` and CSS `url('')`
+* 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.
+
+```bash
+gem install premailer
+```
+
+## Example
+
+```ruby
+premailer = Premailer.new('http://example.com/myfile.html', :warn_level => Premailer::Warnings::SAFE)
+
+# Write the HTML output
+File.open("output.html", "w") do |fout|
+  fout.puts premailer.to_inline_css
+end
+
+# Write the plain-text output
+File.open("ouput.txt", "w") do |fout|
+  fout.puts premailer.to_plain_text
+end
+
+# 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 . 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.
+
+| CSS Attribute | Availability |
+| ------------- | ------------ |
+| -premailer-width | Available on `table`, `th` and `td` elements |
+| -premailer-height | Available on `table`, `tr`, `th` and `td` elements |
+| -premailer-cellpadding | Available on `table` elements |
+| -premailer-cellspacing | Available on `table` elements |
+
+Each of these CSS declarations will be copied to appropriate element's attribute.
+
+For example
+
+```css
+table { -premailer-cellspacing: 5; -premailer-width: 500; }
+```
+
+will result in 
+
+```html
+<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 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-2012.  See [LICENSE.md](https://github.com/alexdunae/premailer/blob/master/LICENSE.md) for license details.
+

data/lib/premailer/adapter.rb

@@ -1,15 +1,16 @@
-# = HTTPI::Adapter
-#
-# Manages the adapter classes. Currently supports:
-#
-# * nokogiri
-# * hpricot
+
+
 class Premailer
+  # Manages the adapter classes. Currently supports:
+  #
+  # * nokogiri
+  # * hpricot
   module Adapter
 
     autoload :Hpricot, 'premailer/adapter/hpricot'
     autoload :Nokogiri, 'premailer/adapter/nokogiri'
 
+    # adapter to required file mapping.
     REQUIREMENT_MAP = [
       ["hpricot",  :hpricot],
       ["nokogiri", :nokogiri],
@@ -24,7 +25,8 @@ class Premailer
 
     # 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.
+    # then checks to see which are installed if none are loaded.
+    # @raise [RuntimeError] unless suitable adapter found.
     def self.default
       return :hpricot  if defined?(::Hpricot)
       return :nokogiri if defined?(::Nokogiri)
@@ -38,15 +40,17 @@ class Premailer
         end
       end
 
-      raise "No suitable adapter for Premailer was found, please install hpricot or nokogiri"
+      raise RuntimeError.new("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.
+    # Sets the adapter to use.
+    # @raise [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.
+    # Returns an adapter.
+    # @raise [ArgumentError] unless the adapter exists.
     def self.find(adapter)
       return adapter if adapter.is_a?(Module)
 

data/lib/premailer/adapter/hpricot.rb

@@ -2,11 +2,11 @@ require 'hpricot'
 
 class Premailer
   module Adapter
+    # Hpricot adapter
     module Hpricot
 
       # Merge CSS into the HTML document.
-      #
-      # Returns a string.
+      # @return [String] HTML.
       def to_inline_css
         doc = @processed_doc
         @unmergable_rules = CssParser::Parser.new
@@ -29,16 +29,16 @@ class Premailer
             @unmergable_rules.add_rule_set!(CssParser::RuleSet.new(selector, declaration)) unless @options[:preserve_styles]
           else
             begin
-	            if selector =~ Premailer::RE_RESET_SELECTORS
+              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]
+                @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\']')
@@ -57,6 +57,11 @@ class Premailer
           end
         end
 
+        # Remove script tags
+        if @options[:remove_scripts]
+          doc.search("script").remove
+        end
+
         # Read STYLE attributes and perform folding
         doc.search("*[@style]").each do |el|
           style = el.attributes['style'].to_s
@@ -74,13 +79,10 @@ class Premailer
           # 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(/;$/, '').strip if el[html_att].nil? and not merged[css_att].empty?
+              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
@@ -128,7 +130,7 @@ class Premailer
       #
       # <tt>doc</tt> is an Hpricot document and <tt>unmergable_css_rules</tt> is a Css::RuleSet.
       #
-      # Returns an Hpricot document.
+      # @return [::Hpricot] a document.
       def write_unmergable_css_rules(doc, unmergable_rules) # :nodoc:
         styles = ''
         unmergable_rules.each_selector(:all, :force_important => true) do |selector, declarations, specificity|
@@ -137,7 +139,9 @@ class Premailer
 
         unless styles.empty?
           style_tag = "\n<style type=\"text/css\">\n#{styles}</style>\n"
-          if body = doc.search('body')
+          if head = doc.search('head')
+            head.append(style_tag)
+          elsif body = doc.search('body')
             body.append(style_tag)
           else
             doc.inner_html= doc.inner_html << style_tag
@@ -151,7 +155,7 @@ class Premailer
       #
       # If present, uses the <body> element as its base; otherwise uses the whole document.
       #
-      # Returns a string.
+      # @return [String] Plain text.
       def to_plain_text
         html_src = ''
         begin
@@ -163,24 +167,25 @@ class Premailer
       end
 
 
-      # Returns the original HTML as a string.
+      # Gets the original HTML as a string.
+      # @return [String] HTML.
       def to_s
         @doc.to_original_html
       end
 
       # Load the HTML file and convert it into an Hpricot document.
       #
-      # Returns an Hpricot document.
+      # @return [::Hpricot] a 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
+        elsif @is_local_file
           @base_dir = File.dirname(input)
           thing = File.open(input, 'r')
-				else
+        else
           thing = open(input)
         end
 
@@ -191,3 +196,4 @@ class Premailer
     end
   end
 end
+

data/lib/premailer/adapter/nokogiri.rb

@@ -2,11 +2,12 @@ require 'nokogiri'
 
 class Premailer
   module Adapter
+    # Nokogiri adapter
     module Nokogiri
 
       # Merge CSS into the HTML document.
       #
-      # Returns a string.
+      # @return [String] an HTML.
       def to_inline_css
         doc = @processed_doc
         @unmergable_rules = CssParser::Parser.new
@@ -47,6 +48,11 @@ class Premailer
           end
         end
 
+        # Remove script tags
+        if @options[:remove_scripts]
+          doc.search("script").remove
+        end
+
         # Read STYLE attributes and perform folding
         doc.search("*[@style]").each do |el|
           style = el.attributes['style'].to_s
@@ -64,15 +70,12 @@ class Premailer
           # 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(/;$/, '').strip if el[html_att].nil? and not merged[css_att].empty?
+              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)
+          el['style'] = Premailer.escape_string(merged.declarations_to_s).split(';').map(&:strip).sort.join('; ')
         end
 
         doc = write_unmergable_css_rules(doc, @unmergable_rules)
@@ -109,7 +112,7 @@ class Premailer
         @processed_doc = doc
         if is_xhtml?
           # we don't want to encode carriage returns
-          @processed_doc.to_xhtml(:encoding => nil).gsub(/&\#xD;/i, "\r")
+          @processed_doc.to_xhtml(:encoding => nil).gsub(/&\#(xD|13);/i, "\r")
         else
           @processed_doc.to_html
         end
@@ -120,7 +123,7 @@ class Premailer
       #
       # <tt>doc</tt> is an Nokogiri document and <tt>unmergable_css_rules</tt> is a Css::RuleSet.
       #
-      # Returns an Nokogiri document.
+      # @return [::Nokogiri::XML] a document.
       def write_unmergable_css_rules(doc, unmergable_rules) # :nodoc:
         styles = ''
         unmergable_rules.each_selector(:all, :force_important => true) do |selector, declarations, specificity|
@@ -129,13 +132,18 @@ class Premailer
 
         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)            
+          if head = doc.search('head')
+            doc.at_css('head').add_child(::Nokogiri::XML.fragment(style_tag))
+          elsif body = doc.search('body')
+            if doc.at_css('body').children && !doc.at_css('body').children.empty?
+              doc.at_css('body').children.before(::Nokogiri::XML.fragment(style_tag))
+            else
+              doc.at_css('body').add_child(::Nokogiri::XML.fragment(style_tag))
+            end
           else
             doc.inner_html = style_tag += doc.inner_html
           end
         end
-
         doc
       end
 
@@ -144,7 +152,7 @@ class Premailer
       #
       # If present, uses the <body> element as its base; otherwise uses the whole document.
       #
-      # Returns a string.
+      # @return [String] a plain text.
       def to_plain_text
         html_src = ''
         begin
@@ -155,7 +163,8 @@ class Premailer
         convert_to_text(html_src, @options[:line_length], @html_encoding)
       end
 
-      # Returns the original HTML as a string.
+      # Gets the original HTML as a string.
+      # @return [String] HTML.
       def to_s
         if is_xhtml?
           @doc.to_xhtml(:encoding => nil)
@@ -166,7 +175,7 @@ class Premailer
 
       # Load the HTML file and convert it into an Nokogiri document.
       #
-      # Returns an Nokogiri document.
+      # @return [::Nokogiri::XML] a document.
       def load_html(input) # :nodoc:
         thing = nil
 
@@ -185,15 +194,34 @@ class Premailer
         end
 
         return nil unless thing
-
         doc = nil
 
+        # Handle HTML entities
+        if @options[:replace_html_entities] == true and thing.is_a?(String)
+          if RUBY_VERSION =~ /1.9/
+            html_entity_ruby_version = "1.9"
+          elsif RUBY_VERSION =~ /1.8/
+            html_entity_ruby_version = "1.8"
+          end
+          if html_entity_ruby_version
+            HTML_ENTITIES[html_entity_ruby_version].map do |entity, replacement|
+              thing.gsub! entity, replacement
+            end
+          end
+        end
         # Default encoding is ASCII-8BIT (binary) per http://groups.google.com/group/nokogiri-talk/msg/0b81ef0dc180dc74
+        # However, we really don't want to hardcode this. ASCII-8BIG should be the default, but not the only option.
         if thing.is_a?(String) and RUBY_VERSION =~ /1.9/
-          thing = thing.force_encoding('ASCII-8BIT').encode!
-          doc = ::Nokogiri::HTML(thing) {|c| c.recover }
+          thing = thing.force_encoding(@options[:input_encoding]).encode!
+          doc = ::Nokogiri::HTML(thing, nil, @options[:input_encoding]) {|c| c.recover }
         else
-          doc = ::Nokogiri::HTML(thing, nil, @options[:inputencoding] || 'BINARY') {|c| c.recover }
+          default_encoding = RUBY_PLATFORM == 'java' ? nil : 'BINARY'
+          doc = ::Nokogiri::HTML(thing, nil, @options[:input_encoding] || default_encoding) {|c| c.recover }
+        end
+
+        # Fix for removing any CDATA tags inserted per https://github.com/sparklemotion/nokogiri/issues/311
+        doc.search("style").children.each do |child|
+          child.swap(child.text()) if child.cdata?
         end
 
         return doc