roadie 1.0.1 → 1.1.0

data/Changelog.md

@@ -0,0 +1,37 @@
+### dev
+
+[full changelog](https://github.com/Mange/roadie/compare/v1.1.0...master)
+
+* Nothing yet
+
+### 1.1.0
+
+[full changelog](https://github.com/Mange/roadie/compare/v1.0.1...v1.1.0)
+
+* Enhancements:
+  * Support for inlining `<link>` elements (thanks to [aliix](https://github.com/aliix))
+
+### 1.0.1
+
+[full changelog](https://github.com/Mange/roadie/compare/v1.0.0...v1.0.1)
+
+* Enhancements:
+    * Full, official support for Ruby 1.9.2 (in addition to 1.8.7)
+* Dependencies:
+    * Explicilty depend on nokogiri >= 1.4.4
+
+### 1.0.0
+
+[full changelog](https://github.com/Mange/roadie/compare/legacy...v1.0.0)
+
+Roadie fork!
+
+* Enhancements:
+  * Support for Rails 3.0
+  * Code cleanup
+  * Support `!important`
+  * Tests
+  * + some other enhancements
+* Deprecations:
+  * Removed support for Rails 2.x
+

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    roadie (1.0.0)
+    roadie (1.0.1)
       actionmailer (~> 3.0.0)
       css_parser
       nokogiri (>= 1.4.4)
@@ -40,7 +40,7 @@ GEM
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
     mime-types (1.16)
-    nokogiri (1.4.4)
+    nokogiri (1.4.5)
     polyglot (0.3.1)
     rack (1.2.1)
     rack-mount (0.6.13)

data/README.md

@@ -0,0 +1,151 @@
+Roadie
+======
+
+> Making HTML emails comfortable for the Rails rockstars
+
+Roadie tries to make sending HTML emails a little less painful in Rails 3 by inlining stylesheets and rewrite relative URLs for you.
+
+If you want to have this in Rails 2, please see [MailStyle](https://www.github.com/purify/mail_style).
+
+How does it work?
+-----------------
+
+Email clients have bad support for stylesheets, and some of them blocks stylesheets from downloading. The easiest way to handle this is to work with all styles inline, but that is error prone and hard to work with as you cannot use classes and/or reuse styling.
+
+This gem helps making this easier by automatically inlining stylesheet rules into the document before sending it. You just give it a list of stylesheets and it will go though all of the selectors assigning the styles to the maching elements. Careful attention has been put into rules being applied in the correct order, so it should behave just like in the browser¹.
+
+Roadie also rewrites all relative URLs in the email to a absolute counterpart, making images you insert and those referenced in your stylesheets work. No more headaches about how to write the stylesheets while still having them work with emails from your acceptance environments.
+
+¹: Of course, rules like `:hover` will not work by definition. Only static styles can be added.
+
+Features
+--------
+
+* Writes CSS styles inline
+  * Respects `!important` styles
+  * Does not overwrite styles already present in the `style` attribute of tags
+  * Supports the same CSS selectors as [Nokogiri](http://nokogiri.org/) (use CSS3 selectors in your emails!)
+* Makes image urls absolute
+  * Hostname and port configurable on a per-environment basis
+* Makes link `href`s absolute
+* Automatically adds proper html skeleton when missing (you don't have to create a layout for emails)²
+
+²: This might be removed in a future version, though. You really ought to create a good layout and not let Roadie guess how you want to have it structured
+
+### What about Sass / Less? ###
+
+Sass is supported "by accident" as long as the stylesheets are generated and stored in the stylesheets directory. This is the default behavior from Sass. You are recommended to add a deploy task that generates the stylesheets to make sure that they are present at all times.
+
+Install
+-------
+
+Roadie is officially supported in both Ruby 1.8.7 and 1.9.2.
+
+Add the gem to Rails' Gemfile
+
+```ruby
+gem 'roadie'
+```
+
+Usage
+-----
+
+Simply specify the `:css` option to mailer:
+
+```ruby
+class Notifier < ActionMailer::Base
+  default :css => :email, :from => 'support@mycompany.com'
+
+  def registration_mail
+    mail(:subject => 'Welcome Aboard', :to => 'someone@example.com')
+  end
+
+  def newsletter
+    mail(:subject => 'Newsletter', :to => 'someone@example.com', :css => [:email, :newsletter])
+  end
+end
+```
+
+This will look for a css file called `email.css` in your `public/stylesheets` folder. The `css` method can take either a string, a symbol or an array of both. You should pass the CSS filename without the ".css" extension.
+
+### Image URL rewriting ###
+
+If you have `default_url_options[:host]` set in your mailer, then Roadie will do it's best to make the URLs of images and in stylesheets absolute.
+
+In `application.rb`:
+
+```ruby
+class Application
+  config.action_mailer.default_url_options = {:host => 'example.com'}
+end
+```
+
+If you want to to be different depending on your environment, just set it in your environment's configuration instead.
+
+### Ignoring stylesheets ###
+
+By default, `style` and `link` elements in the email document's `head` are processed along with the stylesheets and removed from the `head`.
+
+You can set a special `data-immutable="true"` attribute on `style` and `link` tags you do not want to be processed and removed from the document's `head`. This is the place to put things like `:hover` selectors that you want to have for email clients allowing them.
+
+Style and link elements with `media="print"` are always ignored.
+
+### Inlining link tags ###
+
+Any `link` element that is part of your email will be linked in. You can exclude them by setting `data-immutable` as you would on normal `style` elements. Linked stylesheets for print media is also ignored as you would expect.
+
+If the `link` tag uses an absolute URL to the stylesheet, it will not be inlined. Use a relative path instead:
+
+```html
+<head>
+  <link rel="stylesheet" type="text/css" href="/stylesheets/emails/rock.css">        <!-- Will be inlined -->
+  <link rel="stylesheet" type="text/css" href="http://www.metal.org/metal.css">      <!-- Will NOT be inlined -->
+  <link rel="stylesheet" type="text/css" href="/stylesheets/jazz.css" media="print"> <!-- Will NOT be inlined -->
+  <link rel="stylesheet" type="text/css" href="/ambient.css" data-immutable>         <!-- Will NOT be inlined -->
+</head>
+```
+
+Bugs / TODO
+-----------
+
+* Improve overall performance
+* Clean up stylesheet assignment code
+
+Documentation
+-------------
+
+* [Online documentation for 1.0.1](http://rubydoc.info/gems/roadie/1.0.1/frames)
+* [Online documentation for 1.0.0](http://rubydoc.info/gems/roadie/1.0.0/frames)
+* [Online documentation for master](http://rubydoc.info/github/Mange/roadie/master/frames)
+* [Changelog](https://github.com/Mange/roadie/blob/master/Changelog.md)
+
+History and contributors
+------------------------
+
+This gem was originally developed for Rails 2 use on [Purify](http://purifyapp.com) under the name [MailStyle](https://www.github.com/purify/mail_style). However, the author stopped maintaining it and a fork took place to make it Rails 3 compatible.
+
+The following people have contributed to the orignal gem:
+
+* [Jim Neath](http://jimneath.org) (Original author)
+* [Lars Klevans](http://tastybyte.blogspot.com/)
+* [Jonas Grimfelt](http://github.com/grimen)
+* [Ben Johnson](http://www.binarylogic.com)
+* [Istvan Hoka](http://istvanhoka.com/)
+* [Voraz](http://blog.voraz.com.br)
+
+License
+-------
+
+(The MIT License)
+
+Copyright (c) 2009-2011
+
+* [Jim Neath](http://jimneath.org)
+* Magnus Bergmark <magnus.bergmark@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the ‘Software’), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED ‘AS IS’, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/lib/roadie/css_file_not_found.rb

@@ -2,11 +2,21 @@ module Roadie
   # Raised when a stylesheet specified for inlining is not present.
   # You can access the target filename via #filename.
   class CSSFileNotFound < StandardError
-    attr_reader :filename
+    attr_reader :filename, :guess
 
-    def initialize(filename)
+    def initialize(filename, guess = nil)
       @filename = filename
-      super("Could not find #{filename}")
+      @guess = guess
+      super(build_message)
     end
+
+    private
+      def build_message
+        if guess
+          "Could not find #{filename} (guessed from #{guess.inspect})"
+        else
+          "Could not find #{filename}"
+        end
+      end
   end
 end

data/lib/roadie/inliner.rb

@@ -39,6 +39,7 @@ module Roadie
       adjust_html do |document|
         @document = document
         add_missing_structure
+        extract_link_elements
         extract_inline_style_elements
         inline_css_rules
         make_image_urls_absolute
@@ -88,6 +89,18 @@ module Roadie
         end
       end
 
+      def extract_link_elements
+        all_link_elements_to_be_inlined_with_url.each do |link, url|
+          # Joining on an "absolute" path ignores everything before the absoluted path
+          # so we have to remove the starting slash
+          url_path = url.path.sub(%r{^/}, '')
+          file_path = Rails.root.join('public', url_path)
+          raise CSSFileNotFound.new(file_path, link['href']) unless file_path.file?
+          @inline_css << file_path.read
+          link.remove
+        end
+      end
+
       def extract_inline_style_elements
         document.css("style").each do |style|
           next if style['media'] == 'print' or style['data-immutable']
@@ -177,5 +190,18 @@ module Roadie
           :path => base_path
         })
       end
+
+      def all_link_elements_with_url
+        document.css("link[rel=stylesheet]").map { |link| [link, URI.parse(link['href'])] }
+      end
+
+      def all_link_elements_to_be_inlined_with_url
+        all_link_elements_with_url.reject do |link, url|
+          absolute_path_url = (url.host or url.path.nil?)
+          blacklisted_element = (link['media'] == 'print' or link['data-immutable'])
+
+          absolute_path_url or blacklisted_element
+        end
+      end
   end
 end

data/lib/roadie/version.rb

@@ -1,3 +1,3 @@
 module Roadie
-  VERSION = '1.0.1'
+  VERSION = '1.1.0'
 end

data/roadie.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency 'rspec-rails', '>= 2.0.0'
 
-  s.extra_rdoc_files = %w[README.textile]
+  s.extra_rdoc_files = %w[README.md Changelog.md]
   s.require_paths = %w[lib]
 
   s.files         = `git ls-files`.split("\n")

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

@@ -0,0 +1 @@
+p { color: green; }

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

@@ -0,0 +1 @@
+p { color: purple; font-size: 18px; }

data/spec/integration_spec.rb

@@ -27,7 +27,7 @@ describe "roadie integration" do
     IntegrationMailer.delivery_method = :test
   end
 
-  it "should inline styles for an email" do
+  it "inlines styles for an email" do
     email = IntegrationMailer.notification('doe@example.com', 'your quota limit has been reached')
 
     email.to.should == ['doe@example.com']
@@ -50,12 +50,12 @@ describe "roadie integration" do
     email.deliver
   end
 
-  it "should not add headers for the roadie options" do
+  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')
   end
 
-  it "should keep custom headers in place" do
+  it "keeps custom headers in place" do
     email = IntegrationMailer.marketing('everyone@inter.net')
     email.header['X-Spam'].should be_present
   end

data/spec/lib/roadie/action_mailer_extensions_spec.rb

@@ -31,25 +31,25 @@ describe Roadie::ActionMailerExtensions, "inlining styles" do
   end
 
   describe "for singlepart text/plain" do
-    it "should not touch the email body" do
+    it "does not touch the email body" do
       Roadie.should_not_receive(:inline_css)
       InliningMailer.singlepart_plain
     end
   end
 
   describe "for singlepart text/html" do
-    it "should inline css to the email body" 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'
     end
   end
 
   describe "for multipart" do
-    it "should keep both parts" do
+    it "keeps both parts" do
       InliningMailer.multipart.should have(2).parts
     end
 
-    it "should inline css to the email's html part" do
+    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'
@@ -79,27 +79,27 @@ describe Roadie::ActionMailerExtensions, "loading css files" do
     Roadie.stub!(:inline_css => 'html')
   end
 
-  it "should load css from Rails' stylesheet root" do
+  it "loads css from Rails' stylesheet root" do
     Roadie.should_receive(:load_css).with(Rails.root.join('public', 'stylesheets'), anything).and_return('')
     CssLoadingMailer.use_default
   end
 
-  it "should load the css specified in the default mailer settings" do
+  it "loads the css specified in the default mailer settings" do
     Roadie.should_receive(:load_css).with(anything, ['default_value']).and_return('')
     CssLoadingMailer.use_default
   end
 
-  it "should load the css specified in the specific mailer action instead of the default choice" do
+  it "loads the css specified in the specific mailer action instead of the default choice" do
     Roadie.should_receive(:load_css).with(anything, ['specific']).and_return('')
     CssLoadingMailer.override(:specific)
   end
 
-  it "should load no css when specifying false in the mailer action" do
+  it "loads no css when specifying false in the mailer action" do
     Roadie.should_not_receive(:load_css)
     CssLoadingMailer.override(false)
   end
 
-  it "should load multiple css files when given an array" do
+  it "loads multiple css files when given an array" do
     Roadie.should_receive(:load_css).with(anything, ['specific', 'other']).and_return('')
     CssLoadingMailer.override([:specific, :other])
   end

data/spec/lib/roadie/css_file_not_found_spec.rb

@@ -6,8 +6,24 @@ module Roadie
       CSSFileNotFound.new('file.css').filename.should == 'file.css'
     end
 
-    it "has a message" do
-      CSSFileNotFound.new('style.css').message.should == 'Could not find style.css'
+    it "can be initialized with the guess the filename was based on" do
+      CSSFileNotFound.new('file.css', :file).guess.should == :file
+    end
+
+    it "has a nil guess when no guess was specified" do
+      CSSFileNotFound.new('').guess.should be_nil
+    end
+
+    context "without a guess" do
+      it "has a message with the wanted filename" do
+        CSSFileNotFound.new('style.css').message.should == 'Could not find style.css'
+      end
+    end
+
+    context "with a guess" do
+      it "has a message with the wanted filename and the guess" do
+        CSSFileNotFound.new('style.css', :style).message.should == 'Could not find style.css (guessed from :style)'
+      end
     end
   end
 end

data/spec/lib/roadie/inliner_spec.rb

@@ -15,29 +15,29 @@ describe Roadie::Inliner do
       use_css ''
     end
 
-    it "should inline simple attributes" do
+    it "inlines simple attributes" do
       use_css 'p { color: green }'
       rendering('<p></p>').should have_styling('color' => 'green')
     end
 
-    it "should keep the order of the styles that was inlined" do
+    it "keeps the order of the styles that are inlined" do
       use_css 'h1 { padding: 2px; margin: 5px; }'
       rendering('<h1></h1>').should have_styling([['padding', '2px'], ['margin', '5px']])
     end
 
-    it "should combine multiple selectors into one" do
+    it "combines multiple selectors into one" do
       use_css 'p { color: green; }
               .tip { float: right; }'
       rendering('<p class="tip"></p>').should have_styling('color' => 'green', 'float' => 'right')
     end
 
-    it "should use the ones attributes with the highest specificality when conflicts arises" do
+    it "uses the attributes with the highest specificity when conflicts arises" do
       use_css "p { color: red; }
               .safe { color: green; }"
       rendering('<p class="safe"></p>').should have_styling('color' => 'green')
     end
 
-    it "should sort styles by specificity order" do
+    it "sorts styles by specificity order" do
       use_css 'p      { margin: 2px; }
                #big   { margin: 10px; }
                .down  { margin-bottom: 5px; }'
@@ -51,7 +51,7 @@ describe Roadie::Inliner do
       ])
     end
 
-    it "should support multiple selectors for the same rules" do
+    it "supports multiple selectors for the same rules" do
       use_css 'p, a { color: green; }'
       rendering('<p></p><a></a>').tap do |document|
         document.should have_styling('color' => 'green').at_selector('p')
@@ -59,29 +59,29 @@ describe Roadie::Inliner do
       end
     end
 
-    it "should respect !important properties" do
+    it "respects !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')
     end
 
-    it "should combine with already present inline styles" do
+    it "combines with already present inline styles" do
       use_css "p { color: green }"
       rendering('<p style="font-size: 1.1em"></p>').should have_styling([['color', 'green'], ['font-size', '1.1em']])
     end
 
-    it "should not touch already present inline styles" do
+    it "does not touch already present inline styles" do
       use_css "p { color: red }"
       rendering('<p style="color: green"></p>').should have_styling([['color', 'red'], ['color', 'green']])
     end
 
-    it "should ignore selectors with :psuedo-classes" do
+    it "ignores selectors with :psuedo-classes" do
       use_css 'p:hover { color: red }'
       rendering('<p></p>').should_not have_styling('color' => 'red')
     end
 
-    describe "inline <style> elements" do
-      it "should be used for inlined styles" do
+    describe "inline <style> element" do
+      it "is used for inlined styles" do
         rendering(<<-HTML).should have_styling([['color', 'green'], ['font-size', '1.1em']])
           <html>
             <head>
@@ -95,7 +95,7 @@ describe Roadie::Inliner do
         HTML
       end
 
-      it "should be removed" do
+      it "is removed" do
         rendering(<<-HTML).should_not have_selector('style')
           <html>
             <head>
@@ -108,16 +108,16 @@ describe Roadie::Inliner do
         HTML
       end
 
-      it "should not be touched when data-immutable=true" do
+      it "is not touched when data-immutable is set" do
         document = rendering <<-HTML
-          <style type="text/css" data-immutable="true">p { color: red; }</style>
+          <style type="text/css" data-immutable>p { color: red; }</style>
           <p></p>
         HTML
-        document.should have_selector('style[data-immutable=true]')
+        document.should have_selector('style[data-immutable]')
         document.should_not have_styling('color' => 'red')
       end
 
-      it "should not be touched when media=print" do
+      it "is not touched when for print media" do
         document = rendering <<-HTML
           <style type="text/css" media="print">p { color: red; }</style>
           <p></p>
@@ -126,7 +126,9 @@ describe Roadie::Inliner do
         document.should_not have_styling('color' => 'red').at_selector('p')
       end
 
-      it "should still be inlined when no external css rules are defined" do
+      it "is still inlined when no external css rules are defined" do
+        # This is just testing that the main code paths are still active even
+        # when css is set to nil
         use_css nil
         rendering(<<-HTML).should have_styling('color' => 'green').at_selector('p')
           <style type="text/css">p { color: green; }</style>
@@ -136,23 +138,194 @@ describe Roadie::Inliner do
     end
   end
 
+  describe "linked stylesheets" do
+    before(:each) do
+      Rails.stub(:root => FixturesPath)
+    end
+
+    it "inlines styles from the linked stylesheet" do
+      rendering(<<-HTML).should have_styling('color' => 'green').at_selector('p')
+        <html>
+          <head>
+            <link rel="stylesheet" href="/stylesheets/green_paragraphs.css">
+          </head>
+          <body>
+            <p></p>
+          </body>
+        </html>
+      HTML
+    end
+
+    it "inlines styles from more than one linked stylesheet" do
+      html = <<-HTML
+        <html>
+          <head>
+            <link rel="stylesheet" href="/stylesheets/green_paragraphs.css">
+            <link rel="stylesheet" href="/stylesheets/large_purple_paragraphs.css">
+          </head>
+          <body>
+            <p></p>
+          </body>
+        </html>
+      HTML
+
+      rendering(html).should have_styling([
+        ['color', 'purple'],
+        ['font-size', '18px'],
+      ]).at_selector('p')
+    end
+
+    it "removes the stylesheet links from the DOM" do
+      rendering(<<-HTML).should_not have_selector('link')
+        <html>
+          <head>
+            <link rel="stylesheet" href="/stylesheets/green_paragraphs.css">
+            <link rel="stylesheet" href="/stylesheets/large_purple_paragraphs.css">
+          </head>
+          <body>
+          </body>
+        </html>
+      HTML
+    end
+
+    context "when stylesheet is for print media" do
+      it "does not inline the stylesheet" do
+        rendering(<<-HTML).should_not have_styling('color' => 'green').at_selector('p')
+          <html>
+            <head>
+              <link rel="stylesheet" href="/stylesheets/green_paragraphs.css" media="print">
+            </head>
+            <body>
+              <p></p>
+            </body>
+          </html>
+        HTML
+      end
+
+      it "does not remove the links" do
+        rendering(<<-HTML).should have_selector('link')
+          <html>
+            <head>
+              <link rel="stylesheet" href="/stylesheets/green_paragraphs.css" media="print">
+            </head>
+            <body>
+            </body>
+          </html>
+        HTML
+      end
+    end
+
+    context "when stylesheet is marked as immutable" do
+      it "does not inline the stylesheet" do
+        rendering(<<-HTML).should_not have_styling('color' => 'green').at_selector('p')
+          <html>
+            <head>
+              <link rel="stylesheet" href="/stylesheets/green_paragraphs.css" data-immutable="true">
+            </head>
+            <body>
+              <p></p>
+            </body>
+          </html>
+        HTML
+      end
+
+      it "does not remove link" do
+        rendering(<<-HTML).should have_selector('link')
+          <html>
+            <head>
+              <link rel="stylesheet" href="/stylesheets/green_paragraphs.css" data-immutable="true">
+            </head>
+            <body>
+            </body>
+          </html>
+        HTML
+      end
+    end
+
+    context "when stylesheet link uses an absolute URL" do
+      it "does not inline the stylesheet" do
+        rendering(<<-HTML).should_not have_styling('color' => 'green').at_selector('p')
+          <html>
+            <head>
+              <link rel="stylesheet" href="http://www.example.com/green_paragraphs.css">
+            </head>
+            <body>
+              <p></p>
+            </body>
+          </html>
+        HTML
+      end
+
+      it "does not remove link" do
+        rendering(<<-HTML).should have_selector('link')
+          <html>
+            <head>
+              <link rel="stylesheet" href="http://www.example.com/green_paragraphs.css">
+            </head>
+            <body>
+            </body>
+          </html>
+        HTML
+      end
+    end
+
+    context "stylesheet cannot be found on disk" do
+      it "raises an error" do
+        html = <<-HTML
+          <html>
+            <head>
+              <link rel="stylesheet" href="/stylesheets/not_found.css">
+            </head>
+            <body>
+            </body>
+          </html>
+        HTML
+
+        expect { rendering(html) }.to raise_error do |error|
+          error.should be_a(Roadie::CSSFileNotFound)
+          error.filename.should == Rails.root.join('public', 'stylesheets', 'not_found.css')
+          error.guess.should == '/stylesheets/not_found.css'
+        end
+      end
+    end
+
+    context "link element is not for a stylesheet" do
+      it "is ignored" do
+        html = <<-HTML
+          <html>
+            <head>
+              <link rel="not_stylesheet" href="/stylesheets/green_paragraphs.css">
+            </head>
+            <body>
+              <p></p>
+            </body>
+          </html>
+        HTML
+        rendering(html).tap do |document|
+          document.should_not have_styling('color' => 'green').at_selector('p')
+          document.should have_selector('link')
+        end
+      end
+    end
+  end
+
   describe "making urls absolute" do
-    it "should work on image sources" do
+    it "works on image sources" do
       rendering('<img src="/images/foo.jpg" />').should have_attribute('src' => 'http://example.com/images/foo.jpg')
       rendering('<img src="../images/foo.jpg" />').should have_attribute('src' => 'http://example.com/images/foo.jpg')
       rendering('<img src="foo.jpg" />').should have_attribute('src' => 'http://example.com/foo.jpg')
     end
 
-    it "should not touch image sources that are already absolute" do
+    it "does not touch image sources that are already absolute" do
       rendering('<img src="http://other.example.org/images/foo.jpg" />').should have_attribute('src' => 'http://other.example.org/images/foo.jpg')
     end
 
-    it "should work on inlined style attributes" do
+    it "works on inlined style attributes" do
       rendering('<p style="background: url(/paper.png)"></p>').should have_styling('background' => 'url(http://example.com/paper.png)')
       rendering('<p style="background: url(&quot;/paper.png&quot;)"></p>').should have_styling('background' => 'url("http://example.com/paper.png")')
     end
 
-    it "should work on external style declarations" do
+    it "works on external style declarations" do
       use_css "p { background-image: url(/paper.png); }
                table { background-image: url('/paper.png'); }
                div { background-image: url(\"/paper.png\"); }"
@@ -161,14 +334,14 @@ describe Roadie::Inliner do
       rendering('<div></div>').should have_styling('background-image' => 'url("http://example.com/paper.png")')
     end
 
-    it "should not touch style urls that are already absolute" do
+    it "does not touch style urls that are already absolute" do
       external_url = 'url(http://other.example.org/paper.png)'
       use_css "p { background-image: #{external_url}; }"
       rendering('<p></p>').should have_styling('background-image' => external_url)
       rendering(%(<div style="background-image: #{external_url}"></div>)).should have_styling('background-image' => external_url)
     end
 
-    it "should not touch the urls when no url options are defined" do
+    it "does not touch the urls when no url options are defined" do
       use_css "img { background: url(/a.jpg); }"
       rendering('<img src="/b.jpg" />', :url_options => nil).tap do |document|
         document.should have_attribute('src' => '/b.jpg').at_selector('img')
@@ -176,7 +349,7 @@ describe Roadie::Inliner do
       end
     end
 
-    it "should support port and protocol settings" do
+    it "supports port and protocol settings" do
       use_css "img { background: url(/a.jpg); }"
       rendering('<img src="/b.jpg" />', :url_options => {:host => 'example.com', :protocol => 'https', :port => '8080'}).tap do |document|
         document.should have_attribute('src' => 'https://example.com:8080/b.jpg').at_selector('img')
@@ -184,38 +357,38 @@ describe Roadie::Inliner do
       end
     end
 
-    it "should not touch data: URIs" do
+    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 "inserting tags" do
-    it "should insert a doctype if not present" do
+    it "inserts a doctype if not present" do
       rendering('<html><body></body></html>').to_xml.should include('<!DOCTYPE ')
       rendering('<!DOCTYPE html><html><body></body></html>').to_xml.should_not match(/(DOCTYPE.*?){2}/)
     end
 
-    it "should set xmlns of <html> to that of XHTML" do
+    it "sets xmlns of <html> to that of XHTML" do
       rendering('<html><body></body></html>').should have_selector('html[xmlns="http://www.w3.org/1999/xhtml"]')
     end
 
-    it "should insert basic html structure if not present" do
+    it "inserts basic html structure if not present" do
       rendering('<h1>Hey!</h1>').should have_selector('html > head + body > h1')
     end
 
-    it "should insert <head> if not present" do
+    it "inserts <head> if not present" do
       rendering('<html><body></body></html>').should have_selector('html > head + body')
     end
 
-    it "should insert meta tag describing content-type" do
+    it "inserts meta tag describing content-type" do
       rendering('<html><head></head><body></body></html>').tap do |document|
         document.should have_selector('head meta[http-equiv="Content-Type"]')
         document.css('head meta[http-equiv="Content-Type"]').first['content'].should == 'text/html; charset=UTF-8'
       end
     end
 
-    it "should not insert duplicate meta tags describing content-type" do
+    it "does not insert duplicate meta tags describing content-type" do
       rendering(<<-HTML).to_html.scan('meta').should have(1).item
       <html>
         <head>
@@ -227,15 +400,15 @@ describe Roadie::Inliner do
   end
 
   describe "css url regex" do
-    it "should parse css urls" do
+    it "parses css urls" do
       {
-        'url(/foo.jpg)' => '/foo.jpg',
-        'url("/foo.jpg")' => '/foo.jpg',
-        "url('/foo.jpg')" => '/foo.jpg',
-        'url(http://localhost/foo.jpg)' => 'http://localhost/foo.jpg',
-        'url("http://localhost/foo.jpg")' => 'http://localhost/foo.jpg',
-        "url('http://localhost/foo.jpg')" => 'http://localhost/foo.jpg',
-        'url(/andromeda_(galaxy).jpg)' => '/andromeda_(galaxy).jpg',
+        %{url(/foo.jpg)}                   => '/foo.jpg',
+        %{url("/foo.jpg")}                 => '/foo.jpg',
+        %{url('/foo.jpg')}                 => '/foo.jpg',
+        %{url(http://localhost/foo.jpg)}   => 'http://localhost/foo.jpg',
+        %{url("http://localhost/foo.jpg")} => 'http://localhost/foo.jpg',
+        %{url('http://localhost/foo.jpg')} => 'http://localhost/foo.jpg',
+        %{url(/andromeda_(galaxy).jpg)}    => '/andromeda_(galaxy).jpg',
       }.each do |raw, expected|
         raw =~ Roadie::Inliner::CSS_URL_REGEXP
         $2.should == expected

data/spec/lib/roadie/style_declaration_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 module Roadie
   describe StyleDeclaration do
-    it "should be initialized with a property, value, if it is marked as important, and the specificity" do
+    it "is initialized with a property, value, if it is marked as important, and the specificity" do
       StyleDeclaration.new('color', 'green', true, 45).tap do |declaration|
         declaration.property.should == 'color'
         declaration.value.should == 'green'
@@ -12,7 +12,7 @@ module Roadie
     end
 
     describe "string representation" do
-      it "should be the property and the value joined with a colon" do
+      it "is the property and the value joined with a colon" do
         StyleDeclaration.new('color', 'green', false, 1).to_s.should == 'color:green'
         StyleDeclaration.new('font-size', '1.1em', false, 1).to_s.should == 'font-size:1.1em'
       end
@@ -23,18 +23,18 @@ module Roadie
         StyleDeclaration.new('color', 'green', important, specificity)
       end
 
-      it "should compare on specificity" do
+      it "compares on specificity" do
         declaration(5).should be == declaration(5)
         declaration(4).should be < declaration(5)
         declaration(6).should be > declaration(5)
       end
 
       context "with an important declaration" do
-        it "should be less than the important declaration regardless of the specificity" do
+        it "is less than the important declaration regardless of the specificity" do
           declaration(99, false).should be < declaration(1, true)
         end
 
-        it "should compare like normal when both declarations are important" do
+        it "compares like normal when both declarations are important" do
           declaration(5, true).should be == declaration(5, true)
           declaration(4, true).should be < declaration(5, true)
           declaration(6, true).should be > declaration(5, true)

data/spec/lib/roadie_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe Roadie do
   describe ".inline_css" do
-    it "should create an instance of Roadie::Inliner and execute it" do
+    it "creates an instance of Roadie::Inliner and execute it" do
       Roadie::Inliner.should_receive(:new).with('attri', 'butes').and_return(double('inliner', :execute => 'html'))
       Roadie.inline_css('attri', 'butes').should == 'html'
     end
@@ -11,16 +11,16 @@ describe Roadie do
   describe ".load_css(root, targets)" do
     let(:fixtures_root) { Pathname.new(__FILE__).dirname.join('..', 'fixtures', 'public', 'stylesheets') }
 
-    it "should load files matching the target names under root/public/stylesheets" do
+    it "loads files matching the target names under root/public/stylesheets" do
       Roadie.load_css(fixtures_root, ['foo']).should == 'contents of foo'
     end
 
-    it "should load files in order and join them with a newline" do
+    it "loads files in order and join them with a newline" do
       Roadie.load_css(fixtures_root, %w[foo bar]).should == "contents of foo\ncontents of bar"
       Roadie.load_css(fixtures_root, %w[bar foo]).should == "contents of bar\ncontents of foo"
     end
 
-    it "should raise a Roadie::CSSFileNotFound error when a css file could not be found" do
+    it "raises a Roadie::CSSFileNotFound error when a css file could not be found" do
       expect { Roadie.load_css(fixtures_root, ['not_here']) }.to raise_error(Roadie::CSSFileNotFound, /not_here/)
     end
   end

data/spec/spec_helper.rb

@@ -34,3 +34,5 @@ else
   end
 end
 
+FixturesPath = Pathname.new(File.dirname(__FILE__)).join('fixtures')
+

metadata

@@ -2,7 +2,7 @@
 name: roadie
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors: 
 - Magnus Bergmark
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-14 00:00:00 +02:00
+date: 2011-06-24 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -65,15 +65,17 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- README.textile
+- README.md
+- Changelog.md
 files: 
 - .autotest
 - .gitignore
 - .yardopts
+- Changelog.md
 - Gemfile
 - Gemfile.lock
 - MIT-LICENSE
-- README.textile
+- README.md
 - Rakefile
 - autotest/discover.rb
 - lib/roadie.rb
@@ -85,7 +87,9 @@ files:
 - roadie.gemspec
 - spec/fixtures/public/stylesheets/bar.css
 - spec/fixtures/public/stylesheets/foo.css
+- spec/fixtures/public/stylesheets/green_paragraphs.css
 - spec/fixtures/public/stylesheets/integration.css
+- spec/fixtures/public/stylesheets/large_purple_paragraphs.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
@@ -130,7 +134,9 @@ summary: Making HTML emails comfortable for the Rails rockstars
 test_files: 
 - spec/fixtures/public/stylesheets/bar.css
 - spec/fixtures/public/stylesheets/foo.css
+- spec/fixtures/public/stylesheets/green_paragraphs.css
 - spec/fixtures/public/stylesheets/integration.css
+- spec/fixtures/public/stylesheets/large_purple_paragraphs.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

data/README.textile

@@ -1,114 +0,0 @@
-h1. Roadie
-
-Roadie tries to make sending HTML emails a little less painful in Rails 3 by inlining stylesheets and rewrite relative URLs for you.
-
-If you want to have this in Rails 2, please see "MailStyle":https://www.github.com/purify/mail_style.
-
-h2. How does it work?
-
-Email clients have bad support for stylesheets, and some of them blocks stylesheets from downloading. The easiest way to handle this is to work with all styles inline, but that is error prone and hard to work with as you cannot use classes and/or reuse styling.
-
-This gem helps making this easier by automatically inlining stylesheet rules into the document before sending it. You just give it a list of stylesheets and it will go though all of the selectors assigning the styles to the maching elements. Careful attention has been put into rules being applied in the correct order, so it should behave just like in the browser[1].
-
-Roadie also rewrites all relative URLs in the email to a absolute counterpart, making images you insert and those referenced in your stylesheets work. No more headaches about how to write the stylesheets while still having them work with emails from your acceptance environments.
-
-fn1. Of course, rules like @:hover@ will not work by definition. Only static styles can be added.
-
-h2. Features
-
-* Writes CSS styles inline
-** Respects @!important@ styles
-** Does not overwrite styles already present in the @style@ attribute of tags
-** Supports the same CSS selectors as "Nokogiri":http://nokogiri.org/ (use CSS3 selectors in your emails!)
-* Makes image urls absolute
-** Hostname and port configurable on a per-environment basis
-* Makes link <code>href</code>s absolute
-* Automatically adds proper html skeleton when missing (you don't have to create a layout for emails)[2]
-
-fn2. This might be removed in a future version, though. You really ought to create a good layout and not let Roadie guess how you want to have it structured
-
-h3. What about Sass / Less?
-
-Sass is supported "by accident" as long as the stylesheets are generated and stored in the stylesheets directory. This is the default behavior from Sass. You are recommended to add a deploy task that generates the stylesheets to make sure that they are present at all times.
-
-h2. Install
-
-Roadie is officially supported in both Ruby 1.8.7 and 1.9.2.
-
-Add the gem to Rails' Gemfile
-<pre><code>gem 'roadie'</code></pre>
-
-h2. Usage
-
-Simply specify the <code>:css</code> option to mailer:
-
-<pre><code>class Notifier < ActionMailer::Base
-  default :css => :email, :from => 'support@mycompany.com'
-  def registration_mail
-    mail(:subject => 'Welcome Aboard', :to => 'someone@example.com')
-  end
-
-  def newsletter
-    mail(:subject => 'Newsletter', :to => 'someone@example.com', :css => [:email, :newsletter])
-  end
-end</code></pre>
-(you could also use the @defaults@ method in ActionMailer)
-
-This will look for a css file called @email.css@ in your @public/stylesheets@ folder. The @css@ method can take either a string, a symbol or an array of both. You should pass the CSS filename without the ".css" extension.
-
-h3. Image URL Correcting
-
-If you have @default_url_options[:host]@ set in your mailer, then Roadie will do it's best to make the urls of images and in stylesheets absolute.
-
-In @application.rb@:
-<pre><code>class Application
-  config.action_mailer.default_url_options = {:host => 'example.com'}
-end</code></pre>
-
-If you want to to be different depending on your environment, just set it in your environment's configuration instead.
-
-h3. Ignoring stylesheets
-
-By default, @style@ elements in the email document's @head@ are processed along with the stylesheets and removed from the @head@.
-
-You can set a special <code>data-immutable="true"</code> attribute on @style@ tags you do not want to be processed and removed from the document's @head@. This is the place to put things like @:hover@ selectors that you want to have for email clients allowing them.
-
-Style elements with <code>media="print"</code> are always ignored.
-
-h2. Documentation
-
-* "Online documentation for master":http://rubydoc.info/github/Mange/roadie/master/frames
-
-h2. Bugs / TODO
-
-* Improve overall performance
-* Clean up stylesheet assignment code
-
-h2. History and contributors
-
-This gem was originally developed for Rails 2 use on "Purify":http://purifyapp.com under the name "MailStyle":https://www.github.com/purify/mail_style. However, the author stopped maintaining it and a fork took place to make it Rails 3 compatible.
-
-The following people have contributed to the orignal gem:
-
-* "Jim Neath":http://jimneath.org (Original author)
-* "Lars Klevans":http://tastybyte.blogspot.com/
-* "Jonas Grimfelt":http://github.com/grimen
-* "Ben Johnson":http://www.binarylogic.com
-* "Istvan Hoka":http://istvanhoka.com/
-* "Voraz":http://blog.voraz.com.br
-
-h2. License
-
-(The MIT License)
-
-Copyright &copy; 2009-2011
-
-* "Jim Neath":http://jimneath.org
-* Magnus Bergmark <magnus.bergmark@gmail.com>
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the ‘Software’), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED ‘AS IS’, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-