2005-01-08 18:32:11 -05:00
|
|
|
module ActionView
|
|
|
|
module Helpers
|
2007-06-23 13:49:18 -04:00
|
|
|
# This helper to exposes a method for caching of view fragments.
|
2005-01-10 13:20:58 -05:00
|
|
|
# See ActionController::Caching::Fragments for usage instructions.
|
2005-01-08 18:32:11 -05:00
|
|
|
module CacheHelper
|
2007-06-23 13:49:18 -04:00
|
|
|
# A method for caching fragments of a view rather than an entire
|
|
|
|
# action or page. This technique is useful caching pieces like
|
|
|
|
# menus, lists of news topics, static HTML fragments, and so on.
|
|
|
|
# This method takes a block that contains the content you wish
|
|
|
|
# to cache. See ActionController::Caching::Fragments for more
|
|
|
|
# information.
|
|
|
|
#
|
|
|
|
# ==== Examples
|
|
|
|
# If you wanted to cache a navigation menu, you could do the
|
|
|
|
# following.
|
|
|
|
#
|
|
|
|
# <% cache do %>
|
|
|
|
# <%= render :partial => "menu" %>
|
|
|
|
# <% end %>
|
|
|
|
#
|
|
|
|
# You can also cache static content...
|
|
|
|
#
|
|
|
|
# <% cache do %>
|
|
|
|
# <p>Hello users! Welcome to our website!</p>
|
|
|
|
# <% end %>
|
|
|
|
#
|
|
|
|
# ...and static content mixed with RHTML content.
|
|
|
|
#
|
|
|
|
# <% cache do %>
|
|
|
|
# Topics:
|
|
|
|
# <%= render :partial => "topics", :collection => @topic_list %>
|
|
|
|
# <i>Topics listed alphabetically</i>
|
|
|
|
# <% end %>
|
2008-01-03 16:05:12 -05:00
|
|
|
def cache(name = {}, options = nil, &block)
|
Add deprecation notices for <% %>.
* The approach is to compile <% %> into a method call that checks whether
the value returned from a block is a String. If it is, it concats to the buffer and
prints a deprecation warning.
* <%= %> uses exactly the same logic to compile the template, which first checks
to see whether it's compiling a block.
* This should have no impact on other uses of block in templates. For instance, in
<% [1,2,3].each do |i| %><%= i %><% end %>, the call to each returns an Array,
not a String, so the result is not concatenated
* In two cases (#capture and #cache), a String can be returned that should *never*
be concatenated. We have temporarily created a String subclass called NonConcattingString
which behaves (and is serialized) identically to String, but is not concatenated
by the code that handles deprecated <% %> block helpers. Once we remove support
for <% %> block helpers, we can remove NonConcattingString.
2010-03-15 14:58:05 -04:00
|
|
|
controller.fragment_for(name, options, &block)
|
2005-01-08 18:32:11 -05:00
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|