premailer-rails 1.9.5 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1d3d9d793a427df886ea2b99af60ce466db67bd2
-  data.tar.gz: 3849875af6ec63a8194008c94ab543a0b8fbd920
+SHA256:
+  metadata.gz: d1ade699bd19b081f52953b727ac7d58019325a8724ebcb49f95158eb832b10d
+  data.tar.gz: 380a46fefaa3d09f491975b45d47590af610d72965ce7c6190b94aeb78a57a6d
 SHA512:
-  metadata.gz: e99f797aaa7f53584f5b8b63b5a20358be04e70a6c3677774abaf04814ceb1574393b7532dad24e36c5accc2ab86bed46aac6efc7967534afb1a5d9880be1dfe
-  data.tar.gz: 17df1bf7a56bba9ed2474f85012b78d810b924b28efe756827ae66494a5948065dbb4f1aeae8dfc94744d2a830e18fd7f82ade8a90ec63f60a41481623c4e64d
+  metadata.gz: 374b301926c5084c16ee45c169715d5d53f413f398791e4c20ec3b50b52d8f065dbda20fb55c702bee153051c6480432577c1f5f33f0fe94d431a42bd07b7b7b
+  data.tar.gz: 2567fb6f0ab9323a6f05e292349b7a9e03d65991a5477c0584baa488dd01247469bf123e96669721f0e6326b1b3cb6b3f571dc0a6da8a428a92845d832241d51

data/.github/workflows/test.yml

@@ -0,0 +1,64 @@
+name: Test
+
+on:
+  push:
+    branches:
+      - "*"
+  pull_request:
+    branches:
+      - "*"
+  # Enable triggering CI runs manually.
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    continue-on-error: ${{ matrix.experimental }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - '2.7'
+          - '3.1'
+        action_mailer_version:
+          - 5
+          - 6
+          - 7
+        propshaft:
+          - false
+          - true
+        experimental:
+          - false
+        exclude:
+          - ruby: '3.1'
+            action_mailer_version: 5
+          - action_mailer_version: 5
+            propshaft: true
+          - action_mailer_version: 6
+            propshaft: true
+        include:
+          - ruby: head
+            action_mailer_version: head
+            propshaft: false
+            experimental: true
+          - ruby: head
+            action_mailer_version: head
+            propshaft: true
+            experimental: true
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set env vars
+        run: |
+          echo "ACTION_MAILER_VERSION=${{ matrix.action_mailer_version }}" >> $GITHUB_ENV
+          echo "PROPSHAFT=${{ matrix.propshaft }}" >> $GITHUB_ENV
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bundle exec rake

data/.gitignore

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

data/CHANGELOG.md

@@ -1,5 +1,45 @@
 # Changelog
 
+## v1.12.0
+
+- Lazily load actionmailer (@c960657, #260)
+- HTTP request for CSS files now have an `Accept: text/css` header (@ElMassimo, #261)
+- Added support for [Propshaft](https://github.com/rails/propshaft) (@Intrepidd, #277)
+
+## 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

data/Gemfile

@@ -1,20 +1,24 @@
 source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
 gemspec
 
-action_mailer_version = ENV.fetch('ACTION_MAILER_VERSION', '4')
+rails_version = ENV.fetch('ACTION_MAILER_VERSION', '7')
 
-if action_mailer_version == 'master'
-  git 'git://github.com/rails/rails.git' do
-    gem 'actionmailer'
+if rails_version == 'head'
+  gem 'rails', github: 'rails/rails'
+  if ENV['PROPSHAFT'] == 'true'
+    gem 'propshaft', github: 'rails/propshaft'
+  else
+    gem 'sprockets-rails', github: 'rails/sprockets-rails'
   end
 else
-  gem 'actionmailer', "~> #{action_mailer_version}"
-end
-
-platforms :rbx do
-  gem 'rubysl'
-  gem 'racc'
+  gem 'rails', "~> #{rails_version}"
+  if ENV['PROPSHAFT'] == 'true'
+    gem 'propshaft'
+  else
+    gem 'sprockets-rails' if rails_version >= '7'
+  end
 end
 
-gem 'tins', '< 1.7' if RUBY_VERSION.split('.').first.to_i < 2
+gem 'byebug'

data/README.md

@@ -4,9 +4,7 @@ CSS styled emails without the hassle.
 
 [![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]
 
 ## Introduction
 
@@ -39,34 +37,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`:
@@ -75,19 +73,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
 
@@ -106,7 +97,8 @@ configs are:
 ```ruby
 {
   input_encoding: 'UTF-8',
-  generate_text_part: true
+  generate_text_part: true,
+  strategies: [:filesystem, :asset_pipeline, :network]
 }
 ```
 
@@ -158,6 +150,14 @@ Premailer::Rails::Hook.perform(mail)
 
 This will modify the email in place, useful e.g. in tests.
 
+## Supported Rails Versions
+
+This gem is tested on Rails versions 5 through 7.
+
+For Rails 7, it support both the classical Sprockets asset pipeline as well as the new [Propshaft](https://github.com/rails/propshaft) gem.
+
+If you're looking to integrate with Webpacker, check out [these instructions](https://github.com/fphilipe/premailer-rails/issues/232#issuecomment-839819705).
+
 ## Small Print
 
 ### Author
@@ -168,25 +168,20 @@ Philipe Fatio ([@fphilipe][fphilipe twitter])
 
 premailer-rails is released under the MIT license. See the [license file].
 
-[build-image]: https://travis-ci.org/fphilipe/premailer-rails.svg
-[build-link]:  https://travis-ci.org/fphilipe/premailer-rails
+[build-image]: https://github.com/fphilipe/premailer-rails/actions/workflows/test.yml/badge.svg
+[build-link]:  https://github.com/fphilipe/premailer-rails/actions/workflows/test.yml
 [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.svg
-[deps-link]:   https://gemnasium.com/fphilipe/premailer-rails
 [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.svg
-[cov-link]:    https://coveralls.io/r/fphilipe/premailer-rails
 [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
+[actionmailer]: https://github.com/rails/rails/tree/main/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.9.5
+1.12.0

data/examples/rails5/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gem 'rails', '~> 5.2', '>= 5.2.8.1'
+gem 'premailer-rails', path: '../..'

data/{example → examples/rails5}/Rakefile

@@ -1,6 +1,6 @@
 # Add your own tasks in files placed in lib/tasks ending in .rake,
 # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
 
-require File.expand_path('../config/application', __FILE__)
+require_relative 'config/application'
 
 Rails.application.load_tasks

data/{example → examples/rails5}/bin/rails

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

data/{example → examples/rails5}/config/application.rb

@@ -1,12 +1,15 @@
-require File.expand_path('../boot', __FILE__)
+require_relative 'boot'
 
 require 'action_controller/railtie'
 require 'action_mailer/railtie'
 require 'sprockets/railtie'
 
+# Require the gems listed in Gemfile, including any gems
+# you've limited to :test, :development, or :production.
 Bundler.require(*Rails.groups)
 
 module Example
   class Application < Rails::Application
+    config.load_defaults 5.2
   end
 end

data/examples/rails5/config/boot.rb

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

data/{example → examples/rails5}/config/environment.rb

@@ -1,5 +1,5 @@
 # Load the Rails application.
-require File.expand_path('../application', __FILE__)
+require_relative 'application'
 
 # Initialize the Rails application.
 Rails.application.initialize!

data/{example → examples/rails5}/config.ru

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

data/examples/rails6/.gitignore

@@ -0,0 +1,16 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-journal
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp

data/examples/rails6/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'rails', '~> 6.1.7'
+gem 'webrick' if RUBY_VERSION >= '3'
+gem 'premailer-rails', path: '../..'

data/examples/rails6/README.md

@@ -0,0 +1,10 @@
+# Example Rails App
+
+To run this app, run:
+
+```shell
+bundle
+bundle exec rails s
+```
+
+Then point your browser at [http://localhost:3000/](http://localhost:3000/).

data/examples/rails6/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

data/examples/rails6/app/assets/config/manifest.js

@@ -0,0 +1 @@
+//= link email.css

data/examples/rails6/app/assets/stylesheets/email.css

@@ -0,0 +1,32 @@
+body {
+  background: #efefef;
+  font-family: "Helvetica Neue", Helvetica, Arial, sans-serif;
+}
+
+p {
+  line-height: 1.4;
+}
+
+.wrap {
+  max-width: 40em;
+  margin: 0 auto;
+  padding: 1em;
+  background: white;
+}
+
+.greeting {
+  text-align: center;
+  font-weight: bold;
+  font-size: 110%;
+}
+
+.footer {
+  font-size: 90%;
+  color: #666;
+}
+
+a {
+  color: green;
+  text-decoration: none;
+  border-bottom: 2px solid green;
+}

data/examples/rails6/app/mailers/example_mailer.rb

@@ -0,0 +1,7 @@
+class ExampleMailer < ActionMailer::Base
+  default from: "from@example.com"
+
+  def test_message
+    mail to: 'to@example.org', subject: 'Test Message'
+  end
+end

data/examples/rails6/app/views/example_mailer/test_message.html.erb

@@ -0,0 +1,18 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset='utf-8'>
+    <%= stylesheet_link_tag :email %>
+  </head>
+  <body>
+    <div class='wrap'>
+      <p class='greeting'>Hi, John Doe</p>
+      <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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+      </p>
+      <div class='footer'>
+        To unsubscribe, <a href='http://www.google.com/'>click here</a>.
+      </div>
+    </div>
+  </body>
+</html>

data/examples/rails6/bin/rails

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

data/examples/rails6/config/application.rb

@@ -0,0 +1,15 @@
+require_relative 'boot'
+
+require 'action_controller/railtie'
+require 'action_mailer/railtie'
+require 'sprockets/railtie'
+
+# Require the gems listed in Gemfile, including any gems
+# you've limited to :test, :development, or :production.
+Bundler.require(*Rails.groups)
+
+module Example
+  class Application < Rails::Application
+    config.load_defaults 6.1
+  end
+end

data/examples/rails6/config/boot.rb

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

data/examples/rails6/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require_relative 'application'
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/examples/rails6/config/environments/development.rb

@@ -0,0 +1,9 @@
+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/examples/rails6/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/examples/rails6/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  root to: redirect('rails/mailers/example_mailer/test_message')
+end

data/examples/rails6/config.ru

@@ -0,0 +1,6 @@
+# This file is used by Rack-based servers to start the application.
+
+require_relative 'config/environment'
+
+run Rails.application
+Rails.application.load_server

data/examples/rails6/test/mailers/previews/example_mailer_preview.rb

@@ -0,0 +1,5 @@
+class ExampleMailerPreview < ActionMailer::Preview
+  def test_message
+    ExampleMailer.test_message
+  end
+end

data/examples/rails7-propshaft/.gitignore

@@ -0,0 +1,16 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-journal
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp

data/examples/rails7-propshaft/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'rails', '~> 7.0.4'
+gem 'propshaft'
+gem 'webrick' if RUBY_VERSION >= '3'
+gem 'premailer-rails', path: '../..'

data/examples/rails7-propshaft/README.md

@@ -0,0 +1,10 @@
+# Example Rails App
+
+To run this app, run:
+
+```shell
+bundle
+bundle exec rails s
+```
+
+Then point your browser at [http://localhost:3000/](http://localhost:3000/).

data/examples/rails7-propshaft/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

data/examples/rails7-propshaft/app/assets/stylesheets/email.css

@@ -0,0 +1,32 @@
+body {
+  background: #efefef;
+  font-family: "Helvetica Neue", Helvetica, Arial, sans-serif;
+}
+
+p {
+  line-height: 1.4;
+}
+
+.wrap {
+  max-width: 40em;
+  margin: 0 auto;
+  padding: 1em;
+  background: white;
+}
+
+.greeting {
+  text-align: center;
+  font-weight: bold;
+  font-size: 110%;
+}
+
+.footer {
+  font-size: 90%;
+  color: #666;
+}
+
+a {
+  color: green;
+  text-decoration: none;
+  border-bottom: 2px solid green;
+}

data/examples/rails7-propshaft/app/mailers/example_mailer.rb

@@ -0,0 +1,7 @@
+class ExampleMailer < ActionMailer::Base
+  default from: "from@example.com"
+
+  def test_message
+    mail to: 'to@example.org', subject: 'Test Message'
+  end
+end