instance method
stale?
Ruby on Rails 4.2.9
Since v3.0.20Signature
stale?(record_or_options, additional_options = {})
Sets the etag and/or last_modified on the response and checks it against the client request. If the request doesn’t match the options provided, the request is considered stale and should be generated from scratch. Otherwise, it’s fresh and we don’t need to generate anything and a reply of 304 Not Modified is sent.
Parameters:
-
:etag. -
:last_modified. -
:publicBy default the Cache-Control header is private, set this totrueif you want your application to be cachable by other devices (proxy caches). -
:templateBy default, the template digest for the current controller/action is included in ETags. If the action renders a different template, you can include its digest instead. If the action doesn’t render a template at all, you can passtemplate: falseto skip any attempt to check for a template digest.
Example:
def show @article = Article.find(params[:id]) if stale?(etag: @article, last_modified: @article.created_at) @statistics = @article.really_expensive_call respond_to do |format| # all the supported formats end end end
You can also just pass a record where last_modified will be set by calling updated_at and the etag by passing the object itself.
def show @article = Article.find(params[:id]) if stale?(@article) @statistics = @article.really_expensive_call respond_to do |format| # all the supported formats end end end
When passing a record, you can still set whether the public header:
def show @article = Article.find(params[:id]) if stale?(@article, public: true) @statistics = @article.really_expensive_call respond_to do |format| # all the supported formats end end end
When rendering a different template than the default controller/action style, you can indicate which digest to include in the ETag:
def show super if stale? @article, template: 'widgets/show' end
Parameters
-
record_or_optionsreq -
additional_optionsopt = {}
Source
# File actionpack/lib/action_controller/metal/conditional_get.rb, line 160
def stale?(record_or_options, additional_options = {})
fresh_when(record_or_options, additional_options)
!request.fresh?(response)
end
Defined in actionpack/lib/action_controller/metal/conditional_get.rb line 160
· View on GitHub
· Improve this page
· Find usages on GitHub
Defined in ActionController::ConditionalGet