roadie 2.0.0 → 2.1.0.pre1

data/spec/lib/roadie/asset_pipeline_provider_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+require 'shared_examples/asset_provider_examples'
+
+module Roadie
+  describe AssetPipelineProvider do
+    let(:provider) { AssetPipelineProvider.new }
+
+    it_behaves_like AssetProvider
+
+    it "has a configurable prefix" do
+      AssetPipelineProvider.new("/prefix").prefix.should == "/prefix"
+    end
+
+    it 'has a prefix of "/assets" by default' do
+      provider.prefix.should == "/assets"
+    end
+
+    describe "#find(file)" do
+      let(:pipeline) { double("Rails asset pipeline") }
+      before(:each) { Roadie.app.stub(:assets => pipeline) }
+
+      def expect_pipeline_access(name, returning = '')
+        pipeline.should_receive(:[]).with(name).and_return(returning)
+      end
+
+      it "loads files matching the target names in Rails assets" do
+        expect_pipeline_access('foo', 'contents of foo')
+        expect_pipeline_access('foo.css', 'contents of foo.css')
+
+        provider.find('foo').should == 'contents of foo'
+        provider.find('foo.css').should == 'contents of foo.css'
+      end
+
+      it "strips the contents" do
+        expect_pipeline_access('foo', "   contents  \n ")
+        provider.find('foo').should == "contents"
+      end
+
+      it "removes the prefix from the filename" do
+        expect_pipeline_access('foo')
+        expect_pipeline_access('path/to/foo')
+        expect_pipeline_access('bar')
+
+        provider = AssetPipelineProvider.new("/prefix")
+        provider.find('/prefix/foo')
+        provider.find('/prefix/path/to/foo')
+        provider.find('prefix/bar')
+      end
+
+      it "cleans up double slashes from the path" do
+        expect_pipeline_access('path/to/foo')
+
+        provider = AssetPipelineProvider.new("/prefix/")
+        provider.find('/prefix/path/to//foo')
+      end
+
+      it "raises a Roadie::CSSFileNotFound error when the file could not be found" do
+        expect_pipeline_access('not_here', nil)
+        expect {
+          provider.find('not_here')
+        }.to raise_error(Roadie::CSSFileNotFound, /not_here/)
+      end
+    end
+  end
+end

data/spec/lib/roadie/filesystem_provider_spec.rb

@@ -0,0 +1,94 @@
+require 'spec_helper'
+require 'shared_examples/asset_provider_examples'
+require 'tmpdir'
+
+module Roadie
+  describe FilesystemProvider do
+    let(:provider) { FilesystemProvider.new }
+
+    it_behaves_like AssetProvider
+
+    it "has a configurable prefix" do
+      FilesystemProvider.new("/prefix").prefix.should == "/prefix"
+    end
+
+    it "has a configurable path" do
+      path = Pathname.new("/path")
+      FilesystemProvider.new('', path).path.should == path
+    end
+
+    it "bases the path on the project root if passed a string with a relative path" do
+      FilesystemProvider.new('', "foo/bar").path.should == Roadie.app.root.join("foo", "bar")
+      FilesystemProvider.new('', "/foo/bar").path.should == Pathname.new("/foo/bar")
+    end
+
+    it 'has a path of "<root>/public/stylesheets" by default' do
+      FilesystemProvider.new.path.should == Roadie.app.root.join('public', 'stylesheets')
+    end
+
+    it 'has a prefix of "/stylesheets" by default' do
+      FilesystemProvider.new.prefix.should == "/stylesheets"
+    end
+
+    describe "#find(file)" do
+      around(:each) do |example|
+        Dir.mktmpdir do |path|
+          Dir.chdir(path) { example.run }
+        end
+      end
+
+      let(:provider) { FilesystemProvider.new('/prefix', Pathname.new('.')) }
+
+      def create_file(name, contents = '')
+        Pathname.new(name).tap do |path|
+          path.dirname.mkpath unless path.dirname.directory?
+          path.open('w') { |file| file << contents }
+        end
+      end
+
+      it "loads files from the filesystem" do
+        create_file('foo.css', 'contents of foo.css')
+        provider.find('foo.css').should == 'contents of foo.css'
+      end
+
+      it "removes the prefix" do
+        create_file('foo.css', 'contents of foo.css')
+        provider.find('/prefix/foo.css').should == 'contents of foo.css'
+        provider.find('prefix/foo.css').should == 'contents of foo.css'
+      end
+
+      it 'tries the filename with a ".css" extension if it does not exist' do
+        create_file('bar',     'in bare bar')
+        create_file('bar.css', 'in bar.css')
+        create_file('foo.css', 'in foo.css')
+
+        provider.find('bar').should == 'in bare bar'
+        provider.find('foo').should == 'in foo.css'
+      end
+
+      it "strips the contents" do
+        create_file('foo.css', "   contents  \n ")
+        provider.find('foo.css').should == "contents"
+      end
+
+      it "supports nested directories" do
+        create_file('path/to/foo.css')
+        create_file('path/from/bar.css')
+
+        provider.find('path/to/foo.css')
+        provider.find('path/from/bar.css')
+      end
+
+      it "works with double slashes in the path" do
+        create_file('path/to/foo.css')
+        provider.find('path/to//foo.css')
+      end
+
+      it "raises a Roadie::CSSFileNotFound error when the file could not be found" do
+        expect {
+          provider.find('not_here.css')
+        }.to raise_error(Roadie::CSSFileNotFound, /not_here/)
+      end
+    end
+  end
+end

data/spec/lib/roadie/inliner_spec.rb

@@ -2,10 +2,23 @@
 require 'spec_helper'
 
 describe Roadie::Inliner do
-  def use_css(css); @css = css; end
+  let(:provider) { double("asset provider", :all => '') }
+
+  def use_css(css)
+    provider.stub(:all).with(['global.css']).and_return(css)
+  end
+
   def rendering(html, options = {})
     url_options = options.fetch(:url_options, {:host => 'example.com'})
-    Nokogiri::HTML.parse Roadie::Inliner.new(@css, html, url_options).execute
+    Nokogiri::HTML.parse Roadie::Inliner.new(provider, ['global.css'], html, url_options).execute
+  end
+
+  describe "initialization" do
+    it "warns about asset_path_prefix being non-functional" do
+      expect {
+        Roadie::Inliner.new(provider, [], '', :asset_path_prefix => 'foo')
+      }.to raise_error(ArgumentError, /asset_path_prefix/)
+    end
   end
 
   describe "inlining styles" do
@@ -149,7 +162,13 @@ describe Roadie::Inliner do
   end
 
   describe "linked stylesheets" do
+    def fake_file(name, contents)
+      provider.should_receive(:find).with(name).and_return(contents)
+    end
+
     it "inlines styles from the linked stylesheet" do
+      fake_file('/assets/green_paragraphs.css', 'p { color: green; }')
+
       rendering(<<-HTML).should have_styling('color' => 'green').at_selector('p')
         <html>
           <head>
@@ -163,6 +182,8 @@ describe Roadie::Inliner do
     end
 
     it "inlines styles from the linked stylesheet in subdirectory" do
+      fake_file('/assets/subdirectory/red_paragraphs.css', 'p { color: red; }')
+
       rendering(<<-HTML).should have_styling('color' => 'red').at_selector('p')
         <html>
           <head>
@@ -176,11 +197,14 @@ describe Roadie::Inliner do
     end
 
     it "inlines styles from more than one linked stylesheet" do
+      fake_file('/assets/large_purple_paragraphs.css', 'p { font-size: 18px; color: purple; }')
+      fake_file('/assets/green_paragraphs.css', 'p { color: green; }')
+
       html = <<-HTML
         <html>
           <head>
-            <link rel="stylesheet" href="/assets/green_paragraphs.css">
             <link rel="stylesheet" href="/assets/large_purple_paragraphs.css">
+            <link rel="stylesheet" href="/assets/green_paragraphs.css">
           </head>
           <body>
             <p></p>
@@ -189,12 +213,13 @@ describe Roadie::Inliner do
       HTML
 
       rendering(html).should have_styling([
-        ['color', 'purple'],
         ['font-size', '18px'],
+        ['color', 'green'],
       ]).at_selector('p')
     end
 
     it "removes the stylesheet links from the DOM" do
+      provider.stub(:find => '')
       rendering(<<-HTML).should_not have_selector('link')
         <html>
           <head>
@@ -302,7 +327,7 @@ describe Roadie::Inliner do
 
         expect { rendering(html) }.to raise_error do |error|
           error.should be_a(Roadie::CSSFileNotFound)
-          error.filename.should == Roadie.assets['not_found.css']
+          error.filename.should == Roadie.app.assets['not_found.css']
           error.guess.should == '/assets/not_found.css'
         end
       end

data/spec/lib/roadie_spec.rb

@@ -8,31 +8,46 @@ describe Roadie do
     end
   end
 
-  describe ".assets" do
-    it "delegates to Rails.application.assets" do
-      Rails.stub(:application => double(:assets => 'assets'))
-      Roadie.assets.should == 'assets'
+  describe ".app" do
+    it "delegates to Rails.application" do
+      Rails.stub(:application => 'application')
+      Roadie.app.should == 'application'
     end
   end
 
-  describe ".load_css(targets)" do
-    it "loads files matching the target names in Rails assets" do
-      Roadie.load_css(['foo']).should == 'contents of foo'
-      Roadie.load_css(['foo.css']).should == 'contents of foo'
+  describe ".providers" do
+    it "returns an array of all provider classes" do
+      Roadie.should have(2).providers
+      Roadie.providers.should include(Roadie::AssetPipelineProvider, Roadie::FilesystemProvider)
     end
+  end
+
+  describe ".current_provider" do
+    let(:provider) { Object.new }
 
-    it "loads files in order and join them with a newline" do
-      Roadie.load_css(%w[foo bar]).should == "contents of foo\ncontents of bar"
-      Roadie.load_css(%w[bar foo]).should == "contents of bar\ncontents of foo"
+    context "with a set provider in the config" do
+      it "uses the set provider" do
+        Roadie.app.config.roadie.provider = provider
+        Roadie.current_provider.should == provider
+      end
     end
 
-    it "loads files also from asset subdirectories" do
-      Roadie.load_css(%w[foo subdirectory/findme.css]).should == "contents of foo\ncan you really find me?"
-      Roadie.load_css(%w[bar foo]).should == "contents of bar\ncontents of foo"
+    context "with rails' asset pipeline enabled" do
+      before(:each) { Roadie.app.config.assets.enabled = true }
+
+      it "uses the AssetPipelineProvider" do
+        Roadie::AssetPipelineProvider.should_receive(:new).and_return(provider)
+        Roadie.current_provider.should == provider
+      end
     end
 
-    it "raises a Roadie::CSSFileNotFound error when a css file could not be found" do
-      expect { Roadie.load_css(['not_here']) }.to raise_error(Roadie::CSSFileNotFound, /not_here/)
+    context "with rails' asset pipeline disabled" do
+      before(:each) { Roadie.app.config.assets.enabled = false }
+
+      it "uses the FilesystemProvider" do
+        Roadie::FilesystemProvider.should_receive(:new).and_return(provider)
+        Roadie.current_provider.should == provider
+      end
     end
   end
 end

data/spec/shared_examples/asset_provider_examples.rb

@@ -0,0 +1,11 @@
+shared_examples_for Roadie::AssetProvider do
+  describe "#all(files)" do
+    it "loads files in order and join them with a newline" do
+      provider.should_receive(:find).with('one').twice.and_return('contents of one')
+      provider.should_receive(:find).with('two').twice.and_return('contents of two')
+
+      provider.all(%w[one two]).should == "contents of one\ncontents of two"
+      provider.all(%w[two one]).should == "contents of two\ncontents of one"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -13,27 +13,31 @@ rescue Bundler::BundlerError => e
 end
 
 require 'rspec'
-
-require 'action_mailer'
+require 'rails'
 require 'sprockets'
 require 'roadie'
 
 FIXTURES_PATH = Pathname.new(File.dirname(__FILE__)).join('fixtures')
+Roadie::Railtie.run_initializers
 
 class TestApplication
   def config
-    OpenStruct.new(:action_mailer => OpenStruct.new(:default_url_options => {:host => "example.com"}))
+    @config ||= OpenStruct.new({
+      :action_mailer => OpenStruct.new(:default_url_options => {:host => "example.com"}),
+      :assets => OpenStruct.new(:enabled => false),
+      :roadie => OpenStruct.new(:provider => nil),
+    })
   end
 
   def assets
     env = Sprockets::Environment.new
-    env.append_path FIXTURES_PATH.join('app','assets','stylesheets')
+    env.append_path root.join('app','assets','stylesheets')
     env
   end
-end
 
-unless defined?(Rails)
-  class Rails; end
+  def root
+    FIXTURES_PATH
+  end
 end
 
 RSpec.configure do |c|

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: roadie
 version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: 2.0.0
+  prerelease: 6
+  version: 2.1.0.pre1
 platform: ruby
 authors: 
 - Magnus Bergmark
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-13 00:00:00 +02:00
+date: 2011-11-24 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -58,16 +58,27 @@ dependencies:
   type: :runtime
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: rspec-rails
+  name: rails
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.0.0
+        version: "0"
   type: :development
   version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rspec-rails
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.0
+  type: :development
+  version_requirements: *id006
 description: Roadie tries to make sending HTML emails a little less painful in Rails 3 by inlining stylesheets and rewrite relative URLs for you.
 email: 
 - magnus.bergmark@gmail.com
@@ -92,27 +103,29 @@ files:
 - autotest/discover.rb
 - lib/roadie.rb
 - lib/roadie/action_mailer_extensions.rb
+- lib/roadie/asset_pipeline_provider.rb
+- lib/roadie/asset_provider.rb
 - lib/roadie/css_file_not_found.rb
+- lib/roadie/filesystem_provider.rb
 - lib/roadie/inliner.rb
+- lib/roadie/railtie.rb
 - lib/roadie/style_declaration.rb
 - lib/roadie/version.rb
 - roadie.gemspec
-- spec/fixtures/app/assets/stylesheets/bar.css
-- spec/fixtures/app/assets/stylesheets/foo.css
-- spec/fixtures/app/assets/stylesheets/green_paragraphs.css
 - spec/fixtures/app/assets/stylesheets/integration.css
-- spec/fixtures/app/assets/stylesheets/large_purple_paragraphs.css
-- spec/fixtures/app/assets/stylesheets/subdirectory/findme.css
-- spec/fixtures/app/assets/stylesheets/subdirectory/red_paragraphs.css
+- spec/fixtures/public/stylesheets/integration.css
 - spec/fixtures/views/integration_mailer/marketing.html.erb
 - spec/fixtures/views/integration_mailer/notification.html.erb
 - spec/fixtures/views/integration_mailer/notification.text.erb
 - spec/integration_spec.rb
 - spec/lib/roadie/action_mailer_extensions_spec.rb
+- spec/lib/roadie/asset_pipeline_provider_spec.rb
 - spec/lib/roadie/css_file_not_found_spec.rb
+- spec/lib/roadie/filesystem_provider_spec.rb
 - spec/lib/roadie/inliner_spec.rb
 - spec/lib/roadie/style_declaration_spec.rb
 - spec/lib/roadie_spec.rb
+- spec/shared_examples/asset_provider_examples.rb
 - spec/spec_helper.rb
 - spec/support/have_attribute_matcher.rb
 - spec/support/have_selector_matcher.rb
@@ -136,9 +149,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version 
-      version: "0"
+      version: 1.3.1
 requirements: []
 
 rubyforge_project: 
@@ -147,22 +160,20 @@ signing_key:
 specification_version: 3
 summary: Making HTML emails comfortable for the Rails rockstars
 test_files: 
-- spec/fixtures/app/assets/stylesheets/bar.css
-- spec/fixtures/app/assets/stylesheets/foo.css
-- spec/fixtures/app/assets/stylesheets/green_paragraphs.css
 - spec/fixtures/app/assets/stylesheets/integration.css
-- spec/fixtures/app/assets/stylesheets/large_purple_paragraphs.css
-- spec/fixtures/app/assets/stylesheets/subdirectory/findme.css
-- spec/fixtures/app/assets/stylesheets/subdirectory/red_paragraphs.css
+- spec/fixtures/public/stylesheets/integration.css
 - spec/fixtures/views/integration_mailer/marketing.html.erb
 - spec/fixtures/views/integration_mailer/notification.html.erb
 - spec/fixtures/views/integration_mailer/notification.text.erb
 - spec/integration_spec.rb
 - spec/lib/roadie/action_mailer_extensions_spec.rb
+- spec/lib/roadie/asset_pipeline_provider_spec.rb
 - spec/lib/roadie/css_file_not_found_spec.rb
+- spec/lib/roadie/filesystem_provider_spec.rb
 - spec/lib/roadie/inliner_spec.rb
 - spec/lib/roadie/style_declaration_spec.rb
 - spec/lib/roadie_spec.rb
+- spec/shared_examples/asset_provider_examples.rb
 - spec/spec_helper.rb
 - spec/support/have_attribute_matcher.rb
 - spec/support/have_selector_matcher.rb