Module: AbstractController::Caching::Fragments

Extended by:
ActiveSupport::Concern
Included in:
AbstractController::Caching
Defined in:
actionpack/lib/abstract_controller/caching/fragments.rb

Overview

Abstract Controller Caching Fragments

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 can be shared amongst multiple parties. The caching is done using 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')

Defined Under Namespace

Modules: ClassMethods

Instance Method Summary collapse

Methods included from ActiveSupport::Concern

append_features, class_methods, extended, included, prepend_features, prepended

Instance Method Details

#combined_fragment_cache_key(key) ⇒ Object

Given a key (as described in expire_fragment), returns a key array suitable for use in reading, writing, or expiring a cached fragment. All keys begin with :views, followed by ENV["RAILS_CACHE_ID"] or ENV["RAILS_APP_VERSION"] if set, followed by any controller-wide key prefix values, ending with the specified key value.



70
71
72
73
74
75
76
77
78
 
# File 'actionpack/lib/abstract_controller/caching/fragments.rb', line 70

def combined_fragment_cache_key(key)
  head = self.class.fragment_cache_keys.map { |k| instance_exec(&k) }
  tail = key.is_a?(Hash) ? url_for(key).split("://").last : key

  cache_key = [:views, ENV["RAILS_CACHE_ID"] || ENV["RAILS_APP_VERSION"], head, tail]
  cache_key.flatten!(1)
  cache_key.compact!
  cache_key
end

#expire_fragment(key, options = nil) ⇒ Object

Removes fragments from the cache.

key can take one of three forms:

  • String - This would normally take the form of a path, like pages/45/notes.

  • Hash - Treated as an implicit call to url_for, like { controller: 'pages', action: 'notes', id: 45}

  • Regexp - Will remove any fragment that matches, so %r{pages/\d*/notes} might remove all notes. Make sure you don’t use anchors in the regex (^ or $) because the actual filename matched looks like ./cache/filename/path.cache. Note: Regexp expiration is only supported on caches that can iterate over all keys (unlike memcached).

options is passed through to the cache store’s delete method (or delete_matched, for Regexp keys).



134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'actionpack/lib/abstract_controller/caching/fragments.rb', line 134

def expire_fragment(key, options = nil)
  return unless cache_configured?
  key = combined_fragment_cache_key(key) unless key.is_a?(Regexp)

  instrument_fragment_cache :expire_fragment, key do
    if key.is_a?(Regexp)
      cache_store.delete_matched(key, options)
    else
      cache_store.delete(key, options)
    end
  end
end

#fragment_exist?(key, options = nil) ⇒ Boolean

Check if a cached fragment from the location signified by key exists (see expire_fragment for acceptable formats).

Returns:

  • (Boolean) 


107
108
109
110
111
112
113
114
 
# File 'actionpack/lib/abstract_controller/caching/fragments.rb', line 107

def fragment_exist?(key, options = nil)
  return unless cache_configured?
  key = combined_fragment_cache_key(key)

  instrument_fragment_cache :exist_fragment?, key do
    cache_store.exist?(key, options)
  end
end

#instrument_fragment_cache(name, key, &block) ⇒ Object

:nodoc:



147
148
149
 
# File 'actionpack/lib/abstract_controller/caching/fragments.rb', line 147

def instrument_fragment_cache(name, key, &block) # :nodoc:
  ActiveSupport::Notifications.instrument("#{name}.#{instrument_name}", instrument_payload(key), &block)
end

#read_fragment(key, options = nil) ⇒ Object

Reads a cached fragment from the location signified by key (see expire_fragment for acceptable formats).



95
96
97
98
99
100
101
102
103
 
# File 'actionpack/lib/abstract_controller/caching/fragments.rb', line 95

def read_fragment(key, options = nil)
  return unless cache_configured?

  key = combined_fragment_cache_key(key)
  instrument_fragment_cache :read_fragment, key do
    result = cache_store.read(key, options)
    result.respond_to?(:html_safe) ? result.html_safe : result
  end
end

#write_fragment(key, content, options = nil) ⇒ Object

Writes content to the location signified by key (see expire_fragment for acceptable formats).



82
83
84
85
86
87
88
89
90
91
 
# File 'actionpack/lib/abstract_controller/caching/fragments.rb', line 82

def write_fragment(key, content, options = nil)
  return content unless cache_configured?

  key = combined_fragment_cache_key(key)
  instrument_fragment_cache :write_fragment, key do
    content = content.to_str
    cache_store.write(key, content, options)
  end
  content
end