Module: Mongoid::Cacheable

Extended by:
ActiveSupport::Concern
Included in:
Composable
Defined in:
lib/mongoid/cacheable.rb

Overview

Encapsulates behavior around caching.

Since:

  • 6.0.0

Instance Method Summary collapse

Instance Method Details

#cache_key ⇒ String

Print out the cache key. This will append different values on the plural model name.

If new_record? - will append /new If not - will append /id-updated_at.to_s(cache_timestamp_format) Without updated_at - will append /id

This is usually called insode a cache() block

Examples:

Returns the cache key

document.cache_key

Returns:

  • (String) —

    the string with or without updated_at

Since:

  • 2.4.0



32
33
34
35
36
 
# File 'lib/mongoid/cacheable.rb', line 32

def cache_key
  return "#{model_key}/new" if new_record?
  return "#{model_key}/#{_id}-#{updated_at.utc.to_s(cache_timestamp_format)}" if do_or_do_not(:updated_at)
  "#{model_key}/#{_id}"
end