sprockets-helpers 0.4.0 → 0.5.0

data/lib/sprockets/helpers/asset_path.rb

@@ -2,34 +2,33 @@ module Sprockets
   module Helpers
     # `AssetPath` generates a full path for an asset
     # that exists in Sprockets environment.
-    class AssetPath < FilePath
-      #
-      def initialize(asset, options = {})
+    class AssetPath < BasePath
+      def initialize(uri, asset, options = {})
+        @uri     = uri
         @options = {
           :body   => false,
           :digest => Helpers.digest,
           :prefix => Helpers.prefix
         }.merge options
         
-        @source = @options[:digest] ? asset.digest_path : asset.logical_path
+        @uri.path = @options[:digest] ? asset.digest_path : asset.logical_path
       end
       
       protected
       
-      # Prepends the assets prefix
-      def rewrite_base_path(path) # :nodoc:
+      def rewrite_path
         prefix = if options[:prefix].respond_to? :call
-          options[:prefix].call path
+          warn 'DEPRECATION WARNING: Using a Proc for Sprockets::Helpers.prefix is deprecated and will be removed in 1.0. Please use Sprockets::Helpers.asset_host instead.'
+          options[:prefix].call uri.path
         else
           options[:prefix].to_s
         end
-
-        File.join prefix, path
+        
+        prepend_path(prefix)
       end
       
-      # Rewrite the query string to inlcude body flag if necessary.
-      def rewrite_query(path)
-        options[:body] ? "#{path}?body=1" : path
+      def rewrite_query
+        append_query('body=1') if options[:body]
       end
     end
   end

data/lib/sprockets/helpers/base_path.rb

@@ -0,0 +1,101 @@
+require 'uri'
+require 'zlib'
+
+module Sprockets
+  module Helpers
+    # 
+    class BasePath
+      # The parsed URI from which to generate the full path to the asset.
+      attr_reader :uri
+      
+      # The various options used when generating the path.
+      attr_reader :options
+      
+      #
+      def initialize(uri, options = {})
+        @uri     = uri
+        @options = options
+      end
+      
+      # Returns the full path to the asset, complete with
+      # timestamp.
+      def to_s
+        rewrite_path
+        rewrite_query
+        rewrite_host
+        
+        uri.to_s
+      end
+      
+      protected
+      
+      # Hook for rewriting the base path.
+      def rewrite_path # :nodoc:
+      end
+      
+      # Hook for rewriting the query string.
+      def rewrite_query # :nodoc:
+      end
+      
+      # Hook for rewriting the host.
+      def rewrite_host # :nodoc:
+        if host = compute_asset_host
+          uri.host   = host
+          uri.scheme = compute_scheme
+        end
+      end
+      
+      # Pick an asset host for this source. Returns +nil+ if no host is set,
+      # the host if no wildcard is set, the host interpolated with the
+      # numbers 0-3 if it contains <tt>%d</tt> (the number is the source hash mod 4),
+      # or the value returned from invoking call on an object responding to call
+      # (proc or otherwise).
+      def compute_asset_host # :nodoc:
+        if host = options[:asset_host] || Helpers.asset_host
+          if host.respond_to?(:call)
+            host.call(uri.to_s)
+          elsif host =~ /%d/
+            host % (Zlib.crc32(uri.to_s) % 4)
+          else
+            host
+          end
+        end
+      end
+      
+      # Pick a scheme for the protocol if we are using
+      # an asset host.
+      def compute_scheme # :nodoc:
+        protocol = options[:protocol] || Helpers.protocol
+        
+        if protocol.nil? || protocol == :relative
+          nil
+        else
+          protocol.to_s.sub %r{://\z}, ''
+        end
+      end
+      
+      # Prepends the given path. If the path is absolute
+      # An attempt to merge the URIs is made.
+      #
+      # TODO: Simplify this once Proc support for :prefix is removed.
+      def prepend_path(value) # :nodoc:
+        prefix_uri = URI.parse(value)
+        uri.path   = File.join prefix_uri.path, uri.path
+        
+        if prefix_uri.absolute?
+          @uri = prefix_uri.merge(uri)
+        end
+      end
+      
+      # Append the given query string to the URI
+      # instead of clobbering it.
+      def append_query(value) # :nodoc:
+        if uri.query.nil? || uri.query.empty? 
+          uri.query = value
+        else
+          uri.query << ('&' + value)
+        end
+      end
+    end
+  end
+end

data/lib/sprockets/helpers/file_path.rb

@@ -4,57 +4,28 @@ module Sprockets
     # in the output path. It's used by #asset_path to generate
     # paths when using asset tags like #javascript_include_tag,
     # #stylesheet_link_tag, and #image_tag
-    class FilePath
-      # The path from which to generate the full path to the asset.
-      attr_reader :source
-      
-      # The various options used when generating the path.
-      attr_reader :options
-      
-      # The base directory the file would be found in
-      attr_reader :dir
-    
-      #
-      def initialize(source, options = {})
-        @source  = source.to_s
-        @options = options
-        @dir     = options[:dir].to_s
-      end
-      
-      # Returns the full path to the asset, complete with
-      # timestamp.
-      def to_s
-        path = rewrite_base_path(source)
-        path = rewrite_query(path)
-        path
-      end
+    class FilePath < BasePath
       
       protected
       
-      # Prepends the base path if the path is not
-      # already an absolute path.
-      def rewrite_base_path(path) # :nodoc:
-        if path !~ %r(^/)
-          File.join('/', dir, path)
-        else
-          path
+      # Hook for rewriting the base path.
+      def rewrite_path # :nodoc:
+        if uri.path[0] != ?/
+          prepend_path File.join('/', options[:dir].to_s)
         end
       end
       
-      # Appends an asset timestamp based on the
-      # modification time of the asset.
-      def rewrite_query(path) # :nodoc:
-        if timestamp = mtime(path)
-          "#{path}?#{timestamp.to_i}"
-        else
-          path
+      # Hook for rewriting the query string.
+      def rewrite_query # :nodoc:
+        if timestamp = compute_mtime
+          append_query(timestamp.to_i.to_s)
         end
       end
       
       # Returns the mtime for the given path (relative to
       # the output path). Returns nil if the file doesn't exist.
-      def mtime(path) # :nodoc:
-        public_path = File.join(Helpers.public_path, path)
+      def compute_mtime # :nodoc:
+        public_path = File.join(Helpers.public_path, uri.path)
         
         if File.exist?(public_path)
           File.mtime(public_path)

data/lib/sprockets/helpers/manifest_path.rb

@@ -3,14 +3,14 @@ module Sprockets
     # `ManifestPath` uses the digest path and
     # prepends the prefix.
     class ManifestPath < AssetPath
-      #
-      def initialize(path, options = {})
+      def initialize(uri, path, options = {})
+        @uri     = uri
         @options = {
           :body   => false,
           :prefix => Helpers.prefix
         }.merge options
         
-        @source = path.to_s
+        @uri.path = path.to_s
       end
     end
   end

data/lib/sprockets/helpers/version.rb

@@ -1,5 +1,5 @@
 module Sprockets
   module Helpers
-    VERSION = '0.4.0'
+    VERSION = '0.5.0'
   end
 end

data/lib/sprockets/helpers.rb

@@ -1,26 +1,27 @@
-require 'sprockets/helpers/version'
 require 'sprockets'
+require 'sprockets/helpers/version'
+require 'sprockets/helpers/base_path'
+require 'sprockets/helpers/asset_path'
+require 'sprockets/helpers/file_path'
+require 'sprockets/helpers/manifest_path'
+require 'uri'
 
 module Sprockets
   module Helpers
-    autoload :AssetPath,    'sprockets/helpers/asset_path'
-    autoload :FilePath,     'sprockets/helpers/file_path'
-    autoload :ManifestPath, 'sprockets/helpers/manifest_path'
-    
-    # Pattern for checking if a given path is an external URI.
-    URI_MATCH = %r(^[-a-z]+://|^cid:|^//)
-    
     class << self
+      # Link to assets from a dedicated server.
+      attr_accessor :asset_host
+      
       # When true, the asset paths will return digest paths.
       attr_accessor :digest
       
       # Set the Sprockets environment to search for assets.
       # This defaults to the context's #environment method.
       attr_accessor :environment
-
+      
       # The manifest file used for lookup
       attr_accessor :manifest
-
+      
       # The base URL the Sprocket environment is mapped to.
       # This defaults to '/assets'.
       def prefix
@@ -28,6 +29,14 @@ module Sprockets
       end
       attr_writer :prefix
       
+      # Customize the protocol when using asset hosts.
+      # If the value is :relative, A relative protocol ('//')
+      # will be used.
+      def protocol
+        @protocol ||= 'http://'
+      end
+      attr_writer :protocol
+      
       # The path to the public directory, where the assets
       # not managed by Sprockets will be located.
       # Defaults to './public'
@@ -72,26 +81,29 @@ module Sprockets
     #   asset_path 'http://www.example.com/js/xmlhr.js'   # => 'http://www.example.com/js/xmlhr.js'
     # 
     def asset_path(source, options = {})
-      return source if source =~ URI_MATCH
+      uri = URI.parse(source)
+      
+      # Return fast if the URI is absolute
+      return source if uri.absolute?
       
       # Append extension if necessary
-      if options[:ext] && File.extname(source).empty?
-        source << ".#{options[:ext]}"
+      if options[:ext] && File.extname(uri.path).empty?
+        uri.path << ".#{options[:ext]}"
       end
-        
+      
       # If a manifest is present, try to grab the path from the manifest first
-      if Helpers.manifest && Helpers.manifest.assets[source]
-        return ManifestPath.new(Helpers.manifest.assets[source], options).to_s
+      if Helpers.manifest && Helpers.manifest.assets[uri.path]
+        return ManifestPath.new(uri, Helpers.manifest.assets[uri.path], options).to_s
       end
-
+      
       # If the source points to an asset in the Sprockets
       # environment use AssetPath to generate the full path.
-      assets_environment.resolve(source) do |path|
-        return AssetPath.new(assets_environment[path], options).to_s
+      assets_environment.resolve(uri.path) do |path|
+        return AssetPath.new(uri, assets_environment[path], options).to_s
       end
       
       # Use FilePath for normal files on the file system
-      FilePath.new(source, options).to_s
+      FilePath.new(uri, options).to_s
     end
     alias_method :path_to_asset, :asset_path
     

data/spec/sprockets-helpers_spec.rb

@@ -45,28 +45,90 @@ describe Sprockets::Helpers do
     end
   end
   
-  describe '.prefix' do
+  describe '.asset_host' do
     context 'that is a string' do
-      it 'sets a custom assets prefix' do
+      it 'prepends the asset_host' do
         within_construct do |c|
-          c.file 'assets/logo.jpg'
-
-          context.asset_path('logo.jpg').should == '/assets/logo.jpg'
-          Sprockets::Helpers.prefix = '/images'
-          context.asset_path('logo.jpg').should == '/images/logo.jpg'
-          Sprockets::Helpers.prefix = nil
+          c.file 'assets/main.js'
+          c.file 'public/logo.jpg'
+          
+          Sprockets::Helpers.asset_host = 'assets.example.com'
+          context.asset_path('main.js').should == 'http://assets.example.com/assets/main.js'
+          context.asset_path('logo.jpg').should =~ %r(http://assets.example.com/logo.jpg\?\d+)
+          Sprockets::Helpers.asset_host = nil
+        end
+      end
+      
+      context 'with a wildcard' do
+        it 'cycles asset_host between 0-3' do
+          within_construct do |c|
+            c.file 'assets/main.css'
+            c.file 'public/logo.jpg'
+            
+            Sprockets::Helpers.asset_host = 'assets%d.example.com'
+            context.asset_path('main.css').should =~ %r(http://assets[0-3].example.com/assets/main.css)
+            context.asset_path('logo.jpg').should =~ %r(http://assets[0-3].example.com/logo.jpg\?\d+)
+            Sprockets::Helpers.asset_host = nil
+          end
         end
       end
     end
-
+    
     context 'that is a proc' do
-      it 'sets a custom assets prefix' do
+      it 'prepends the returned asset_host' do
         within_construct do |c|
-          c.file 'assets/logo.jpg'
-
-          Sprockets::Helpers.prefix = Proc.new { |source| "http://example.com/#{File.basename(source, '.jpg')}" }
-          context.asset_path('logo.jpg').should == 'http://example.com/logo/logo.jpg'
-          Sprockets::Helpers.prefix = nil
+          c.file 'assets/main.js'
+          c.file 'public/logo.jpg'
+          
+          Sprockets::Helpers.asset_host = Proc.new { |source| File.basename(source, File.extname(source)) + '.assets.example.com' }
+          context.asset_path('main.js').should == 'http://main.assets.example.com/assets/main.js'
+          context.asset_path('logo.jpg').should =~ %r(http://logo.assets.example.com/logo.jpg\?\d+)
+          Sprockets::Helpers.asset_host = nil
+        end
+      end
+    end
+  end
+  
+  describe '.prefix' do
+    it 'sets a custom assets prefix' do
+      within_construct do |c|
+        c.file 'assets/logo.jpg'
+        
+        context.asset_path('logo.jpg').should == '/assets/logo.jpg'
+        Sprockets::Helpers.prefix = '/images'
+        context.asset_path('logo.jpg').should == '/images/logo.jpg'
+        Sprockets::Helpers.prefix = nil
+      end
+    end
+  end
+  
+  describe '.protocol' do
+    it 'sets the protocol to use with asset_hosts' do
+      within_construct do |c|
+        c.file 'assets/main.js'
+        c.file 'public/logo.jpg'
+        
+        Sprockets::Helpers.asset_host = 'assets.example.com'
+        Sprockets::Helpers.protocol   = 'https'
+        context.asset_path('main.js').should == 'https://assets.example.com/assets/main.js'
+        context.asset_path('logo.jpg').should =~ %r(https://assets.example.com/logo.jpg\?\d+)
+        Sprockets::Helpers.asset_host = nil
+        Sprockets::Helpers.protocol   = nil
+      end
+    end
+    
+    context 'that is :relative' do
+      it 'sets a relative protocol' do
+        within_construct do |c|
+          c.file 'assets/main.js'
+          c.file 'public/logo.jpg'
+          
+          Sprockets::Helpers.asset_host = 'assets.example.com'
+          Sprockets::Helpers.protocol   = :relative
+          context.asset_path('main.js').should == '//assets.example.com/assets/main.js'
+          context.asset_path('logo.jpg').should =~ %r(\A//assets.example.com/logo.jpg\?\d+)
+          Sprockets::Helpers.asset_host = nil
+          Sprockets::Helpers.protocol   = nil
         end
       end
     end
@@ -101,6 +163,7 @@ describe Sprockets::Helpers do
       it 'returns absolute paths' do
         context.asset_path('/path/to/file.js').should == '/path/to/file.js'
         context.asset_path('/path/to/file.jpg').should == '/path/to/file.jpg'
+        context.asset_path('/path/to/file.eot?#iefix').should == '/path/to/file.eot?#iefix'
       end
       
       it 'appends the extension for javascripts and stylesheets' do
@@ -118,9 +181,13 @@ describe Sprockets::Helpers do
         within_construct do |c|
           c.file 'public/main.js'
           c.file 'public/favicon.ico'
+          c.file 'public/font.eot'
+          c.file 'public/font.svg'
           
           context.asset_path('main', :ext => 'js').should =~ %r(/main.js\?\d+)
           context.asset_path('/favicon.ico').should =~ %r(/favicon.ico\?\d+)
+          context.asset_path('font.eot?#iefix').should =~ %r(/font.eot\?\d+#iefix)
+          context.asset_path('font.svg#FontName').should =~ %r(/font.svg\?\d+#FontName)
         end
       end
     end
@@ -150,17 +217,25 @@ describe Sprockets::Helpers do
       it 'uses the digest path if configured' do
         within_construct do |c|
           c.file 'assets/main.js'
+          c.file 'assets/font.eot'
+          c.file 'assets/font.svg'
           
           context.asset_path('main', :ext => 'js').should == '/assets/main.js'
           context.asset_path('main', :ext => 'js', :digest => true).should =~ %r(/assets/main-[0-9a-f]+.js)
+          context.asset_path('font.eot?#iefix', :digest => true).should =~ %r(/assets/font-[0-9a-f]+.eot\?#iefix)
+          context.asset_path('font.svg#FontName', :digest => true).should =~ %r(/assets/font-[0-9a-f]+.svg#FontName)
         end
       end
       
       it 'returns a body parameter' do
         within_construct do |c|
           c.file 'assets/main.js'
+          c.file 'assets/font.eot'
+          c.file 'assets/font.svg'
           
           context.asset_path('main', :ext => 'js', :body => true).should == '/assets/main.js?body=1'
+          context.asset_path('font.eot?#iefix', :body => true).should == '/assets/font.eot?body=1#iefix'
+          context.asset_path('font.svg#FontName', :body => true).should == '/assets/font.svg?body=1#FontName'
         end
       end
     end
@@ -171,19 +246,19 @@ describe Sprockets::Helpers do
           within_construct do |c|
             asset_file    = c.file 'assets/application.js'
             manifest_file = c.join 'manifest.json'
-        
+            
             manifest = Sprockets::Manifest.new(env, manifest_file)
             manifest.compile 'application.js'
-
+            
             Sprockets::Helpers.configure do |config|
               config.digest   = true
               config.prefix   = '/assets'
               config.manifest = Sprockets::Manifest.new(env, manifest_file)
             end
-              
+            
             asset_file.delete
-            context.asset_path('application.js').should =~ %r(/assets/application-[0-9a-f]+.js)        
-
+            context.asset_path('application.js').should =~ %r(/assets/application-[0-9a-f]+.js)
+            
             Sprockets::Helpers.digest = nil
             Sprockets::Helpers.prefix = nil
           end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sprockets-helpers
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-19 00:00:00.000000000 Z
+date: 2012-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sprockets
-  requirement: &70151392212820 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,15 @@ dependencies:
         version: '2.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70151392212820
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: appraisal
-  requirement: &70151392211980 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +37,15 @@ dependencies:
         version: '0.4'
   type: :development
   prerelease: false
-  version_requirements: *70151392211980
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70151392210640 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +53,15 @@ dependencies:
         version: '2.6'
   type: :development
   prerelease: false
-  version_requirements: *70151392210640
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
 - !ruby/object:Gem::Dependency
   name: test-construct
-  requirement: &70151392209760 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +69,15 @@ dependencies:
         version: '1.2'
   type: :development
   prerelease: false
-  version_requirements: *70151392209760
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70151392208960 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +85,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70151392208960
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Asset path helpers for Sprockets 2.x applications
 email:
 - me@petebrowne.com
@@ -87,6 +112,7 @@ files:
 - lib/sprockets-helpers.rb
 - lib/sprockets/helpers.rb
 - lib/sprockets/helpers/asset_path.rb
+- lib/sprockets/helpers/base_path.rb
 - lib/sprockets/helpers/file_path.rb
 - lib/sprockets/helpers/manifest_path.rb
 - lib/sprockets/helpers/version.rb
@@ -107,7 +133,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2985089145650135547
+      hash: -831447907
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -116,10 +142,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2985089145650135547
+      hash: -831447907
 requirements: []
 rubyforge_project: sprockets-helpers
-rubygems_version: 1.8.11
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Asset path helpers for Sprockets 2.x applications