premailer-rails 1.5.1 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c14b05b4d57365b47366c6c56d7080ed7610bb0e
-  data.tar.gz: 3bb5ba65597cc2fe6d40fc053785683ad0e08d69
+  metadata.gz: 5a2073ed1c61cca54326ea63233c597afc05673a
+  data.tar.gz: 8a067a0516b3ff404ead0d70b147408a0ca88dea
 SHA512:
-  metadata.gz: af255aab35b0a2ebbbe9fc554d45bbf190878531ba2faef489cc88dcc4d1b40031713da7a21f8cdbbc1cdc49fdd8e96ca32ac2a3f439f40af4602fc3874c4bbc
-  data.tar.gz: 7aed5714d084a540a096da8df6606894d68616dbcfe1de3fb9bdcaee3eeb61624c2f1377064a850c10c6e454926ef8fda3815fc8aaca635f1398b5bd4e8c2046
+  metadata.gz: 613d3feeeceb8be28f49e32c656b945d98ce23b6b22ef597e063a519a3e798e250e8ae80fe0a2bcd700acd6ee6b13efbdf92bf9813266c61aa0ef147d9fc4e45
+  data.tar.gz: 869483a1f22ae2e38587eb73f763fa11f430271c74a30f0ebdbb08164893113dd962027b43524abec789467481209e764d98cfb4798305b1c9662975a5ed8fa2

data/.travis.yml

@@ -1,8 +1,18 @@
 language: ruby
+cache: bundler
 script: "bundle exec rspec"
 rvm:
   - 2.0.0
   - 1.9.3
+  - ruby-head
   - jruby-19mode
   - rbx-19mode
-env: "JRUBY_OPTS=--debug"
+env:
+  - "ACTION_MAILER_VERSION=3.1.0"
+  - "ACTION_MAILER_VERSION=3.2.0"
+  - "ACTION_MAILER_VERSION=4.0.0"
+  - "ACTION_MAILER_VERSION=head"
+matrix:
+  allow_failures:
+    - env: "ACTION_MAILER_VERSION=head"
+    - rvm: ruby-head

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## v1.6.0
+
+- Only use asset pipeline if Rails is defined and if compile is true
+
+- Depend on actionmailer instead of rails
+
+- Check whether `::Rails` is defined before using it
+
+- Add ability to skip premailer
+
+- Test against multiple action mailer versions on travis
+
+- Ensure CSS strings are always UTF-8 encoded
+
+- Require premailer version >= 1.7.9
+
 ## v1.5.1
 
 - Prefer precompiled assets over asset pipeline

data/Gemfile

@@ -2,6 +2,16 @@ source "https://rubygems.org"
 
 gemspec
 
+action_mailer_version = ENV.fetch('ACTION_MAILER_VERSION', '4.0')
+
+if action_mailer_version == 'head'
+  git 'git://github.com/rails/rails.git' do
+    gem 'actionmailer'
+  end
+else
+  gem 'actionmailer', "~> #{action_mailer_version}"
+end
+
 platforms :jruby do
   gem "jruby-openssl"
 end

data/README.md

@@ -1,78 +1,120 @@
 # premailer-rails
 
-[![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)
+CSS styled emails without the hassle.
 
-This gem is a no config solution for the wonderful [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.
+[![Build Status][build-image]][build-link]
+[![Gem Version][gem-image]][gem-link]
+[![Dependency Status][deps-image]][deps-link]
+[![Code Climate][gpa-image]][gpa-link]
+[![Coverage Status][cov-image]][cov-link]
+[![Bitdeli Badge][stats-image]][stats-link]
 
-By default it inlines all inline `<style>` declarations and all the CSS files that are linked to in the HTML:
+## Introduction
 
-```html
-<link rel="stylesheet" ... />
-```
+This gem is a drop in solution for styling HTML emails with CSS without having
+to do the hard work yourself.
 
-Don't worry about the host in the CSS URL since this will be ignored.
+Styling emails is not just a matter of linking to a stylesheet. Most clients,
+especially web clients, ignore linked stylesheets or `<style>` tags in the HTML.
+The workaround is to write all the CSS rules in the `style` attribute of each
+tag inside your email. This is a rather tedious and hard to maintain approach.
 
-The retrieval of the file depends on your assets configuration:
+Premailer to the rescue! The great [premailer] gem applies all CSS rules to each
+matching HTML element by adding them to the `style` attribute. This allows you
+to keep HTML and CSS in separate files, just as you're used to from web
+development, thus keeping your sanity.
 
-* 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
-  found (e.g. it is only available on a CDN and not locally), it will be
-  HTTP requested.
+This gem is an adapter for premailer to work with [actionmailer] out of the box.
+Actionmailer is the email framework used in Rails, which also works outside of
+Rails. Although premailer-rails has certain Rails specific features, **it also
+works in the absence of Rails** making it compatible with other frameworks such
+as sinatra.
 
-* Classic static assets: It will try to load the CSS file located in
-  `public/stylesheets/`
+premailer-rails works with actionmailer by registering a delivery hook. This
+causes all emails that are delivered to be processed by premailer-rails. This
+means that, by simply including premailer-rails in your `Gemfile`, you'll get
+styled emails without having to set anything up.
 
 ## Installation
 
-Simply add the gem to your Gemfile in your Rails project:
+Simply add the gem to your `Gemfile`:
 
-    gem 'premailer-rails'
+```ruby
+gem 'premailer-rails'
+```
 
-premailer-rails requires either nokogiri or hpricot. It doesn't list them as a dependency so you can choose which one to use.
+premailer-rails requires either [nokogiri] or [hpricot]. It doesn't list them as
+a dependency so you can choose which one to use. Since hpricot is no longer
+maintained, I suggest you to go with nokogiri. Add either one to your `Gemfile`:
 
-    gem 'nokogiri'
-    # or
-    gem 'hpricot'
+```ruby
+gem 'nokogiri'
+# or
+gem 'hpricot'
+```
 
-If both are loaded for some reason, premailer chooses hpricot.
+If both gems are loaded for some reason, premailer chooses hpricot.
 
 That's it!
 
 ## Configuration
 
 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:
+pass these options on to the underlying premailer instance, specify them
+as follows (in Rails you could do that in an initializer such as
+`config/initializers/premailer_rails.rb`):
 
 ```ruby
-Premailer::Rails.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)
-
-The default configs are:
+For a list of options, refer to the [premailer documentation]. The default
+configs are:
 
 ```ruby
 {
-  input_encoding:     'UTF-8',
-  inputencoding:      'UTF-8',
+  input_encoding: '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 automatically generate a text part from the html part, set
+the config `:generate_text_part` to false.
 
-If you don't want to automatically generate a text part from the html part, set the config `:generate_text_part` to false.
+Note that the options `:with_html_string` and `:css_string` are used internally
+by premailer-rails and thus will be overridden.
 
-Note that the options `:with_html_string` and `:css_string` are used internally and thus will be overridden.
+## Usage
 
+premailer-rails processes all outgoing emails by default. If you wish to skip
+premailer for a certain email, simply set the `:skip_premailer` header:
 
-[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/fphilipe/premailer-rails/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
+```ruby
+class UserMailer < ActionMailer::Base
+  def welcome_email(user)
+    mail to: user.email,
+         subject: 'Welcome to My Awesome Site',
+         skip_premailer: true
+  end
+end
+```
 
+[build-image]: https://travis-ci.org/fphilipe/premailer-rails.png
+[build-link]:  https://travis-ci.org/fphilipe/premailer-rails
+[gem-image]:   https://badge.fury.io/rb/premailer-rails.png
+[gem-link]:    https://rubygems.org/gems/premailer-rails
+[deps-image]:  https://gemnasium.com/fphilipe/premailer-rails.png
+[deps-link]:   https://gemnasium.com/fphilipe/premailer-rails
+[gpa-image]:   https://codeclimate.com/github/fphilipe/premailer-rails.png
+[gpa-link]:    https://codeclimate.com/github/fphilipe/premailer-rails
+[cov-image]:   https://coveralls.io/repos/fphilipe/premailer-rails/badge.png
+[cov-link]:    https://coveralls.io/r/fphilipe/premailer-rails
+[stats-image]: https://d2weczhvl823v0.cloudfront.net/fphilipe/premailer-rails/trend.png
+[stats-link]:  https://bitdeli.com/
+
+[premailer]:    https://github.com/premailer/premailer
+[actionmailer]: https://github.com/rails/rails/tree/master/actionmailer
+[nokogiri]:     https://github.com/sparklemotion/nokogiri
+[hpricot]:      https://github.com/hpricot/hpricot
+
+[premailer documentation]: http://rubydoc.info/gems/premailer/1.7.3/Premailer:initialize

data/VERSION

@@ -1 +1 @@
-1.5.1
+1.6.0

data/lib/premailer/rails.rb

@@ -11,8 +11,7 @@ require 'premailer/rails/nokogiri_fix'
 class Premailer
   module Rails
     @config = {
-      input_encoding:     'UTF-8',
-      inputencoding:      'UTF-8',
+      input_encoding: 'UTF-8',
       generate_text_part: true
     }
     class << self

data/lib/premailer/rails/css_helper.rb

@@ -9,13 +9,14 @@ class Premailer
       STRATEGIES = [
         CSSLoaders::CacheLoader,
         CSSLoaders::FileSystemLoader,
-        CSSLoaders::AssetPipelineLoader
+        CSSLoaders::AssetPipelineLoader,
+        CSSLoaders::NetworkLoader
       ]
 
       # 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")
+        urls.map { |url| load_css(url).force_encoding('UTF-8') }.join("\n")
       end
 
       private
@@ -27,24 +28,11 @@ class Premailer
       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
+        @cache[url] =
+          STRATEGIES.each do |strategy|
+            css = strategy.load(url)
+            break css if css
+          end
       end
     end
   end

data/lib/premailer/rails/css_loaders.rb

@@ -1,65 +1,6 @@
 require 'uri'
-require 'zlib'
 
-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
-              Net::HTTP.get(uri_for_path(path))
-            end
-          end
-        end
-
-        def assets_enabled?
-          ::Rails.configuration.assets.enabled rescue false
-        end
-
-        def file_name(path)
-          path
-            .sub("#{::Rails.configuration.assets.prefix}/", '')
-            .sub(/-\h{32}\.css$/, '.css')
-        end
-
-        def uri_for_path(path)
-          URI(path).tap do |uri|
-            scheme, host =
-              ::Rails.configuration.action_controller.asset_host.split(%r{:?//})
-            scheme = 'http' if scheme.blank?
-            uri.scheme ||= scheme
-            uri.host ||= host
-          end
-        end
-      end
-
-      # Loads the CSS from the file system.
-      module FileSystemLoader
-        extend self
-
-        def load(path)
-          file_path = "#{::Rails.root}/public#{path}"
-          File.read(file_path) if File.exist?(file_path)
-        end
-      end
-    end
-  end
-end
+require 'premailer/rails/css_loaders/cache_loader'
+require 'premailer/rails/css_loaders/file_system_loader'
+require 'premailer/rails/css_loaders/asset_pipeline_loader'
+require 'premailer/rails/css_loaders/network_loader'

data/lib/premailer/rails/css_loaders/asset_pipeline_loader.rb

@@ -0,0 +1,27 @@
+class Premailer
+  module Rails
+    module CSSLoaders
+      module AssetPipelineLoader
+        extend self
+
+        def load(url)
+          if asset_pipeline_present?
+            file = file_name(url)
+            asset = ::Rails.application.assets.find_asset(file)
+            asset.to_s if asset
+          end
+        end
+
+        def asset_pipeline_present?
+          defined?(::Rails) and ::Rails.application.respond_to?(:assets)
+        end
+
+        def file_name(url)
+          URI(url).path
+            .sub("#{::Rails.configuration.assets.prefix}/", '')
+            .sub(/-\h{32}\.css$/, '.css')
+        end
+      end
+    end
+  end
+end

data/lib/premailer/rails/css_loaders/cache_loader.rb

@@ -0,0 +1,19 @@
+class Premailer
+  module Rails
+    module CSSLoaders
+      module CacheLoader
+        extend self
+
+        def load(url)
+          unless development_env?
+            CSSHelper.cache[url]
+          end
+        end
+
+        def development_env?
+          defined?(::Rails) and ::Rails.env.development?
+        end
+      end
+    end
+  end
+end

data/lib/premailer/rails/css_loaders/file_system_loader.rb

@@ -0,0 +1,15 @@
+class Premailer
+  module Rails
+    module CSSLoaders
+      module FileSystemLoader
+        extend self
+
+        def load(url)
+          path = URI(url).path
+          file_path = "public#{path}"
+          File.read(file_path) if File.exist?(file_path)
+        end
+      end
+    end
+  end
+end

data/lib/premailer/rails/css_loaders/network_loader.rb

@@ -0,0 +1,32 @@
+class Premailer
+  module Rails
+    module CSSLoaders
+      module NetworkLoader
+        extend self
+
+        def load(url)
+          uri = uri_for_url(url)
+          Net::HTTP.get(uri) if uri
+        end
+
+        def uri_for_url(url)
+          uri = URI(url)
+
+          if not valid_uri?(uri) and defined?(::Rails)
+            scheme, host =
+              ::Rails.configuration.action_controller.asset_host.split(%r{:?//})
+            scheme = 'http' if scheme.blank?
+            uri.scheme ||= scheme
+            uri.host ||= host
+          end
+
+          uri if valid_uri?(uri)
+        end
+
+        def valid_uri?(uri)
+          uri.host.present? && uri.scheme.present?
+        end
+      end
+    end
+  end
+end