premailer-rails3 1.3.1 → 1.3.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a17a57069bfce9809df15e905f26bb4ab2721e25
+  data.tar.gz: 7ba91f1ffa9c5073f5146ed5249eef1560114eb8
+SHA512:
+  metadata.gz: d922dfeb7c62cb82b9a61be651a5ccee3f98614ef747d289505351dd17f17ead55cbe84dae559fa3e53e8fe3afb8d11662c04958639435e10ab00b17a3ff40e8
+  data.tar.gz: 22daec1ea1a916420a146d6d79f516f983ad2e45ba2462e56fd6b51e96b83bdafb79ec5657fbd6b38f459f225135a469cd866b2c1581197208ee8544afae5635

data/.travis.yml

@@ -1,8 +1,10 @@
 language: ruby
+script: "bundle exec rspec"
 rvm:
+  - 2.0.0
   - 1.9.3
+  - 1.8.7
   - jruby-18mode # JRuby in 1.8 mode
   - jruby-19mode # JRuby in 1.9 mode
   - rbx-18mode
   - rbx-19mode
-  - 1.8.7

data/Gemfile

@@ -2,3 +2,7 @@ source "http://rubygems.org"
 
 # Specify your gem's dependencies in premailer-rails3.gemspec
 gemspec
+
+platforms :jruby do
+  gem "jruby-openssl"
+end

data/README.md

@@ -1,9 +1,12 @@
-# premailer-rails3
+# premailer-rails
 
-[![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)
+[![Build Status](https://travis-ci.org/fphilipe/premailer-rails.png)](https://travis-ci.org/fphilipe/premailer-rails)
+[![Gem Version](https://badge.fury.io/rb/premailer-rails.png)](http://badge.fury.io/rb/premailer-rails)
+[![Dependency Status](https://gemnasium.com/fphilipe/premailer-rails.png)](https://gemnasium.com/fphilipe/premailer-rails)
+[![Code Climate](https://codeclimate.com/github/fphilipe/premailer-rails.png)](https://codeclimate.com/github/fphilipe/premailer-rails)
 
 This gem is a no config solution for the wonderful
-[Premailer gem](https://github.com/alexdunae/premailer) to be used with Rails 3.
+[Premailer gem](https://github.com/alexdunae/premailer) to be used with Rails.
 It uses interceptors which were introduced in Rails 3 and tweaks all mails which
 are `deliver`ed and adds a plain text part to them and inlines all CSS rules
 into the HTML part.
@@ -16,11 +19,8 @@ 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 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:
+Every CSS file 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/`. If the asset can't be
@@ -38,9 +38,9 @@ app. The retrieval of the file depends on your assets configuration:
 
 Simply add the gem to your Gemfile in your Rails project:
 
-    gem 'premailer-rails3'
+    gem 'premailer-rails'
 
-premailer-rails3 requires either nokogiri or hpricot. It doesn't list them as a
+premailer-rails requires either nokogiri or hpricot. It doesn't list them as a
 dependency so you can choose which one to use.
 
     gem 'nokogiri'
@@ -53,13 +53,13 @@ That's it!
 
 ## Configuration
 
-Premailer itself accepts a number of options. In order for premailer-rails3 to
+Premailer itself accepts a number of options. In order for premailer-rails to
 pass these options on to the underlying premailer instance, specify them in an
 initializer:
 
 ```ruby
-PremailerRails.config.merge!(:preserve_styles => true,
-                             :remove_ids      => true)
+Premailer::Rails.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)

data/VERSION

@@ -0,0 +1 @@
+1.3.2

data/lib/premailer/rails.rb

@@ -0,0 +1,23 @@
+require 'premailer'
+require 'action_mailer'
+
+require 'premailer/rails/css_loaders'
+require 'premailer/rails/css_helper'
+require 'premailer/rails/customized_premailer'
+require 'premailer/rails/hook'
+require 'premailer/rails/nokogiri_fix'
+
+class Premailer
+  module Rails
+    @config = {
+      :input_encoding     => 'UTF-8',
+      :inputencoding      => 'UTF-8',
+      :generate_text_part => true
+    }
+    class << self
+      attr_accessor :config
+    end
+  end
+end
+
+ActionMailer::Base.register_interceptor(Premailer::Rails::Hook)

data/lib/premailer/rails/css_helper.rb

@@ -0,0 +1,58 @@
+require 'open-uri'
+require 'zlib'
+
+class Premailer
+  module Rails
+    module CSSHelper
+      extend self
+
+      @cache = {}
+      attr :cache
+
+      STRATEGIES = [
+        CSSLoaders::CacheLoader,
+        CSSLoaders::AssetPipelineLoader,
+        CSSLoaders::FileSystemLoader
+      ]
+
+      # Returns all linked CSS files concatenated as string.
+      def css_for_doc(doc)
+        urls = css_urls_in_doc(doc)
+        urls.map { |url| load_css(url) }.join("\n")
+      end
+
+      private
+
+      def css_urls_in_doc(doc)
+        doc.search('link[@type="text/css"]').map do |link|
+          link.attributes['href'].to_s
+        end
+      end
+
+      def has_inline_css?(doc)
+        not doc.search('style[@type="text/css"]').empty?
+      end
+
+      def load_css(url)
+        path = extract_path(url)
+
+        @cache[path] = STRATEGIES.each do |strategy|
+                         css = strategy.load(path)
+                         break css if css
+                       end
+      end
+
+      # 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
+        end
+
+        url
+      end
+    end
+  end
+end

data/lib/premailer/rails/css_loaders.rb

@@ -0,0 +1,66 @@
+class Premailer
+  module Rails
+    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 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)
+          path.sub("#{::Rails.configuration.assets.prefix}/", '') \
+            .sub(/-.*\.css$/, '.css')
+        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#{path}")
+        end
+      end
+    end
+  end
+end

data/lib/premailer/rails/customized_premailer.rb

@@ -0,0 +1,20 @@
+class Premailer
+  module Rails
+    class CustomizedPremailer < ::Premailer
+      def initialize(html)
+        # In order to pass the CSS as string to super it is necessary to access
+        # the parsed HTML beforehand. To do so, the adapter needs to be
+        # initialized. The ::Premailer::Adaptor handles the discovery of a
+        # suitable adaptor (Nokogiri or Hpricot). To make load_html work, an
+        # adaptor needs to be included and @options[:with_html_string] needs to
+        # be set. For further information, refer to ::Premailer#initialize.
+        @options = Rails.config.merge(:with_html_string => true)
+        Premailer.send(:include, Adapter.find(Adapter.use))
+        doc = load_html(html)
+
+        options = @options.merge(:css_string => CSSHelper.css_for_doc(doc))
+        super(html, options)
+      end
+    end
+  end
+end

data/lib/premailer/rails/hook.rb

@@ -0,0 +1,45 @@
+class Premailer
+  module Rails
+    class Hook
+      def self.delivering_email(message)
+        # If the mail only has one part, it may be stored in message.body. In that
+        # case, if the mail content type is text/html, the body part will be the
+        # html body.
+        if message.html_part
+          html_body       = message.html_part.body.to_s
+          needs_multipart = true
+          message.parts.delete(message.html_part)
+        elsif message.content_type =~ /text\/html/
+          html_body       = message.body.to_s
+          message.body    = nil
+          needs_multipart = Rails.config[:generate_text_part]
+        end
+
+        if html_body
+          premailer = CustomizedPremailer.new(html_body)
+          charset   = message.charset
+
+          if needs_multipart
+            # IMPORTANT: Plain text part must be generated before CSS is inlined.
+            # Not doing so results in CSS declarations visible in the plain text
+            # part.
+            if Rails.config[:generate_text_part] \
+            and not message.text_part
+              message.text_part do
+                content_type "text/plain; charset=#{charset}"
+                body premailer.to_plain_text
+              end
+            end
+
+            message.html_part do
+              content_type "text/html; charset=#{charset}"
+              body premailer.to_inline_css
+            end
+          else
+            message.body = premailer.to_inline_css
+          end
+        end
+      end
+    end
+  end
+end

data/lib/premailer/rails/nokogiri_fix.rb

@@ -0,0 +1,13 @@
+require 'premailer/adapter/nokogiri'
+
+Premailer::Adapter::Nokogiri.module_eval do
+  # Patch load_html method to fix character encoding issues.
+  def load_html(html)
+    if RUBY_VERSION.to_f >= 1.9
+      html = html.force_encoding('UTF-8').encode!
+      ::Nokogiri::HTML(html) {|c| c.recover }
+    else
+      ::Nokogiri::HTML(html, nil, 'UTF-8') {|c| c.recover }
+    end
+  end
+end

data/lib/premailer/rails/premailer.rb

@@ -0,0 +1,20 @@
+class Premailer
+  module Rails
+    class CustomizedPremailer < ::Premailer
+      def initialize(html)
+        # In order to pass the CSS as string to super it is necessary to access
+        # the parsed HTML beforehand. To do so, the adapter needs to be
+        # initialized. The ::Premailer::Adaptor handles the discovery of a
+        # suitable adaptor (Nokogiri or Hpricot). To make load_html work, an
+        # adaptor needs to be included and @options[:with_html_string] needs to
+        # be set. For further information, refer to ::Premailer#initialize.
+        @options = Rails.config.merge(:with_html_string => true)
+        Premailer.send(:include, Adapter.find(Adapter.use))
+        doc = load_html(html)
+
+        options = @options.merge(:css_string => CSSHelper.css_for_doc(doc))
+        super(html, options)
+      end
+    end
+  end
+end

data/lib/premailer/rails/version.rb

@@ -0,0 +1,7 @@
+class Premailer
+  module Rails
+    VERSION = File.read(
+      File.expand_path('../../../../VERSION', __FILE__)
+    ).strip
+  end
+end

data/lib/premailer/rails3.rb

@@ -0,0 +1,23 @@
+require 'premailer'
+require 'action_mailer'
+
+require 'premailer/rails/css_loaders'
+require 'premailer/rails/css_helper'
+require 'premailer/rails/customized_premailer'
+require 'premailer/rails/hook'
+require 'premailer/rails/nokogiri_fix'
+
+class Premailer
+  module Rails
+    @config = {
+      :input_encoding     => 'UTF-8',
+      :inputencoding      => 'UTF-8',
+      :generate_text_part => true
+    }
+    class << self
+      attr_accessor :config
+    end
+  end
+end
+
+ActionMailer::Base.register_interceptor(Premailer::Rails::Hook)

data/premailer-rails3.gemspec

@@ -1,29 +1,30 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
-require "premailer-rails3/version"
+require "premailer/rails/version"
 
 Gem::Specification.new do |s|
   s.name        = "premailer-rails3"
-  s.version     = PremailerRails::VERSION
+  s.version     = Premailer::Rails::VERSION
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Philipe Fatio"]
   s.email       = ["philipe.fatio@gmail.com"]
-  s.homepage    = "https://github.com/fphilipe/premailer-rails3"
-  s.summary     = %q{Easily create HTML emails in Rails 3.}
-  s.description = %q{This gem brings you the power of the premailer gem to Rails 3
-                     without any configuration needs. Create HTML emails, include a
-                     CSS file as you do in a normal HTML document and premailer will
-                     inline the included CSS.}
+  s.homepage    = "https://github.com/fphilipe/premailer-rails"
+  s.summary     = %q{Easily create styled HTML emails in Rails.}
+  s.description = %q{This gem brings you the power of the premailer gem to Rails
+                     without any configuration needs. Create HTML emails,
+                     include a CSS file as you do in a normal HTML document and
+                     premailer will inline the included CSS.}
 
-  s.rubyforge_project = "premailer-rails3"
-
-  s.files         = `git ls-files`.split("\n")
+  files = `git ls-files`.split("\n")
+  files.delete('premailer-rails.gemspec')
+  files.push('premailer-rails3.gemspec')
+  s.files         = files
   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_dependency("premailer", ["~> 1.7"])
-  s.add_dependency("rails", ["~> 3"])
+  s.add_dependency("rails", [">= 3"])
 
   s.add_development_dependency 'rspec-core'
   s.add_development_dependency 'rspec-expectations'
@@ -31,4 +32,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'mail'
   s.add_development_dependency 'nokogiri'
   s.add_development_dependency 'hpricot'
+
+  s.post_install_message = 'This gem has been renamed to premailer-rails. This is the last version that is released under the old name. Please change this in your Gemfile.'
 end

data/spec/{premailer-rails3 → lib}/css_helper_spec.rb

@@ -1,15 +1,15 @@
 require 'spec_helper'
 
-describe PremailerRails::CSSHelper do
+describe Premailer::Rails::CSSHelper do
   # Reset the CSS cache
-  after { PremailerRails::CSSHelper.send(:instance_variable_set, '@cache', {}) }
+  after { Premailer::Rails::CSSHelper.send(:instance_variable_set, '@cache', {}) }
 
   def load_css(path)
-    PremailerRails::CSSHelper.send(:load_css, path)
+    Premailer::Rails::CSSHelper.send(:load_css, path)
   end
 
   def css_for_doc(doc)
-    PremailerRails::CSSHelper.css_for_doc(doc)
+    Premailer::Rails::CSSHelper.css_for_doc(doc)
   end
 
   describe '#css_for_doc' do
@@ -20,11 +20,11 @@ describe PremailerRails::CSSHelper do
       let(:files) { %w[ stylesheets/base.css stylesheets/font.css ] }
 
       it 'should return the content of both files concatenated' do
-        PremailerRails::CSSHelper \
+        Premailer::Rails::CSSHelper \
           .expects(:load_css) \
           .with('http://example.com/stylesheets/base.css') \
           .returns('content of base.css')
-        PremailerRails::CSSHelper \
+        Premailer::Rails::CSSHelper \
           .expects(:load_css) \
           .with('http://example.com/stylesheets/font.css') \
           .returns('content of font.css')
@@ -32,34 +32,6 @@ describe PremailerRails::CSSHelper do
         css_for_doc(doc).should == "content of base.css\ncontent of font.css"
       end
     end
-
-    context 'when HTML contains style tag' do
-      let(:files) { [] }
-      let(:html) { Fixtures::HTML.with_style_block }
-
-      it 'should not load the default file' do
-        PremailerRails::CSSHelper \
-          .expects(:load_css) \
-          .with(:default) \
-          .never
-
-        css_for_doc(doc).should be_nil
-      end
-    end
-
-    context 'when HTML contains no linked CSS file nor style block tag' do
-      let(:files) { [] }
-      let(:html) { Fixtures::HTML.with_no_css_link }
-
-      it 'should load the default file' do
-        PremailerRails::CSSHelper \
-          .expects(:load_css) \
-          .with(:default) \
-          .returns('content of default css')
-
-        css_for_doc(doc).should == 'content of default css'
-      end
-    end
   end
 
   describe '#load_css' do
@@ -81,7 +53,8 @@ describe PremailerRails::CSSHelper do
 
     context 'when file is cached' do
       it 'should return the cached value' do
-        cache = PremailerRails::CSSHelper.send(:instance_variable_get, '@cache')
+        cache =
+          Premailer::Rails::CSSHelper.send(:instance_variable_get, '@cache')
         cache['/stylesheets/base.css'] = 'content of base.css'
 
         load_css('http://example.com/stylesheets/base.css') \
@@ -91,7 +64,8 @@ describe PremailerRails::CSSHelper do
 
     context 'when in development mode' do
       it 'should not return cached values' do
-        cache = PremailerRails::CSSHelper.send(:instance_variable_get, '@cache')
+        cache =
+          Premailer::Rails::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') \
@@ -103,29 +77,6 @@ describe PremailerRails::CSSHelper do
       end
     end
 
-    context 'when Hassle is used' do
-      before { Rails.configuration.middleware.stubs(:include?) \
-                                             .with(Hassle) \
-                                             .returns(true) }
-
-      it 'should load email.css when the default CSS is requested' do
-        File.expects(:read) \
-            .with('RAILS_ROOT/tmp/hassle/stylesheets/email.css') \
-            .returns('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
-        File.expects(:read) \
-            .with('RAILS_ROOT/tmp/hassle/stylesheets/base.css') \
-            .returns('content of base.css')
-
-        load_css('http://example.com/stylesheets/base.css') \
-          .should == 'content of base.css'
-      end
-    end
-
     context 'when Rails asset pipeline is used' do
       before {
         Rails.configuration.stubs(:assets).returns(
@@ -136,14 +87,6 @@ describe PremailerRails::CSSHelper do
         )
       }
 
-      it 'should load email.css when the default CSS is requested' do
-        Rails.application.assets.expects(:find_asset) \
-                                .with('email.css') \
-                                .returns(mock(:to_s => '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
         Rails.application.assets.expects(:find_asset) \
                                 .with('base.css') \
@@ -204,14 +147,6 @@ describe PremailerRails::CSSHelper do
     end
 
     context 'when static stylesheets are used' do
-      it 'should load email.css when the default CSS is requested' do
-        File.expects(:read) \
-            .with('RAILS_ROOT/public/stylesheets/email.css') \
-            .returns('content of default css')
-
-        load_css(:default).should == 'content of default css'
-      end
-
       it 'should return the content of the static file' do
         File.expects(:read) \
             .with('RAILS_ROOT/public/stylesheets/base.css') \