premailer-rails 1.9.2 → 1.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0bcfc086df0af15eaab84de807f48b52d0210d40
-  data.tar.gz: 4379b96a4be95002b4cafcb094b7db201ccde437
+  metadata.gz: 88c3e4cb9ff7a5d1bcf7437242957d0882d5c783
+  data.tar.gz: b89082332333a80f33437e2f424a3c77cf33ce88
 SHA512:
-  metadata.gz: 8767537172dd6c4d2b7601949524b039151de25a3a585efea14874b03de820e00e2618f07defdea841330cf2fb7254cd08a5331fd0c9f16edbdd4e8a5401ea61
-  data.tar.gz: 069b054a1127bc31a6eec936b7e6311256b7b95c6b464644cfb14ef9819710e8ffce73b36965f6e2fcacdabe194cedb3c83d3af3a7dcf327d4cd05b1cfae3ecf
+  metadata.gz: 16f4d14dcad194bc945ab41f360b88669428408d21e9035ac8c05b1c91095fb51f6658ec160f0ea3b8a1085acb17d253f45cc319d9862060802e2a6121c8e91a
+  data.tar.gz: a7bd533d813480744b008ac7ba60418588e8c183aaec38c34df993e248ea613b7e3b1744df170180d06a76b589813dc233abf7bafacb72c278b212e0c6d797b3

data/CHANGELOG.md

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

data/README.md

@@ -121,6 +121,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
@@ -141,6 +146,18 @@ 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

data/VERSION

@@ -1 +1 @@
-1.9.2
+1.9.3

data/lib/premailer/rails/css_helper.rb

@@ -27,7 +27,11 @@ class Premailer
 
       def css_urls_in_doc(doc)
         doc.search('link[@rel="stylesheet"]:not([@data-premailer="ignore"])').map do |link|
-          link.remove
+          if link.respond_to?(:remove)
+            link.remove
+          else
+            link.parent.children.delete(link)
+          end
           link.attributes['href'].to_s
         end
       end

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

@@ -19,9 +19,14 @@ class Premailer
         end
 
         def file_name(url)
+          prefix = [
+            ::Rails.configuration.relative_url_root,
+            ::Rails.configuration.assets.prefix,
+            '/'
+          ].join
           URI(url).path
-            .sub("#{::Rails.configuration.assets.prefix}/", '')
-            .sub(/-(\h{32}|\h{64})\.css$/, '.css')
+            .sub(/\A#{prefix}/, '')
+            .sub(/-(\h{32}|\h{64})\.css\z/, '.css')
         end
       end
     end

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

@@ -7,7 +7,7 @@ class Premailer
         def load(url)
           path = URI(url).path
           file_path = "public#{path}"
-          File.read(file_path) if File.exist?(file_path)
+          File.read(file_path) if File.file?(file_path)
         end
       end
     end

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

@@ -16,7 +16,7 @@ class Premailer
             return uri if uri.scheme.present?
             URI("http://#{uri.to_s}")
           elsif asset_host_present?
-            scheme, host = asset_host.split(%r{:?//})
+            scheme, host = asset_host(url).split(%r{:?//})
             scheme, host = host, scheme if host.nil?
             scheme = 'http' if scheme.blank?
             path = url
@@ -28,9 +28,9 @@ class Premailer
           ::Rails.configuration.action_controller.asset_host.present?
         end
 
-        def asset_host
+        def asset_host(url)
           config = ::Rails.configuration.action_controller.asset_host
-          config.respond_to?(:call) ? config.call : config
+          config.respond_to?(:call) ? config.call(url) : config
         end
       end
     end

data/spec/integration/css_helper_spec.rb

@@ -1,177 +1,186 @@
 require 'spec_helper'
 
 describe Premailer::Rails::CSSHelper do
-  # Reset the CSS cache:
-  after do
-    Premailer::Rails::CSSLoaders::CacheLoader.clear!
-  end
-
-  def css_for_url(path)
-    Premailer::Rails::CSSHelper.css_for_url(path)
-  end
+  [ :Nokogiri, :Hpricot ].each do |adapter|
+    next if adapter == :Hpricot and RUBY_PLATFORM == 'java'
 
-  def css_for_doc(doc)
-    Premailer::Rails::CSSHelper.css_for_doc(doc)
-  end
+    context "when adapter is #{adapter}" do
+      # Reset the CSS cache:
+      after do
+        Premailer::Rails::CSSLoaders::CacheLoader.clear!
+      end
 
-  def expect_file(path, content='file content')
-    allow(File).to receive(:exist?).with(path).and_return(true)
-    expect(File).to receive(:read).with(path).and_return(content)
-  end
+      def css_for_url(path)
+        Premailer::Rails::CSSHelper.css_for_url(path)
+      end
 
-  describe '#css_for_doc' do
-    let(:html) { Fixtures::HTML.with_css_links(*files) }
-    let(:doc) { Nokogiri(html) }
+      def css_for_doc(doc)
+        Premailer::Rails::CSSHelper.css_for_doc(doc)
+      end
 
-    context 'when HTML contains linked CSS files' do
-      let(:files) { %w[ stylesheets/base.css stylesheets/font.css ] }
+      def expect_file(path, content='file content')
+        allow(File).to receive(:file?).with(path).and_return(true)
+        expect(File).to receive(:read).with(path).and_return(content)
+      end
 
-      it 'returns the content of both files concatenated' do
-        allow(Premailer::Rails::CSSHelper).to \
-          receive(:css_for_url)
-            .with('http://example.com/stylesheets/base.css')
-            .and_return('content of base.css')
-        allow(Premailer::Rails::CSSHelper).to \
-          receive(:css_for_url)
-            .with('http://example.com/stylesheets/font.css')
-            .and_return('content of font.css')
+      describe '#css_for_doc' do
+        let(:html) { Fixtures::HTML.with_css_links(*files) }
+        let(:doc) { send(adapter, html) }
 
-        expect(css_for_doc(doc)).to eq("content of base.css\ncontent of font.css")
-      end
-    end
+        context 'when HTML contains linked CSS files' do
+          let(:files) { %w[ stylesheets/base.css stylesheets/font.css ] }
 
-    context 'when HTML contains ignored links' do
-      let(:files) { ['ignore.css', 'data-premailer' => 'ignore'] }
+          it 'returns the content of both files concatenated' do
+            allow(Premailer::Rails::CSSHelper).to \
+              receive(:css_for_url)
+                .with('http://example.com/stylesheets/base.css')
+                .and_return('content of base.css')
+            allow(Premailer::Rails::CSSHelper).to \
+              receive(:css_for_url)
+                .with('http://example.com/stylesheets/font.css')
+                .and_return('content of font.css')
 
-      it 'ignores links' do
-        expect(Premailer::Rails::CSSHelper).to_not receive(:css_for_url)
-        css_for_doc(doc)
-      end
-    end
-  end
+            expect(css_for_doc(doc)).to eq("content of base.css\ncontent of font.css")
+          end
+        end
 
-  describe '#css_for_url' do
-    context 'when path is a url' do
-      it 'loads the CSS at the local path' do
-        expect_file('public/stylesheets/base.css')
+        context 'when HTML contains ignored links' do
+          let(:files) { ['ignore.css', 'data-premailer' => 'ignore'] }
 
-        css_for_url('http://example.com/stylesheets/base.css?test')
+          it 'ignores links' do
+            expect(Premailer::Rails::CSSHelper).to_not receive(:css_for_url)
+            css_for_doc(doc)
+          end
+        end
       end
-    end
 
-    context 'when path is a relative url' do
-      it 'loads the CSS at the local path' do
-        expect_file('public/stylesheets/base.css')
-        css_for_url('/stylesheets/base.css?test')
-      end
-    end
+      describe '#css_for_url' do
+        context 'when path is a url' do
+          it 'loads the CSS at the local path' do
+            expect_file('public/stylesheets/base.css')
 
-    context 'when file is cached' do
-      it 'returns the cached value' do
-        Premailer::Rails::CSSLoaders::CacheLoader.store(
-          'http://example.com/stylesheets/base.css',
-          'content of base.css'
-        )
+            css_for_url('http://example.com/stylesheets/base.css?test')
+          end
+        end
 
-        expect(css_for_url('http://example.com/stylesheets/base.css')).to \
-          eq('content of base.css')
-      end
-    end
+        context 'when path is a relative url' do
+          it 'loads the CSS at the local path' do
+            expect_file('public/stylesheets/base.css')
+            css_for_url('/stylesheets/base.css?test')
+          end
+        end
 
-    context 'when in development mode' do
-      it 'does not return cached values' do
-        Premailer::Rails::CSSLoaders::CacheLoader.store(
-          'http://example.com/stylesheets/base.css',
-          'cached content of base.css'
-        )
-        content = 'new content of base.css'
-        expect_file('public/stylesheets/base.css', content)
-        allow(Rails.env).to receive(:development?).and_return(true)
-
-        expect(css_for_url('http://example.com/stylesheets/base.css')).to eq(content)
-      end
-    end
+        context 'when file is cached' do
+          it 'returns the cached value' do
+            Premailer::Rails::CSSLoaders::CacheLoader.store(
+              'http://example.com/stylesheets/base.css',
+              'content of base.css'
+            )
 
-    context 'when Rails asset pipeline is used' do
-      before do
-        allow(Rails.configuration).to receive(:assets).and_return(double(prefix: '/assets'))
-      end
+            expect(css_for_url('http://example.com/stylesheets/base.css')).to \
+              eq('content of base.css')
+          end
+        end
 
-      context 'and a precompiled file exists' do
-        it 'returns that file' do
-          path = '/assets/email-digest.css'
-          content = 'read from file'
-          expect_file("public#{path}", content)
-          expect(css_for_url(path)).to eq(content)
+        context 'when in development mode' do
+          it 'does not return cached values' do
+            Premailer::Rails::CSSLoaders::CacheLoader.store(
+              'http://example.com/stylesheets/base.css',
+              'cached content of base.css'
+            )
+            content = 'new content of base.css'
+            expect_file('public/stylesheets/base.css', content)
+            allow(Rails.env).to receive(:development?).and_return(true)
+
+            expect(css_for_url('http://example.com/stylesheets/base.css')).to eq(content)
+          end
         end
-      end
 
-      it 'returns the content of the file compiled by Rails' do
-        expect(Rails.application.assets).to \
-          receive(:find_asset)
-            .with('base.css')
-            .and_return(double(to_s: 'content of base.css'))
+        context 'when Rails asset pipeline is used' do
+          before do
+            allow(Rails.configuration)
+              .to receive(:assets).and_return(double(prefix: '/assets'))
+            allow(Rails.configuration)
+              .to receive(:relative_url_root).and_return(nil)
+          end
 
-        expect(css_for_url('http://example.com/assets/base.css')).to \
-          eq('content of base.css')
-      end
+          context 'and a precompiled file exists' do
+            it 'returns that file' do
+              path = '/assets/email-digest.css'
+              content = 'read from file'
+              expect_file("public#{path}", content)
+              expect(css_for_url(path)).to eq(content)
+            end
+          end
 
-      it 'returns same file when path contains file fingerprint' do
-        expect(Rails.application.assets).to \
-          receive(:find_asset)
-            .with('base.css')
-            .and_return(double(to_s: 'content of base.css'))
+          it 'returns the content of the file compiled by Rails' do
+            expect(Rails.application.assets).to \
+              receive(:find_asset)
+                .with('base.css')
+                .and_return(double(to_s: 'content of base.css'))
 
-        expect(css_for_url(
-          'http://example.com/assets/base-089e35bd5d84297b8d31ad552e433275.css'
-        )).to eq('content of base.css')
-      end
+            expect(css_for_url('http://example.com/assets/base.css')).to \
+              eq('content of base.css')
+          end
 
-      context 'when asset can not be found' do
-        let(:response) { 'content of base.css' }
-        let(:path) { '/assets/base-089e35bd5d84297b8d31ad552e433275.css' }
-        let(:url) { "http://assets.example.com#{path}" }
-        let(:asset_host) { 'http://assets.example.com' }
+          it 'returns same file when path contains file fingerprint' do
+            expect(Rails.application.assets).to \
+              receive(:find_asset)
+                .with('base.css')
+                .and_return(double(to_s: 'content of base.css'))
 
-        before do
-          allow(Rails.application.assets).to \
-            receive(:find_asset).and_return(nil)
+            expect(css_for_url(
+              'http://example.com/assets/base-089e35bd5d84297b8d31ad552e433275.css'
+            )).to eq('content of base.css')
+          end
 
-          config = double(asset_host: asset_host)
-          allow(Rails.configuration).to \
-            receive(:action_controller).and_return(config)
+          context 'when asset can not be found' do
+            let(:response) { 'content of base.css' }
+            let(:path) { '/assets/base-089e35bd5d84297b8d31ad552e433275.css' }
+            let(:url) { "http://assets.example.com#{path}" }
+            let(:asset_host) { 'http://assets.example.com' }
 
-          uri_satisfaction = satisfy { |uri| uri.to_s == url }
-          allow(Net::HTTP).to \
-            receive(:get).with(uri_satisfaction).and_return(response)
-        end
+            before do
+              allow(Rails.application.assets).to \
+                receive(:find_asset).and_return(nil)
 
-        it 'requests the file' do
-          expect(css_for_url(url)).to eq('content of base.css')
-        end
+              config = double(asset_host: asset_host)
+              allow(Rails.configuration).to \
+                receive(:action_controller).and_return(config)
 
-        context 'when file url does not include the host' do
-          it 'requests the file using the asset host as host' do
-            expect(css_for_url(path)).to eq('content of base.css')
-          end
+              uri_satisfaction = satisfy { |uri| uri.to_s == url }
+              allow(Net::HTTP).to \
+                receive(:get).with(uri_satisfaction).and_return(response)
+            end
 
-          context 'and the asset host uses protocol relative scheme' do
-            let(:asset_host) { '//assets.example.com' }
+            it 'requests the file' do
+              expect(css_for_url(url)).to eq('content of base.css')
+            end
 
-            it 'requests the file using http as the scheme' do
-              expect(css_for_url(path)).to eq('content of base.css')
+            context 'when file url does not include the host' do
+              it 'requests the file using the asset host as host' do
+                expect(css_for_url(path)).to eq('content of base.css')
+              end
+
+              context 'and the asset host uses protocol relative scheme' do
+                let(:asset_host) { '//assets.example.com' }
+
+                it 'requests the file using http as the scheme' do
+                  expect(css_for_url(path)).to eq('content of base.css')
+                end
+              end
             end
           end
         end
-      end
-    end
 
-    context 'when static stylesheets are used' do
-      it 'returns the content of the static file' do
-        content = 'content of base.css'
-        expect_file('public/stylesheets/base.css', content)
-        loaded_content = css_for_url('http://example.com/stylesheets/base.css')
-        expect(loaded_content).to eq(content)
+        context 'when static stylesheets are used' do
+          it 'returns the content of the static file' do
+            content = 'content of base.css'
+            expect_file('public/stylesheets/base.css', content)
+            loaded_content = css_for_url('http://example.com/stylesheets/base.css')
+            expect(loaded_content).to eq(content)
+          end
+        end
       end
     end
   end

data/spec/unit/css_loaders/asset_pipeline_loader_spec.rb

@@ -2,9 +2,9 @@ require 'spec_helper'
 
 describe Premailer::Rails::CSSLoaders::AssetPipelineLoader do
   before do
-    assets = double(prefix: '/assets')
-    config = double(assets: assets)
-    allow(Rails).to receive(:configuration).and_return(config)
+    allow(Rails.configuration)
+      .to receive(:assets).and_return(double(prefix: '/assets'))
+    allow(Rails.configuration).to receive(:relative_url_root).and_return(nil)
   end
 
   describe ".file_name" do
@@ -17,6 +17,16 @@ describe Premailer::Rails::CSSLoaders::AssetPipelineLoader do
       it { is_expected.to eq('application.css') }
     end
 
+    context "when asset file path contains prefix and relative_url_root is set" do
+      before do
+        allow(Rails.configuration)
+          .to receive(:relative_url_root).and_return('/foo')
+      end
+
+      let(:asset) { '/foo/assets/application.css' }
+      it { is_expected.to eq('application.css') }
+    end
+
     context "when asset file path contains 32 chars fingerprint" do
       let(:asset) { 'application-6776f581a4329e299531e1d52aa59832.css' }
       it { is_expected.to eq('application.css') }

data/spec/unit/css_loaders/network_loader_spec.rb

@@ -39,9 +39,14 @@ describe Premailer::Rails::CSSLoaders::NetworkLoader do
         it { is_expected.to eq(URI("http://example.com/assets/foo.css")) }
       end
 
-      context 'and a proc as asset host' do
-        let(:asset_host) { ->{ 'example.com' } }
-        it { is_expected.to eq(URI("http://example.com/assets/foo.css")) }
+      context 'and a callable object as asset host' do
+        let(:asset_host) { double }
+
+        it 'calls #call with the asset path as argument' do
+          expect(asset_host).to receive(:call).with(url).and_return(
+            'http://example.com')
+          expect(subject).to eq(URI('http://example.com/assets/foo.css'))
+        end
       end
 
       context 'without an asset host' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: premailer-rails
 version: !ruby/object:Gem::Version
-  version: 1.9.2
+  version: 1.9.3
 platform: ruby
 authors:
 - Philipe Fatio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-10 00:00:00.000000000 Z
+date: 2016-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: premailer