premailer-rails 1.8.0 → 1.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1acf912800a7228a1dcf6b89f5412ee87490f975
-  data.tar.gz: 2ab5e6bf63b3d7a0fa974b5495df7919eaeb9d10
+SHA256:
+  metadata.gz: 13055f85c556422022c71564c81f5816ecffd482e4514c1481212fab2c942eb7
+  data.tar.gz: 8b9093f66f195ac826382329877be7c9b863650c5bcb0c057bae0cc073b8978d
 SHA512:
-  metadata.gz: feef5aa13b18d39709bf2f9fd931eecff8876a11bf3500199f91c2ba06e15853d60787984425371b51ef4fbc60c555a7b8df38ab0e108e4c4766e4e624fba52b
-  data.tar.gz: dc7c3b13551d5445c58998154a342d79f2b4e0d56fd4b909d1264df3d0511e958d03bbd475f98a387c3c8bdec23fcead519c7a60ac150dff7955f78da46bb884
+  metadata.gz: a861465e80d026c7e221b09f0c395be4d4fb26fa3662a233de5ba8295c41f0861b79958f873830fa4bd6333bd21798298155f8cadf1cf7861f08f5348ee3f901
+  data.tar.gz: f4cd1b29b3b1a4ee43fe83971b35b6a43896298ab3c1fec8d4fc91e2fc0d1290b353bba0096e2ae45376e394f6ad00142cf3dda7447a72259c7639c01fbd4231

data/.gitignore

@@ -2,3 +2,7 @@
 doc/
 Gemfile.lock
 coverage/
+spec/rails_app/log/*
+spec/rails_app/tmp/*
+.ruby-version
+/.bundle

data/.travis.yml

@@ -1,21 +1,16 @@
+sudo: false
 language: ruby
-before_install:
-  - gem install bundler
 cache: bundler
-script: "bundle exec rspec"
+script: bundle exec rspec
 rvm:
-  - 2.1.0
-  - 2.0.0
-  - 1.9.3
-  - ruby-head
-  - jruby-19mode
-  - rbx-2
+  - 2.6.5
+  - 2.7.0
 env:
-  - "ACTION_MAILER_VERSION=3.1.0"
-  - "ACTION_MAILER_VERSION=3.2.0"
-  - "ACTION_MAILER_VERSION=4.0.0"
-  - "ACTION_MAILER_VERSION=head"
+  matrix:
+    - ACTION_MAILER_VERSION=5
+    - ACTION_MAILER_VERSION=6
+    - ACTION_MAILER_VERSION=master
 matrix:
+  fast_finish: true
   allow_failures:
-    - env: "ACTION_MAILER_VERSION=head"
-    - rvm: ruby-head
+    - env: ACTION_MAILER_VERSION=master

data/CHANGELOG.md

@@ -1,5 +1,79 @@
 # Changelog
 
+## v1.11.1
+
+- Check if `Rails.application` is defined (@pabloh, #250)
+
+## v1.11.0
+
+- Remove `force_encoding!`
+
+## v1.10.3
+
+- Remove upper version constraint for actionmailer
+
+## v1.10.2
+
+- Explicitly check for assets_manifest (@derekwheel, #214)
+
+## v1.10.1
+
+- Catch error when sprockets can't find asset (@kirs, #209)
+
+## v1.10.0
+
+- Drop support for hpricot now that premailer-rails also doesn't support it
+- Use `Rails.application.assets_manifest` instead of `Rails.application.assets` in Asset Pipeline loader (@kirs, #201)
+- Introduce `:strategies` config option that allows to control CSS fetching stragies
+
+## v1.9.7
+
+- Use `Rails.root` in `FileSystemLoader` (@stanhu, #195)
+
+## v1.9.6
+
+- Handle `relative_url_root` in when loading CSS from file system
+
+## v1.9.5
+
+- Mention license in gemspec
+
+## v1.9.4
+
+- Improve check for Rails module
+- Preserve body encoding to prevent garbled mails
+
+## v1.9.3
+
+- Add support for rails' `relative_url_root` config
+- Fix link tag removal under Hpricot
+- Pass url to `asset_host` if it responds to `call`
+- Fixed issue where urls may conflict with folder names.
+
+## v1.9.2
+
+- Update rails dependency to allow rails 5
+
+## v1.9.1
+
+- Respect data-premailer="ignore" on link tags
+- Ensure content-transfer-encoding is maintained
+
+## v1.9.0
+
+- Improved CSS loading and caching.
+- Fixed incompatibility with newer rails and sprockets versions.
+
+## v1.8.2
+
+- `Premailer::Rails::CSSLoaders::NetworkLoader` is more resilient and works even
+  if the Rails asset host is set without a URI scheme. (panthomakos)
+- Remove stylesheet links from the HTML that have been processed.
+
+## v1.8.1
+
+- Add support for longer fingerprint generated by sprocket 3.
+
 ## v1.8.0
 
 - `ActionMailer` interceptors are registered after Rails initialization and no

data/Gemfile

@@ -2,17 +2,23 @@ source 'https://rubygems.org'
 
 gemspec
 
-action_mailer_version = ENV.fetch('ACTION_MAILER_VERSION', '4.0')
+rails_version = ENV.fetch('ACTION_MAILER_VERSION', '5')
 
-if action_mailer_version == 'head'
+if rails_version == 'master'
   git 'git://github.com/rails/rails.git' do
-    gem 'actionmailer'
+    gem 'rails'
   end
+  gem 'sprockets-rails', github: 'rails/sprockets-rails'
+  gem 'arel', github: 'rails/arel'
 else
-  gem 'actionmailer', "~> #{action_mailer_version}"
+  gem 'rails', "~> #{rails_version}"
 end
 
+gem 'byebug'
+
 platforms :rbx do
   gem 'rubysl'
   gem 'racc'
 end
+
+gem 'tins', '< 1.7' if RUBY_VERSION.split('.').first.to_i < 2

data/README.md

@@ -7,7 +7,6 @@ CSS styled emails without the hassle.
 [![Dependency Status][deps-image]][deps-link]
 [![Code Climate][gpa-image]][gpa-link]
 [![Coverage Status][cov-image]][cov-link]
-[![Bitdeli Badge][stats-image]][stats-link]
 
 ## Introduction
 
@@ -40,34 +39,34 @@ styled emails without having to set anything up.
 Whenever premailer-rails processes an email, it collects the URLs of all linked
 stylesheets (`<link rel="stylesheet" href="css_url">`). Then, for each of these
 URLs, it tries to get the content through a couple of strategies. As long as
-a strategy does not return anything, the next one is used. The strategies and
-their order are as follows:
+a strategy does not return anything, the next one is used. The strategies
+available are:
 
-1.  **Cache:** If there's a file in cache matching that URL, the cache content
-    is returned.  The cache right now is rather rudimentary. Whenever a CSS file
-    is retrieved, it is stored in memory such that subsequent requests to the
-    same file are faster. The caching is disabled inside Rails in the
-    development environment.
-
-2.  **File System:** If there's a file inside `public/` with the same path as in
+-   `:filesystem`: If there's a file inside `public/` with the same path as in
     the URL, it is read from disk. E.g. if the URL is
     `http://cdn.example.com/assets/email.css` the contents of the file located
     at `public/assets/email.css` gets returned if it exists.
 
-3.  **Asset Pipeline:** If Rails is available and the asset pipeline is enabled,
+-   `:asset_pipeline`: If Rails is available and the asset pipeline is enabled,
     the file is retrieved through the asset pipeline. E.g. if the URL is
     `http://cdn.example.com/assets/email-fingerprint123.css`, the file
     `email.css` is requested from the asset pipeline. That is, the fingerprint
     and the prefix (in this case `assets` is the prefix) are stripped before
     requesting it from the asset pipeline.
 
-4.  **Network:** As a last resort, the URL is simply requested and the response
-    body is used. This is usefull when the assets are not bundled in the
+-   `:network`: As a last resort, the URL is simply requested and the response
+    body is used. This is useful when the assets are not bundled in the
     application and only available on a CDN. On Heroku e.g. you can add assets
     to your `.slugignore` causing your assets to not be available to the app
     (and thus resulting in a smaller app) and deploy the assets to a CDN such
     as S3/CloudFront.
 
+You can configure which strategies you want to use as well as specify their
+order. Refer to the *Configuration* section for more on this.
+
+Note that the retrieved CSS is cached when the gem is running with Rails in
+production.
+
 ## Installation
 
 Simply add the gem to your `Gemfile`:
@@ -76,19 +75,12 @@ Simply add the gem to your `Gemfile`:
 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. Since hpricot is no longer
-maintained, I suggest you to go with nokogiri. Add either one to your `Gemfile`:
-
-```ruby
-gem 'nokogiri'
-# or
-gem 'hpricot'
-```
-
-If both gems are loaded for some reason, premailer chooses hpricot.
-
-That's it!
+premailer-rails and premailer require a gem that is used to parse the email's
+HTML. For a list of supported gems and how to select which one to use, please
+refer to the [*Adapter*
+section](https://github.com/premailer/premailer#adapters) of premailer. Note
+that there is no hard dependency from either gem so you should add one yourself.
+Also note that this gem is only tested with [nokogiri].
 
 ## Configuration
 
@@ -107,7 +99,8 @@ configs are:
 ```ruby
 {
   input_encoding: 'UTF-8',
-  generate_text_part: true
+  generate_text_part: true,
+  strategies: [:filesystem, :asset_pipeline, :network]
 }
 ```
 
@@ -122,6 +115,11 @@ If you're using this gem outside of Rails, you'll need to call
 is done ideally in some kind of initializer, depending on the framework you're
 using.
 
+premailer-rails reads all stylesheet `<link>` tags, inlines the linked CSS
+and removes the tags. If you wish to ignore a certain tag, e.g. one that links to
+external fonts such as Google Fonts, you can add a `data-premailer="ignore"`
+attribute.
+
 ## Usage
 
 premailer-rails processes all outgoing emails by default. If you wish to skip
@@ -137,39 +135,51 @@ class UserMailer < ActionMailer::Base
 end
 ```
 
+Note that the mere presence of this header causes premailer to be skipped, i.e.,
+even setting `skip_premailer: false` will cause premailer to be skipped. The
+reason for that is that the `skip_premailer` is a simple header and the value is
+transformed into a string, causing `'false'` to become truthy.
+
+Emails are only processed upon delivery, i.e. when calling `#deliver` on the
+email, or when [previewing them in
+rails](http://api.rubyonrails.org/v4.1.0/classes/ActionMailer/Base.html#class-ActionMailer::Base-label-Previewing+emails).
+If you wish to manually trigger the inlining, you can do so by calling the hook:
+
+```ruby
+mail = SomeMailer.some_message(args)
+Premailer::Rails::Hook.perform(mail)
+```
+
+This will modify the email in place, useful e.g. in tests.
+
 ## Small Print
 
 ### Author
 
 Philipe Fatio ([@fphilipe][fphilipe twitter])
 
-[![Support via Gittip][tip-image]][tip-link]
-
 ### License
 
 premailer-rails is released under the MIT license. See the [license file].
 
-[build-image]: https://travis-ci.org/fphilipe/premailer-rails.png
+[build-image]: https://travis-ci.org/fphilipe/premailer-rails.svg
 [build-link]:  https://travis-ci.org/fphilipe/premailer-rails
-[gem-image]:   https://badge.fury.io/rb/premailer-rails.png
+[gem-image]:   https://badge.fury.io/rb/premailer-rails.svg
 [gem-link]:    https://rubygems.org/gems/premailer-rails
-[deps-image]:  https://gemnasium.com/fphilipe/premailer-rails.png
+[deps-image]:  https://gemnasium.com/fphilipe/premailer-rails.svg
 [deps-link]:   https://gemnasium.com/fphilipe/premailer-rails
-[gpa-image]:   https://codeclimate.com/github/fphilipe/premailer-rails.png
+[gpa-image]:   https://codeclimate.com/github/fphilipe/premailer-rails.svg
 [gpa-link]:    https://codeclimate.com/github/fphilipe/premailer-rails
-[cov-image]:   https://coveralls.io/repos/fphilipe/premailer-rails/badge.png
+[cov-image]:   https://coveralls.io/repos/fphilipe/premailer-rails/badge.svg
 [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/
-[tip-image]:   https://rawgithub.com/twolfson/gittip-badge/0.1.0/dist/gittip.png
+[tip-image]:   https://rawgithub.com/twolfson/gittip-badge/0.1.0/dist/gittip.svg
 [tip-link]:    https://www.gittip.com/fphilipe/
 
 [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
+[premailer documentation]: https://www.rubydoc.info/gems/premailer/Premailer:initialize
 
 [fphilipe twitter]: https://twitter.com/fphilipe
 [license file]:     LICENSE

data/VERSION

@@ -1 +1 @@
-1.8.0
+1.11.1

data/example/Gemfile

@@ -1,8 +1,6 @@
 source 'https://rubygems.org'
 
-gem 'rails', github: 'rails'
-gem 'sprockets-rails'
-
+gem 'rails', '~> 5.0.0.beta3'
 gem 'premailer-rails', path: '..'
 gem 'nokogiri'
 

data/example/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application', __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/example/config.ru

@@ -1,4 +1,4 @@
 # This file is used by Rack-based servers to start the application.
 
-require ::File.expand_path('../config/environment',  __FILE__)
+require ::File.expand_path('../config/environment', __FILE__)
 run Rails.application

data/example/config/application.rb

@@ -2,6 +2,7 @@ require File.expand_path('../boot', __FILE__)
 
 require 'action_controller/railtie'
 require 'action_mailer/railtie'
+require 'sprockets/railtie'
 
 Bundler.require(*Rails.groups)
 

data/example/config/boot.rb

@@ -1,4 +1,3 @@
-# Set up gems listed in the Gemfile.
 ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
 
-require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+require 'bundler/setup' # Set up gems listed in the Gemfile.

data/example/config/environments/development.rb

@@ -2,4 +2,8 @@ Rails.application.configure do
   config.cache_classes = false
   config.eager_load = false
   config.consider_all_requests_local = true
+  config.action_controller.perform_caching = false
+  config.assets.debug = true
+  config.assets.digest = true
+  config.assets.raise_runtime_errors = true
 end

data/example/config/environments/production.rb

@@ -0,0 +1,9 @@
+Rails.application.configure do
+  config.cache_classes = true
+  config.eager_load = true
+  config.consider_all_requests_local = false
+  config.action_controller.perform_caching = true
+  config.assets.compile = false
+  config.assets.digest = true
+  config.log_level = :info
+end

data/example/config/initializers/assets.rb

@@ -0,0 +1,2 @@
+Rails.application.config.assets.version = '1.0'
+Rails.application.config.assets.precompile += %w( email.css )

data/lib/premailer/rails.rb

@@ -6,13 +6,13 @@ require 'premailer/rails/css_loaders'
 require 'premailer/rails/css_helper'
 require 'premailer/rails/customized_premailer'
 require 'premailer/rails/hook'
-require 'premailer/rails/railtie' if defined?(Rails)
 
 class Premailer
   module Rails
     @config = {
       input_encoding: 'UTF-8',
-      generate_text_part: true
+      generate_text_part: true,
+      strategies: [:filesystem, :asset_pipeline, :network]
     }
     class << self
       attr_accessor :config
@@ -27,3 +27,5 @@ class Premailer
     end
   end
 end
+
+require 'premailer/rails/railtie' if defined?(Rails)

data/lib/premailer/rails/css_helper.rb

@@ -3,36 +3,65 @@ class Premailer
     module CSSHelper
       extend self
 
-      @cache = {}
-      attr :cache
+      FileNotFound = Class.new(StandardError)
 
-      STRATEGIES = [
-        CSSLoaders::CacheLoader,
-        CSSLoaders::FileSystemLoader,
-        CSSLoaders::AssetPipelineLoader,
-        CSSLoaders::NetworkLoader
-      ]
+      attr_accessor :cache
+      self.cache = {}
 
       # 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).force_encoding('UTF-8') }.join("\n")
+        css_urls_in_doc(doc).map { |url| css_for_url(url) }.join("\n")
+      end
+
+      def css_for_url(url)
+        if cache_enabled?
+          load_css_with_cache(url)
+        else
+          load_css(url)
+        end
       end
 
       private
 
       def css_urls_in_doc(doc)
-        doc.search('link[@rel="stylesheet"]').map do |link|
+        doc.search('link[@rel="stylesheet"]:not([@data-premailer="ignore"])').map do |link|
+          if link.respond_to?(:remove)
+            link.remove
+          else
+            link.parent.children.delete(link)
+          end
           link.attributes['href'].to_s
         end
       end
 
+      def load_css_with_cache(url)
+        self.cache[url] ||= load_css(url)
+      end
+
+      def cache_enabled?
+        defined?(::Rails.env) && ::Rails.env.production?
+      end
+
       def load_css(url)
-        @cache[url] =
-          STRATEGIES.each do |strategy|
-            css = strategy.load(url)
-            break css if css
-          end
+        Premailer::Rails.config.fetch(:strategies).each do |strategy|
+          css = find_strategy(strategy).load(url)
+          return css if css
+        end
+
+        raise FileNotFound, %{File with URL "#{url}" could not be loaded by any strategy.}
+      end
+
+      def find_strategy(key)
+        case key
+        when :filesystem
+          CSSLoaders::FileSystemLoader
+        when :asset_pipeline
+          CSSLoaders::AssetPipelineLoader
+        when :network
+          CSSLoaders::NetworkLoader
+        else
+          key
+        end
       end
     end
   end