aboutsummaryrefslogtreecommitdiffstats
path: root/actionpack/lib/action_controller/caching/fragments.rb
diff options
context:
space:
mode:
Diffstat (limited to 'actionpack/lib/action_controller/caching/fragments.rb')
-rw-r--r--actionpack/lib/action_controller/caching/fragments.rb36
1 files changed, 18 insertions, 18 deletions
diff --git a/actionpack/lib/action_controller/caching/fragments.rb b/actionpack/lib/action_controller/caching/fragments.rb
index 9c77b0ccf4..879d5fdd94 100644
--- a/actionpack/lib/action_controller/caching/fragments.rb
+++ b/actionpack/lib/action_controller/caching/fragments.rb
@@ -1,29 +1,29 @@
-module ActionController #:nodoc:
+module ActionController
module Caching
- # Fragment caching is used for caching various blocks within
+ # Fragment caching is used for caching various blocks within
# views without caching the entire action as a whole. This is
- # useful when certain elements of an action change frequently or
- # depend on complicated state while other parts rarely change or
+ # useful when certain elements of an action change frequently or
+ # depend on complicated state while other parts rarely change or
# can be shared amongst multiple parties. The caching is done using
- # the <tt>cache</tt> helper available in the Action View. See
+ # the +cache+ helper available in the Action View. See
# ActionView::Helpers::CacheHelper for more information.
#
# While it's strongly recommended that you use key-based cache
# expiration (see links in CacheHelper for more information),
# it is also possible to manually expire caches. For example:
#
- # expire_fragment("name_of_cache")
+ # expire_fragment('name_of_cache')
module Fragments
- # Given a key (as described in <tt>expire_fragment</tt>), returns
- # a key suitable for use in reading, writing, or expiring a
+ # Given a key (as described in +expire_fragment+), returns
+ # a key suitable for use in reading, writing, or expiring a
# cached fragment. All keys are prefixed with <tt>views/</tt> and uses
# ActiveSupport::Cache.expand_cache_key for the expansion.
def fragment_cache_key(key)
ActiveSupport::Cache.expand_cache_key(key.is_a?(Hash) ? url_for(key).split("://").last : key, :views)
end
- # Writes <tt>content</tt> to the location signified by
- # <tt>key</tt> (see <tt>expire_fragment</tt> for acceptable formats).
+ # Writes +content+ to the location signified by
+ # +key+ (see +expire_fragment+ for acceptable formats).
def write_fragment(key, content, options = nil)
return content unless cache_configured?
@@ -35,8 +35,8 @@ module ActionController #:nodoc:
content
end
- # Reads a cached fragment from the location signified by <tt>key</tt>
- # (see <tt>expire_fragment</tt> for acceptable formats).
+ # Reads a cached fragment from the location signified by +key+
+ # (see +expire_fragment+ for acceptable formats).
def read_fragment(key, options = nil)
return unless cache_configured?
@@ -47,8 +47,8 @@ module ActionController #:nodoc:
end
end
- # Check if a cached fragment from the location signified by
- # <tt>key</tt> exists (see <tt>expire_fragment</tt> for acceptable formats)
+ # Check if a cached fragment from the location signified by
+ # +key+ exists (see +expire_fragment+ for acceptable formats).
def fragment_exist?(key, options = nil)
return unless cache_configured?
key = fragment_cache_key(key)
@@ -65,7 +65,7 @@ module ActionController #:nodoc:
# * String - This would normally take the form of a path, like
# <tt>pages/45/notes</tt>.
# * Hash - Treated as an implicit call to +url_for+, like
- # <tt>{:controller => "pages", :action => "notes", :id => 45}</tt>
+ # <tt>{ controller: 'pages', action: 'notes', id: 45}</tt>
# * Regexp - Will remove any fragment that matches, so
# <tt>%r{pages/\d*/notes}</tt> might remove all notes. Make sure you
# don't use anchors in the regex (<tt>^</tt> or <tt>$</tt>) because
@@ -74,8 +74,8 @@ module ActionController #:nodoc:
# only supported on caches that can iterate over all keys (unlike
# memcached).
#
- # +options+ is passed through to the cache store's <tt>delete</tt>
- # method (or <tt>delete_matched</tt>, for Regexp keys.)
+ # +options+ is passed through to the cache store's +delete+
+ # method (or <tt>delete_matched</tt>, for Regexp keys).
def expire_fragment(key, options = nil)
return unless cache_configured?
key = fragment_cache_key(key) unless key.is_a?(Regexp)
@@ -89,7 +89,7 @@ module ActionController #:nodoc:
end
end
- def instrument_fragment_cache(name, key)
+ def instrument_fragment_cache(name, key) # :nodoc:
ActiveSupport::Notifications.instrument("#{name}.action_controller", :key => key){ yield }
end
end