Module: IdentityCache

Extended by:
ActiveSupport::Concern, CacheHash
Includes:
ArTransactionChanges, BelongsToCaching, CacheInvalidation, CacheKeyGeneration, ConfigurationDSL, QueryAPI, ShouldUseCache
Defined in:
lib/identity_cache.rb,
lib/identity_cache/railtie.rb,
lib/identity_cache/version.rb,
lib/identity_cache/query_api.rb,
lib/identity_cache/cache_hash.rb,
lib/identity_cache/cache_fetcher.rb,
lib/identity_cache/fallback_fetcher.rb,
lib/identity_cache/should_use_cache.rb,
lib/identity_cache/configuration_dsl.rb,
lib/identity_cache/belongs_to_caching.rb,
lib/identity_cache/cache_invalidation.rb,
lib/identity_cache/cache_key_generation.rb,
lib/identity_cache/memoized_cache_proxy.rb,
lib/identity_cache/without_primary_index.rb,
lib/identity_cache/parent_model_expiration.rb

Defined Under Namespace

Modules: BelongsToCaching, CacheHash, CacheInvalidation, CacheKeyGeneration, ConfigurationDSL, QueryAPI, ShouldUseCache, WithoutPrimaryIndex Classes: AlreadyIncludedError, AssociationError, CacheFetcher, DerivedModelError, FallbackFetcher, InverseAssociationError, MemoizedCacheProxy, Railtie, UnsupportedAssociationError, UnsupportedScopeError

Constant Summary collapse

CACHED_NIL =
:idc_cached_nil
BATCH_SIZE =
1000
DELETED =
:idc_cached_deleted
DELETED_TTL =
1000
VERSION =
"0.5.1"
CACHE_VERSION =
7

Constants included from CacheInvalidation

CacheInvalidation::CACHE_KEY_NAMES

Constants included from CacheKeyGeneration

CacheKeyGeneration::DEFAULT_NAMESPACE

Class Attribute Summary collapse

Class Method Summary collapse

Methods included from CacheHash

memcache_hash

Methods included from CacheInvalidation

#reload

Methods included from QueryAPI

#expire_cache

Methods included from CacheKeyGeneration

#attribute_cache_key_for_attribute_and_current_values, #attribute_cache_key_for_attribute_and_previous_values, #current_values_for_fields, denormalized_schema_hash, #old_values_for_fields, #primary_cache_index_key, schema_to_string

Class Attribute Details

.loggerObject


83
84
85
# File 'lib/identity_cache.rb', line 83

def logger
  @logger || Rails.logger
end

.readonlyObject

Returns the value of attribute readonly


46
47
48
# File 'lib/identity_cache.rb', line 46

def readonly
  @readonly
end

Class Method Details

.cacheObject


79
80
81
# File 'lib/identity_cache.rb', line 79

def cache
  @cache ||= MemoizedCacheProxy.new
end

.cache_backend=(cache_adaptor) ⇒ Object

Sets the cache adaptor IdentityCache will be using

Parameters

cache_adaptor - A ActiveSupport::Cache::Store


71
72
73
74
75
76
77
# File 'lib/identity_cache.rb', line 71

def cache_backend=(cache_adaptor)
  if defined?(@cache)
    cache.cache_backend = cache_adaptor
  else
    @cache = MemoizedCacheProxy.new(cache_adaptor)
  end
end

.eager_load!Object


153
154
155
# File 'lib/identity_cache.rb', line 153

def eager_load!
  ParentModelExpiration.install_all_pending_parent_expiry_hooks
end

.fetch(key) ⇒ Object

Cache retrieval and miss resolver primitive; given a key it will try to retrieve the associated value from the cache otherwise it will return the value of the execution of the block.

Parameters

key A cache key string


103
104
105
106
107
108
109
# File 'lib/identity_cache.rb', line 103

def fetch(key)
  if should_use_cache?
    unmap_cached_nil_for(cache.fetch(key) { map_cached_nil_for yield })
  else
    yield
  end
end

.fetch_multi(*keys) ⇒ Object

Same as fetch, except that it will try a collection of keys, using the multiget operation of the cache adaptor.

Parameters

keys A collection or array of key strings


124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
# File 'lib/identity_cache.rb', line 124

def fetch_multi(*keys)
  keys.flatten!(1)
  return {} if keys.size == 0

  result = if should_use_cache?
    fetch_in_batches(keys.uniq) do |missed_keys|
      results = yield missed_keys
      results.map {|e| map_cached_nil_for e }
    end
  else
    results = yield keys
    Hash[keys.zip(results)]
  end

  result.each do |key, value|
    result[key] = unmap_cached_nil_for(value)
  end

  result
end

.included(base) ⇒ Object

:nodoc:


58
59
60
61
62
63
# File 'lib/identity_cache.rb', line 58

def included(base) #:nodoc:
  raise AlreadyIncludedError if base.respond_to?(:cached_model)
  base.class_attribute :cached_model
  base.cached_model = base
  super
end

.map_cached_nil_for(value) ⇒ Object


111
112
113
# File 'lib/identity_cache.rb', line 111

def map_cached_nil_for(value)
  value.nil? ? IdentityCache::CACHED_NIL : value
end

.should_fill_cache?Boolean

:nodoc:

Returns:

  • (Boolean)

87
88
89
# File 'lib/identity_cache.rb', line 87

def should_fill_cache? # :nodoc:
  !readonly
end

.should_use_cache?Boolean

:nodoc:

Returns:

  • (Boolean)

91
92
93
94
# File 'lib/identity_cache.rb', line 91

def should_use_cache? # :nodoc:
  pool = ActiveRecord::Base.connection_pool
  !pool.active_connection? || pool.connection.open_transactions == 0
end

.unmap_cached_nil_for(value) ⇒ Object


115
116
117
# File 'lib/identity_cache.rb', line 115

def unmap_cached_nil_for(value)
  value == IdentityCache::CACHED_NIL ? nil : value
end

.with_fetch_read_only_records(value = true) ⇒ Object


145
146
147
148
149
150
151
# File 'lib/identity_cache.rb', line 145

def with_fetch_read_only_records(value = true)
  old_value = self.fetch_read_only_records
  self.fetch_read_only_records = value
  yield
ensure
  self.fetch_read_only_records = old_value
end