модуль ActionController::ConditionalGet

# File actionpack/lib/action_controller/metal/conditional_get.rb, line 233
def expires_in(seconds, options = {})
  response.cache_control.merge!(
    max_age: seconds,
    public: options.delete(:public),
    must_revalidate: options.delete(:must_revalidate)
  )
  options.delete(:private)

  response.cache_control[:extras] = options.map { |k, v| "#{k}=#{v}" }
  response.date = Time.now unless response.date?
end

Устанавливает заголовок HTTP 1.1 Cache-Control. По умолчанию устанавливает инструкцию private, чтобы промежуточные кэши не кэшировали ответ.

expires_in 20.minutes
expires_in 3.hours, public: true
expires_in 3.hours, public: true, must_revalidate: true

Этот метод перезапишет существующий заголовок Cache-Control. См. www.w3.org/Protocols/rfc2616/rfc2616-sec14.html для других возможностей.

Метод также гарантирует наличие заголовка HTTP Date для совместимости с клиентами.

# File actionpack/lib/action_controller/metal/conditional_get.rb, line 248
def expires_now
  response.cache_control.replace(no_cache: true)
end

Устанавливает заголовок HTTP 1.1 Cache-Control со значением no-cache. Это означает, что ресурс будет помечен как устаревший, поэтому клиенты должны всегда повторно проверять его. Промежуточные кэши/браузеры всё ещё могут хранить ресурс.

# File actionpack/lib/action_controller/metal/conditional_get.rb, line 104
def fresh_when(object = nil, etag: nil, weak_etag: nil, strong_etag: nil, last_modified: nil, public: false, template: nil)
  weak_etag ||= etag || object unless strong_etag
  last_modified ||= object.try(:updated_at) || object.try(:maximum, :updated_at)

  if strong_etag
    response.strong_etag = combine_etags strong_etag,
      last_modified: last_modified, public: public, template: template
  elsif weak_etag || template
    response.weak_etag = combine_etags weak_etag,
      last_modified: last_modified, public: public, template: template
  end

  response.last_modified = last_modified if last_modified
  response.cache_control[:public] = true if public

  head :not_modified if request.fresh?(response)
end

Устанавливает etag, last_modified, или оба в ответе и рендерит 304 Not Modified ответ, если запрос уже свежий.

Параметры:

• :etag Устанавливает «слабый» валидатор ETag в ответе. См. параметр :weak_etag.

• :weak_etag Устанавливает «слабый» валидатор ETag в ответе. Запросы с установленным заголовком If-None-Match могут вернуть 304 Not Modified, если ETag совпадёт точно. Слабый ETag указывает на семантическое соответствие, а не на байтовое равенство, поэтому он подходит для кэширования HTML-страниц в браузерных кэшах. Он не может быть использован для ответов, которые должны быть байтово идентичными, например, для обработки запросов Range в файлах PDF.

• :strong_etag Устанавливает «сильный» валидатор ETag в ответе. Запросы с установленным заголовком If-None-Match могут вернуть 304 Not Modified, если ETag совпадёт точно. Сильный ETag подразумевает точное равенство: ответ должен совпадать байт в байт. Это необходимо для обработки запросов Range в больших видео- или PDF-файлах, например, или для совместимости с некоторыми CDN, которые не поддерживают слабые ETags.

• :last_modified Устанавливает «слабый» валидатор последнего обновления в ответе. Последующие запросы с установленным заголовком If-Modified-Since могут вернуть 304 Not Modified, если last_modified <= If-Modified-Since.

• :public По умолчанию заголовок Cache-Control является частным. Установите это в true, если вы хотите, чтобы приложение кэшировалось другими устройствами (прокси-кэшами).

• :template По умолчанию в ETags включается хэш шаблона для текущего контроллера/действия. Если действие рендерит другой шаблон, вы можете включить его хэш вместо этого. Если действие вообще не рендерит шаблон, вы можете передать template: false, чтобы пропустить попытку проверки хэша шаблона.

Пример:

def show
  @article = Article.find(params[:id])
  fresh_when(etag: @article, last_modified: @article.updated_at, public: true)
end

Это отобразит шаблон show, если запрос не отправляет совпадающий ETag или If-Modified-Since заголовок, и просто 304 Not Modified ответ, если есть совпадение.

Вы также можете передать просто запись. В этом случае last_modified будет установлено вызовом updated_at и etag путём передачи самого объекта.

def show
  @article = Article.find(params[:id])
  fresh_when(@article)
end

Вы также можете передать объект, который отвечает на maximum, например, коллекцию записей Active Record. В этом случае last_modified будет установлено вызовом maximum(:updated_at) на коллекции (временная метка последней обновлённой записи) и etag путём передачи самого объекта.

def index
  @articles = Article.all
  fresh_when(@articles)
end

При передаче записи или коллекции вы всё ещё можете установить заголовок public:

def show
  @article = Article.find(params[:id])
  fresh_when(@article, public: true)
end

При рендеринге другого шаблона, отличного от стиля по умолчанию контроллера/действия, вы можете указать, какой хэш включить в ETag:

before_action { fresh_when @article, template: 'widgets/show' }

# File actionpack/lib/action_controller/metal/conditional_get.rb, line 260
def http_cache_forever(public: false)
  expires_in 100.years, public: public

  yield if stale?(etag: request.fullpath,
                  last_modified: Time.new(2011, 1, 1).utc,
                  public: public)
end

Кэшировать или выполнить блок. Кэш не должен истекать.

Вы можете использовать этот метод, когда у вас есть HTTP-ответ, который никогда не меняется, и браузер и прокси должны кэшировать его без ограничений.

• public: По умолчанию HTTP-ответы являются частными, кэшируются только в браузере пользователя. Чтобы разрешить кэширование ответа прокси, установите true для того, чтобы они могли предоставить кэшированный ответ всем пользователям.

# File actionpack/lib/action_controller/metal/conditional_get.rb, line 217
def stale?(object = nil, **freshness_kwargs)
  fresh_when(object, **freshness_kwargs)
  !request.fresh?(response)
end

Устанавливает etag и/или last_modified в ответе и проверяет его по отношению к запросу клиента. Если запрос не соответствует предоставленным параметрам, запрос считается устаревшим и должен быть сгенерирован заново. В противном случае, запрос свежий и мы не должны ничего генерировать, и отправляется ответ 304 Not Modified.

Параметры:

• :etag Устанавливает «слабый» валидатор ETag в ответе. См. параметр :weak_etag.

• :weak_etag Устанавливает «слабый» валидатор ETag в ответе. Запросы с установленным заголовком If-None-Match могут вернуть 304 Not Modified, если ETag совпадёт точно. Слабый ETag указывает на семантическое соответствие, а не на байтовое равенство, поэтому он подходит для кэширования HTML-страниц в браузерных кэшах. Он не может быть использован для ответов, которые должны быть байтово идентичными, например, для обработки запросов Range в файлах PDF.

• :strong_etag Устанавливает «сильный» валидатор ETag в ответе. Запросы с установленным заголовком If-None-Match могут вернуть 304 Not Modified, если ETag совпадёт точно. Сильный ETag подразумевает точное равенство: ответ должен совпадать байт в байт. Это необходимо для обработки запросов Range в больших видео- или PDF-файлах, например, или для совместимости с некоторыми CDN, которые не поддерживают слабые ETags.

• :last_modified Устанавливает «слабый» валидатор последнего обновления в ответе. Последующие запросы с установленным заголовком If-Modified-Since могут вернуть 304 Not Modified, если last_modified <= If-Modified-Since.

• :public По умолчанию заголовок Cache-Control является частным. Установите это в true, если вы хотите, чтобы приложение кэшировалось другими устройствами (прокси-кэшами).

• :template По умолчанию в ETags включается хэш шаблона для текущего контроллера/действия. Если действие рендерит другой шаблон, вы можете включить его хэш вместо этого. Если действие вообще не рендерит шаблон, вы можете передать template: false чтобы пропустить попытку проверки хэша шаблона.

Пример:

def show
  @article = Article.find(params[:id])

  if stale?(etag: @article, last_modified: @article.updated_at)
    @statistics = @article.really_expensive_call
    respond_to do |format|
      # all the supported formats
    end
  end
end

Вы также можете передать просто запись. В этом случае last_modified будет установлено вызовом updated_at и etag путём передачи самого объекта.

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

Вы также можете передать объект, который отвечает на maximum, например, коллекцию записей Active Record. В этом случае last_modified будет установлено вызовом +maximum(:updated_at)+ на коллекции (временная метка последней обновлённой записи) и etag путём передачи самого объекта.

def index
  @articles = Article.all

  if stale?(@articles)
    @statistics = @articles.really_expensive_call
    respond_to do |format|
      # all the supported formats
    end
  end
end

При передаче записи или коллекции вы всё ещё можете установить заголовок public:

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

При рендеринге другого шаблона, отличного от стиля по умолчанию контроллера/действия, вы можете указать, какой хэш включить в ETag:

def show
  super if stale? @article, template: 'widgets/show'
end