Merge pull request rails#1870 from chriseppstein/asset_urls_master

Asset urls master

Author: spastorino

actionpack/lib/action_view/asset_paths.rb

@@ -4,7 +4,7 @@ module ActionView
   class AssetPaths #:nodoc:
     attr_reader :config, :controller
 
-    def initialize(config, controller)
+    def initialize(config, controller = nil)
       @config = config
       @controller = controller
     end
@@ -13,21 +13,29 @@ def initialize(config, controller)
     # Prefix with <tt>/dir/</tt> if lacking a leading +/+. Account for relative URL
     # roots. Rewrite the asset path for cache-busting asset ids. Include
     # asset host, if configured, with the correct request protocol.
-    def compute_public_path(source, dir, ext = nil, include_host = true)
+    #
+    # When include_host is true and the asset host does not specify the protocol
+    # the protocol parameter specifies how the protocol will be added.
+    # When :relative (default), the protocol will be determined by the client using current protocol
+    # When :request, the protocol will be the request protocol
+    # Otherwise, the protocol is used (E.g. :http, :https, etc)
+    def compute_public_path(source, dir, ext = nil, include_host = true, protocol = nil)
       source = source.to_s
       return source if is_uri?(source)
 
       source = rewrite_extension(source, dir, ext) if ext
       source = rewrite_asset_path(source, dir)
-
-      if controller && include_host
-        has_request = controller.respond_to?(:request)
-        source = rewrite_host_and_protocol(source, has_request)
-      end
-
+      source = rewrite_relative_url_root(source, relative_url_root) if has_request?
+      source = rewrite_host_and_protocol(source, protocol) if include_host
       source
     end
 
+    # Return the filesystem path for the source
+    def compute_source_path(source, dir, ext)
+      source = rewrite_extension(source, dir, ext) if ext
+      File.join(config.assets_dir, dir, source)
+    end
+
     def is_uri?(path)
       path =~ %r{^[-a-z]+://|^cid:|^//}
     end
@@ -46,13 +54,45 @@ def rewrite_relative_url_root(source, relative_url_root)
       relative_url_root && !source.starts_with?("#{relative_url_root}/") ? "#{relative_url_root}#{source}" : source
     end
 
-    def rewrite_host_and_protocol(source, has_request)
-      source = rewrite_relative_url_root(source, controller.config.relative_url_root) if has_request
+    def has_request?
+      controller.respond_to?(:request)
+    end
+
+    def rewrite_host_and_protocol(source, protocol = nil)
       host = compute_asset_host(source)
-      if has_request && host && !is_uri?(host)
-        host = "#{controller.request.protocol}#{host}"
+      if host && !is_uri?(host)
+        if (protocol || default_protocol) == :request && !has_request?
+          host = nil
+        else
+          host = "#{compute_protocol(protocol)}#{host}"
+        end
+      end
+      host.nil? ? source : "#{host}#{source}"
+    end
+
+    def compute_protocol(protocol)
+      protocol ||= default_protocol
+      case protocol
+      when :relative
+        "//"
+      when :request
+        unless @controller
+          invalid_asset_host!("The protocol requested was :request. Consider using :relative instead.")
+        end
+        @controller.request.protocol
+      else
+        "#{protocol}://"
       end
-      "#{host}#{source}"
+    end
+
+    def default_protocol
+      protocol = @config.action_controller.default_asset_host_protocol if @config.action_controller.present?
+      protocol ||= @config.default_asset_host_protocol
+      protocol || (has_request? ? :request : :relative)
+    end
+
+    def invalid_asset_host!(help_message)
+      raise ActionController::RoutingError, "This asset host cannot be computed without a request in scope. #{help_message}"
     end
 
     # Pick an asset host for this source. Returns +nil+ if no host is set,
@@ -61,19 +101,45 @@ def rewrite_host_and_protocol(source, has_request)
     # or the value returned from invoking call on an object responding to call
     # (proc or otherwise).
     def compute_asset_host(source)
-      if host = config.asset_host
+      if host = asset_host_config
         if host.respond_to?(:call)
-          case host.is_a?(Proc) ? host.arity : host.method(:call).arity
-          when 2
-            request = controller.respond_to?(:request) && controller.request
-            host.call(source, request)
-          else
-            host.call(source)
+          args = [source]
+          arity = arity_of(host)
+          if arity > 1 && !has_request?
+            invalid_asset_host!("Remove the second argument to your asset_host Proc if you do not need the request.")
           end
+          args << current_request if (arity > 1 || arity < 0) && has_request?
+          host.call(*args)
         else
           (host =~ /%d/) ? host % (source.hash % 4) : host
         end
       end
     end
+
+    def relative_url_root
+      config = controller.config if controller.respond_to?(:config)
+      config ||= config.action_controller if config.action_controller.present?
+      config ||= config
+      config.relative_url_root
+    end
+
+    def asset_host_config
+      if config.action_controller.present?
+        config.action_controller.asset_host
+      else
+        config.asset_host
+      end
+    end
+
+    # Returns the current request if one exists.
+    def current_request
+      controller.request if has_request?
+    end
+
+    # Returns the arity of a callable
+    def arity_of(callable)
+      callable.respond_to?(:arity) ? callable.arity : callable.method(:call).arity
+    end
+
   end
 end

actionpack/lib/action_view/helpers/asset_tag_helpers/asset_include_tag.rb

@@ -60,12 +60,16 @@ def include_tag(*sources)
 
         private
 
-          def path_to_asset(source, include_host = true)
-            asset_paths.compute_public_path(source, asset_name.to_s.pluralize, extension, include_host)
+          def path_to_asset(source, include_host = true, protocol = nil)
+            asset_paths.compute_public_path(source, asset_name.to_s.pluralize, extension, include_host, protocol)
+          end
+
+          def path_to_asset_source(source)
+            asset_paths.compute_source_path(source, asset_name.to_s.pluralize, extension)
           end
 
           def compute_paths(*args)
-            expand_sources(*args).collect { |source| asset_paths.compute_public_path(source, asset_name.pluralize, extension, false) }
+            expand_sources(*args).collect { |source| path_to_asset_source(source) }
           end
 
           def expand_sources(sources, recursive)
@@ -92,7 +96,7 @@ def update_source_list(list, source)
 
           def ensure_sources!(sources)
             sources.each do |source|
-              asset_file_path!(path_to_asset(source, false))
+              asset_file_path!(path_to_asset_source(source))
             end
           end
 
@@ -123,19 +127,14 @@ def write_asset_file_contents(joined_asset_path, asset_paths)
 
             # Set mtime to the latest of the combined files to allow for
             # consistent ETag without a shared filesystem.
-            mt = asset_paths.map { |p| File.mtime(asset_file_path(p)) }.max
+            mt = asset_paths.map { |p| File.mtime(asset_file_path!(p)) }.max
             File.utime(mt, mt, joined_asset_path)
           end
 
-          def asset_file_path(path)
-            File.join(config.assets_dir, path.split('?').first)
-          end
-
-          def asset_file_path!(path, error_if_file_is_uri = false)
-            if asset_paths.is_uri?(path)
+          def asset_file_path!(absolute_path, error_if_file_is_uri = false)
+            if asset_paths.is_uri?(absolute_path)
               raise(Errno::ENOENT, "Asset file #{path} is uri and cannot be merged into single file") if error_if_file_is_uri
             else
-              absolute_path = asset_file_path(path)
               raise(Errno::ENOENT, "Asset file not found at '#{absolute_path}'" ) unless File.exist?(absolute_path)
               return absolute_path
             end

actionpack/lib/action_view/helpers/asset_tag_helpers/stylesheet_tag_helpers.rb

@@ -16,7 +16,8 @@ def extension
         end
 
         def asset_tag(source, options)
-          tag("link", { "rel" => "stylesheet", "type" => Mime::CSS, "media" => "screen", "href" => ERB::Util.html_escape(path_to_asset(source)) }.merge(options), false, false)
+          # We force the :request protocol here to avoid a double-download bug in IE7 and IE8
+          tag("link", { "rel" => "stylesheet", "type" => Mime::CSS, "media" => "screen", "href" => ERB::Util.html_escape(path_to_asset(source, true, :request)) }.merge(options), false, false)
         end
 
         def custom_dir
@@ -52,19 +53,15 @@ def register_stylesheet_expansion(expansions)
         # If the +source+ filename has no extension, <tt>.css</tt> will be appended (except for explicit URIs).
         # Full paths from the document root will be passed through.
         # Used internally by +stylesheet_link_tag+ to build the stylesheet path.
-        #
+        # 
         # ==== Examples
         #   stylesheet_path "style"                                  # => /stylesheets/style.css
         #   stylesheet_path "dir/style.css"                          # => /stylesheets/dir/style.css
         #   stylesheet_path "/dir/style.css"                         # => /dir/style.css
         #   stylesheet_path "http://www.example.com/css/style"       # => http://www.example.com/css/style
         #   stylesheet_path "http://www.example.com/css/style.css"   # => http://www.example.com/css/style.css
         def stylesheet_path(source)
-          if config.use_sprockets
-            asset_path(source, 'css')
-          else
-            asset_paths.compute_public_path(source, 'stylesheets', 'css')
-          end
+          asset_paths.compute_public_path(source, 'stylesheets', 'css', true, :request)
         end
         alias_method :path_to_stylesheet, :stylesheet_path # aliased to avoid conflicts with a stylesheet_path named route
 

actionpack/lib/sprockets/helpers/rails_helper.rb

@@ -10,6 +10,12 @@ def asset_paths
         @asset_paths ||= begin
           config     = self.config if respond_to?(:config)
           controller = self.controller if respond_to?(:controller)
+          config ||= Rails.application.config
+          if config.action_controller.present?
+            config.action_controller.default_asset_host_protocol ||= :relative
+          else
+            config.default_asset_host_protocol ||= :relative
+          end
           RailsHelper::AssetPaths.new(config, controller)
         end
       end
@@ -50,29 +56,34 @@ def stylesheet_link_tag(*sources)
               'rel'   => "stylesheet",
               'type'  => "text/css",
               'media' => "screen",
-              'href'  => asset_path(source, 'css', body)
+              'href'  => asset_path(source, 'css', body, :request)
             }.merge(options.stringify_keys)
 
             tag 'link', tag_options
           end
         end.join("\n").html_safe
       end
 
+      def asset_path(source, default_ext = nil, body = false, protocol = nil)
+        source = source.logical_path if source.respond_to?(:logical_path)
+        path = asset_paths.compute_public_path(source, 'assets', default_ext, true, protocol)
+        body ? "#{path}?body=1" : path
+      end
+
     private
       def debug_assets?
         params[:debug_assets] == '1' ||
           params[:debug_assets] == 'true'
       end
 
-      def asset_path(source, default_ext = nil, body = false)
-        source = source.logical_path if source.respond_to?(:logical_path)
-        path = asset_paths.compute_public_path(source, Rails.application.config.assets.prefix, default_ext, true)
-        body ? "#{path}?body=1" : path
-      end
-
       class AssetPaths < ::ActionView::AssetPaths #:nodoc:
-        def compute_public_path(source, dir, ext=nil, include_host=true)
-          super(source, Rails.application.config.assets.prefix, ext, include_host)
+        def compute_public_path(source, dir, ext=nil, include_host=true, protocol = nil)
+          super(source, Rails.application.config.assets.prefix, ext, include_host, protocol)
+        end
+
+        # Return the filesystem path for the source
+        def compute_source_path(source, ext)
+          asset_for(source, ext)
         end
 
         def asset_for(source, ext)
@@ -104,7 +115,7 @@ def assets
 
         # When included in Sprockets::Context, we need to ask the top-level config as the controller is not available
         def performing_caching?
-          @config ?  @config.perform_caching : Rails.application.config.action_controller.perform_caching
+          config.action_controller.present? ? config.action_controller.perform_caching : config.perform_caching
         end
       end
     end

actionpack/test/template/asset_tag_helper_test.rb

@@ -862,7 +862,7 @@ def test_caching_javascript_include_tag_when_caching_off_and_missing_javascript_
 
   def test_caching_stylesheet_link_tag_when_caching_on
     ENV["RAILS_ASSET_ID"] = ""
-    @controller.config.asset_host = 'http://a0.example.com'
+    @controller.config.asset_host = 'a0.example.com'
     config.perform_caching = true
 
     assert_dom_equal(
@@ -972,7 +972,7 @@ def test_caching_stylesheet_link_tag_when_caching_off_and_missing_css_file
 
   def test_caching_stylesheet_link_tag_when_caching_on_with_proc_asset_host
     ENV["RAILS_ASSET_ID"] = ""
-    @controller.config.asset_host = Proc.new { |source| "http://a#{source.length}.example.com" }
+    @controller.config.asset_host = Proc.new { |source| "a#{source.length}.example.com" }
     config.perform_caching = true
 
     assert_equal '/stylesheets/styles.css'.length, 23
@@ -1099,13 +1099,23 @@ def test_should_ignore_relative_root_path_on_complete_url
   end
 
   def test_should_compute_proper_path_with_asset_host
-    @controller.config.asset_host = "http://assets.example.com"
+    @controller.config.asset_host = "assets.example.com"
     assert_dom_equal(%(<link href="http://www.example.com/collaboration/hieraki" rel="alternate" title="RSS" type="application/rss+xml" />), auto_discovery_link_tag)
-    assert_dom_equal(%(http://assets.example.com/collaboration/hieraki/javascripts/xmlhr.js), javascript_path("xmlhr"))
-    assert_dom_equal(%(http://assets.example.com/collaboration/hieraki/stylesheets/style.css), stylesheet_path("style"))
-    assert_dom_equal(%(http://assets.example.com/collaboration/hieraki/images/xml.png), image_path("xml.png"))
-    assert_dom_equal(%(<img alt="Mouse" onmouseover="this.src='http://assets.example.com/collaboration/hieraki/images/mouse_over.png'" onmouseout="this.src='http://assets.example.com/collaboration/hieraki/images/mouse.png'" src="http://assets.example.com/collaboration/hieraki/images/mouse.png" />), image_tag("mouse.png", :mouseover => "/images/mouse_over.png"))
-    assert_dom_equal(%(<img alt="Mouse2" onmouseover="this.src='http://assets.example.com/collaboration/hieraki/images/mouse_over2.png'" onmouseout="this.src='http://assets.example.com/collaboration/hieraki/images/mouse2.png'" src="http://assets.example.com/collaboration/hieraki/images/mouse2.png" />), image_tag("mouse2.png", :mouseover => image_path("mouse_over2.png")))
+    assert_dom_equal(%(gopher://assets.example.com/collaboration/hieraki/javascripts/xmlhr.js), javascript_path("xmlhr"))
+    assert_dom_equal(%(gopher://assets.example.com/collaboration/hieraki/stylesheets/style.css), stylesheet_path("style"))
+    assert_dom_equal(%(gopher://assets.example.com/collaboration/hieraki/images/xml.png), image_path("xml.png"))
+    assert_dom_equal(%(<img alt="Mouse" onmouseover="this.src='gopher://assets.example.com/collaboration/hieraki/images/mouse_over.png'" onmouseout="this.src='gopher://assets.example.com/collaboration/hieraki/images/mouse.png'" src="gopher://assets.example.com/collaboration/hieraki/images/mouse.png" />), image_tag("mouse.png", :mouseover => "/images/mouse_over.png"))
+    assert_dom_equal(%(<img alt="Mouse2" onmouseover="this.src='gopher://assets.example.com/collaboration/hieraki/images/mouse_over2.png'" onmouseout="this.src='gopher://assets.example.com/collaboration/hieraki/images/mouse2.png'" src="gopher://assets.example.com/collaboration/hieraki/images/mouse2.png" />), image_tag("mouse2.png", :mouseover => image_path("mouse_over2.png")))
+  end
+
+  def test_should_compute_proper_path_with_asset_host_and_default_protocol
+    @controller.config.asset_host = "assets.example.com"
+    @controller.config.default_asset_host_protocol = :request
+    assert_dom_equal(%(gopher://assets.example.com/collaboration/hieraki/javascripts/xmlhr.js), javascript_path("xmlhr"))
+    assert_dom_equal(%(gopher://assets.example.com/collaboration/hieraki/stylesheets/style.css), stylesheet_path("style"))
+    assert_dom_equal(%(gopher://assets.example.com/collaboration/hieraki/images/xml.png), image_path("xml.png"))
+    assert_dom_equal(%(<img alt="Mouse" onmouseover="this.src='gopher://assets.example.com/collaboration/hieraki/images/mouse_over.png'" onmouseout="this.src='gopher://assets.example.com/collaboration/hieraki/images/mouse.png'" src="gopher://assets.example.com/collaboration/hieraki/images/mouse.png" />), image_tag("mouse.png", :mouseover => "/images/mouse_over.png"))
+    assert_dom_equal(%(<img alt="Mouse2" onmouseover="this.src='gopher://assets.example.com/collaboration/hieraki/images/mouse_over2.png'" onmouseout="this.src='gopher://assets.example.com/collaboration/hieraki/images/mouse2.png'" src="gopher://assets.example.com/collaboration/hieraki/images/mouse2.png" />), image_tag("mouse2.png", :mouseover => image_path("mouse_over2.png")))
   end
 
   def test_should_ignore_asset_host_on_complete_url
@@ -1123,12 +1133,12 @@ def test_should_wildcard_asset_host_between_zero_and_four
     assert_match(%r(http://a[0123].example.com/collaboration/hieraki/images/xml.png), image_path('xml.png'))
   end
 
-  def test_asset_host_without_protocol_should_use_request_protocol
+  def test_asset_host_without_protocol_should_be_protocol_relative
     @controller.config.asset_host = 'a.example.com'
     assert_equal 'gopher://a.example.com/collaboration/hieraki/images/xml.png', image_path('xml.png')
   end
 
-  def test_asset_host_without_protocol_should_use_request_protocol_even_if_path_present
+  def test_asset_host_without_protocol_should_be_protocol_relative_even_if_path_present
     @controller.config.asset_host = 'a.example.com/files/go/here'
     assert_equal 'gopher://a.example.com/files/go/here/collaboration/hieraki/images/xml.png', image_path('xml.png')
   end