roadie 2.0.0 → 2.1.0.pre1

data/.gitignore

@@ -8,3 +8,4 @@ pkg
 .rvmrc
 
 gemfiles/*.lock
+doc

data/Changelog.md

@@ -1,9 +1,20 @@
 ### dev
 
-[full changelog](https://github.com/Mange/roadie/compare/v2.0.0...master)
+[full changelog](https://github.com/Mange/roadie/compare/v2.1.0.pre1...master)
 
 * Nothing yet
 
+### 2.1.0.pre1
+
+[full changelog](https://github.com/Mange/roadie/compare/v2.0.0...v2.1.0.pre1)
+
+* Enhancements:
+  * Support normal filesystem instead of only Asset pipeline
+  * Enable users to create their own way of fetching CSS
+  * Improve test coverage a bit
+  * Use a railtie to hook into Rails
+  * Use real Rails for testing integration
+
 ### 2.0.0
 
 [full changelog](https://github.com/Mange/roadie/compare/v1.1.3...v2.0.0)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    roadie (2.0.0)
+    roadie (2.1.0.pre1)
       actionmailer (~> 3.1.0)
       css_parser
       nokogiri (>= 1.4.4)
@@ -10,27 +10,36 @@ PATH
 GEM
   remote: http://rubygems.org/
   specs:
-    actionmailer (3.1.1)
-      actionpack (= 3.1.1)
+    actionmailer (3.1.3)
+      actionpack (= 3.1.3)
       mail (~> 2.3.0)
-    actionpack (3.1.1)
-      activemodel (= 3.1.1)
-      activesupport (= 3.1.1)
+    actionpack (3.1.3)
+      activemodel (= 3.1.3)
+      activesupport (= 3.1.3)
       builder (~> 3.0.0)
       erubis (~> 2.7.0)
       i18n (~> 0.6)
-      rack (~> 1.3.2)
+      rack (~> 1.3.5)
       rack-cache (~> 1.1)
       rack-mount (~> 0.8.2)
       rack-test (~> 0.6.1)
-      sprockets (~> 2.0.2)
-    activemodel (3.1.1)
-      activesupport (= 3.1.1)
+      sprockets (~> 2.0.3)
+    activemodel (3.1.3)
+      activesupport (= 3.1.3)
       builder (~> 3.0.0)
       i18n (~> 0.6)
-    activesupport (3.1.1)
+    activerecord (3.1.3)
+      activemodel (= 3.1.3)
+      activesupport (= 3.1.3)
+      arel (~> 2.2.1)
+      tzinfo (~> 0.3.29)
+    activeresource (3.1.3)
+      activemodel (= 3.1.3)
+      activesupport (= 3.1.3)
+    activesupport (3.1.3)
       multi_json (~> 1.0)
     addressable (2.2.6)
+    arel (2.2.1)
     builder (3.0.0)
     css_parser (1.2.5)
       addressable
@@ -43,11 +52,11 @@ GEM
       i18n (>= 0.4.0)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
-    mime-types (1.16)
+    mime-types (1.17.2)
     multi_json (1.0.3)
     nokogiri (1.5.0)
-    polyglot (0.3.2)
-    rack (1.3.4)
+    polyglot (0.3.3)
+    rack (1.3.5)
     rack-cache (1.1)
       rack (>= 0.4)
     rack-mount (0.8.3)
@@ -56,42 +65,52 @@ GEM
       rack
     rack-test (0.6.1)
       rack (>= 1.0)
-    railties (3.1.1)
-      actionpack (= 3.1.1)
-      activesupport (= 3.1.1)
+    rails (3.1.3)
+      actionmailer (= 3.1.3)
+      actionpack (= 3.1.3)
+      activerecord (= 3.1.3)
+      activeresource (= 3.1.3)
+      activesupport (= 3.1.3)
+      bundler (~> 1.0)
+      railties (= 3.1.3)
+    railties (3.1.3)
+      actionpack (= 3.1.3)
+      activesupport (= 3.1.3)
       rack-ssl (~> 1.3.2)
       rake (>= 0.8.7)
       rdoc (~> 3.4)
       thor (~> 0.14.6)
-    rake (0.9.2)
-    rdoc (3.10)
+    rake (0.9.2.2)
+    rdoc (3.11)
       json (~> 1.4)
-    rspec (2.6.0)
-      rspec-core (~> 2.6.0)
-      rspec-expectations (~> 2.6.0)
-      rspec-mocks (~> 2.6.0)
-    rspec-core (2.6.4)
-    rspec-expectations (2.6.0)
+    rspec (2.7.0)
+      rspec-core (~> 2.7.0)
+      rspec-expectations (~> 2.7.0)
+      rspec-mocks (~> 2.7.0)
+    rspec-core (2.7.1)
+    rspec-expectations (2.7.0)
       diff-lcs (~> 1.1.2)
-    rspec-mocks (2.6.0)
-    rspec-rails (2.6.1)
+    rspec-mocks (2.7.0)
+    rspec-rails (2.7.0)
       actionpack (~> 3.0)
       activesupport (~> 3.0)
       railties (~> 3.0)
-      rspec (~> 2.6.0)
-    sprockets (2.0.2)
+      rspec (~> 2.7.0)
+    sprockets (2.0.3)
       hike (~> 1.2)
       rack (~> 1.0)
-      tilt (~> 1.1, != 1.3.0)
+      tilt (!= 1.3.0, ~> 1.1)
     thor (0.14.6)
     tilt (1.3.3)
     treetop (1.4.10)
       polyglot
       polyglot (>= 0.3.1)
+    tzinfo (0.3.31)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  rails
   roadie!
   rspec-rails (>= 2.0.0)

data/README.md

@@ -36,15 +36,11 @@ Let me know if you want any other combination supported officially
 
 This project follows [Semtantic Versioning](http://semver.org/) and has been since version 1.0.0.
 
-Two branches are currently in place:
-* 2.x - Rails 3.1
-* 1.x - Rails 3.0
-
-The 1.x branch will continue to be supported until it is deemed unnecessary by the author, but properly made pull requests will be accepted indefinitely.
-
 Features
 --------
 
+* Supports Rails' Asset Pipeline and simple filesystem access out of the box
+* You can add support for CSS from any place inside your apps
 * Writes CSS styles inline
   * Respects `!important` styles
   * Does not overwrite styles already present in the `style` attribute of tags
@@ -58,7 +54,7 @@ Features
 
 ### What about Sass / Less? ###
 
-Sass is supported "by accident" as long as the stylesheets are generated and stored in the asset directories. You are recommended to add a deploy task that generates the stylesheets to make sure that they are present at all times on the machine generating the emails.
+Sass is supported as long as the stylesheets are generated and stored in the asset directories. You are recommended to add a deploy task that generates the stylesheets to make sure that they are present at all times on the machine generating the emails.
 
 Install
 -------
@@ -69,10 +65,21 @@ Add the gem to Rails' Gemfile
 gem 'roadie'
 ```
 
+Configuring
+-----------
+
+Roadie listens to the following options (set in `Application.rb` or in your environment's configuration files:
+
+* `config.action_mailer.default_url_options` - Used for making URLs absolute
+* `config.assets.enabled` - If the asset pipeline is turned off, Roadie will default to searching for assets in `public/stylesheets`
+* `config.roadie.provider` - Set the provider manually, ignoring all other options. Use for advanced cases, or when you have non-default paths or other options.
+
 Usage
 -----
 
-Simply specify the `:css` option to mailer:
+Just add a `<link rel="stylesheet" />` or `<style type="text/css"></style>` element inside your email layout and it will be inlined automatically.
+
+You can also specify the `:css` option to mailer to have it inlined automatically without you having to make a layout:
 
 ```ruby
 class Notifier < ActionMailer::Base
@@ -127,6 +134,29 @@ If the `link` tag uses an absolute URL to the stylesheet, it will not be inlined
 </head>
 ```
 
+Writing your own provider
+-------------------------
+
+A provider handles searching CSS files for you. Cou can easily create your own provider for your specific app by subclassing `Roadie::AssetProvider`. See the API documentation for information about how to build them.
+
+Example Subclassing the `AssetPipelineProvider`:
+
+```ruby
+# application.rb
+config.roadie.provider = UserAssetsProvider.new
+
+# lib/user_assets_provider.rb
+class UserAssetsProvider < Roadie::AssetPipelineProvider
+  def find(name)
+    super
+  rescue CSSFileNotFound
+    user = User.find_by_name(name)
+    raise unless user
+    user.custom_css
+  end
+end
+```
+
 Bugs / TODO
 -----------
 
@@ -154,7 +184,7 @@ History and contributors
 
 Major contributors to Roadie:
 
-* [Arttu Tervo (arttu)](https://github.com/arttu) - Asset pipeline support
+* [Arttu Tervo (arttu)](https://github.com/arttu) - Original Asset pipeline support
 
 You can [see all contributors](https://github.com/Mange/roadie/contributors) on GitHub.
 

data/lib/roadie.rb

@@ -1,37 +1,56 @@
 module Roadie
-  # Shortcut for inlining CSS using {Inliner}
-  # @see Inliner
-  def self.inline_css(*args)
-    Roadie::Inliner.new(*args).execute
-  end
+  class << self
+    # Shortcut for inlining CSS using {Inliner}
+    # @see Inliner
+    def inline_css(*args)
+      Roadie::Inliner.new(*args).execute
+    end
 
-  # Shortcut to Rails.application.assets
-  def self.assets
-    Rails.application.assets
-  end
+    # Shortcut to Rails.application
+    def app
+      Rails.application
+    end
+
+    # Returns all available providers
+    def providers
+      [AssetPipelineProvider, FilesystemProvider]
+    end
+
+    # Returns the active provider
+    #
+    # If no provider has been configured a new provider will be instantiated
+    # depending on if the asset pipeline is enabled or not.
+    #
+    # If +config.assets.enabled+ is +true+, the {AssetPipelineProvider} will be used
+    # while {FilesystemProvider} will be used if it is set to +false+.
+    #
+    # @see AssetPipelineProvider
+    # @see FilesystemProvider
+    def current_provider
+      return config.roadie.provider if config.roadie.provider
 
-  # Tries to load the CSS "names" specified in the +targets+ parameter using the Rails asset pipeline.
-  #
-  # @example
-  #   Roadie.load_css(%w[application newsletter])
-  #
-  # @param [Array<String|Symbol>] targets Stylesheet names
-  # @return [String] The combined contents of the CSS files
-  # @raise [CSSFileNotFound] When a target cannot be found from Rails assets
-  def self.load_css(targets)
-    targets.map do |file|
-      raise CSSFileNotFound, file unless assets[file]
-      assets[file].to_s.strip
-    end.join("\n")
+      if config.assets.enabled
+        AssetPipelineProvider.new
+      else
+        FilesystemProvider.new
+      end
+    end
+
+    private
+      def config
+        Roadie.app.config
+      end
   end
 end
 
 require 'roadie/version'
 require 'roadie/css_file_not_found'
 require 'roadie/style_declaration'
-require 'roadie/inliner'
 
-require 'action_mailer'
-require 'roadie/action_mailer_extensions'
+require 'roadie/asset_provider'
+require 'roadie/asset_pipeline_provider'
+require 'roadie/filesystem_provider'
+
+require 'roadie/inliner'
 
-ActionMailer::Base.send :include, Roadie::ActionMailerExtensions
+require 'roadie/railtie' if defined?(Rails)

data/lib/roadie/action_mailer_extensions.rb

@@ -16,7 +16,12 @@ module Roadie
 
     protected
       def mail_with_inline_styles(headers = {}, &block)
-        @inline_style_css_targets = headers[:css]
+        if headers.has_key?(:css)
+          @targets = headers[:css]
+        else
+          @targets = default_css_targets
+        end
+
         mail_without_inline_styles(headers, &block).tap do |email|
           email.header.fields.delete_if { |field| field.name == 'css' }
         end
@@ -28,25 +33,25 @@ module Roadie
       end
 
     private
+      def default_css_targets
+        self.class.default[:css]
+      end
+
       def url_options
         Rails.application.config.action_mailer.default_url_options
       end
 
       def inline_style_response(response)
         if response[:content_type] == 'text/html'
-          response.merge :body => Roadie.inline_css(css_rules, response[:body], url_options)
+          response.merge :body => Roadie.inline_css(Roadie.current_provider, css_targets, response[:body], url_options)
         else
           response
         end
       end
 
       def css_targets
-        return nil if @inline_style_css_targets == false
-        Array(@inline_style_css_targets || self.class.default[:css] || []).map { |target| target.to_s }
-      end
-
-      def css_rules
-        @css_rules ||= Roadie.load_css(css_targets) if css_targets.present?
+        return [] unless @targets
+        Array.wrap(@targets || []).map { |target| target.to_s }
       end
   end
 end

data/lib/roadie/asset_pipeline_provider.rb

@@ -0,0 +1,28 @@
+module Roadie
+  # A provider that hooks into Rail's Asset Pipeline.
+  #
+  # Usage:
+  #   config.roadie.provider = AssetPipelineProvider.new('prefix')
+  #
+  # @see http://guides.rubyonrails.org/asset_pipeline.html
+  class AssetPipelineProvider < AssetProvider
+    # Looks up the file with the given name in the asset pipeline
+    #
+    # @return [String] contents of the file
+    def find(name)
+      asset_file(name).to_s.strip
+    end
+
+    private
+      def assets
+        Roadie.app.assets
+      end
+
+      def asset_file(name)
+        basename = remove_prefix(name)
+        assets[basename].tap do |file|
+          raise CSSFileNotFound.new(basename) unless file
+        end
+      end
+  end
+end

data/lib/roadie/asset_provider.rb

@@ -0,0 +1,62 @@
+module Roadie
+  # @abstract Subclass to create your own providers
+  class AssetProvider
+    # The prefix is whatever is prepended to your stylesheets when referenced inside markup.
+    #
+    # The prefix is stripped away from any URLs before they are looked up in {#find}:
+    #   find("/assets/posts/comment.css")
+    #   # Same as: (if prefix == "/assets"
+    #   find("posts/comment.css")
+    attr_reader :prefix
+
+    # @param [String] prefix Prefix of assets as seen from the browser
+    # @see #prefix
+    def initialize(prefix = "/assets")
+      @prefix = prefix
+      @quoted_prefix = prepare_prefix(prefix)
+    end
+
+    # Iterates all the passed elements and calls {#find} on them, joining the results with a newline.
+    #
+    # @example
+    #   MyProvider.all("first", "second.css", :third)
+    #
+    # @param [Array] files The target files to be loaded together
+    # @raise [CSSFileNotFound] In case any of the elements is not found
+    # @see #find
+    def all(files)
+      files.map { |file| find(file) }.join("\n")
+    end
+
+    # @abstract Implement in your own subclass
+    #
+    # Return the CSS contents of the file specified. A provider should not care about
+    # the +.css+ extension; it can, however, behave differently if it's passed or not.
+    #
+    # If the asset cannot be found, the method should raise {CSSFileNotFound}.
+    #
+    # @example
+    #   MyProvider.find("mystyle")
+    #   MyProvider.find("mystyle.css")
+    #   MyProvider.find(:mystyle)
+    #
+    # @param [String, Symbol] name Name of the file requested
+    # @raise [CSSFileNotFound] In case any of the elements is not found
+    def find(name)
+      raise "Not implemented"
+    end
+
+    private
+      def prepare_prefix(prefix)
+        if prefix =~ /^\//
+          "/?#{Regexp.quote(prefix[1, prefix.size])}"
+        else
+          Regexp.quote(prefix)
+        end
+      end
+
+      def remove_prefix(name)
+        name.sub(/^#{@quoted_prefix}\/?/, '').sub(%r{^/}, '').gsub(%r{//+}, '/')
+      end
+  end
+end