Contents

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] 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

Version data entries

5 entries across 5 versions & 2 rubygems

Version	Path
roadie-2.4.3	lib/roadie/asset_provider.rb
md-roadie-2.4.2.md.1	lib/roadie/asset_provider.rb
roadie-2.4.2	lib/roadie/asset_provider.rb
roadie-2.4.1	lib/roadie/asset_provider.rb
roadie-2.4.0	lib/roadie/asset_provider.rb