premailer-rails3 1.2.0 → 1.3.0

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - jruby-18mode # JRuby in 1.8 mode
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-18mode
+  - rbx-19mode
+  - 1.8.7

data/README.md

@@ -1,4 +1,6 @@
-# Premailer Rails 3 README
+# premailer-rails3
+
+[![Build Status](https://secure.travis-ci.org/fphilipe/premailer-rails3.png?branch=master)](http://travis-ci.org/fphilipe/premailer-rails3) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/fphilipe/premailer-rails3)
 
 This gem is a no config solution for the wonderful
 [Premailer gem](https://github.com/alexdunae/premailer) to be used with Rails 3.
@@ -14,14 +16,16 @@ By default it inlines all the CSS files that are linked to in the HTML:
 
 Don't worry about the host in the CSS URL since this will be ignored.
 
-If no CSS file is linked to in the HTML it will try to load a default CSS file
-`email.css`.
+If no CSS file is linked to in the HTML and no inline `<style type="text/css">`
+is presnet, it will try to load a default CSS file `email.css`.
 
 Every CSS file (including the default `email.css`) is loaded from within the
 app. The retrieval of the file depends on your assets configuration:
 
 * Rails 3.1 asset pipeline: It will load the compiled version of the CSS asset
-  which is normally located in `app/assets/stylesheets/`.
+  which is normally located in `app/assets/stylesheets/`. If the asset can't be
+  found (e.g. it is only available on a CDN and not locally), it will be
+  HTTP requested.
 
 * Classic static assets: It will try to load the CSS file located in
   `public/stylesheets/`
@@ -54,8 +58,8 @@ pass these options on to the underlying premailer instance, specify them in an
 initializer:
 
 ```ruby
-PremailerRails.config.merge(:preserve_styles => true,
-                            :remove_ids      => true)
+PremailerRails.config.merge!(:preserve_styles => true,
+                             :remove_ids      => true)
 ```
 
 For a list of options, refer to the [Premailer documentation](http://rubydoc.info/gems/premailer/1.7.3/Premailer:initialize)
@@ -65,10 +69,16 @@ The default configs are:
 ```ruby
 {
   :input_encoding     => 'UTF-8',
+  :inputencoding      => 'UTF-8',
   :generate_text_part => true
 }
 ```
 
+The input encoding option [changed](https://github.com/alexdunae/premailer/commit/5f5cbb4ac181299a7e73d3eca11f3cf546585364)
+at some point. To make sure this option works regardless of the premailer
+version, the old and new setting is specified. If you want to use another
+encoding make sure to specify the right one or both.
+
 If you don't want to generate a text part from the html part, set the config
 `:generate_text_part` to false.
 

data/lib/premailer-rails3.rb

@@ -1,4 +1,5 @@
 require 'premailer'
+require 'premailer-rails3/css_loaders'
 require 'premailer-rails3/css_helper'
 require 'premailer-rails3/premailer'
 require 'premailer-rails3/hook'
@@ -6,6 +7,7 @@ require 'premailer-rails3/hook'
 module PremailerRails
   @config = {
     :input_encoding     => 'UTF-8',
+    :inputencoding      => 'UTF-8',
     :generate_text_part => true
   }
   class << self

data/lib/premailer-rails3/css_helper.rb

@@ -5,74 +5,56 @@ module PremailerRails
   module CSSHelper
     extend self
 
-    @@css_cache = {}
+    @cache = {}
+    attr :cache
 
+    STRATEGIES = [
+      CSSLoaders::CacheLoader,
+      CSSLoaders::HassleLoader,
+      CSSLoaders::AssetPipelineLoader,
+      CSSLoaders::FileSystemLoader
+    ]
+
+    # Returns all linked CSS files concatenated as string.
     def css_for_doc(doc)
-      css = doc.search('link[@type="text/css"]').map { |link|
-              url = link.attributes['href'].to_s
-              load_css_at_path(url) unless url.blank?
-            }.reject(&:blank?).join("\n")
-      css = load_css_at_path(:default) if css.blank?
-      css
+      urls = css_urls_in_doc(doc)
+      if urls.empty?
+        load_css(:default) unless has_inline_css? doc
+      else
+        urls.map { |url| load_css(url) }.join("\n")
+      end
     end
 
     private
 
-    def load_css_at_path(path)
-      if path.is_a? String
-        # Remove everything after ? including ?
-        path = path[0..(path.index('?') - 1)] if path.include? '?'
-        # Remove the host
-        path = path.sub(/^https?\:\/\/[^\/]*/, '') if path.index('http') == 0
-      end
-
-      # Don't cache in development.
-      if Rails.env.development? or not @@css_cache.include? path
-        @@css_cache[path] =
-          if defined? Hassle and Rails.configuration.middleware.include? Hassle
-            file = path == :default ? '/stylesheets/email.css' : path
-            File.read("#{Rails.root}/tmp/hassle#{file}")
-          elsif assets_enabled?
-            file = if path == :default
-                     'email.css'
-                   else
-                     path.sub("#{Rails.configuration.assets.prefix}/", '') \
-                         .sub(/-.*\.css$/, '.css')
-                   end
-            if asset = Rails.application.assets.find_asset(file)
-              asset.to_s
-            else
-              request_and_unzip(file)
-            end
-          else
-            file = path == :default ? '/stylesheets/email.css' : path
-            File.read("#{Rails.root}/public#{file}")
-          end
+    def css_urls_in_doc(doc)
+      doc.search('link[@type="text/css"]').map do |link|
+        link.attributes['href'].to_s
       end
+    end
 
-      @@css_cache[path]
-    rescue NoMethodError => ex
-      # Log an error and return empty css:
-      Rails.logger.try(:warn, ex.message)
-      ''
+    def has_inline_css?(doc)
+      not doc.search('style[@type="text/css"]').empty?
     end
 
-    def assets_enabled?
-      Rails.configuration.assets.enabled rescue false
+    def load_css(url)
+      path = extract_path(url)
+
+      @cache[path] = STRATEGIES.each do |strategy|
+                       css = strategy.load(path)
+                       break css if css
+                     end
     end
 
-    def request_and_unzip(file)
-      url = [
-        Rails.configuration.action_controller.asset_host,
-        Rails.configuration.assets.prefix.sub(/^\//, ''),
-        Rails.configuration.assets.digests[file]
-      ].join('/')
-      response = Kernel.open(url)
-      begin
-        Zlib::GzipReader.new(response).read
-      rescue Zlib::GzipFile::Error
-        response.rewind
-        response.read
+    # Extracts the path of a url.
+    def extract_path(url)
+      if url.is_a? String
+        # Remove everything after ? including ?
+        url = url[0..(url.index('?') - 1)] if url.include? '?'
+        # Remove the host
+        url = url.sub(/^https?\:\/\/[^\/]*/, '') if url.index('http') == 0
+      else
+        url
       end
     end
   end

data/lib/premailer-rails3/css_loaders.rb

@@ -0,0 +1,91 @@
+module PremailerRails
+  module CSSLoaders
+    # Loads the CSS from cache when not in development env.
+    module CacheLoader
+      extend self
+
+      def load(path)
+        unless Rails.env.development?
+          CSSHelper.cache[path]
+        end
+      end
+    end
+
+    # Loads the CSS from Hassle middleware if present.
+    module HassleLoader
+      extend self
+
+      def load(path)
+        if hassle_enabled?
+          File.read("#{Rails.root}/tmp/hassle#{normalized_path(path)}")
+        end
+      end
+
+      def hassle_enabled?
+        Rails.configuration.middleware.include? Hassle rescue false
+      end
+
+      def normalized_path(path)
+        path == :default ? '/stylesheets/email.css' : path
+      end
+    end
+
+    # Loads the CSS from the asset pipeline.
+    module AssetPipelineLoader
+      extend self
+
+      def load(path)
+        if assets_enabled?
+          file = file_name(path)
+          if asset = Rails.application.assets.find_asset(file)
+            asset.to_s
+          else
+            request_and_unzip(file)
+          end
+        end
+      end
+
+      def assets_enabled?
+        Rails.configuration.assets.enabled rescue false
+      end
+
+      def file_name(path)
+        if path == :default
+          'email.css'
+        else
+          path.sub("#{Rails.configuration.assets.prefix}/", '') \
+            .sub(/-.*\.css$/, '.css')
+        end
+      end
+
+      def request_and_unzip(file)
+        url = [
+          Rails.configuration.action_controller.asset_host,
+          Rails.configuration.assets.prefix.sub(/^\//, ''),
+          Rails.configuration.assets.digests[file]
+        ].join('/')
+        response = Kernel.open(url)
+
+        begin
+          Zlib::GzipReader.new(response).read
+        rescue Zlib::GzipFile::Error, Zlib::Error
+          response.rewind
+          response.read
+        end
+      end
+    end
+
+    # Loads the CSS from the file system.
+    module FileSystemLoader
+      extend self
+
+      def load(path)
+        File.read("#{Rails.root}/public#{normalized_path(path)}")
+      end
+
+      def normalized_path(path)
+        path == :default ? '/stylesheets/email.css' : path
+      end
+    end
+  end
+end

data/lib/premailer-rails3/version.rb

@@ -1,3 +1,3 @@
 module PremailerRails
-  VERSION = "1.2.0"
+  VERSION = '1.3.0'
 end

data/spec/fixtures/html.rb

@@ -28,11 +28,15 @@ module Fixtures
         links << LINK % "http://example.com/#{file}"
       end
 
-      TEMPLATE % links.join("\n")
+      TEMPLATE % links.join
     end
 
     def with_no_css_link
       with_css_links
     end
+
+    def with_style_block
+      TEMPLATE % '<style type="text/css">p { color: red; }</style>'
+    end
   end
 end

data/spec/fixtures/message.rb

@@ -19,6 +19,24 @@ module Fixtures
 </html>
     HTML
 
+    HTML_PART_WITH_CSS = <<-HTML
+<html>
+  <head>
+    <style type="text/css">
+      p { color: red; }
+    </style>
+  </head>
+  <body>
+    <p>
+      Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
+      tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim
+      veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea
+      commodo consequat.
+    </p>
+  </body>
+</html>
+    HTML
+
     TEXT_PART = <<-TEXT
 Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor
 incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis

data/spec/premailer-rails3/css_helper_spec.rb

@@ -2,10 +2,10 @@ require 'spec_helper'
 
 describe PremailerRails::CSSHelper do
   # Reset the CSS cache
-  after { PremailerRails::CSSHelper.send(:class_variable_set, '@@css_cache', {}) }
+  after { PremailerRails::CSSHelper.send(:instance_variable_set, '@cache', {}) }
 
-  def load_css_at_path(path)
-    PremailerRails::CSSHelper.send(:load_css_at_path, path)
+  def load_css(path)
+    PremailerRails::CSSHelper.send(:load_css, path)
   end
 
   def css_for_doc(doc)
@@ -21,11 +21,11 @@ describe PremailerRails::CSSHelper do
 
       it 'should return the content of both files concatenated' do
         PremailerRails::CSSHelper \
-          .expects(:load_css_at_path) \
+          .expects(:load_css) \
           .with('http://example.com/stylesheets/base.css') \
           .returns('content of base.css')
         PremailerRails::CSSHelper \
-          .expects(:load_css_at_path) \
+          .expects(:load_css) \
           .with('http://example.com/stylesheets/font.css') \
           .returns('content of font.css')
 
@@ -33,49 +33,53 @@ describe PremailerRails::CSSHelper do
       end
     end
 
-    context 'when HTML contains no linked CSS file' do
+    context 'when HTML contains style tag' do
       let(:files) { [] }
+    end
+
+    context 'when HTML contains no linked CSS file' do
+      let(:html) { Fixtures::HTML.with_style_block }
 
-      it 'should return the content of the default file' do
+      it 'should not load the default file' do
         PremailerRails::CSSHelper \
-          .expects(:load_css_at_path) \
+          .expects(:load_css) \
           .with(:default) \
-          .returns('content of default css file')
+          .never
 
-        css_for_doc(doc).should == 'content of default css file'
+        css_for_doc(doc).should be_nil
       end
     end
   end
 
-  describe '#load_css_at_path' do
+  describe '#load_css' do
     context 'when path is a url' do
       it 'should load the CSS at the local path' do
         File.expects(:read).with('RAILS_ROOT/public/stylesheets/base.css')
 
-        load_css_at_path('http://example.com/stylesheets/base.css?test')
+        load_css('http://example.com/stylesheets/base.css?test')
       end
     end
 
     context 'when file is cached' do
       it 'should return the cached value' do
-        cache = PremailerRails::CSSHelper.send(:class_variable_get, '@@css_cache')
+        cache = PremailerRails::CSSHelper.send(:instance_variable_get, '@cache')
         cache['/stylesheets/base.css'] = 'content of base.css'
 
-        load_css_at_path('http://example.com/stylesheets/base.css') \
+        load_css('http://example.com/stylesheets/base.css') \
           .should == 'content of base.css'
       end
     end
 
     context 'when in development mode' do
       it 'should not return cached values' do
-        cache = PremailerRails::CSSHelper.send(:class_variable_get, '@@css_cache')
+        cache = PremailerRails::CSSHelper.send(:instance_variable_get, '@cache')
         cache['/stylesheets/base.css'] = 'cached content of base.css'
         File.expects(:read) \
             .with('RAILS_ROOT/public/stylesheets/base.css') \
             .returns('new content of base.css')
         Rails.env.stubs(:development?).returns(true)
 
-        load_css_at_path('http://example.com/stylesheets/base.css') \
+        load_css('http://example.com/stylesheets/base.css') \
           .should == 'new content of base.css'
       end
     end
@@ -90,7 +94,7 @@ describe PremailerRails::CSSHelper do
             .with('RAILS_ROOT/tmp/hassle/stylesheets/email.css') \
             .returns('content of default css')
 
-        load_css_at_path(:default).should == 'content of default css'
+        load_css(:default).should == 'content of default css'
       end
 
       it 'should return the content of the file compiled by Hassle' do
@@ -98,7 +102,7 @@ describe PremailerRails::CSSHelper do
             .with('RAILS_ROOT/tmp/hassle/stylesheets/base.css') \
             .returns('content of base.css')
 
-        load_css_at_path('http://example.com/stylesheets/base.css') \
+        load_css('http://example.com/stylesheets/base.css') \
           .should == 'content of base.css'
       end
     end
@@ -118,7 +122,7 @@ describe PremailerRails::CSSHelper do
                                 .with('email.css') \
                                 .returns(mock(:to_s => 'content of default css'))
 
-        load_css_at_path(:default).should == 'content of default css'
+        load_css(:default).should == 'content of default css'
       end
 
       it 'should return the content of the file compiled by Rails' do
@@ -126,7 +130,7 @@ describe PremailerRails::CSSHelper do
                                 .with('base.css') \
                                 .returns(mock(:to_s => 'content of base.css'))
 
-        load_css_at_path('http://example.com/assets/base.css') \
+        load_css('http://example.com/assets/base.css') \
           .should == 'content of base.css'
       end
 
@@ -136,7 +140,7 @@ describe PremailerRails::CSSHelper do
                          .with('base.css') \
                          .returns(mock(:to_s => 'content of base.css'))
 
-        load_css_at_path(
+        load_css(
           'http://example.com/assets/base-089e35bd5d84297b8d31ad552e433275.css'
         ).should == 'content of base.css'
       end
@@ -165,7 +169,7 @@ describe PremailerRails::CSSHelper do
         it 'should request the file' do
           Kernel.expects(:open).with(url).returns(string_io)
 
-          load_css_at_path(
+          load_css(
             'http://example.com/assets/base.css'
           ).should == 'content of base.css'
         end
@@ -173,7 +177,7 @@ describe PremailerRails::CSSHelper do
         it 'should request the same file when path contains file fingerprint' do
           Kernel.expects(:open).with(url).returns(string_io)
 
-          load_css_at_path(
+          load_css(
             'http://example.com/assets/base-089e35bd5d84297b8d31ad552e433275.css'
           ).should == 'content of base.css'
         end
@@ -186,7 +190,7 @@ describe PremailerRails::CSSHelper do
             .with('RAILS_ROOT/public/stylesheets/email.css') \
             .returns('content of default css')
 
-        load_css_at_path(:default).should == 'content of default css'
+        load_css(:default).should == 'content of default css'
       end
 
       it 'should return the content of the static file' do
@@ -194,7 +198,7 @@ describe PremailerRails::CSSHelper do
             .with('RAILS_ROOT/public/stylesheets/base.css') \
             .returns('content of base.css')
 
-        load_css_at_path('http://example.com/stylesheets/base.css') \
+        load_css('http://example.com/stylesheets/base.css') \
           .should == 'content of base.css'
       end
     end

data/spec/premailer-rails3/premailer_spec.rb

@@ -16,11 +16,21 @@ describe PremailerRails::Premailer do
       end
 
       describe '#to_inline_css' do
-        it 'should return the HTML with the CSS inlined' do
-          PremailerRails::CSSHelper.stubs(:css_for_doc).returns('p { color: red; }')
-          html = Fixtures::Message::HTML_PART
-          premailer = PremailerRails::Premailer.new(html)
-          premailer.to_inline_css.should include '<p style="color: red;">'
+        context 'when inline CSS block present' do
+          it 'should return the HTML with the CSS inlined' do
+            PremailerRails::CSSHelper.stubs(:css_for_doc).returns('p { color: red; }')
+            html = Fixtures::Message::HTML_PART
+            premailer = PremailerRails::Premailer.new(html)
+            premailer.to_inline_css.should include '<p style="color: red;">'
+          end
+        end
+
+        context 'when CSS is loaded externally' do
+          it 'should return the HTML with the CSS inlined' do
+            html = Fixtures::Message::HTML_PART_WITH_CSS
+            premailer = PremailerRails::Premailer.new(html)
+            premailer.to_inline_css.should include '<p style="color: red;">'
+          end
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: premailer-rails3
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-12 00:00:00.000000000 Z
+date: 2012-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: premailer
@@ -151,6 +151,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -158,6 +159,7 @@ files:
 - Rakefile
 - lib/premailer-rails3.rb
 - lib/premailer-rails3/css_helper.rb
+- lib/premailer-rails3/css_loaders.rb
 - lib/premailer-rails3/hook.rb
 - lib/premailer-rails3/premailer.rb
 - lib/premailer-rails3/version.rb