roadie 2.3.4 → 2.4.0

data/lib/roadie/railtie.rb

@@ -13,6 +13,14 @@ module Roadie
   #     config.roadie.provider = nil
   #       You can use this to set a provider yourself. See {Roadie::AssetProvider}.
   #
+  #     config.roadie.after_inlining = lambda do |doc| 
+  #       doc.css('#products p.desc a[href^="/"]').each do |link|
+  #         link['href'] = "http://www.foo.com" + link['href']
+  #       end
+  #     end
+  #       You can use this to set a custom inliner. A custom inliner transforms an outgoing HTML email using application specific rules. 
+  #       The custom inliner is invoked after the default inliner.A custom inliner can be created using a `lambda` that accepts one parameter 
+  #       or an object that responds to the `call` method with one parameter.
   #
   # @see Roadie
   # @see AssetProvider
@@ -20,6 +28,7 @@ module Roadie
     config.roadie = ActiveSupport::OrderedOptions.new
     config.roadie.enabled = true
     config.roadie.provider = nil
+    config.roadie.after_inlining = nil
 
     initializer "roadie.extend_action_mailer" do
       ActiveSupport.on_load(:action_mailer) do

data/lib/roadie/selector.rb

@@ -0,0 +1,48 @@
+module Roadie
+  class Selector
+    def initialize(selector)
+      @selector = selector.to_s.strip
+    end
+
+    def specificity
+      @specificity ||= CssParser.calculate_specificity selector
+    end
+
+    def inlinable?
+      !(pseudo_element? || at_rule? || pseudo_function?)
+    end
+
+    def to_s
+      selector
+    end
+
+    def to_str() to_s end
+    def inspect() selector.inspect end
+
+    def ==(other)
+      if other.is_a?(self.class)
+        other.selector == selector
+      else
+        super
+      end
+    end
+
+    protected
+      attr_reader :selector
+
+    private
+      BAD_PSEUDO_FUNCTIONS = %w[:active :focus :hover :link :target :visited].freeze
+
+      def pseudo_element?
+        selector.include? '::'
+      end
+
+      def at_rule?
+        selector[0, 1] == '@'
+      end
+
+      def pseudo_function?
+        BAD_PSEUDO_FUNCTIONS.any? { |bad| selector.include?(bad) }
+      end
+  end
+end

data/lib/roadie/style_declaration.rb

@@ -23,12 +23,20 @@ module Roadie
     end
 
     def to_s
-      [property, value].join(':')
+      [property, value_with_important].join(':')
     end
 
     def inspect
-      extra = [important ? '!important' : nil, specificity].compact
-      "#{to_s} (#{extra.join(' , ')})"
+      "#{to_s} (#{specificity})"
+    end
+
+    private
+    def value_with_important
+      if important
+        "#{value} !important"
+      else
+        value
+      end
     end
   end
 end

data/lib/roadie/version.rb

@@ -1,3 +1,3 @@
 module Roadie
-  VERSION = '2.3.4'
+  VERSION = '2.4.0'
 end

data/roadie.gemspec

@@ -14,12 +14,14 @@ Gem::Specification.new do |s|
   s.summary     = %q{Making HTML emails comfortable for the Rails rockstars}
   s.description = %q{Roadie tries to make sending HTML emails a little less painful in Rails 3 by inlining stylesheets and rewrite relative URLs for you.}
 
-  s.add_dependency 'nokogiri', '>= 1.4.4'
-  s.add_dependency 'css_parser'
-  s.add_dependency 'actionmailer', '> 3.0.0', '< 3.3.0'
+  s.add_dependency 'nokogiri', '~> 1.6.0'
+  s.add_dependency 'css_parser', '~> 1.3.4'
+  s.add_dependency 'actionmailer', '> 3.0.0', '< 5.0.0'
   s.add_dependency 'sprockets'
 
+  s.add_development_dependency 'rake'
   s.add_development_dependency 'rails'
+  s.add_development_dependency 'rspec'
   s.add_development_dependency 'rspec-rails'
 
   s.add_development_dependency 'appraisal'

data/spec/integration_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 module Roadie
   shared_examples "roadie integration" do
     mailer = Class.new(AnonymousMailer) do
-      default :css => :integration, :from => 'john@example.com'
+      default :css => 'integration', :from => 'john@example.com'
       append_view_path FIXTURES_PATH.join('views')
 
       # Needed for correct path lookup

data/spec/lib/roadie/action_mailer_extensions_spec.rb

@@ -4,7 +4,7 @@ require 'spec_helper'
 module Roadie
   describe ActionMailerExtensions, "CSS selection" do
     mailer = Class.new(AnonymousMailer) do
-      default :css => :default
+      default :css => 'default'
 
       def default_css
         mail(:subject => "Default CSS") do |format|
@@ -20,7 +20,7 @@ module Roadie
     end
 
     def expect_global_css(files)
-      Roadie.should_receive(:inline_css).with(provider, files, anything, anything).and_return('')
+      Roadie.should_receive(:inline_css).with(provider, files, anything, anything, anything).and_return('')
     end
 
     let(:provider) { double("asset provider", :all => '') }
@@ -76,9 +76,85 @@ module Roadie
     end
   end
 
+  describe ActionMailerExtensions, "after_initialize handler" do
+    let(:global_after_inlining_handler) { double("global after inlining handler") }
+    let(:per_mailer_after_inlining_handler) { double("per mailer after inlining handler") }
+    let(:per_mail_after_inlining_handler) { double("per mail after inlining handler") }
+    let(:provider) { double("asset provider", :all => '') }
+
+    before(:each) do
+      Roadie.stub(:current_provider => provider)
+      Roadie.stub(:after_inlining_handler => global_after_inlining_handler)
+    end
+
+    def expect_inlining_handler(handler)
+      Roadie.should_receive(:inline_css).with(provider, anything, anything, anything, handler)
+    end
+
+    describe "global" do
+      let(:mailer) do
+        Class.new(AnonymousMailer) do
+          def nil_handler
+            mail(:subject => "Nil handler") do |format|
+              format.html { render :text => '' }
+            end
+          end
+
+          def global_handler
+            mail(:subject => "Global handler") do |format|
+              format.html { render :text => '' }
+            end
+          end
+        end
+      end
+
+      it "is set to the provided global handler when mailer/per mail handler are not specified" do
+        expect_inlining_handler(global_after_inlining_handler)
+        mailer.global_handler
+      end
+
+      it "is not used when not set" do
+        Roadie.stub(:after_inlining_handler => nil)
+        expect_inlining_handler(nil)
+        mailer.nil_handler
+      end
+    end
+
+    describe "overridden" do
+      let(:mailer) do
+        handler = per_mailer_after_inlining_handler
+        Class.new(AnonymousMailer) do
+          default :after_inlining => handler
+
+          def per_mailer_handler
+            mail(:subject => "Mailer handler") do |format|
+              format.html { render :text => '' }
+            end
+          end
+
+          def per_mail_handler(handler)
+            mail(:subject => "Per Mail handler", :after_inlining => handler) do |format|
+              format.html { render :text => '' }
+            end
+          end
+        end
+      end
+
+      it "is set to the provided mailer handler" do
+        expect_inlining_handler(per_mailer_after_inlining_handler)
+        mailer.per_mailer_handler
+      end
+
+      it "is set to the provided per mail handler" do
+        expect_inlining_handler(per_mail_after_inlining_handler)
+        mailer.per_mail_handler(per_mail_after_inlining_handler)
+      end
+    end
+  end
+
   describe ActionMailerExtensions, "using HTML" do
     mailer = Class.new(AnonymousMailer) do
-      default :css => :simple
+      default :css => 'simple'
 
       def multipart
         mail(:subject => "Multipart email") do |format|
@@ -116,7 +192,7 @@ module Roadie
 
     describe "for singlepart text/html" do
       it "inlines css to the email body" do
-        Roadie.should_receive(:inline_css).with(provider, ['simple'], 'Hello HTML', anything).and_return('html')
+        Roadie.should_receive(:inline_css).with(provider, ['simple'], 'Hello HTML', anything, anything).and_return('html')
         mailer.singlepart_html.body.decoded.should == 'html'
       end
 
@@ -133,7 +209,7 @@ module Roadie
       end
 
       it "inlines css to the email's html part" do
-        Roadie.should_receive(:inline_css).with(provider, ['simple'], 'Hello HTML', anything).and_return('html')
+        Roadie.should_receive(:inline_css).with(provider, ['simple'], 'Hello HTML', anything, anything).and_return('html')
         email = mailer.multipart
         email.html_part.body.decoded.should == 'html'
         email.text_part.body.decoded.should == 'Hello Text'

data/spec/lib/roadie/inliner_spec.rb

@@ -10,7 +10,8 @@ describe Roadie::Inliner do
 
   def rendering(html, options = {})
     url_options = options.fetch(:url_options, {:host => 'example.com'})
-    Nokogiri::HTML.parse Roadie::Inliner.new(provider, ['global.css'], html, url_options).execute
+    after_inlining_handler = options[:after_inlining_handler]
+    Nokogiri::HTML.parse Roadie::Inliner.new(provider, ['global.css'], html, url_options, after_inlining_handler).execute
   end
 
   describe "initialization" do
@@ -82,10 +83,10 @@ describe Roadie::Inliner do
       end
     end
 
-    it "respects !important properties" do
+    it "keeps !important properties" do
       use_css "a { text-decoration: underline !important; }
                a.hard-to-spot { text-decoration: none; }"
-      rendering('<a class="hard-to-spot"></a>').should have_styling('text-decoration' => 'underline')
+      rendering('<a class="hard-to-spot"></a>').should have_styling('text-decoration' => 'underline !important')
     end
 
     it "combines with already present inline styles" do
@@ -98,9 +99,37 @@ describe Roadie::Inliner do
       rendering('<p style="color: green"></p>').should have_styling([['color', 'red'], ['color', 'green']])
     end
 
-    it "ignores selectors with :psuedo-classes" do
-      use_css 'p:hover { color: red }'
-      rendering('<p></p>').should_not have_styling('color' => 'red')
+    it "does not apply link and dynamic pseudo selectors" do
+      use_css "
+        p:active { color: red }
+        p:focus { color: red }
+        p:hover { color: red }
+        p:link { color: red }
+        p:target { color: red }
+        p:visited { color: red }
+
+        p.active { width: 100%; }
+      "
+      rendering('<p class="active"></p>').should have_styling('width' => '100%')
+    end
+
+    it "does not crash on any pseudo element selectors" do
+      use_css "
+        p.some-element { width: 100%; }
+        p::some-element { color: red; }
+      "
+      rendering('<p class="some-element"></p>').should have_styling('width' => '100%')
+    end
+
+    it "works with nth-child" do
+      use_css "
+        p { color: red; }
+        p:nth-child(2n) { color: green; }
+      "
+      rendering("
+        <p class='one'></p>
+        <p class='two'></p>
+      ").should have_styling('color' => 'green').at_selector('.two')
     end
 
     it "ignores selectors with @" do
@@ -135,6 +164,17 @@ describe Roadie::Inliner do
       expect { rendering '<p></p>' }.not_to raise_error
     end
 
+    it "does not pick up scripts generating styles" do
+      expect {
+        rendering <<-HTML
+          <script>
+            var color = "red";
+            document.write("<style type='text/css'>p { color: " + color + "; }</style>");
+          </script>
+        HTML
+      }.not_to raise_error
+    end
+
     describe "inline <style> element" do
       it "is used for inlined styles" do
         rendering(<<-HTML).should have_styling([['color', 'green'], ['font-size', '1.1em']])
@@ -190,6 +230,17 @@ describe Roadie::Inliner do
           <p>Hello World</p>
         HTML
       end
+
+      it "is not touched when inside a SVG element" do
+        expect {
+          rendering <<-HTML
+            <p>Hello World</p>
+            <svg>
+              <style>This is not parseable by the CSS parser!</style>
+            </svg>
+          HTML
+        }.to_not raise_error
+      end
     end
   end
 
@@ -433,12 +484,49 @@ describe Roadie::Inliner do
       end
     end
 
+    # This case was happening for some users when emails were rendered as part
+    # of the request cycle. I do not know it we *really* should accept these
+    # values, but it looks like Rails do accept it so we might as well do it
+    # too.
+    it "supports protocol settings with additional tokens" do
+      use_css "img { background: url(/a.jpg); }"
+      rendering('<img src="/b.jpg" />', :url_options => {:host => 'example.com', :protocol => 'https://'}).tap do |document|
+        document.should have_attribute('src' => 'https://example.com/b.jpg').at_selector('img')
+        document.should have_styling('background' => 'url(https://example.com/a.jpg)')
+      end
+    end
+
     it "does not touch data: URIs" do
       use_css "div { background: url(data:abcdef); }"
       rendering('<div></div>').should have_styling('background' => 'url(data:abcdef)')
     end
   end
 
+  describe "custom converter" do
+    let(:html) { '<div id="foo"></div>' }
+
+    it "is invoked" do
+      after_inlining_handler = double("converter")
+      after_inlining_handler.should_receive(:call).with(anything)
+      rendering(html, :after_inlining_handler => after_inlining_handler)
+    end
+
+    it "modifies the document using lambda" do
+      after_inlining_handler = lambda {|d| d.css("#foo").first["class"] = "bar"}
+      rendering(html, :after_inlining_handler => after_inlining_handler).css("#foo").first["class"].should == "bar"
+    end
+
+    it "modifies the document using object" do
+      klass = Class.new do
+        def call(d)
+          d.css("#foo").first["class"] = "bar"
+        end
+      end
+      after_inlining_handler = klass.new
+      rendering(html, :after_inlining_handler => after_inlining_handler).css("#foo").first["class"].should == "bar"
+    end
+  end
+
   describe "inserting tags" do
     it "inserts a doctype if not present" do
       rendering('<html><body></body></html>').to_xml.should include('<!DOCTYPE ')

data/spec/lib/roadie/selector_spec.rb

@@ -0,0 +1,51 @@
+# encoding: UTF-8
+require 'spec_helper'
+
+module Roadie
+  describe Selector do
+    it "can be coerced into String" do
+      ("I love " + Selector.new("html")).should == "I love html"
+    end
+
+    it "can be inlined when simple" do
+      Selector.new("html body #main p.class").should be_inlinable
+    end
+
+    it "cannot be inlined when containing pseudo functions" do
+      %w[
+        p:active
+        p:focus
+        p:hover
+        p:link
+        p:target
+        p:visited
+      ].each do |bad_selector|
+        Selector.new(bad_selector).should_not be_inlinable
+      end
+
+      Selector.new('p.active').should be_inlinable
+    end
+
+    it "cannot be inlined when containing pseudo elements" do
+      Selector.new('p::some-element').should_not be_inlinable
+    end
+
+    it "cannot be inlined when selector is an at-rule" do
+      Selector.new('@keyframes progress-bar-stripes').should_not be_inlinable
+    end
+
+    it "has a calculated specificity" do
+      selector = "html p.active.nice #main.deep-selector"
+      Selector.new(selector).specificity.should == CssParser.calculate_specificity(selector)
+    end
+
+    it "is equal to other selectors when they match the same things" do
+      Selector.new("foo").should == Selector.new("foo ")
+      Selector.new("foo").should_not == "foo"
+    end
+
+    it "strips the given selector" do
+      Selector.new(" foo  \n").to_s.should == Selector.new("foo").to_s
+    end
+  end
+end