roadie 2.0.0 → 2.1.0.pre1

data/lib/roadie/filesystem_provider.rb

@@ -0,0 +1,74 @@
+require 'pathname'
+
+module Roadie
+  # A provider that looks for files on the filesystem
+  #
+  # Usage:
+  #   config.roadie.provider = FilesystemProvider.new("prefix", "path/to/stylesheets")
+  #
+  # Path specification follows certain rules thatare detailed in {#initialize}.
+  #
+  # @see #initialize
+  class FilesystemProvider < AssetProvider
+    # @return [Pathname] Pathname representing the directory of the assets
+    attr_reader :path
+
+    # Initializes a new instance of FilesystemProvider.
+    #
+    # The passed path can come in some variants:
+    # * +Pathname+ - will be used as-is
+    # * +String+ - If pointing to an absolute path, uses that path. If a relative path, relative from the +Rails.root+
+    # * +nil+ - Use the default path (equal to "public/stylesheets")
+    #
+    # @example Pointing to a directory in the project
+    #   FilesystemProvider.new(Rails.root.join("public", "assets"))
+    #   FilesystemProvider.new("public/assets")
+    #
+    # @example Pointing to external resource
+    #   FilesystemProvider.new("/home/app/stuff")
+    #
+    # @param [String] prefix The prefix (see {#prefix})
+    # @param [String, Pathname, nil] path The path to use
+    def initialize(prefix = "/stylesheets", path = nil)
+      super(prefix)
+      if path
+        @path = resolve_path(path)
+      else
+        @path = default_path
+      end
+    end
+
+    # Looks for the file in the tree. If the file cannot be found, and it does not end with ".css", the lookup
+    # will be retried with ".css" appended to the filename.
+    #
+    # @return [String] contents of the file
+    def find(name)
+      base = remove_prefix(name)
+      file = path.join(base)
+      if file.exist?
+        file.read.strip
+      else
+        return find("#{base}.css") if base.to_s !~ /\.css$/
+        raise CSSFileNotFound.new(name, base.to_s)
+      end
+    end
+
+    private
+      def default_path
+        resolve_path("public/stylesheets")
+      end
+
+      def resolve_path(path)
+        if path.kind_of?(Pathname)
+          @path = path
+        else
+          pathname = Pathname.new(path)
+          if pathname.absolute?
+            @path = pathname
+          else
+            @path = Roadie.app.root.join(path)
+          end
+        end
+      end
+  end
+end

data/lib/roadie/inliner.rb

@@ -21,17 +21,24 @@ module Roadie
       \)
     }x
 
-    # Initialize a new Inliner with the given CSS, HTML and url_options.
+    # Initialize a new Inliner with the given Provider, CSS targets, HTML, and `url_options`.
     #
-    # @param [String] css
+    # @param [AssetProvider] assets
+    # @param [Array] targets List of CSS files to load via the provider
     # @param [String] html
-    # @param [Hash] url_options Supported keys: +:host+, +:port+, +:protocol+ and +:asset_path_prefix:+
-    def initialize(css, html, url_options)
-      @css = css
-      @inline_css = []
+    # @param [Hash] url_options Supported keys: +:host+, +:port+, +:protocol+
+    def initialize(assets, targets, html, url_options)
+      @assets = assets
+      @css = assets.all(targets)
       @html = html
+      @inline_css = []
       @url_options = url_options
-      @asset_path_prefix = (url_options && url_options[:asset_path_prefix] || "/assets/")
+
+      if url_options and url_options[:asset_path_prefix]
+        raise ArgumentError, "The asset_path_prefix URL option is not working anymore. You need to add the following configuration to your application.rb:\n" +
+                             "    config.roadie.provider = AssetPipelineProvider.new(#{url_options[:asset_path_prefix].inspect})\n" +
+                             "Note that the prefix \"/assets\" is the default one, so you do not need to configure anything in that case."
+      end
     end
 
     # Start the inlining and return the final HTML output
@@ -50,7 +57,7 @@ module Roadie
     end
 
     private
-      attr_reader :css, :html, :url_options, :document
+      attr_reader :css, :html, :assets, :url_options, :document
 
       def inline_css
         @inline_css.join("\n")
@@ -63,13 +70,6 @@ module Roadie
         end
       end
 
-      def find_asset_from_url(url)
-        asset_filename = url.path.sub(/^#{Regexp.quote(@asset_path_prefix)}/, '').gsub(%r{^/|//+}, '')
-        Roadie.assets[asset_filename].tap do |asset|
-          raise CSSFileNotFound.new(asset_filename, url) unless asset
-        end
-      end
-
       def adjust_html
         Nokogiri::HTML.parse(html).tap do |document|
           yield document
@@ -99,7 +99,7 @@ module Roadie
 
       def extract_link_elements
         all_link_elements_to_be_inlined_with_url.each do |link, url|
-          asset = find_asset_from_url(url)
+          asset = assets.find(url.path)
           @inline_css << asset.to_s
           link.remove
         end

data/lib/roadie/railtie.rb

@@ -0,0 +1,22 @@
+require 'action_mailer'
+require 'roadie/action_mailer_extensions'
+
+module Roadie
+  # {Roadie::Railtie} registers {Roadie} with the current Rails application
+  # It adds another configuration option:
+  #
+  #     config.roadie.provider = nil
+  #
+  # You can use this to set a provider yourself.
+  #
+  # @see Roadie
+  # @see AssetProvider
+  class Railtie < Rails::Railtie
+    config.roadie = ActiveSupport::OrderedOptions.new
+    config.roadie.provider = nil
+
+    initializer "roadie.extend_action_mailer" do
+      ActionMailer::Base.send :include, Roadie::ActionMailerExtensions
+    end
+  end
+end

data/lib/roadie/version.rb

@@ -1,3 +1,3 @@
 module Roadie
-  VERSION = '2.0.0'
+  VERSION = '2.1.0.pre1'
 end

data/roadie.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'actionmailer', '~> 3.1.0'
   s.add_dependency 'sprockets'
 
+  s.add_development_dependency 'rails'
   s.add_development_dependency 'rspec-rails', '>= 2.0.0'
 
   s.extra_rdoc_files = %w[README.md Changelog.md]

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/integration_spec.rb

@@ -1,68 +1,83 @@
 require 'spec_helper'
 
-describe "roadie integration" do
-  class IntegrationMailer < ActionMailer::Base
-    default :css => :integration, :from => 'john@example.com'
-    append_view_path FIXTURES_PATH.join('views')
-
-    def notification(to, reason)
-      @reason = reason
-      mail(:subject => 'Notification for you', :to => to) { |format| format.html; format.text }
+module Roadie
+  shared_examples "roadie integration" do
+    mailer = Class.new(ActionMailer::Base) do
+      def self.name() "IntegrationMailer" end
+
+      default :css => :integration, :from => 'john@example.com'
+      append_view_path FIXTURES_PATH.join('views')
+
+      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
     end
 
-    def marketing(to)
-      headers('X-Spam' => 'No way! Trust us!')
-      mail(:subject => 'Buy cheap v1agra', :to => to)
+    before(:each) do
+      Rails.application.config.action_mailer.default_url_options = {:host => "example.app.org"}
+
+      Rails.stub(:root => FIXTURES_PATH)
+      mailer.delivery_method = :test
     end
-  end
 
-  before(:each) do
-    config = double(:action_mailer => double(:default_url_options => {:host => "example.app.org"}))
-    Rails.application.stub(:config => config)
+    it "inlines styles for an email" do
+      email = mailer.notification('doe@example.com', 'your quota limit has been reached')
 
-    Rails.stub(:root => FIXTURES_PATH)
-    IntegrationMailer.delivery_method = :test
-  end
+      email.to.should == ['doe@example.com']
+      email.from.should == ['john@example.com']
+      email.should have(2).parts
 
-  it "inlines styles for an email" do
-    email = IntegrationMailer.notification('doe@example.com', 'your quota limit has been reached')
+      email.parts.find { |part| part.mime_type == 'text/html' }.tap do |html_part|
+        document = Nokogiri::HTML.parse(html_part.body.decoded)
+        document.should have_selector('html > head + body')
+        document.should have_selector('body #message h1')
+        document.should have_styling('background' => 'url(http://example.app.org/images/dots.png) repeat-x').at_selector('body')
+        document.should have_selector('strong[contains("quota")]')
+      end
 
-    email.to.should == ['doe@example.com']
-    email.from.should == ['john@example.com']
-    email.should have(2).parts
+      email.parts.find { |part| part.mime_type == 'text/plain' }.tap do |plain_part|
+        plain_part.body.decoded.should_not match(/<.*>/)
+      end
 
-    email.parts.find { |part| part.mime_type == 'text/html' }.tap do |html_part|
-      document = Nokogiri::HTML.parse(html_part.body.decoded)
-      document.should have_selector('html > head + body')
-      document.should have_selector('body #message h1')
-      document.should have_styling('background' => 'url(http://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
 
-    email.parts.find { |part| part.mime_type == 'text/plain' }.tap do |plain_part|
-      plain_part.body.decoded.should_not match(/<.*>/)
+    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
 
-    # If we deliver mails we can catch weird problems with headers being invalid
-    email.deliver
-  end
+    it "keeps custom headers in place" do
+      email = mailer.marketing('everyone@inter.net')
+      email.header['X-Spam'].should be_present
+    end
 
-  it "does not add headers for the roadie options" do
-    email = IntegrationMailer.notification('doe@example.com', 'no berries left in chest')
-    email.header.fields.map(&:name).should_not include('css')
+    it "applies CSS3 styles" do
+      email = mailer.notification('doe@example.com', 'your quota limit has been reached')
+      document = Nokogiri::HTML.parse(email.html_part.body.decoded)
+      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
   end
 
-  it "keeps custom headers in place" do
-    email = IntegrationMailer.marketing('everyone@inter.net')
-    email.header['X-Spam'].should be_present
+  describe "filesystem integration" do
+    it_behaves_like "roadie integration" do
+      before(:each) { Rails.application.config.assets.enabled = false }
+    end
   end
 
-  it "applies CSS3 styles" do
-    email = IntegrationMailer.notification('doe@example.com', 'your quota limit has been reached')
-    document = Nokogiri::HTML.parse(email.html_part.body.decoded)
-    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'])
+  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

@@ -1,106 +1,122 @@
 # coding: utf-8
 require 'spec_helper'
 
-describe Roadie::ActionMailerExtensions, "inlining styles" do
-  class InliningMailer < ActionMailer::Base
-    default :css => :simple
-
-    def multipart
-      mail(:subject => "Multipart email") do |format|
-        format.html { render :text => 'Hello HTML' }
-        format.text { render :text => 'Hello Text' }
+module Roadie
+  describe ActionMailerExtensions, "CSS selection" do
+    mailer = Class.new(ActionMailer::Base) do
+      default :css => :default
+
+      # Just to make ActionMailer::Base not puke
+      def self.name
+        "SomeMailer"
       end
-    end
 
-    def singlepart_html
-      mail(:subject => "HTML email") do |format|
-        format.html { render :text => 'Hello HTML' }
+      def default_css
+        mail(:subject => "Default CSS") do |format|
+          format.html { render :text => '' }
+        end
       end
-    end
 
-    def singlepart_plain
-      mail(:subject => "Text email") do |format|
-        format.text { render :text => 'Hello Text' }
+      def override_css(css)
+        mail(:subject => "Default CSS", :css => css) do |format|
+          format.html { render :text => '' }
+        end
       end
     end
-  end
-
-  before(:each) do
-    Roadie.stub!(:load_css => 'loaded css')
-    Roadie.stub!(:inline_css => 'unexpected value passed to inline_css')
-  end
 
-  describe "for singlepart text/plain" do
-    it "does not touch the email body" do
-      Roadie.should_not_receive(:inline_css)
-      InliningMailer.singlepart_plain
+    def expect_global_css(files)
+      Roadie.should_receive(:inline_css).with(provider, files, anything, anything).and_return('')
     end
-  end
 
-  describe "for singlepart text/html" do
-    it "inlines css to the email body" do
-      Roadie.should_receive(:inline_css).with(anything, 'Hello HTML', anything).and_return('html')
-      InliningMailer.singlepart_html.body.decoded.should == 'html'
+    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
-  end
 
-  describe "for multipart" do
-    it "keeps both parts" do
-      InliningMailer.multipart.should have(2).parts
+    it "uses no global CSS when :css is set to nil" do
+      expect_global_css []
+      mailer.override_css(nil)
     end
 
-    it "inlines css to the email's html part" do
-      Roadie.should_receive(:inline_css).with(anything, 'Hello HTML', anything).and_return('html')
-      email = InliningMailer.multipart
-      email.html_part.body.decoded.should == 'html'
-      email.text_part.body.decoded.should == 'Hello Text'
+    it "uses no global CSS when :css is set to false" do
+      expect_global_css []
+      mailer.override_css(false)
     end
-  end
-end
 
-describe Roadie::ActionMailerExtensions, "loading css files" do
-  class CssLoadingMailer < ActionMailer::Base
-    default :css => :default_value
-    def use_default
-      mail &with_empty_html_response
+    it "uses the default CSS when :css is not specified" do
+      expect_global_css ['default']
+      mailer.default_css
     end
 
-    def override(target)
-      mail :css => target, &with_empty_html_response
+    it "uses the specified CSS instead of the default" do
+      expect_global_css ['some', 'other/files']
+      mailer.override_css([:some, 'other/files'])
     end
+  end
 
-    protected
-      def with_empty_html_response
-        Proc.new { |format| format.html { render :text => '' } }
+  describe ActionMailerExtensions, "using HTML" do
+    mailer = Class.new(ActionMailer::Base) do
+      default :css => :simple
+
+      # Just to make ActionMailer::Base not puke
+      def self.name
+        "SomeMailer"
       end
-  end
 
-  before(:each) do
-    Roadie.stub!(:inline_css => 'html')
-  end
+      def multipart
+        mail(:subject => "Multipart email") do |format|
+          format.html { render :text => 'Hello HTML' }
+          format.text { render :text => 'Hello Text' }
+        end
+      end
 
-  it "loads css from Roadie" do
-    Roadie.should_receive(:load_css).with(anything).and_return('')
-    CssLoadingMailer.use_default
-  end
+      def singlepart_html
+        mail(:subject => "HTML email") do |format|
+          format.html { render :text => 'Hello HTML' }
+        end
+      end
 
-  it "loads the css specified in the default mailer settings" do
-    Roadie.should_receive(:load_css).with(['default_value']).and_return('')
-    CssLoadingMailer.use_default
-  end
+      def singlepart_plain
+        mail(:subject => "Text email") do |format|
+          format.text { render :text => 'Hello Text' }
+        end
+      end
+    end
 
-  it "loads the css specified in the specific mailer action instead of the default choice" do
-    Roadie.should_receive(:load_css).with(['specific']).and_return('')
-    CssLoadingMailer.override(:specific)
-  end
+    let(:provider) { double("asset provider", :all => '') }
 
-  it "loads no css when specifying false in the mailer action" do
-    Roadie.should_not_receive(:load_css)
-    CssLoadingMailer.override(false)
-  end
+    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).and_return('html')
+        mailer.singlepart_html.body.decoded.should == 'html'
+      end
+    end
 
-  it "loads multiple css files when given an array" do
-    Roadie.should_receive(:load_css).with(['specific', 'other']).and_return('')
-    CssLoadingMailer.override([:specific, :other])
+    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).and_return('html')
+        email = mailer.multipart
+        email.html_part.body.decoded.should == 'html'
+        email.text_part.body.decoded.should == 'Hello Text'
+      end
+    end
   end
 end