RubyGems - premailer-rails - Versions diffs - 1.8.0 → 1.11.1 - Mend

premailer-rails 1.8.0 → 1.11.1

Files changed (52) hide show

checksums.yaml +5 -5
data/.gitignore +4 -0
data/.travis.yml +10 -15
data/CHANGELOG.md +74 -0
data/Gemfile +10 -4
data/README.md +49 -39
data/VERSION +1 -1
data/example/Gemfile +1 -3
data/example/bin/rails +4 -0
data/example/config.ru +1 -1
data/example/config/application.rb +1 -0
data/example/config/boot.rb +1 -2
data/example/config/environments/development.rb +4 -0
data/example/config/environments/production.rb +9 -0
data/example/config/initializers/assets.rb +2 -0
data/lib/premailer/rails.rb +4 -2
data/lib/premailer/rails/css_helper.rb +45 -16
data/lib/premailer/rails/css_loaders.rb +0 -1
data/lib/premailer/rails/css_loaders/asset_pipeline_loader.rb +19 -10
data/lib/premailer/rails/css_loaders/file_system_loader.rb +24 -2
data/lib/premailer/rails/css_loaders/network_loader.rb +15 -8
data/lib/premailer/rails/customized_premailer.rb +6 -6
data/lib/premailer/rails/hook.rb +16 -8
data/premailer-rails.gemspec +4 -4
data/spec/integration/css_helper_spec.rb +92 -42
data/spec/integration/delivery_spec.rb +13 -0
data/spec/integration/hook_spec.rb +53 -1
data/spec/rails_app/app/assets/config/manifest.js +3 -0
data/spec/rails_app/app/assets/stylesheets/application.css +3 -0
data/spec/rails_app/app/mailers/application_mailer.rb +4 -0
data/spec/rails_app/app/mailers/welcome_mailer.rb +6 -0
data/spec/rails_app/app/views/layouts/mailer.html.erb +11 -0
data/spec/rails_app/app/views/welcome_mailer/welcome_email.html.erb +1 -0
data/spec/rails_app/config.ru +5 -0
data/spec/rails_app/config/application.rb +13 -0
data/spec/rails_app/config/boot.rb +5 -0
data/spec/rails_app/config/environment.rb +2 -0
data/spec/rails_app/config/environments/test.rb +10 -0
data/spec/rails_app/config/initializers/assets.rb +1 -0
data/spec/rails_app/config/routes.rb +3 -0
data/spec/spec_helper.rb +3 -4
data/spec/support/fixtures/html.rb +8 -4
data/spec/support/fixtures/message.rb +56 -0
data/spec/unit/css_loaders/asset_pipeline_loader_spec.rb +19 -4
data/spec/unit/css_loaders/file_system_loader_spec.rb +37 -0
data/spec/unit/css_loaders/network_loader_spec.rb +58 -0
data/spec/unit/customized_premailer_spec.rb +32 -40
metadata +63 -34
data/lib/premailer/rails/css_loaders/cache_loader.rb +0 -19
data/spec/integration/hook_registration_spec.rb +0 -11
data/spec/support/stubs/action_mailer.rb +0 -5
data/spec/support/stubs/rails.rb +0 -51

data/spec/integration/delivery_spec.rb ADDED Viewed

@@ -0,0 +1,13 @@
+require 'spec_helper'
+describe 'ActionMailer::Base delivery' do
+  it 'delivers email with inlined CSS' do
+    WelcomeMailer.welcome_email("world").deliver_now
+    mail = ActionMailer::Base.deliveries.last
+    expect(mail).to be_present
+    body = mail.html_part.body.to_s
+    expect(body).to be_present
+    expect(body).to include(%{<p style="font-size: 12px;">Hello world</p>})
+  end
+end

data/spec/integration/hook_spec.rb CHANGED Viewed

@@ -5,6 +5,10 @@ describe Premailer::Rails::Hook do
     Premailer::Rails::Hook.perform(message)
   end
+  def body_content(message)
+    Nokogiri::HTML(message.html_string).at('body').content.gsub("\r\n", "\n")
+  end
   class Mail::Message
     def html_string
       (html_part || self).body.to_s
@@ -43,6 +47,54 @@ describe Premailer::Rails::Hook do
     expect(processed_message.parts).to match_array(expected_parts)
   end
+  it 'does not screw up the text by maintaining the original body encoding' do
+    raw_msg = Fixtures::Message.latin_message
+    processed_msg = Fixtures::Message.latin_message
+    run_hook(processed_msg)
+    expect(body_content(processed_msg)).to eq(body_content(raw_msg))
+    raw_msg = Fixtures::Message.non_latin_message
+    processed_msg = Fixtures::Message.non_latin_message
+    run_hook(processed_msg)
+    expect(body_content(processed_msg)).to eq(body_content(raw_msg))
+    raw_msg = Fixtures::Message.greek_message
+    processed_msg = Fixtures::Message.greek_message
+    run_hook(processed_msg)
+    expect(body_content(processed_msg)).to eq(body_content(raw_msg))
+    raw_msg = Fixtures::Message.dash_message
+    processed_msg = Fixtures::Message.dash_message
+    run_hook(processed_msg)
+    expect(body_content(processed_msg)).to eq(body_content(raw_msg))
+  end
+  it 'supports US-ASCII output' do
+    Premailer::Rails.config.merge!(output_encoding: 'US-ASCII')
+    raw_msg = Fixtures::Message.latin_message
+    processed_msg = Fixtures::Message.latin_message
+    run_hook(processed_msg)
+    expect(body_content(processed_msg)).to eq(body_content(raw_msg))
+    raw_msg = Fixtures::Message.non_latin_message
+    processed_msg = Fixtures::Message.non_latin_message
+    run_hook(processed_msg)
+    expect(body_content(processed_msg)).to eq(body_content(raw_msg))
+    raw_msg = Fixtures::Message.greek_message
+    processed_msg = Fixtures::Message.greek_message
+    run_hook(processed_msg)
+    expect(body_content(processed_msg)).to eq(body_content(raw_msg))
+    raw_msg = Fixtures::Message.dash_message
+    processed_msg = Fixtures::Message.dash_message
+    run_hook(processed_msg)
+    expect(body_content(processed_msg)).to eq(body_content(raw_msg))
+  ensure
+    Premailer::Rails.config.delete(:output_encoding)
+  end
   it 'generates a text part from the html' do
     expect { run_hook(message) }.to change(message, :text_part)
   end
@@ -64,7 +116,7 @@ describe Premailer::Rails::Hook do
     it 'does not replace any message part' do
       expect { run_hook(message) }.to_not \
-        change { message.all_parts.map(&:content_type) }
+        change { message.all_parts.map(&:content_type).sort }
     end
   end

data/spec/rails_app/app/assets/config/manifest.js ADDED Viewed

@@ -0,0 +1,3 @@
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css

data/spec/rails_app/app/assets/stylesheets/application.css ADDED Viewed

@@ -0,0 +1,3 @@
+p {
+  font-size: 12px;
+}

data/spec/rails_app/app/mailers/application_mailer.rb ADDED Viewed

@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+  layout 'mailer'
+end

data/spec/rails_app/app/mailers/welcome_mailer.rb ADDED Viewed

@@ -0,0 +1,6 @@
+class WelcomeMailer < ApplicationMailer
+  def welcome_email(greeting)
+    @greeting = greeting
+    mail to: "example@example.com"
+  end
+end

data/spec/rails_app/app/views/layouts/mailer.html.erb ADDED Viewed

@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <link rel="stylesheet" href="/assets/application.css"/>
+  </head>
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/rails_app/app/views/welcome_mailer/welcome_email.html.erb ADDED Viewed

	@@ -0,0 +1 @@
1	+ <p>Hello <%= @greeting %></p>

data/spec/rails_app/config.ru ADDED Viewed

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

data/spec/rails_app/config/application.rb ADDED Viewed

@@ -0,0 +1,13 @@
+require_relative 'boot'
+require "action_mailer/railtie"
+require "action_view/railtie"
+require "sprockets/railtie"
+require "rails/test_unit/railtie"
+Bundler.require(*Rails.groups)
+module Dummy
+  class Application < Rails::Application
+  end
+end

data/spec/rails_app/config/boot.rb ADDED Viewed

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../Gemfile', __dir__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../lib', __dir__)

data/spec/rails_app/config/environment.rb ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ require_relative 'application'
2	+ Rails.application.initialize!

data/spec/rails_app/config/environments/test.rb ADDED Viewed

@@ -0,0 +1,10 @@
+Rails.application.configure do
+  config.cache_classes = true
+  config.eager_load = false
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+  config.action_dispatch.show_exceptions = false
+  config.action_controller.allow_forgery_protection = false
+  config.action_mailer.delivery_method = :test
+  config.active_support.deprecation = :stderr
+end

data/spec/rails_app/config/initializers/assets.rb ADDED Viewed

	@@ -0,0 +1 @@
1	+ Rails.application.config.assets.version = '1.0'

data/spec/rails_app/config/routes.rb ADDED Viewed

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  root 'application#main'
+end

data/spec/spec_helper.rb CHANGED Viewed

@@ -11,12 +11,11 @@ if RUBY_ENGINE == 'ruby'
   end
 end
-require 'premailer/rails'
+# Configure Rails Environment
+ENV["RAILS_ENV"] = "test"
+require File.expand_path("../../spec/rails_app/config/environment.rb", __FILE__)
-require 'support/stubs/action_mailer'
-require 'support/stubs/rails'
 require 'support/fixtures/message'
 require 'support/fixtures/html'
-require 'hpricot' unless RUBY_PLATFORM == 'java'
 require 'nokogiri'

data/spec/support/fixtures/html.rb CHANGED Viewed

@@ -18,17 +18,21 @@ module Fixtures
 </html>
     HTML
-    LINK = <<-LINK
-<link rel='stylesheet' href='%s' />
-    LINK
+    LINK = "<link rel='stylesheet' %s />\n"
     def with_css_links(*files)
+      opts = files.last.is_a?(Hash) ? files.pop : {}
       links = []
       files.each do |file|
-        links << LINK % "http://example.com/#{file}"
+        attrs = { href: "http://example.com/#{file}" }.merge(opts)
+        links << LINK % hash_to_attributes(attrs)
       end
       TEMPLATE % links.join
     end
+    def hash_to_attributes(attrs)
+      attrs.map { |attr, value| "#{attr}='#{value}'" }.join(' ')
+    end
   end
 end

data/spec/support/fixtures/message.rb CHANGED Viewed

@@ -35,6 +35,30 @@ module Fixtures
 </html>
     HTML
+    HTML_PART_IN_GREEK = <<-HTML.encode(Encoding::ISO_8859_7)
+<html>
+  <head>
+  </head>
+  <body>
+    <p>
+      Αα Ββ Γγ Δδ Εε Ζζ Ηη Θθ Ιι Κκ Λλ Μμ Νν Ξξ Οο Ππ Ρρ Σσ Ττ Υυ Φφ Χχ Ψψ Ωω
+    </p>
+  </body>
+</html>
+    HTML
+    HTML_PART_WITH_DASHES = <<-HTML
+<html>
+  <head>
+  </head>
+  <body>
+    <p>
+      Hello there—yes you! What's up with – pardon the interrupion – dashes? I can also do &ndash; and &mdash;.
+    </p>
+  </body>
+</html>
+    HTML
     HTML_PART_WITH_CSS = <<-HTML
 <html>
   <head>
@@ -114,6 +138,38 @@ nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
       message
     end
+    def latin_message
+      base_message.tap do |message|
+        message.body = HTML_PART
+        message.content_type 'text/html; charset=UTF-8'
+        message.ready_to_send!
+      end
+    end
+    def non_latin_message
+      base_message.tap do |message|
+        message.body = HTML_PART_WITH_UNICODE
+        message.content_type 'text/html; charset=UTF-8'
+        message.ready_to_send!
+      end
+    end
+    def greek_message
+      base_message.tap do |message|
+        message.body = HTML_PART_IN_GREEK
+        message.content_type 'text/html; charset=ISO-8859-7'
+        message.ready_to_send!
+      end
+    end
+    def dash_message
+      base_message.tap do |message|
+        message.body = HTML_PART_WITH_DASHES
+        message.content_type 'text/html; charset=UTF-8'
+        message.ready_to_send!
+      end
+    end
     private
     def base_message

data/spec/unit/css_loaders/asset_pipeline_loader_spec.rb CHANGED Viewed

@@ -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,11 +17,26 @@ describe Premailer::Rails::CSSLoaders::AssetPipelineLoader do
       it { is_expected.to eq('application.css') }
     end
-    context "when asset file path contains fingerprint" do
+    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') }
     end
+    context "when asset file path contains 64 chars fingerprint" do
+      let(:asset) { 'application-02275ccb3fd0c11615bbfb11c99ea123ca2287e75045fe7b72cefafb880dad2b.css' }
+      it { is_expected.to eq('application.css') }
+    end
     context "when asset file page contains numbers, but not a fingerprint" do
       let(:asset) { 'test/20130708152545-foo-bar.css' }
       it { is_expected.to eq("test/20130708152545-foo-bar.css") }

data/spec/unit/css_loaders/file_system_loader_spec.rb ADDED Viewed

@@ -0,0 +1,37 @@
+require 'spec_helper'
+describe Premailer::Rails::CSSLoaders::FileSystemLoader do
+  before do
+    allow(Rails.configuration)
+      .to receive(:assets).and_return(double(prefix: '/assets'))
+    allow(Rails)
+      .to receive(:root).and_return(Pathname.new('/rails_root'))
+  end
+  describe '#file_name' do
+    subject { described_class.file_name(asset) }
+    let(:relative_url_root) { nil }
+    before do
+      config = double(relative_url_root: relative_url_root)
+      allow(Rails).to receive(:configuration).and_return(config)
+    end
+    context 'when relative_url_root is not set' do
+      let(:asset) { '/assets/application.css' }
+      it { is_expected.to eq(File.join(Rails.root, 'public/assets/application.css')) }
+    end
+    context 'when relative_url_root is set' do
+      let(:relative_url_root) { '/foo' }
+      let(:asset) { '/foo/assets/application.css' }
+      it { is_expected.to eq(File.join(Rails.root, 'public/assets/application.css')) }
+    end
+    context 'when relative_url_root has a trailing slash' do
+      let(:relative_url_root) { '/foo/' }
+      let(:asset) { '/foo/assets/application.css' }
+      it { is_expected.to eq(File.join(Rails.root, 'public/assets/application.css')) }
+    end
+  end
+end

data/spec/unit/css_loaders/network_loader_spec.rb ADDED Viewed

@@ -0,0 +1,58 @@
+require 'spec_helper'
+describe Premailer::Rails::CSSLoaders::NetworkLoader do
+  describe '#uri_for_url' do
+    subject { described_class.uri_for_url(url) }
+    let(:asset_host) { nil }
+    before do
+      action_controller = double(asset_host: asset_host)
+      config = double(action_controller: action_controller)
+      allow(Rails).to receive(:configuration).and_return(config)
+    end
+    context 'with a valid URL' do
+      let(:url) { 'http://example.com/test.css' }
+      it { is_expected.to eq(URI(url)) }
+    end
+    context 'with a protocol relative URL' do
+      let(:url) { '//example.com/test.css' }
+      it { is_expected.to eq(URI("http:#{url}")) }
+    end
+    context 'with a file path' do
+      let(:url) { '/assets/foo.css' }
+      context 'and a domain as asset host' do
+        let(:asset_host) { 'example.com' }
+        it { is_expected.to eq(URI("http://example.com#{url}")) }
+      end
+      context 'and a URL as asset host' do
+        let(:asset_host) { 'https://example.com' }
+        it { is_expected.to eq(URI("https://example.com/assets/foo.css")) }
+      end
+      context 'and a protocol relative URL as asset host' do
+        let(:asset_host) { '//example.com' }
+        it { is_expected.to eq(URI("http://example.com/assets/foo.css")) }
+      end
+      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
+        let(:asset_host) { nil }
+        it { is_expected.not_to be }
+      end
+    end
+  end
+end

data/spec/unit/customized_premailer_spec.rb CHANGED Viewed

@@ -1,51 +1,43 @@
 require 'spec_helper'
 describe Premailer::Rails::CustomizedPremailer do
-  [ :nokogiri, :hpricot ].each do |adapter|
-    next if adapter == :hpricot and RUBY_PLATFORM == 'java'
+  describe '#to_plain_text' do
+    it 'includes the text from the HTML part' do
+      premailer =
+        Premailer::Rails::CustomizedPremailer
+          .new(Fixtures::Message::HTML_PART)
+      expect(premailer.to_plain_text.gsub(/\s/, ' ').strip).to \
+        eq(Fixtures::Message::TEXT_PART.gsub(/\s/, ' ').strip)
+    end
+  end
-    context "when adapter is #{adapter}" do
-      before { allow(Premailer::Adapter).to receive(:use).and_return(adapter) }
+  describe '#to_inline_css' do
+    let(:regex) { %r{<p style=("|')color: ?red;?\1>} }
-      describe '#to_plain_text' do
-        it 'includes the text from the HTML part' do
-          premailer =
-            Premailer::Rails::CustomizedPremailer
-              .new(Fixtures::Message::HTML_PART)
-          expect(premailer.to_plain_text.gsub(/\s/, ' ').strip).to \
-            eq(Fixtures::Message::TEXT_PART.gsub(/\s/, ' ').strip)
-        end
+    context 'when inline CSS block present' do
+      it 'returns the HTML with the CSS inlined' do
+        allow(Premailer::Rails::CSSHelper).to \
+          receive(:css_for_doc).and_return('p { color: red; }')
+        html = Fixtures::Message::HTML_PART
+        premailer = Premailer::Rails::CustomizedPremailer.new(html)
+        expect(premailer.to_inline_css).to match(regex)
       end
+    end
-      describe '#to_inline_css' do
-        let(:regex) { %r{<p style=("|')color: ?red;?\1>} }
-        context 'when inline CSS block present' do
-          it 'returns the HTML with the CSS inlined' do
-            allow(Premailer::Rails::CSSHelper).to \
-              receive(:css_for_doc).and_return('p { color: red; }')
-            html = Fixtures::Message::HTML_PART
-            premailer = Premailer::Rails::CustomizedPremailer.new(html)
-            expect(premailer.to_inline_css).to match(regex)
-          end
-        end
-        context 'when CSS is loaded externally' do
-          it 'returns the HTML with the CSS inlined' do
-            html = Fixtures::Message::HTML_PART_WITH_CSS
-            premailer = Premailer::Rails::CustomizedPremailer.new(html)
-            expect(premailer.to_inline_css).to match(regex)
-          end
-        end
+    context 'when CSS is loaded externally' do
+      it 'returns the HTML with the CSS inlined' do
+        html = Fixtures::Message::HTML_PART_WITH_CSS
+        premailer = Premailer::Rails::CustomizedPremailer.new(html)
+        expect(premailer.to_inline_css).to match(regex)
+      end
+    end
-        context 'when HTML contains unicode' do
-          it 'does not mess those up' do
-            html = Fixtures::Message::HTML_PART_WITH_UNICODE
-            premailer = Premailer::Rails::CustomizedPremailer.new(html)
-            expect(premailer.to_inline_css).to \
-              include(Fixtures::Message::UNICODE_STRING)
-          end
-        end
+    context 'when HTML contains unicode' do
+      it 'does not mess those up' do
+        html = Fixtures::Message::HTML_PART_WITH_UNICODE
+        premailer = Premailer::Rails::CustomizedPremailer.new(html)
+        expect(premailer.to_inline_css).to \
+          include(Fixtures::Message::UNICODE_STRING)
       end
     end
   end