md-roadie 2.4.2.md.1

data/lib/roadie/railtie.rb

@@ -0,0 +1,39 @@
+require 'action_mailer'
+require 'roadie'
+require 'roadie/action_mailer_extensions'
+
+module Roadie
+  # {Roadie::Railtie} registers {Roadie} with the current Rails application
+  # It adds configuration options:
+  #
+  #     config.roadie.enabled = true
+  #       Set this to false to disable Roadie completely. This could be useful if
+  #       you don't want Roadie in certain environments.
+  #
+  #     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
+  class Railtie < Rails::Railtie
+    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
+        include Roadie::ActionMailerExtensions
+      end
+    end
+  end
+end

data/lib/roadie/selector.rb

@@ -0,0 +1,50 @@
+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
+                                :-ms-input-placeholder :-moz-placeholder
+                                :before :after].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

@@ -0,0 +1,42 @@
+module Roadie
+  class StyleDeclaration
+    include Comparable
+    attr_reader :property, :value, :important, :specificity
+
+    def initialize(property, value, important, specificity)
+      @property = property
+      @value = value
+      @important = important
+      @specificity = specificity
+    end
+
+    def important?
+      @important
+    end
+
+    def <=>(other)
+      if important == other.important
+        specificity <=> other.specificity
+      else
+        important ? 1 : -1
+      end
+    end
+
+    def to_s
+      [property, value_with_important].join(':')
+    end
+
+    def inspect
+      "#{to_s} (#{specificity})"
+    end
+
+    private
+    def value_with_important
+      if important
+        "#{value} !important"
+      else
+        value
+      end
+    end
+  end
+end

data/lib/roadie/version.rb

@@ -0,0 +1,3 @@
+module Roadie
+  VERSION = '2.4.2.md.1'
+end

data/md-roadie.gemspec

@@ -0,0 +1,36 @@
+# roadie.gemspec
+# -*- encoding: utf-8 -*-
+
+$:.push File.expand_path("../lib", __FILE__)
+require 'roadie/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'md-roadie'
+  s.version     = Roadie::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Magnus Bergmark', 'BJ Neilsen']
+  s.email       = ['magnus.bergmark@gmail.com', 'bj.neilsen@gmail.com']
+  s.homepage    = 'http://github.com/Mange/roadie'
+  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', RUBY_VERSION < '1.9.3' ? ['> 1.5.0', '< 1.6.0'] : '> 1.5.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 'special_delivery'
+
+  s.add_development_dependency 'appraisal'
+
+  s.extra_rdoc_files = %w[README.md Changelog.md]
+  s.require_paths = %w[lib]
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- spec/*`.split("\n")
+end
+

data/spec/fixtures/app/assets/stylesheets/integration.css

@@ -0,0 +1,10 @@
+body { background: url(../images/dots.png) repeat-x; }
+#message { background-color: #fff; margin: 0 auto; width: 75%; }
+
+h1 { color: #eee; }
+strong {
+  -moz-box-shadow: #62b0d7 1px 1px 1px 1px inset, #aaaaaa 1px 1px 3px 0;
+  -webkit-box-shadow: #62b0d7 1px 1px 1px 1px inset, #aaaaaa 1px 1px 3px 0;
+  -o-box-shadow: #62b0d7 1px 1px 1px 1px inset, #aaaaaa 1px 1px 3px 0;
+  box-shadow: #62b0d7 1px 1px 1px 1px inset, #aaaaaa 1px 1px 3px 0;
+}

data/spec/fixtures/public/stylesheets/integration.css

@@ -0,0 +1,10 @@
+body { background: url(../images/dots.png) repeat-x; }
+#message { background-color: #fff; margin: 0 auto; width: 75%; }
+
+h1 { color: #eee; }
+strong {
+  -moz-box-shadow: #62b0d7 1px 1px 1px 1px inset, #aaaaaa 1px 1px 3px 0;
+  -webkit-box-shadow: #62b0d7 1px 1px 1px 1px inset, #aaaaaa 1px 1px 3px 0;
+  -o-box-shadow: #62b0d7 1px 1px 1px 1px inset, #aaaaaa 1px 1px 3px 0;
+  box-shadow: #62b0d7 1px 1px 1px 1px inset, #aaaaaa 1px 1px 3px 0;
+}

data/spec/fixtures/views/integration_mailer/marketing.html.erb

@@ -0,0 +1,2 @@
+Contact us to buy stuff!
+<a href="http://www.example.com/cheap-marketing">SPAM MASTERS</a>

data/spec/fixtures/views/integration_mailer/notification.html.erb

@@ -0,0 +1,8 @@
+<div id="message">
+  <h1>Dear person</1>
+
+  <p>I have to inform you that <strong><%= @reason %></strong>.</p>
+
+  <p>Thank you,<br />
+  The app</p>
+</div>

data/spec/fixtures/views/integration_mailer/notification.text.erb

@@ -0,0 +1,6 @@
+= Dear person =
+
+I have to inform you that <%= @reason %>.
+
+Thank you,
+The app

data/spec/integration_spec.rb

@@ -0,0 +1,110 @@
+require 'spec_helper'
+
+module Roadie
+  shared_examples "roadie integration" do
+    mailer = Class.new(AnonymousMailer) do
+      default :css => 'integration', :from => 'john@example.com'
+      append_view_path FIXTURES_PATH.join('views')
+
+      # Needed for correct path lookup
+      self.mailer_name = "integration_mailer"
+
+      def notification(to, reason)
+        @reason = reason
+        mail(:subject => 'Notification for you', :to => to) { |format| format.html; format.text }
+      end
+
+      def marketing(to)
+        headers('X-Spam' => 'No way! Trust us!')
+        mail(:subject => 'Buy cheap v1agra', :to => to)
+      end
+
+      def url_options
+        # This allows apps to calculate any options on a per-email basis
+        super.merge(:protocol => 'https')
+      end
+    end
+
+    def parse_html_in_email(mail)
+      Nokogiri::HTML.parse mail.html_part.body.decoded
+    end
+
+    before(:each) do
+      change_default_url_options(:host => 'example.app.org')
+      mailer.delivery_method = :test
+    end
+
+    it "inlines styles for an email" do
+      email = mailer.notification('doe@example.com', 'your quota limit has been reached')
+
+      email.to.should == ['doe@example.com']
+      email.from.should == ['john@example.com']
+      email.should have(2).parts
+
+      email.text_part.body.decoded.should_not match(/<.*>/)
+
+      html = email.html_part.body.decoded
+      html.should include '<!DOCTYPE'
+      html.should include '<head'
+
+      document = parse_html_in_email(email)
+      document.should have_selector('body #message h1')
+      document.should have_styling('background' => 'url(https://example.app.org/images/dots.png) repeat-x').at_selector('body')
+      document.should have_selector('strong[contains("quota")]')
+
+      # If we deliver mails we can catch weird problems with headers being invalid
+      email.deliver
+    end
+
+    it "does not add headers for the roadie options" do
+      email = mailer.notification('doe@example.com', 'no berries left in chest')
+      email.header.fields.map(&:name).should_not include('css')
+    end
+
+    it "keeps custom headers in place" do
+      email = mailer.marketing('everyone@inter.net')
+      email.header['X-Spam'].should be_present
+    end
+
+    it "applies CSS3 styles" do
+      email = mailer.notification('doe@example.com', 'your quota limit has been reached')
+      document = parse_html_in_email(email)
+      strong_node = document.css('strong').first
+      stylings = SpecHelpers.styling_of_node(strong_node)
+      stylings.should include(['box-shadow', '#62b0d7 1px 1px 1px 1px inset, #aaaaaa 1px 1px 3px 0'])
+      stylings.should include(['-o-box-shadow', '#62b0d7 1px 1px 1px 1px inset, #aaaaaa 1px 1px 3px 0'])
+    end
+
+    it "only removes the css option when disabled" do
+      Rails.application.config.roadie.enabled = false
+
+      email = mailer.notification('doe@example.com', 'your quota limit has been reached')
+
+      email.header.fields.map(&:name).should_not include('css')
+
+      email.to.should == ['doe@example.com']
+      email.from.should == ['john@example.com']
+      email.should have(2).parts
+
+      html = email.html_part.body.decoded
+      html.should_not include '<!DOCTYPE'
+      html.should_not include '<head'
+
+      document = parse_html_in_email(email)
+      document.should_not have_styling('color' => '#eee').at_selector('h1')
+      document.should_not have_styling('background' => 'url(https://example.app.org/images/dots.png) repeat-x').at_selector('body')
+    end
+  end
+
+  describe "filesystem integration" do
+    it_behaves_like "roadie integration" do
+      before(:each) { Rails.application.config.assets.enabled = false }
+    end
+  end
+
+  describe "asset pipeline integration" do
+    it_behaves_like "roadie integration" do
+      before(:each) { Rails.application.config.assets.enabled = true }
+    end
+  end
+end

data/spec/lib/roadie/action_mailer_extensions_spec.rb

@@ -0,0 +1,227 @@
+# coding: utf-8
+require 'spec_helper'
+
+module Roadie
+  describe ActionMailerExtensions, "CSS selection" do
+    mailer = Class.new(AnonymousMailer) do
+      default :css => 'default'
+
+      def default_css
+        mail(:subject => "Default CSS") do |format|
+          format.html { render :text => '' }
+        end
+      end
+
+      def override_css(css)
+        mail(:subject => "Default CSS", :css => css) do |format|
+          format.html { render :text => '' }
+        end
+      end
+    end
+
+    def expect_global_css(files)
+      Roadie.should_receive(:inline_css).with(provider, files, anything, anything, anything).and_return('')
+    end
+
+    let(:provider) { double("asset provider", :all => '') }
+
+    before(:each) do
+      Roadie.stub(:inline_css => 'unexpected value passed to inline_css')
+      Roadie.stub(:current_provider => provider)
+    end
+
+    it "uses the default CSS when :css is not specified" do
+      expect_global_css ['default']
+      mailer.default_css
+    end
+
+    it "uses the specified CSS instead of the default" do
+      expect_global_css ['some', 'other/files']
+      mailer.override_css([:some, 'other/files'])
+    end
+
+    it "allows procs defining the CSS files to use" do
+      proc = lambda { 'from proc' }
+
+      expect_global_css ['from proc']
+      mailer.override_css([proc])
+    end
+
+    it "runs procs in the context of the instance" do
+      new_mailer = Class.new(mailer) do
+        private
+        def a_private_method
+          'from private method'
+        end
+      end
+      proc = lambda { a_private_method }
+
+      expect_global_css ['from private method']
+      new_mailer.override_css([proc])
+    end
+
+    it "uses no global CSS when :css is set to nil" do
+      expect_global_css []
+      mailer.override_css(nil)
+    end
+
+    it "uses no global CSS when :css is set to false" do
+      expect_global_css []
+      mailer.override_css(false)
+    end
+
+    it "uses no global CSS when :css is set to a proc returning nil" do
+      expect_global_css []
+      mailer.override_css(lambda { nil })
+    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'
+
+      def multipart
+        mail(:subject => "Multipart email") do |format|
+          format.html { render :text => 'Hello HTML' }
+          format.text { render :text => 'Hello Text' }
+        end
+      end
+
+      def singlepart_html
+        mail(:subject => "HTML email") do |format|
+          format.html { render :text => 'Hello HTML' }
+        end
+      end
+
+      def singlepart_plain
+        mail(:subject => "Text email") do |format|
+          format.text { render :text => 'Hello Text' }
+        end
+      end
+    end
+
+    let(:provider) { double("asset provider", :all => '') }
+
+    before(:each) do
+      Roadie.stub(:inline_css => 'unexpected value passed to inline_css')
+      Roadie.stub(:current_provider => provider)
+    end
+
+    describe "for singlepart text/plain" do
+      it "does not touch the email body" do
+        Roadie.should_not_receive(:inline_css)
+        mailer.singlepart_plain
+      end
+    end
+
+    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, anything).and_return('html')
+        mailer.singlepart_html.body.decoded.should == 'html'
+      end
+
+      it "does not inline css when Roadie is disabled" do
+        Roadie.stub :enabled? => false
+        Roadie.should_not_receive(:inline_css)
+        mailer.singlepart_html.body.decoded.should == 'Hello HTML'
+      end
+    end
+
+    describe "for multipart" do
+      it "keeps both parts" do
+        mailer.multipart.should have(2).parts
+      end
+
+      it "inlines css to the email's html part" do
+        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'
+      end
+
+      it "does not inline css when Roadie is disabled" do
+        Roadie.stub :enabled? => false
+        Roadie.should_not_receive(:inline_css)
+        email = mailer.multipart
+        email.html_part.body.decoded.should == 'Hello HTML'
+        email.text_part.body.decoded.should == 'Hello Text'
+      end
+    end
+  end
+end