premailer-rails-revived 1.12.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6777fc2b0d9d7a3627d1799ad29bfedc65e95d4092440e2f0adfc91d7b77483b
+  data.tar.gz: 3af75c762f4aa235c5c84db8d5201a9a442ed324caceb0f9b76ac55ef0a62f70
+SHA512:
+  metadata.gz: 802a9dde3b61a7008800008cfe889d3e6b2eddadcffe10ecbe7af6e337e39bc45cf1b3e4d4514c8ca2a362473caa669b22792a38113add1c97f9d51ba70c4e81
+  data.tar.gz: c14eb13a90a129225d0c62ba6e827c8f66b199e5642fb4b0018c274875fcfdef87ffefb98fe3b3f8ed0ef09f472aef2f0bd992de8751e47f8e80e732455b1b75

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.github/workflows/build.yml

@@ -0,0 +1,43 @@
+name: tests
+on: push
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby:
+          - '2.7.x'
+          - '3.0.x'
+          - '3.1.x'
+        active_support:
+          - '6.0.0'
+          - '6.1.0'
+          - '7.0.0'
+        assets_gem:
+          - 'sprockets-rails'
+          - 'propshaft'
+        exclude:
+          - active_support: '6.0.0'
+            assets_gem: 'propshaft'
+          - active_support: '6.1.0'
+            assets_gem: 'propshaft'
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v1
+      - name: Setup Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Bundle
+        env:
+          ACTION_MAILER_VERSION: ${{ matrix.active_support }}
+          ASSETS_GEM: ${{ matrix.assets_gem }}
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+      - name: Test
+        env:
+          ACTION_MAILER_VERSION: ${{ matrix.active_support }}
+          ASSETS_GEM: ${{ matrix.assets_gem }}
+        run: bundle exec rspec

data/.gitignore

@@ -0,0 +1,8 @@
+*.gem
+doc/
+Gemfile.lock
+coverage/
+spec/rails_app/log/*
+spec/rails_app/tmp/*
+.ruby-version
+/.bundle

data/.rspec

@@ -0,0 +1,2 @@
+--format doc
+--color

data/CHANGELOG.md

@@ -0,0 +1,165 @@
+# Changelog
+
+## v1.12.0
+- Fork and revive this gem
+- Test on github actions rather than travis
+- Add support for rails 7 and propshaft
+
+## 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
+  longer when loading this gem. If you were using this gem outside Rails, you'll
+  need to call `Premailer::Rails.register_interceptors` manually.
+
+## v1.7.0
+
+- Register preview hook for the new previewing functionality introduced in
+  rails 4.1.0
+
+- Add example rails application
+
+## v1.6.1
+
+- Remove Nokogiri unicode fix since it's working properly without it by now
+
+- Make sure html part comes before text part
+
+## 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
+
+- Improve construction of file URL when requesting from CDN
+
+- No longer use open-uri
+
+- Remove gzip unzipping after requesting file
+
+## v1.5.0
+
+- No longer support ruby 1.8
+
+- Find linked stylesheets by `rel='stylesheet'` attribute instead of
+  `type='text/css'`
+
+- Don't test hpricot on JRuby due to incompatibility
+
+## v1.4.0
+
+- Fix attachments
+
+## v1.3.2
+
+- Rename gem to premailer-rails (drop the 3)
+
+- Add support for rails 4
+
+- Refactor code
+
+- Add support for precompiled assets
+
+- No longer include default `email.css`
+
+## v1.1.0
+
+- Fixed several bugs
+
+- Strip asset digest from CSS path
+
+- Improve nokogiri support
+
+- Request CSS file if asset is not found locally
+
+  This allows you to host all your assets on a CDN and deploy the
+  app without the `app/assets` folder.
+
+Thanks to everyone who contributed!

data/Gemfile

@@ -0,0 +1,28 @@
+source 'https://rubygems.org'
+
+gemspec
+
+rails_version = ENV.fetch('ACTION_MAILER_VERSION', '6')
+
+if rails_version == 'master'
+  git 'git://github.com/rails/rails.git' do
+    gem 'rails'
+  end
+  gem 'sprockets-rails', github: 'rails/sprockets-rails'
+  gem 'arel', github: 'rails/arel'
+elsif rails_version.split('.').first.to_i >= 7
+  gem 'rails', "~> #{rails_version}"
+  gem ENV.fetch("ASSETS_GEM", "sprockets-rails")
+else
+  gem 'rails', "~> #{rails_version}"
+end
+
+gem 'byebug'
+gem 'net-smtp', require: false
+
+# platforms :rbx do
+#   gem 'rubysl'
+#   gem 'racc'
+# end
+
+gem 'tins', '< 1.7' if RUBY_VERSION.split('.').first.to_i < 2

data/LICENSE

@@ -0,0 +1,14 @@
+Copyright (C) 2011-2012 Philipe Fatio (fphilipe)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of
+the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,180 @@
+# premailer-rails
+
+CSS styled emails without the hassle.
+
+[![Gem Version][gem-image]][gem-link]
+[![Code Climate][gpa-image]][gpa-link]
+[![Coverage Status][cov-image]][cov-link]
+
+## Introduction
+
+This gem is a drop in solution for styling HTML emails with CSS without having
+to do the hard work yourself.
+
+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.
+
+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.
+
+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.
+
+## How It Works
+
+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.
+
+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
+available are:
+
+-   `: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.
+
+-   `: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.
+
+-   `: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`:
+
+```ruby
+gem 'premailer-rails'
+```
+
+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
+
+Premailer itself accepts a number of options. In order for premailer-rails to
+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)
+```
+
+For a list of options, refer to the [premailer documentation]. The default
+configs are:
+
+```ruby
+{
+  input_encoding: 'UTF-8',
+  generate_text_part: true,
+  strategies: [:filesystem, :asset_pipeline, :network]
+}
+```
+
+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.
+
+If you're using this gem outside of Rails, you'll need to call
+`Premailer::Rails.register_interceptors` manually in order for it to work. This
+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
+premailer for a certain email, simply set the `:skip_premailer` header:
+
+```ruby
+class UserMailer < ActionMailer::Base
+  def welcome_email(user)
+    mail to: user.email,
+         subject: 'Welcome to My Awesome Site',
+         skip_premailer: true
+  end
+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])
+
+### License
+
+premailer-rails is released under the MIT license. See the [license file].
+
+
+[gem-image]:   https://badge.fury.io/rb/premailer-rails.svg
+[gem-link]:    https://rubygems.org/gems/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
+[nokogiri]:     https://github.com/sparklemotion/nokogiri
+
+[premailer documentation]: https://www.rubydoc.info/gems/premailer/Premailer:initialize
+
+[fphilipe twitter]: https://twitter.com/fphilipe
+[license file]:     LICENSE

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/VERSION

@@ -0,0 +1 @@
+1.12.0

data/example/.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/example/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gem 'rails', '~> 5.0.0.beta3'
+gem 'premailer-rails', path: '..'
+gem 'nokogiri'
+
+platforms :rbx do
+  gem 'rubysl'
+  gem 'racc'
+end

data/example/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/example/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 File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/example/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/example/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/example/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/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/application.rb

@@ -0,0 +1,12 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'action_controller/railtie'
+require 'action_mailer/railtie'
+require 'sprockets/railtie'
+
+Bundler.require(*Rails.groups)
+
+module Example
+  class Application < Rails::Application
+  end
+end

data/example/config/boot.rb

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

data/example/config/environment.rb

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

data/example/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/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/example/config/routes.rb

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

data/example/config/secrets.yml

@@ -0,0 +1,2 @@
+development:
+  secret_key_base: bc1d05753b1a42a7d983dcb4f998c433532ec8f91ab3842a36ed3d9072d143a2d9c05a6dc43a3d780a2ff3d8e7b75a1011ae2e0d13a022e98dc1f0299da5a5a0

data/example/config.ru

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

data/example/test/mailers/previews/example_mailer_preview.rb

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