inline-style-umanni 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+pkg/*
+*.gem
+.bundle
+*.swp

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in inline-style.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    inline-style (0.4.10)
+      css_parser
+      facets
+      maca-fork-csspool
+      nokogiri
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.0.4)
+    css_parser (1.1.5)
+    diff-lcs (1.1.2)
+    facets (2.9.1)
+    ffi (1.0.7)
+      rake (>= 0.8.7)
+    i18n (0.5.0)
+    maca-fork-csspool (2.0.2)
+      ffi
+    mail (2.2.15)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    nokogiri (1.4.4)
+    polyglot (0.3.1)
+    rack (1.2.1)
+    rake (0.8.7)
+    rspec (2.4.0)
+      rspec-core (~> 2.4.0)
+      rspec-expectations (~> 2.4.0)
+      rspec-mocks (~> 2.4.0)
+    rspec-core (2.4.0)
+    rspec-expectations (2.4.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.4.0)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  css_parser
+  facets
+  inline-style!
+  maca-fork-csspool
+  mail
+  nokogiri
+  rack
+  rspec
+  rspec-core

data/README.rdoc

@@ -0,0 +1,153 @@
+= inline-style
+
+http://github.com/umanni/inline-style
+
+
+== Description
+
+Will take all css in a page (either from linked stylesheet or from style tag) and will embed it in the style attribute for 
+each refered element taking selector specificity and declarator order.
+
+Useful for html email: some clients (gmail, et all) won't render non inline styles.
+
+* Includes a Rack middleware for using with Rails, Sinatra, etc...
+* Includes a interceptor for the mail gem which allows automatic
+  inline processing for both mail as well as ActionMailer.
+* It takes into account selector specificity.
+
+
+== Usage
+
+    
+    gem 'maca-fork-csspool' # this is optional if csspool is required inline-style will resort to it for css parsing, otherwise it will use the pure ruby css_parser
+    require 'csspool'       # csspool should be faster because it uses librcroco written in C wich can also be an issue, use css_parser if you deploy to heroku
+                      
+    require 'inline-style'
+
+    html  = File.read("./index.html")
+    puts InlineStyle.process(html, :stylesheets_paths => "./styles")
+        
+index.html contains:
+    
+    <style type="text/css" media="screen">
+    * {
+      font-family: "Lucida Grande", Lucida, Verdana, sans-serif;
+      margin: 4px 3px 2px 1px;
+      padding: 0;
+    }
+
+    #list {
+      margin: 10;
+    }
+
+    #list li {
+      font-family: Arial;
+    }
+
+    .element {
+      padding: 10;
+    }
+
+    .odd {
+      background-color: black;
+    }
+
+    .pair {
+      background-color: red;
+    }
+
+    </style>
+    
+    
+    <ul id='number' class='listing inlined' style='background-color: yellow'>
+      <li class='list-element odd'>
+        <span>1</span>
+      </li>
+      <li class='list-element pair'>
+        <span>2</span>
+      </li>
+      <li class='list-element odd'>
+        <span>3</span>
+      </li>
+      <li class='list-element pair'>
+        <span>4</span>
+      </li>
+    </ul>
+
+Will become:
+        
+    <ul id="number" class="listing inlined" style='font-family: "Lucida Grande", Lucida, Verdana, sans-serif;margin: 4.0px 3.0px 2.0px 1.0px;padding: 0.0;background-color: yellow;'>
+      <li class="list-element odd" style='font-family: "Lucida Grande", Lucida, Verdana, sans-serif;margin: 4.0px 3.0px 2.0px 1.0px;padding: 0.0;background-color: black;'>
+        <span style='font-family: "Lucida Grande", Lucida, Verdana, sans-serif;margin: 4.0px 3.0px 2.0px 1.0px;padding: 0.0;'>1</span>
+      </li>
+      <li class="list-element pair" style='font-family: "Lucida Grande", Lucida, Verdana, sans-serif;margin: 4.0px 3.0px 2.0px 1.0px;padding: 0.0;background-color: red;'>
+        <span style='font-family: "Lucida Grande", Lucida, Verdana, sans-serif;margin: 4.0px 3.0px 2.0px 1.0px;padding: 0.0;'>2</span>
+      </li>
+      <li class="list-element odd" style='font-family: "Lucida Grande", Lucida, Verdana, sans-serif;margin: 4.0px 3.0px 2.0px 1.0px;padding: 0.0;background-color: black;'>
+        <span style='font-family: "Lucida Grande", Lucida, Verdana, sans-serif;margin: 4.0px 3.0px 2.0px 1.0px;padding: 0.0;'>3</span>
+      </li>
+      <li class="list-element pair" style='font-family: "Lucida Grande", Lucida, Verdana, sans-serif;margin: 4.0px 3.0px 2.0px 1.0px;padding: 0.0;background-color: red;'>
+        <span style='font-family: "Lucida Grande", Lucida, Verdana, sans-serif;margin: 4.0px 3.0px 2.0px 1.0px;padding: 0.0;'>4</span>
+      </li>
+    </ul>
+
+    
+== Rack Middleware:
+
+    # Process all routes:
+    use InlineStyle::Rack::Middleware
+    
+    # Restrict processing to single route:
+    use InlineStyle::Rack::Middleware, :paths => %r(/mails/.*)
+    
+    # Restrict processing to some routes:
+    use InlineStyle::Rack::Middleware, :paths => [%r(/mails/.*), "/somepath"]
+
+
+== Mail Interceptor
+
+If using the mail library the following code will work:
+
+   Mail.register_interceptor \
+     InlineStyle::Mail::Interceptor.new(:stylesheets_path => 'public')
+
+If using ActionMailer (which wraps mail):
+
+   ActionMailer::Base.register_interceptor \
+     InlineStyle::Mail::Interceptor.new(:stylesheets_path => 'public')
+    
+
+== Requirements:
+
+nokogiri && (css_parser || maca-fork-csspool)
+
+
+== Install:
+
+    sudo gem install inline-style
+
+
+== License:
+
+(The MIT License)
+
+Copyright (c) 2009 Macario Ortega
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler'
+require "rspec/core/rake_task"
+
+task :default => [:spec]
+
+desc "Run specs"
+RSpec::Core::RakeTask.new(:spec)
+
+Bundler::GemHelper.install_tasks

data/example.rb

@@ -0,0 +1,5 @@
+require 'rubygems'
+require "#{ dir = File.dirname(__FILE__) }/lib/inline-style"
+
+html  = File.read("#{ fixtures = dir + '/spec/fixtures' }/boletin.html")
+puts InlineStyle.process(html)

data/inline-style.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "inline-style/version"
+
+Gem::Specification.new do |s|
+  s.name        = "inline-style-umanni"
+  s.version     = InlineStyle::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Umanni"]
+  s.email       = ["ygor@umanni.com"]
+  s.homepage    = ""
+  s.summary     = %q{Inlines CSS for html email delivery}
+  s.description = %q{Inlines CSS for html email delivery}
+  s.post_install_message = %{Please read documentation for changes on the default css parser gem, specifically if you use csspool}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rack'
+  s.add_development_dependency 'rspec-core'
+  s.add_development_dependency 'mail'
+
+  s.add_dependency 'nokogiri'
+  s.add_dependency 'css_parser'
+  s.add_dependency 'maca-fork-csspool'
+end

data/lib/inline-style.rb

@@ -0,0 +1,98 @@
+require 'nokogiri'
+require 'open-uri'
+
+$:.unshift(File.dirname(__FILE__)) unless $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require "inline-style/rule"
+require "inline-style/rack-middleware" # This two may be should be required by user if she needs it
+require "inline-style/mail-interceptor"
+
+class InlineStyle
+  CSSParser =
+  if const_defined? :CSSPool
+    require 'inline-style/csspool_wrapper'
+    CSSPoolWrapper
+  else
+    require 'inline-style/css_parser_wrapper'
+    CssParserWrapper
+  end
+
+  # @param [String, Nokogiri::HTML::Document] html Html or Nokogiri html to be inlined
+  # @param [Hash] opts Processing options
+  #
+  # @option opts [String] :stylesheets_path (ENV['DOCUMENT_ROOT']) 
+  #       Stylesheets root path or app's public directory where the stylesheets are to be found
+  def self.process html, opts = {}
+    new(html, opts).process
+  end
+
+  def initialize html, opts = {}
+    @stylesheets_path = opts[:stylesheets_path] || ENV['DOCUMENT_ROOT'] || '.'
+    @html           = html
+    @dom = String === html ? Nokogiri.HTML(html) : html
+  end
+
+  def process
+    nodes_with_rules.each_pair do |node, rules|
+      rules = rules.sort_by{ |sel| "#{sel.specificity}%04d" % rules.index(sel) }
+
+      styles = []
+      rules.each do |rule|
+        next if rule.dynamic_pseudo_class
+        rule.declarations.each do |declaration| 
+          if defined = styles.assoc(declaration.first)
+            styles[styles.index(defined)] = declaration # overrides defined declaration
+          else
+            styles << declaration
+          end
+        end
+      end
+
+      style = styles.map{ |declaration| declaration.join(': ') }.join('; ') 
+      node['style'] = "#{style};" unless style.empty?
+    end
+    pre_parsed? ? @dom : @dom.to_s
+  end
+
+  private
+  def nodes_with_rules
+    nodes, body = {}, @dom.css('body')
+
+    parse_css.rules.each do |rule|
+      body.css(rule.selector).each do |node|
+        nodes[node] ||= []
+        nodes[node].push rule
+      end
+    end
+
+    body.css('[style]').each do |node| 
+      nodes[node] ||= []
+      nodes[node].push Rule.new ':inline', node['style'], '1000' # :inline is not really a pseudoclass
+    end
+
+    nodes
+  end
+
+  def pre_parsed?
+    @html == @dom
+  end
+
+  # Returns parsed CSS
+  def extract_css
+    @dom.css('style, link[rel=stylesheet]').collect do |node|
+      next unless /^$|screen|all/ === node['media'].to_s
+      node.remove
+
+      if node.name == 'style'
+        node.content 
+      else
+        uri = %r{^https?://} === node['href'] ? node['href'] : File.join(@stylesheets_path, node['href'].sub(/\?.+$/,'')) 
+        open(uri).read
+      end
+    end.join("\n")
+  end
+
+  def parse_css
+    CSSParser.new extract_css 
+  end
+end

data/lib/inline-style/css_parser_wrapper.rb

@@ -0,0 +1,15 @@
+require 'css_parser'
+
+class InlineStyle
+  class CssParserWrapper
+    attr_accessor :rules
+
+    def initialize(css_code)
+      parser, @rules = CssParser::Parser.new, []
+      parser.add_block! css_code
+      parser.each_rule_set do |rule_set| 
+        rule_set.each_selector { |sel, dec, spec| @rules << Rule.new(sel, dec, '%04d' % spec.to_i) } 
+      end
+    end
+  end
+end

data/lib/inline-style/csspool_wrapper.rb

@@ -0,0 +1,12 @@
+class InlineStyle
+  class CSSPoolWrapper
+    attr_accessor :rules
+
+    def initialize css_code
+      parser = CSSPool.CSS css_code
+      @rules = parser.rule_sets.map do |rule_set| 
+        rule_set.selectors.map { |sel| Rule.new(sel.to_s, sel.declarations.join, "0#{sel.specificity.join}") }
+      end.flatten 
+    end
+  end
+end

data/lib/inline-style/mail-interceptor.rb

@@ -0,0 +1,36 @@
+# A interceptor for +mail+ (https://github.com/mikel/mail) to
+# automatically inline the styles of outgoing e-mails. To use:
+#
+#   Mail.register_interceptor \
+#     InlineStyle::Mail::Interceptor.new(:stylesheets_path => 'public')
+#
+# Rails 3's ActionMailer wraps around the +mail+ and also supports
+# interceptors. Example usage:
+#
+#   ActionMailer::Base.register_interceptor \
+#     InlineStyle::Mail::Interceptor.new(:stylesheets_path => 'public')
+#
+module InlineStyle::Mail
+  class Interceptor
+    # The mime types we should inline. Basically HTML and XHTML.
+    # If you have something else you can just push it onto the list
+    INLINE_MIME_TYPES = %w(text/html application/xhtml+xml)
+
+    # Save the options to later pass to InlineStyle.process
+    def initialize(options={})
+      @options = options
+    end
+
+    # Mail callback where we actually inline the styles
+    def delivering_email(part)
+      if part.multipart?
+        for part in part.parts
+          delivering_email part
+        end
+      elsif INLINE_MIME_TYPES.any? {|m| part.content_type.starts_with? m}
+        part.body = InlineStyle.process(part.body.to_s, @options)
+      end
+    end
+
+  end
+end

data/lib/inline-style/rack-middleware.rb

@@ -0,0 +1,33 @@
+module InlineStyle::Rack
+  class Middleware
+    # @param [Hash] opts Middlewar options
+    #
+    # @option opts [String] :stylesheets_path (env['DOCUMENT_ROOT']) 
+    #       Stylesheets root path or app's public directory where the stylesheets are to be found
+    # @option opts [Regexp, Array, String] :paths
+    #       Limit processing to the passed absolute paths
+    #       Can be an array of strings or regular expressions, a single string or regular expression
+    #       If not passed will process output for every path.
+    #       Regexps and strings must comence with '/'
+    # @option opts [Boolean] :pseudo (false) 
+    #       If set to true will inline style for pseudo classes according to the W3C specification:
+    #       http://www.w3.org/TR/css-style-attr.
+    #       Should probably be left as false because browsers don't seem to comply with the specification for pseudo class style in the style attribute.
+    def initialize app, opts = {}
+      @app   = app
+      @opts  = opts
+      @paths = /^(?:#{ [*opts[:paths]].join('|') })/
+    end
+
+    def call env
+      response = @app.call env
+      return response unless @paths === env['PATH_INFO']
+      
+      status, headers, body = response
+      
+      body = InlineStyle.process(body.first, {:stylesheets_path => env['DOCUMENT_ROOT']}.merge(@opts))
+      [status, headers, [body]]
+    end
+  end
+end
+