actionview 5.0.7.2 → 5.1.0.beta1

data/lib/action_view/helpers/asset_url_helper.rb

@@ -1,4 +1,4 @@
-require 'zlib'
+require "zlib"
 
 module ActionView
   # = Action View Asset URL Helpers
@@ -36,7 +36,7 @@ module ActionView
     # some asset downloads to wait for previous assets to finish before they can
     # begin. You can use the <tt>%d</tt> wildcard in the +asset_host+ to
     # distribute the requests over four hosts. For example,
-    # <tt>assets%d.example.com<tt> will spread the asset requests over
+    # <tt>assets%d.example.com</tt> will spread the asset requests over
     # "assets0.example.com", ..., "assets3.example.com".
     #
     #   image_tag("rails.png")
@@ -96,8 +96,8 @@ module ActionView
     # have SSL certificates for each of the asset hosts this technique allows you
     # to avoid warnings in the client about mixed media.
     # Note that the request parameter might not be supplied, e.g. when the assets
-    # are precompiled via a Rake task. Make sure to use a Proc instead of a lambda,
-    # since a Proc allows missing parameters and sets them to nil.
+    # are precompiled via a Rake task. Make sure to use a +Proc+ instead of a lambda,
+    # since a +Proc+ allows missing parameters and sets them to +nil+.
     #
     #   config.action_controller.asset_host = Proc.new { |source, request|
     #     if request && request.ssl?
@@ -117,31 +117,86 @@ module ActionView
     module AssetUrlHelper
       URI_REGEXP = %r{^[-a-z]+://|^(?:cid|data):|^//}i
 
-      # Computes the path to asset in public directory. If :type
-      # options is set, a file extension will be appended and scoped
-      # to the corresponding public directory.
+      # This is the entry point for all assets.
+      # When using the asset pipeline (i.e. sprockets and sprockets-rails), the
+      # behavior is "enhanced". You can bypass the asset pipeline by passing in
+      # <tt>skip_pipeline: true</tt> to the options.
       #
       # All other asset *_path helpers delegate through this method.
       #
-      #   asset_path "application.js"                     # => /assets/application.js
-      #   asset_path "application", type: :javascript     # => /assets/application.js
-      #   asset_path "application", type: :stylesheet     # => /assets/application.css
-      #   asset_path "http://www.example.com/js/xmlhr.js" # => http://www.example.com/js/xmlhr.js
+      # === With the asset pipeline
+      #
+      # All options passed to +asset_path+ will be passed to +compute_asset_path+
+      # which is implemented by sprockets-rails.
+      #
+      #   asset_path("application.js") # => "/assets/application-60aa4fdc5cea14baf5400fba1abf4f2a46a5166bad4772b1effe341570f07de9.js"
+      #
+      # === Without the asset pipeline (<tt>skip_pipeline: true</tt>)
+      #
+      # Accepts a <tt>type</tt> option that can specify the asset's extension. No error
+      # checking is done to verify the source passed into +asset_path+ is valid
+      # and that the file exists on disk.
+      #
+      #   asset_path("application.js", skip_pipeline: true)                 # => "application.js"
+      #   asset_path("filedoesnotexist.png", skip_pipeline: true)           # => "filedoesnotexist.png"
+      #   asset_path("application", type: :javascript, skip_pipeline: true) # => "/javascripts/application.js"
+      #   asset_path("application", type: :stylesheet, skip_pipeline: true) # => "/stylesheets/application.css"
+      #
+      # === Options applying to all assets
+      #
+      # Below lists scenarios that apply to +asset_path+ whether or not you're
+      # using the asset pipeline.
+      #
+      # - All fully qualified urls are returned immediately. This bypasses the
+      #   asset pipeline and all other behavior described.
+      #
+      #     asset_path("http://www.example.com/js/xmlhr.js") # => "http://www.example.com/js/xmlhr.js"
+      #
+      # - All assets that begin with a forward slash are assumed to be full
+      #   urls and will not be expanded. This will bypass the asset pipeline.
+      #
+      #     asset_path("/foo.png") # => "/foo.png"
+      #
+      # - All blank strings will be returned immediately. This bypasses the
+      #   asset pipeline and all other behavior described.
+      #
+      #     asset_path("") # => ""
+      #
+      # - If <tt>config.relative_url_root</tt> is specified, all assets will have that
+      #   root prepended.
+      #
+      #     Rails.application.config.relative_url_root = "bar"
+      #     asset_path("foo.js", skip_pipeline: true) # => "bar/foo.js"
+      #
+      # - A different asset host can be specified via <tt>config.action_controller.asset_host</tt>
+      #   this is commonly used in conjunction with a CDN.
+      #
+      #     Rails.application.config.action_controller.asset_host = "assets.example.com"
+      #     asset_path("foo.js", skip_pipeline: true) # => "http://assets.example.com/foo.js"
+      #
+      # - An extension name can be specified manually with <tt>extname</tt>.
+      #
+      #     asset_path("foo", skip_pipeline: true, extname: ".js")     # => "/foo.js"
+      #     asset_path("foo.css", skip_pipeline: true, extname: ".js") # => "/foo.css.js"
       def asset_path(source, options = {})
         raise ArgumentError, "nil is not a valid asset source" if source.nil?
 
         source = source.to_s
-        return "" unless source.present?
-        return source if source =~ URI_REGEXP
+        return "" if source.blank?
+        return source if URI_REGEXP.match?(source)
 
-        tail, source = source[/([\?#].+)$/], source.sub(/([\?#].+)$/, ''.freeze)
+        tail, source = source[/([\?#].+)$/], source.sub(/([\?#].+)$/, "".freeze)
 
         if extname = compute_asset_extname(source, options)
           source = "#{source}#{extname}"
         end
 
         if source[0] != ?/
-          source = compute_asset_path(source, options)
+          if options[:skip_pipeline]
+            source = public_compute_asset_path(source, options)
+          else
+            source = compute_asset_path(source, options)
+          end
         end
 
         relative_url_root = defined?(config.relative_url_root) && config.relative_url_root
@@ -168,31 +223,35 @@ module ActionView
       #   asset_url "application.js", host: "http://cdn.example.com" # => http://cdn.example.com/assets/application.js
       #
       def asset_url(source, options = {})
-        path_to_asset(source, options.merge(:protocol => :request))
+        path_to_asset(source, options.merge(protocol: :request))
       end
       alias_method :url_to_asset, :asset_url # aliased to avoid conflicts with an asset_url named route
 
       ASSET_EXTENSIONS = {
-        javascript: '.js',
-        stylesheet: '.css'
+        javascript: ".js",
+        stylesheet: ".css"
       }
 
-      # Compute extname to append to asset path. Returns nil if
+      # Compute extname to append to asset path. Returns +nil+ if
       # nothing should be added.
       def compute_asset_extname(source, options = {})
         return if options[:extname] == false
         extname = options[:extname] || ASSET_EXTENSIONS[options[:type]]
-        extname if extname && File.extname(source) != extname
+        if extname && File.extname(source) != extname
+          extname
+        else
+          nil
+        end
       end
 
       # Maps asset types to public directory.
       ASSET_PUBLIC_DIRECTORIES = {
-        audio:      '/audios',
-        font:       '/fonts',
-        image:      '/images',
-        javascript: '/javascripts',
-        stylesheet: '/stylesheets',
-        video:      '/videos'
+        audio:      "/audios",
+        font:       "/fonts",
+        image:      "/images",
+        javascript: "/javascripts",
+        stylesheet: "/stylesheets",
+        video:      "/videos"
       }
 
       # Computes asset path to public directory. Plugins and
@@ -202,6 +261,7 @@ module ActionView
         dir = ASSET_PUBLIC_DIRECTORIES[options[:type]] || ""
         File.join(dir, source)
       end
+      alias :public_compute_asset_path :compute_asset_path
 
       # 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
@@ -213,19 +273,21 @@ module ActionView
         host = options[:host]
         host ||= config.asset_host if defined? config.asset_host
 
-        if host.respond_to?(:call)
-          arity = host.respond_to?(:arity) ? host.arity : host.method(:call).arity
-          args = [source]
-          args << request if request && (arity > 1 || arity < 0)
-          host = host.call(*args)
-        elsif host =~ /%d/
-          host = host % (Zlib.crc32(source) % 4)
+        if host
+          if host.respond_to?(:call)
+            arity = host.respond_to?(:arity) ? host.arity : host.method(:call).arity
+            args = [source]
+            args << request if request && (arity > 1 || arity < 0)
+            host = host.call(*args)
+          elsif host.include?("%d")
+            host = host % (Zlib.crc32(source) % 4)
+          end
         end
 
         host ||= request.base_url if request && options[:protocol] == :request
         return unless host
 
-        if host =~ URI_REGEXP
+        if URI_REGEXP.match?(host)
           host
         else
           protocol = options[:protocol] || config.default_asset_host_protocol || (request ? :request : :relative)
@@ -251,7 +313,7 @@ module ActionView
       #   javascript_path "http://www.example.com/js/xmlhr"    # => http://www.example.com/js/xmlhr
       #   javascript_path "http://www.example.com/js/xmlhr.js" # => http://www.example.com/js/xmlhr.js
       def javascript_path(source, options = {})
-        path_to_asset(source, {type: :javascript}.merge!(options))
+        path_to_asset(source, { type: :javascript }.merge!(options))
       end
       alias_method :path_to_javascript, :javascript_path # aliased to avoid conflicts with a javascript_path named route
 
@@ -263,7 +325,7 @@ module ActionView
       #   javascript_url "js/xmlhr.js", host: "http://stage.example.com" # => http://stage.example.com/assets/dir/xmlhr.js
       #
       def javascript_url(source, options = {})
-        url_to_asset(source, {type: :javascript}.merge!(options))
+        url_to_asset(source, { type: :javascript }.merge!(options))
       end
       alias_method :url_to_javascript, :javascript_url # aliased to avoid conflicts with a javascript_url named route
 
@@ -278,7 +340,7 @@ module ActionView
       #   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, options = {})
-        path_to_asset(source, {type: :stylesheet}.merge!(options))
+        path_to_asset(source, { type: :stylesheet }.merge!(options))
       end
       alias_method :path_to_stylesheet, :stylesheet_path # aliased to avoid conflicts with a stylesheet_path named route
 
@@ -290,7 +352,7 @@ module ActionView
       #   stylesheet_url "css/style.css", host: "http://stage.example.com" # => http://stage.example.com/css/style.css
       #
       def stylesheet_url(source, options = {})
-        url_to_asset(source, {type: :stylesheet}.merge!(options))
+        url_to_asset(source, { type: :stylesheet }.merge!(options))
       end
       alias_method :url_to_stylesheet, :stylesheet_url # aliased to avoid conflicts with a stylesheet_url named route
 
@@ -308,7 +370,7 @@ module ActionView
       # The alias +path_to_image+ is provided to avoid that. Rails uses the alias internally, and
       # plugin authors are encouraged to do so.
       def image_path(source, options = {})
-        path_to_asset(source, {type: :image}.merge!(options))
+        path_to_asset(source, { type: :image }.merge!(options))
       end
       alias_method :path_to_image, :image_path # aliased to avoid conflicts with an image_path named route
 
@@ -320,7 +382,7 @@ module ActionView
       #   image_url "edit.png", host: "http://stage.example.com" # => http://stage.example.com/edit.png
       #
       def image_url(source, options = {})
-        url_to_asset(source, {type: :image}.merge!(options))
+        url_to_asset(source, { type: :image }.merge!(options))
       end
       alias_method :url_to_image, :image_url # aliased to avoid conflicts with an image_url named route
 
@@ -334,7 +396,7 @@ module ActionView
       #   video_path("/trailers/hd.avi")                              # => /trailers/hd.avi
       #   video_path("http://www.example.com/vid/hd.avi")             # => http://www.example.com/vid/hd.avi
       def video_path(source, options = {})
-        path_to_asset(source, {type: :video}.merge!(options))
+        path_to_asset(source, { type: :video }.merge!(options))
       end
       alias_method :path_to_video, :video_path # aliased to avoid conflicts with a video_path named route
 
@@ -346,9 +408,9 @@ module ActionView
       #   video_url "hd.avi", host: "http://stage.example.com" # => http://stage.example.com/hd.avi
       #
       def video_url(source, options = {})
-        url_to_asset(source, {type: :video}.merge!(options))
+        url_to_asset(source, { type: :video }.merge!(options))
       end
-      alias_method :url_to_video, :video_url # aliased to avoid conflicts with an video_url named route
+      alias_method :url_to_video, :video_url # aliased to avoid conflicts with a video_url named route
 
       # Computes the path to an audio asset in the public audios directory.
       # Full paths from the document root will be passed through.
@@ -360,7 +422,7 @@ module ActionView
       #   audio_path("/sounds/horse.wav")                                # => /sounds/horse.wav
       #   audio_path("http://www.example.com/sounds/horse.wav")          # => http://www.example.com/sounds/horse.wav
       def audio_path(source, options = {})
-        path_to_asset(source, {type: :audio}.merge!(options))
+        path_to_asset(source, { type: :audio }.merge!(options))
       end
       alias_method :path_to_audio, :audio_path # aliased to avoid conflicts with an audio_path named route
 
@@ -372,7 +434,7 @@ module ActionView
       #   audio_url "horse.wav", host: "http://stage.example.com" # => http://stage.example.com/horse.wav
       #
       def audio_url(source, options = {})
-        url_to_asset(source, {type: :audio}.merge!(options))
+        url_to_asset(source, { type: :audio }.merge!(options))
       end
       alias_method :url_to_audio, :audio_url # aliased to avoid conflicts with an audio_url named route
 
@@ -385,9 +447,9 @@ module ActionView
       #   font_path("/dir/font.ttf")                                  # => /dir/font.ttf
       #   font_path("http://www.example.com/dir/font.ttf")            # => http://www.example.com/dir/font.ttf
       def font_path(source, options = {})
-        path_to_asset(source, {type: :font}.merge!(options))
+        path_to_asset(source, { type: :font }.merge!(options))
       end
-      alias_method :path_to_font, :font_path # aliased to avoid conflicts with an font_path named route
+      alias_method :path_to_font, :font_path # aliased to avoid conflicts with a font_path named route
 
       # Computes the full URL to a font asset.
       # This will use +font_path+ internally, so most of their behaviors will be the same.
@@ -397,9 +459,9 @@ module ActionView
       #   font_url "font.ttf", host: "http://stage.example.com" # => http://stage.example.com/font.ttf
       #
       def font_url(source, options = {})
-        url_to_asset(source, {type: :font}.merge!(options))
+        url_to_asset(source, { type: :font }.merge!(options))
       end
-      alias_method :url_to_font, :font_url # aliased to avoid conflicts with an font_url named route
+      alias_method :url_to_font, :font_url # aliased to avoid conflicts with a font_url named route
     end
   end
 end

data/lib/action_view/helpers/atom_feed_helper.rb

@@ -1,4 +1,4 @@
-require 'set'
+require "set"
 
 module ActionView
   # = Action View Atom Feed Helpers
@@ -103,7 +103,7 @@ module ActionView
         xml = options.delete(:xml) || eval("xml", block.binding)
         xml.instruct!
         if options[:instruct]
-          options[:instruct].each do |target,attrs|
+          options[:instruct].each do |target, attrs|
             if attrs.respond_to?(:keys)
               xml.instruct!(target, attrs)
             elsif attrs.respond_to?(:each)
@@ -112,13 +112,13 @@ module ActionView
           end
         end
 
-        feed_opts = {"xml:lang" => options[:language] || "en-US", "xmlns" => 'http://www.w3.org/2005/Atom'}
-        feed_opts.merge!(options).reject!{|k,v| !k.to_s.match(/^xml/)}
+        feed_opts = { "xml:lang" => options[:language] || "en-US", "xmlns" => "http://www.w3.org/2005/Atom" }
+        feed_opts.merge!(options).reject! { |k, v| !k.to_s.match(/^xml/) }
 
         xml.feed(feed_opts) do
           xml.id(options[:id] || "tag:#{request.host},#{options[:schema_date]}:#{request.fullpath.split(".")[0]}")
-          xml.link(:rel => 'alternate', :type => 'text/html', :href => options[:root_url] || (request.protocol + request.host_with_port))
-          xml.link(:rel => 'self', :type => 'application/atom+xml', :href => options[:url] || request.url)
+          xml.link(rel: "alternate", type: "text/html", href: options[:root_url] || (request.protocol + request.host_with_port))
+          xml.link(rel: "self", type: "application/atom+xml", href: options[:url] || request.url)
 
           yield AtomFeedBuilder.new(xml, self, options)
         end
@@ -138,7 +138,7 @@ module ActionView
           def method_missing(method, *arguments, &block)
             if xhtml_block?(method, arguments)
               @xml.__send__(method, *arguments) do
-                @xml.div(:xmlns => 'http://www.w3.org/1999/xhtml') do |xhtml|
+                @xml.div(xmlns: "http://www.w3.org/1999/xhtml") do |xhtml|
                   block.call(xhtml)
                 end
               end
@@ -153,7 +153,7 @@ module ActionView
           def xhtml_block?(method, arguments)
             if XHTML_TAG_NAMES.include?(method.to_s)
               last = arguments.last
-              last.is_a?(Hash) && last[:type].to_s == 'xhtml'
+              last.is_a?(Hash) && last[:type].to_s == "xhtml"
             end
           end
       end
@@ -163,7 +163,7 @@ module ActionView
           @xml, @view, @feed_options = xml, view, feed_options
         end
 
-        # Accepts a Date or Time object and inserts it in the proper format. If nil is passed, current time in UTC is used.
+        # Accepts a Date or Time object and inserts it in the proper format. If +nil+ is passed, current time in UTC is used.
         def updated(date_or_time = nil)
           @xml.updated((date_or_time || Time.now.utc).xmlschema)
         end
@@ -174,7 +174,7 @@ module ActionView
         #
         # * <tt>:published</tt>: Time first published. Defaults to the created_at attribute on the record if one such exists.
         # * <tt>:updated</tt>: Time of update. Defaults to the updated_at attribute on the record if one such exists.
-        # * <tt>:url</tt>: The URL for this entry or false or nil for not having a link tag. Defaults to the polymorphic_url for the record.
+        # * <tt>:url</tt>: The URL for this entry or +false+ or +nil+ for not having a link tag. Defaults to the +polymorphic_url+ for the record.
         # * <tt>:id</tt>: The ID for this entry. Defaults to "tag:#{@view.request.host},#{@feed_options[:schema_date]}:#{record.class}/#{record.id}"
         # * <tt>:type</tt>: The TYPE for this entry. Defaults to "text/html".
         def entry(record, options = {})
@@ -189,16 +189,15 @@ module ActionView
               @xml.updated((options[:updated] || record.updated_at).xmlschema)
             end
 
-            type = options.fetch(:type, 'text/html')
+            type = options.fetch(:type, "text/html")
 
             url = options.fetch(:url) { @view.polymorphic_url(record) }
-            @xml.link(:rel => 'alternate', :type => type, :href => url) if url
+            @xml.link(rel: "alternate", type: type, href: url) if url
 
             yield AtomBuilder.new(@xml)
           end
         end
       end
-
     end
   end
 end

data/lib/action_view/helpers/cache_helper.rb

@@ -41,11 +41,11 @@ module ActionView
       #
       # ==== \Template digest
       #
-      # The template digest that's added to the cache key is computed by taking an md5 of the
+      # The template digest that's added to the cache key is computed by taking an MD5 of the
       # contents of the entire template file. This ensures that your caches will automatically
       # expire when you change the template file.
       #
-      # Note that the md5 is taken of the entire template file, not just what's within the
+      # Note that the MD5 is taken of the entire template file, not just what's within the
       # cache do/end call. So it's possible that changing something outside of that call will
       # still expire the cache.
       #
@@ -69,11 +69,11 @@ module ActionView
       #   render 'comments/comments'
       #   render('comments/comments')
       #
-      #   render "header" => render("comments/header")
+      #   render "header" translates to render("comments/header")
       #
-      #   render(@topic)         => render("topics/topic")
-      #   render(topics)         => render("topics/topic")
-      #   render(message.topics) => render("topics/topic")
+      #   render(@topic)         translates to render("topics/topic")
+      #   render(topics)         translates to render("topics/topic")
+      #   render(message.topics) translates to render("topics/topic")
       #
       # It's not possible to derive all render calls like that, though.
       # Here are a few examples of things that can't be derived:
@@ -88,7 +88,7 @@ module ActionView
       #
       # === Explicit dependencies
       #
-      # Some times you'll have template dependencies that can't be derived at all. This is typically
+      # Sometimes you'll have template dependencies that can't be derived at all. This is typically
       # the case when you have template rendering that happens in helpers. Here's an example:
       #
       #   <%= render_sortable_todolists @project.todolists %>
@@ -118,7 +118,7 @@ module ActionView
       #
       # If you use a helper method, for example, inside a cached block and
       # you then update that helper, you'll have to bump the cache as well.
-      # It doesn't really matter how you do it, but the md5 of the template file
+      # It doesn't really matter how you do it, but the MD5 of the template file
       # must change. One recommendation is to simply be explicit in a comment, like:
       #
       #   <%# Helper Dependency Updated: May 6, 2012 at 6pm %>
@@ -130,9 +130,10 @@ module ActionView
       #
       # When rendering a collection of objects that each use the same partial, a `cached`
       # option can be passed.
+      #
       # For collections rendered such:
       #
-      #   <%= render partial: 'notifications/notification', collection: @notifications, cached: true %>
+      #   <%= render partial: 'projects/project', collection: @projects, cached: true %>
       #
       # The `cached: true` will make Action View's rendering read several templates
       # from cache at once instead of one call per template.
@@ -142,13 +143,21 @@ module ActionView
       # Works great alongside individual template fragment caching.
       # For instance if the template the collection renders is cached like:
       #
-      #   # notifications/_notification.html.erb
-      #   <% cache notification do %>
+      #   # projects/_project.html.erb
+      #   <% cache project do %>
       #     <%# ... %>
       #   <% end %>
       #
       # Any collection renders will find those cached templates when attempting
       # to read multiple templates at once.
+      #
+      # If your collection cache depends on multiple sources (try to avoid this to keep things simple),
+      # you can name all these dependencies as part of a block that returns an array:
+      #
+      #   <%= render partial: 'projects/project', collection: @projects, cached: -> project { [ project, current_user ] } %>
+      #
+      # This will include both records as part of the cache key and updating either of them will
+      # expire the cache.
       def cache(name = {}, options = {}, &block)
         if controller.respond_to?(:perform_caching) && controller.perform_caching
           name_options = options.slice(:skip_digest, :virtual_path)
@@ -202,12 +211,14 @@ module ActionView
         end
       end
 
+      attr_reader :cache_hit # :nodoc:
+
     private
 
-      def fragment_name_with_digest(name, virtual_path) #:nodoc:
+      def fragment_name_with_digest(name, virtual_path)
         virtual_path ||= @virtual_path
         if virtual_path
-          name  = controller.url_for(name).split("://").last if name.is_a?(Hash)
+          name = controller.url_for(name).split("://").last if name.is_a?(Hash)
           digest = Digestor.digest name: virtual_path, finder: lookup_context, dependencies: view_cache_dependencies
           [ name, digest ]
         else
@@ -215,18 +226,21 @@ module ActionView
         end
       end
 
-      # TODO: Create an object that has caching read/write on it
-      def fragment_for(name = {}, options = nil, &block) #:nodoc:
-        read_fragment_for(name, options) || write_fragment_for(name, options, &block)
+      def fragment_for(name = {}, options = nil, &block)
+        if content = read_fragment_for(name, options)
+          @cache_hit = true
+          content
+        else
+          @cache_hit = false
+          write_fragment_for(name, options, &block)
+        end
       end
 
-      def read_fragment_for(name, options) #:nodoc:
+      def read_fragment_for(name, options)
         controller.read_fragment(name, options)
       end
 
-      def write_fragment_for(name, options) #:nodoc:
-        # VIEW TODO: Make #capture usable outside of ERB
-        # This dance is needed because Builder can't use capture
+      def write_fragment_for(name, options)
         pos = output_buffer.length
         yield
         output_safe = output_buffer.html_safe?