premailer-rails 1.9.5 → 1.10.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1d3d9d793a427df886ea2b99af60ce466db67bd2
-  data.tar.gz: 3849875af6ec63a8194008c94ab543a0b8fbd920
+SHA256:
+  metadata.gz: 36e83f5f50cf99a5c7c520cc40f135b08e1957f23bd471ab3dfd987549fcca25
+  data.tar.gz: 002da6d81c92ab09bf2af64c6dd7a87c6a0babf6fd70bc2b59361730499bf3e5
 SHA512:
-  metadata.gz: e99f797aaa7f53584f5b8b63b5a20358be04e70a6c3677774abaf04814ceb1574393b7532dad24e36c5accc2ab86bed46aac6efc7967534afb1a5d9880be1dfe
-  data.tar.gz: 17df1bf7a56bba9ed2474f85012b78d810b924b28efe756827ae66494a5948065dbb4f1aeae8dfc94744d2a830e18fd7f82ade8a90ec63f60a41481623c4e64d
+  metadata.gz: 2a44732ed01c2cb9ae7662e8dedaffd3d1989d32f627d7182683c6a6878c12e563cbe370008a4770f3e0643715c458ea981a5dd1a303387f4ddec825da7e80ad
+  data.tar.gz: 23e017fb41932ee883165623cc0afe3f74d9c49a27c5070bd879dfbf174faca160cc76bc3fae350f083be4b89380760016a3c5de8fcfcb1887e4033a855035e3

data/.gitignore

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

data/.travis.yml

@@ -3,20 +3,13 @@ language: ruby
 cache: bundler
 script: bundle exec rspec
 rvm:
-  - 2.3.0
-  - ruby-head
-  - jruby
-  - rbx-2
+  - 2.6.1
 env:
-  global:
-    - JRUBY_OPTS="--2.0"
   matrix:
     - ACTION_MAILER_VERSION=4
-    - ACTION_MAILER_VERSION=5.beta
+    - ACTION_MAILER_VERSION=5
     - ACTION_MAILER_VERSION=master
 matrix:
   fast_finish: true
   allow_failures:
     - env: ACTION_MAILER_VERSION=master
-    - env: ACTION_MAILER_VERSION=5.beta
-    - rvm: ruby-head

data/CHANGELOG.md

@@ -1,5 +1,31 @@
 # Changelog
 
+## 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

@@ -2,16 +2,20 @@ source 'https://rubygems.org'
 
 gemspec
 
-action_mailer_version = ENV.fetch('ACTION_MAILER_VERSION', '4')
+rails_version = ENV.fetch('ACTION_MAILER_VERSION', '5')
 
-if action_mailer_version == 'master'
+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'

data/README.md

@@ -39,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`:
@@ -75,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
 
@@ -106,7 +99,8 @@ configs are:
 ```ruby
 {
   input_encoding: 'UTF-8',
-  generate_text_part: true
+  generate_text_part: true,
+  strategies: [:filesystem, :asset_pipeline, :network]
 }
 ```
 
@@ -184,9 +178,8 @@ premailer-rails is released under the MIT license. See the [license file].
 [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.9.5
+1.10.3

data/lib/premailer/rails/css_helper.rb

@@ -5,12 +5,8 @@ class Premailer
 
       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)
@@ -18,8 +14,10 @@ class Premailer
       end
 
       def css_for_url(url)
-        load_css(url).tap do |content|
-          CSSLoaders::CacheLoader.store(url, content)
+        if cache_enabled?
+          load_css_with_cache(url)
+        else
+          load_css(url)
         end
       end
 
@@ -36,14 +34,35 @@ class Premailer
         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)
-        STRATEGIES.each do |strategy|
-          css = strategy.load(url)
+        Premailer::Rails.config.fetch(:strategies).each do |strategy|
+          css = find_strategy(strategy).load(url)
           return css.force_encoding('UTF-8') 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
 end

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

@@ -5,18 +5,11 @@ class Premailer
         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
+          return unless asset_pipeline_present?
 
-        def asset_pipeline_present?
-          defined?(::Rails) &&
-            ::Rails.respond_to?(:application) &&
-            ::Rails.application.respond_to?(:assets) &&
-            ::Rails.application.assets
+          file = file_name(url)
+          ::Rails.application.assets_manifest.find_sources(file).first
+        rescue Errno::ENOENT, TypeError => _error
         end
 
         def file_name(url)
@@ -29,6 +22,13 @@ class Premailer
             .sub(/\A#{prefix}/, '')
             .sub(/-(\h{32}|\h{64})\.css\z/, '.css')
         end
+
+        def asset_pipeline_present?
+          defined?(::Rails) &&
+            ::Rails.application &&
+            ::Rails.application.respond_to?(:assets_manifest) &&
+            ::Rails.application.assets_manifest
+        end
       end
     end
   end

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

@@ -5,9 +5,31 @@ class Premailer
         extend self
 
         def load(url)
+          file = file_name(url)
+          File.read(file) if File.file?(file)
+        end
+
+        def file_name(url)
           path = URI(url).path
-          file_path = "public#{path}"
-          File.read(file_path) if File.file?(file_path)
+          if relative_url_root
+            path = path.sub(/\A#{relative_url_root.chomp('/')}/, '')
+          end
+          asset_filename(path)
+        end
+
+        def asset_filename(filename)
+          if defined?(::Rails) && ::Rails.respond_to?(:root)
+            File.join(::Rails.root, 'public', filename)
+          else
+            File.join('public', filename)
+          end
+        end
+
+        def relative_url_root
+          defined?(::Rails) &&
+            ::Rails.respond_to?(:configuration) &&
+            ::Rails.configuration.respond_to?(:relative_url_root) &&
+            ::Rails.configuration.relative_url_root
         end
       end
     end

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

@@ -14,7 +14,7 @@ class Premailer
 
           if uri.host.present?
             return uri if uri.scheme.present?
-            URI("http://#{uri.to_s}")
+            URI("http:#{uri}")
           elsif asset_host_present?
             scheme, host = asset_host(url).split(%r{:?//})
             scheme, host = host, scheme if host.nil?

data/lib/premailer/rails/css_loaders.rb

@@ -1,6 +1,5 @@
 require 'uri'
 
-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/customized_premailer.rb

@@ -4,10 +4,10 @@ class 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.
+        # initialized. The ::Premailer::Adapter handles the discovery of
+        # a suitable adapter. To make load_html work, an adapter 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)

data/lib/premailer/rails.rb

@@ -11,7 +11,8 @@ 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

data/premailer-rails.gemspec

@@ -22,10 +22,9 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_dependency 'premailer', '~> 1.7', '>= 1.7.9'
-  s.add_dependency 'actionmailer', '>= 3', '< 6'
+  s.add_dependency 'actionmailer', '>= 3'
 
   s.add_development_dependency 'rspec', '~> 3.3'
   s.add_development_dependency 'nokogiri'
-  s.add_development_dependency 'hpricot' unless RUBY_PLATFORM == 'java'
   s.add_development_dependency 'coveralls' if RUBY_ENGINE == 'ruby'
 end