Module: SafeMemoize::ClassMethods

Defined in:
lib/safe_memoize/class_methods.rb

Overview

Class-level DSL added to any class that does +prepend SafeMemoize+.

Instance Method Summary collapse

Instance Method Details

#memoize(method_name, ttl: UNSET, max_size: UNSET, ttl_refresh: UNSET, if: UNSET, unless: UNSET, shared: UNSET, key: UNSET, store: UNSET, fiber_local: UNSET, ractor_safe: UNSET, namespace: UNSET, shared_cache: UNSET, cache_bust: UNSET, copy_on_read: UNSET, **extension_options) ⇒ void

This method returns an undefined value.

Wraps an existing instance method with a thread-safe per-instance cache.

Must be called after the method is defined. Raises +ArgumentError+ immediately at class-definition time if no such method exists.

Examples:

Zero-argument method

def expensive_query = db.run("SELECT …")
memoize :expensive_query

With TTL and LRU cap

def fetch(id) = http_get(id)
memoize :fetch, ttl: 60, max_size: 500

Conditional — only cache successful responses

memoize :fetch, if: ->(v) { v[:status] == 200 }

Copy-on-read — protect mutable cached config

memoize :config, copy_on_read: true

With a custom store

STORE = SafeMemoize::Stores::Memory.new
memoize :fetch, store: STORE, ttl: 300

Parameters:

  • method_name (Symbol, String) —

    name of the instance method to memoize

  • ttl (Numeric, nil) (defaults to: UNSET) —

    seconds until the cached value expires; +nil+ means the entry never expires. Falls back to SafeMemoize::Configuration#default_ttl when +nil+.

  • max_size (Integer, nil) (defaults to: UNSET) —

    maximum number of cached entries per instance for this method; the least-recently-used entry is evicted when the limit is reached. Falls back to SafeMemoize::Configuration#default_max_size when +nil+.

  • ttl_refresh (Boolean) (defaults to: UNSET) —

    when +true+, every cache hit resets the expiry clock (sliding-window TTL). Requires +ttl:+ to be set.

  • if (Proc, nil) (defaults to: UNSET) —

    callable predicate; the result is cached only when the predicate returns truthy. Receives the computed return value as its argument.

  • unless (Proc, nil) (defaults to: UNSET) —

    inverse of +:if+; the result is not cached when the predicate returns truthy.

  • shared (Boolean) (defaults to: UNSET) —

    when +true+, results are stored on the class rather than per instance — all instances share one cache.

  • key (Proc, nil) (defaults to: UNSET) —

    class-level custom cache key generator. Receives the same arguments as the method and should return a single comparable value. Instance-level keys set via PublicCustomKeyMethods#memoize_with_custom_key take priority.

  • store (Stores::Base, nil) (defaults to: UNSET) —

    custom cache store adapter. Must be a Stores::Base subclass instance. The store is shared across all instances of the class. When +nil+, the default per-instance in-process hash is used. Cannot be combined with +max_size:+ or +shared:+.

  • fiber_local (Boolean) (defaults to: UNSET) —

    when +true+, results are stored in +Fiber[:safe_memoize]+ rather than instance variables. Each fiber gets its own isolated cache that is automatically discarded when the fiber terminates. No mutex is acquired. Cannot be combined with +shared:+ or +store:+.

  • ractor_safe (Boolean) (defaults to: UNSET) —

    when +true+, the class-level shared cache is owned by a supervisor +Ractor+ rather than a +Mutex+-protected ivar, making it accessible from worker Ractors. Requires +shared: true+. Cached values are deep-frozen via +Ractor.make_shareable+. Incompatible with +if:+, +unless:+, +max_size:+, +ttl_refresh:+, +key:+, +store:+, and +copy_on_read:+.

  • namespace (String, nil) (defaults to: UNSET) —

    prefix prepended to every cache key for this method, scoping it to a logical partition. Takes precedence over both the class-level #safe_memoize_namespace and the global SafeMemoize::Configuration#namespace. Useful for versioning a single method independently of its peers. Must not contain the character +:+.

  • cache_bust (Proc, Symbol, nil) (defaults to: UNSET) —

    callable invoked on the instance (via +instance_exec+) on every cache lookup to obtain a version token. The token is folded into the cache key alongside the normal arguments, so when the token changes (e.g. an ActiveRecord +updated_at+ timestamp advances after a +save+) the old key no longer matches any entry — the method is recomputed and the result stored under the new key. Accepts any callable (+Proc+, +lambda+, +Method+) that takes no arguments, or a +Symbol+ naming an instance method. Cannot be combined with +key:+.

  • shared_cache (String, nil) (defaults to: UNSET) —

    name of a globally-registered shared cache store (see SafeMemoize.shared_cache and SafeMemoize.register_shared_cache). All instances of any class that memoizes a method with the same +shared_cache:+ name read and write the same backing store, enabling cross-class cache sharing. The store is resolved at +memoize+ definition time; call SafeMemoize.register_shared_cache before the class is loaded to supply a custom adapter. Incompatible with +shared:+, +store:+, +fiber_local:+, +ractor_safe:+, and +max_size:+. Composes naturally with +namespace:+, +ttl:+, +if:+, and +key:+.

  • copy_on_read (Boolean) (defaults to: UNSET) —

    when +true+, every cache read returns a +dup+ (or +deep_dup+ when available) of the stored value rather than the cached object itself. Prevents callers from mutating shared cached state. Frozen and +nil+ values are returned as-is. Incompatible with +ractor_safe:+ (ractor values are always frozen; use that guarantee instead).

Raises:

  • (ArgumentError) —

    if the method does not exist, or option values are invalid



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
 
# File 'lib/safe_memoize/class_methods.rb', line 87

def memoize(method_name, ttl: UNSET, max_size: UNSET, ttl_refresh: UNSET, if: UNSET, unless: UNSET, shared: UNSET, key: UNSET, store: UNSET, fiber_local: UNSET, ractor_safe: UNSET, namespace: UNSET, shared_cache: UNSET, cache_bust: UNSET, copy_on_read: UNSET, **extension_options)
  method_name = method_name.to_sym

  unless method_defined?(method_name) || private_method_defined?(method_name) || protected_method_defined?(method_name)
    raise ArgumentError, "cannot memoize :#{method_name} — no instance method with that name is defined on #{self}"
  end

  unless extension_options.empty?
    extension_options.each_key do |opt|
      raise ArgumentError, "unknown memoize option :#{opt} — no registered extension handles it" unless SafeMemoize.extension_for_option(opt)
    end

    injected = {}
    extension_options.each do |opt, val|
      result = SafeMemoize.extension_for_option(opt).process_memoize_option(opt, val, method_name, extension_options)
      injected.merge!(result)
    end

    ttl = injected[:ttl] if injected.key?(:ttl)
    max_size = injected[:max_size] if injected.key?(:max_size)
    namespace = injected[:namespace] if injected.key?(:namespace)
    store = injected[:store] if injected.key?(:store)
    shared_cache = injected[:shared_cache] if injected.key?(:shared_cache)
    cache_bust = injected[:cache_bust] if injected.key?(:cache_bust)
  end

  # :if and :unless are reserved Ruby keywords; use binding to extract them
  cond_if = binding.local_variable_get(:if)
  cond_unless = binding.local_variable_get(:unless)

  # Apply class-level defaults (safe_memoize_options) for any still-unset options
  if (cls_defaults = __safe_memoize_defaults__)
    ttl = cls_defaults[:ttl] if ttl.equal?(UNSET) && cls_defaults.key?(:ttl)
    max_size = cls_defaults[:max_size] if max_size.equal?(UNSET) && cls_defaults.key?(:max_size)
    ttl_refresh = cls_defaults[:ttl_refresh] if ttl_refresh.equal?(UNSET) && cls_defaults.key?(:ttl_refresh)
    cond_if = cls_defaults[:if] if cond_if.equal?(UNSET) && cls_defaults.key?(:if)
    cond_unless = cls_defaults[:unless] if cond_unless.equal?(UNSET) && cls_defaults.key?(:unless)
    key = cls_defaults[:key] if key.equal?(UNSET) && cls_defaults.key?(:key)
    cache_bust = cls_defaults[:cache_bust] if cache_bust.equal?(UNSET) && cls_defaults.key?(:cache_bust)
    copy_on_read = cls_defaults[:copy_on_read] if copy_on_read.equal?(UNSET) && cls_defaults.key?(:copy_on_read)
    namespace = cls_defaults[:namespace] if namespace.equal?(UNSET) && cls_defaults.key?(:namespace)
    store = cls_defaults[:store] if store.equal?(UNSET) && cls_defaults.key?(:store)
  end

  # Normalize remaining UNSET to original per-call defaults
  ttl = nil if ttl.equal?(UNSET)
  max_size = nil if max_size.equal?(UNSET)
  ttl_refresh = false if ttl_refresh.equal?(UNSET)
  shared = false if shared.equal?(UNSET)
  key = nil if key.equal?(UNSET)
  store = nil if store.equal?(UNSET)
  fiber_local = false if fiber_local.equal?(UNSET)
  ractor_safe = false if ractor_safe.equal?(UNSET)
  namespace = nil if namespace.equal?(UNSET)
  shared_cache = nil if shared_cache.equal?(UNSET)
  cache_bust = nil if cache_bust.equal?(UNSET)
  copy_on_read = false if copy_on_read.equal?(UNSET)
  cond_if = nil if cond_if.equal?(UNSET)
  cond_unless = nil if cond_unless.equal?(UNSET)

  visibility = memoized_method_visibility(method_name)

  config = SafeMemoize.configuration
  ttl = config.default_ttl if ttl.nil?
  max_size = config.default_max_size if max_size.nil?

  ttl = if ttl.nil?
    nil
  else

    ttl = Float(ttl)
    raise ArgumentError, "ttl must be non-negative" if ttl < 0

    ttl
  end

  max_size = if max_size.nil?
    nil
  else
    raise ArgumentError, "max_size must be a positive integer" unless max_size.is_a?(Integer)
    raise ArgumentError, "max_size must be positive" unless max_size > 0

    max_size
  end

  raise ArgumentError, "ttl_refresh: requires a ttl: to be set" if ttl_refresh && ttl.nil?

  if cond_if && cond_unless
    raise ArgumentError, "cannot specify both :if and :unless"
  end
  raise ArgumentError, ":if must be callable" if cond_if && !cond_if.respond_to?(:call)
  raise ArgumentError, ":unless must be callable" if cond_unless && !cond_unless.respond_to?(:call)
  raise ArgumentError, ":key must be callable" if key && !key.respond_to?(:call)

  if cache_bust
    unless cache_bust.respond_to?(:call) || cache_bust.is_a?(Symbol)
      raise ArgumentError, "cache_bust: must be a callable or Symbol (got #{cache_bust.class})"
    end
    raise ArgumentError, "cache_bust: and key: cannot be combined" if key
  end

  if store
    raise ArgumentError, "store: must be a SafeMemoize::Stores::Base instance (got #{store.class})" unless store.is_a?(SafeMemoize::Stores::Base)
    raise ArgumentError, "max_size: is not supported with store: — use the store adapter's own eviction" if max_size
    raise ArgumentError, "shared: and store: cannot be combined" if shared
  end

  if fiber_local
    raise ArgumentError, "fiber_local: and shared: cannot be combined" if shared
    raise ArgumentError, "fiber_local: and store: cannot be combined" if store
  end

  if ractor_safe
    raise ArgumentError, "ractor_safe: requires shared: true" unless shared
    raise ArgumentError, "ractor_safe: is incompatible with if:/unless:" if cond_if || cond_unless
    raise ArgumentError, "ractor_safe: is incompatible with max_size:" if max_size
    raise ArgumentError, "ractor_safe: is incompatible with ttl_refresh:" if ttl_refresh
    raise ArgumentError, "ractor_safe: is incompatible with key:" if key
    raise ArgumentError, "ractor_safe: is incompatible with store:" if store
    raise ArgumentError, "ractor_safe: is incompatible with copy_on_read:" if copy_on_read
  end

  if namespace
    raise ArgumentError, "namespace: must be a String (got #{namespace.class})" unless namespace.is_a?(String)
    raise ArgumentError, "namespace: must not be empty" if namespace.empty?
    raise ArgumentError, "namespace: must not contain ':'" if namespace.include?(":")
    __safe_memo_method_namespaces__[method_name] = namespace
  end

  if shared_cache
    raise ArgumentError, "shared_cache: must be a String (got #{shared_cache.class})" unless shared_cache.is_a?(String)
    raise ArgumentError, "shared_cache: must not be empty" if shared_cache.empty?
    raise ArgumentError, "shared_cache: and shared: cannot be combined" if shared
    raise ArgumentError, "shared_cache: and store: cannot be combined" if store
    raise ArgumentError, "shared_cache: and fiber_local: cannot be combined" if fiber_local
    raise ArgumentError, "shared_cache: and ractor_safe: cannot be combined" if ractor_safe
    raise ArgumentError, "max_size: is not supported with shared_cache: — use the store adapter's own eviction" if max_size
    store = SafeMemoize.shared_cache(shared_cache)
  end

  # Resolve effective store: per-method store: wins; then class-level
  # safe_memoize_store; then global default_store. max_size: and shared:
  # are incompatible with external stores — fall back silently.
  effective_store = store
  if effective_store.nil? && !max_size && !shared
    class_store = safe_memoize_store
    if class_store
      effective_store = class_store
    else
      global_default = SafeMemoize.configuration.default_store
      if global_default
        unless global_default.is_a?(SafeMemoize::Stores::Base)
          raise ArgumentError,
            "SafeMemoize.configuration.default_store must be a Stores::Base instance (got #{global_default.class})"
        end
        effective_store = global_default
      end
    end
  end

  __safe_memo_class_key_generators__[method_name] = key if key
  __safe_memo_class_cache_bust_generators__[method_name] = cache_bust if cache_bust

  # Normalize to a single "should cache?" predicate
  condition = if cond_if
    cond_if
  elsif cond_unless
    ->(result) { !cond_unless.call(result) }
  end

  # Build a value-duplication function for copy_on_read: true.
  # Frozen and nil values are returned as-is; deep_dup is preferred when available
  # (e.g. ActiveRecord objects) so nested mutable structures are also protected.
  dup_fn = if copy_on_read
    lambda do |v|
      return v if v.nil? || v.frozen?
      v.respond_to?(:deep_dup) ? v.deep_dup : v.dup
    end
  else
    ->(v) { v }
  end

  if effective_store
    miss = SafeMemoize::Stores::Base::MISS

    mod = Module.new do
      define_method(method_name) do |*args, **kwargs, &block|
        return super(*args, **kwargs, &block) if block

        cache_key = compute_cache_key(method_name, args, kwargs)
        cached = effective_store.read(cache_key)

        unless cached.equal?(miss)
          effective_store.write(cache_key, cached, expires_in: ttl) if ttl_refresh
          record_cache_hit(cache_key)
          call_memo_hooks(:on_hit, cache_key, {value: cached, expires_at: nil, cached_at: nil})
          return dup_fn.call(cached)
        end

        start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
        value = Adapters::OpenTelemetry.trace(
          SafeMemoize.configuration.opentelemetry_tracer, method_name, self.class.name
        ) { super(*args, **kwargs) }
        elapsed_time = Process.clock_gettime(Process::CLOCK_MONOTONIC) - start_time

        now = Process.clock_gettime(Process::CLOCK_MONOTONIC)
        if !condition || condition.call(value)
          effective_store.write(cache_key, value, expires_in: ttl)
          call_memo_hooks(:on_store, cache_key, {value: value, expires_at: nil, cached_at: now})
        end

        record_cache_miss(cache_key, elapsed_time)
        call_memo_hooks(:on_miss, cache_key, {value: value, expires_at: nil, cached_at: now})

        dup_fn.call(value)
      end

      send(visibility, method_name)
    end

    prepend mod

    return
  end

  if fiber_local
    mod = Module.new do
      define_method(method_name) do |*args, **kwargs, &block|
        return super(*args, **kwargs, &block) if block

        cache_key = compute_cache_key(method_name, args, kwargs)
        fiber_cache = fiber_memo_cache!
        record = fiber_cache[cache_key]

        if memo_record_live?(record)
          if max_size
            lru = fiber_memo_lru![method_name] ||= {}
            lru.delete(cache_key)
            lru[cache_key] = true
          end
          record[:expires_at] = memo_expires_at(ttl) if ttl_refresh
          record_cache_hit(cache_key)
          call_memo_hooks(:on_hit, cache_key, record)
          dup_fn.call(memo_record_value(record))
        else
          call_memo_hooks(:on_expire, cache_key, record) if record

          start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
          value = Adapters::OpenTelemetry.trace(
            SafeMemoize.configuration.opentelemetry_tracer, method_name, self.class.name
          ) { super(*args, **kwargs) }
          elapsed_time = Process.clock_gettime(Process::CLOCK_MONOTONIC) - start_time

          new_record = memo_record(value, expires_at: memo_expires_at(ttl))

          if !condition || condition.call(value)
            if max_size
              lru = fiber_memo_lru![method_name] ||= {}
              if lru.size >= max_size
                evict_key = lru.keys.first
                lru.delete(evict_key)
                evicted = fiber_cache.delete(evict_key)
                call_memo_hooks(:on_evict, evict_key, evicted) if evicted
              end
            end
            fiber_cache[cache_key] = new_record
            if max_size
              lru = fiber_memo_lru![method_name] ||= {}
              lru.delete(cache_key)
              lru[cache_key] = true
            end
            call_memo_hooks(:on_store, cache_key, new_record)
          end

          record_cache_miss(cache_key, elapsed_time)
          call_memo_hooks(:on_miss, cache_key, new_record)

          dup_fn.call(value)
        end
      end

      send(visibility, method_name)
    end

    prepend mod

    return
  end

  if ractor_safe
    extend(RactorSharedMethods) unless is_a?(RactorSharedMethods)
    supervisor = __safe_memo_ractor_supervisor__
    __memoize_ractor_safe__(method_name, ttl, visibility, supervisor)
    return
  end

  if shared
    klass = self
    shared_mutex = klass.send(:__safe_memo_shared_mutex__)

    mod = Module.new do
      define_method(method_name) do |*args, **kwargs, &block|
        return super(*args, **kwargs, &block) if block

        cache_key = compute_cache_key(method_name, args, kwargs)

        shared_mutex.synchronize do
          shared_cache = klass.send(:__safe_memo_shared_cache__)
          record = shared_cache[cache_key]
          now = Process.clock_gettime(Process::CLOCK_MONOTONIC)
          record_live = record && (record[:expires_at].nil? || record[:expires_at] > now)

          if record_live
            if max_size
              lru = klass.send(:__safe_memo_shared_lru_order__)[method_name] ||= {}
              lru.delete(cache_key)
              lru[cache_key] = true
            end
            record[:expires_at] = memo_expires_at(ttl) if ttl_refresh
            record_cache_hit(cache_key)
            call_memo_hooks(:on_hit, cache_key, record)
            dup_fn.call(record[:value])
          else
            call_memo_hooks(:on_expire, cache_key, record) if record && !record_live

            start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
            value = Adapters::OpenTelemetry.trace(SafeMemoize.configuration.opentelemetry_tracer, method_name, klass.name) { super(*args, **kwargs) }
            elapsed_time = Process.clock_gettime(Process::CLOCK_MONOTONIC) - start_time

            new_record = memo_record(value, expires_at: memo_expires_at(ttl))

            if !condition || condition.call(value)
              if max_size
                lru = klass.send(:__safe_memo_shared_lru_order__)[method_name] ||= {}
                lru.delete_if { |key, _| !shared_cache.key?(key) }
                if lru.size >= max_size
                  lru_key = lru.keys.first
                  lru.delete(lru_key)
                  evicted = shared_cache.delete(lru_key)
                  call_memo_hooks(:on_evict, lru_key, evicted) if evicted
                end
              end
              shared_cache[cache_key] = new_record
              if max_size
                lru = klass.send(:__safe_memo_shared_lru_order__)[method_name] ||= {}
                lru[cache_key] = true
              end
              call_memo_hooks(:on_store, cache_key, new_record)
            end

            record_cache_miss(cache_key, elapsed_time)
            call_memo_hooks(:on_miss, cache_key, new_record)

            dup_fn.call(value)
          end
        end
      end

      send(visibility, method_name)
    end

    prepend mod

    return
  end

  mod = Module.new do
    define_method(method_name) do |*args, **kwargs, &block|
      # Blocks bypass cache entirely — they aren't comparable
      return super(*args, **kwargs, &block) if block

      cache_key = compute_cache_key(method_name, args, kwargs)

      if max_size || condition || ttl_refresh
        # Locked path: used when LRU tracking, conditional storage, or TTL refresh is needed.
        memo_mutex!.synchronize do
          record = memo_cache_record(cache_key)
          if record
            lru_touch(method_name, cache_key) if max_size
            record[:expires_at] = memo_expires_at(ttl) if ttl_refresh
            record_cache_hit(cache_key)
            call_memo_hooks(:on_hit, cache_key, record)
            dup_fn.call(memo_record_value(record))
          else
            start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
            value = Adapters::OpenTelemetry.trace(SafeMemoize.configuration.opentelemetry_tracer, method_name, self.class.name) { super(*args, **kwargs) }
            elapsed_time = Process.clock_gettime(Process::CLOCK_MONOTONIC) - start_time

            new_record = memo_record(value, expires_at: memo_expires_at(ttl))
            if !condition || condition.call(value)
              lru_evict_if_over_limit(method_name, max_size) if max_size
              @__safe_memo_cache__ ||= {}
              @__safe_memo_cache__[cache_key] = new_record
              lru_touch(method_name, cache_key) if max_size
              call_memo_hooks(:on_store, cache_key, new_record)
            end
            record_cache_miss(cache_key, elapsed_time)
            call_memo_hooks(:on_miss, cache_key, new_record)

            dup_fn.call(value)
          end
        end
      else
        # Fast path: check without lock
        if (record = memo_cache_record(cache_key))
          record_cache_hit(cache_key)
          call_memo_hooks(:on_hit, cache_key, record)
          return dup_fn.call(memo_record_value(record))
        end

        # Cache miss - compute and store
        start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
        result = memo_fetch_or_store(cache_key, ttl: ttl) do
          Adapters::OpenTelemetry.trace(SafeMemoize.configuration.opentelemetry_tracer, method_name, self.class.name) { super(*args, **kwargs) }
        end
        elapsed_time = Process.clock_gettime(Process::CLOCK_MONOTONIC) - start_time

        with_memo_lock do
          record_cache_miss(cache_key, elapsed_time)
          new_record = memo_cache_record(cache_key)
          call_memo_hooks(:on_store, cache_key, new_record)
          call_memo_hooks(:on_miss, cache_key, new_record)
        end

        dup_fn.call(result)
      end
    end

    send(visibility, method_name)
  end

  prepend mod
end

#memoize_all(except: [], only: [], include_protected: false, include_private: false, **options) ⇒ void

This method returns an undefined value.

Memoizes every eligible public instance method defined directly on the class.

Accepts all options that #memoize accepts, plus +:except:+ and +:only:+. Raises +ArgumentError+ when both +:only:+ and +:except:+ are given.

Parameters:

  • except (Array<Symbol, String>) (defaults to: []) —

    method names to skip

  • only (Array<Symbol, String>) (defaults to: []) —

    when non-empty, only these methods are memoized

  • include_protected (Boolean) (defaults to: false) —

    also memoize +protected+ methods

  • include_private (Boolean) (defaults to: false) —

    also memoize +private+ methods

  • options (Hash) —

    any additional options forwarded to #memoize

Raises:

  • (ArgumentError) —

    if both +:only:+ and +:except:+ are given



619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
 
# File 'lib/safe_memoize/class_methods.rb', line 619

def memoize_all(except: [], only: [], include_protected: false, include_private: false, **options)
  raise ArgumentError, "cannot specify both :only and :except" if only.any? && except.any?

  excluded = Array(except).map(&:to_sym)
  included = Array(only).map(&:to_sym)

  methods = public_instance_methods(false)
  methods |= protected_instance_methods(false) if include_protected
  methods |= private_instance_methods(false) if include_private

  methods.each do |method_name|
    next if excluded.include?(method_name)
    next if included.any? && !included.include?(method_name)

    memoize(method_name, **options)
  end
end

#reset_all_shared_memos ⇒ void

This method returns an undefined value.

Clears the entire class-level shared cache for this class.



664
665
666
667
668
669
 
# File 'lib/safe_memoize/class_methods.rb', line 664

def reset_all_shared_memos
  __safe_memo_shared_mutex__.synchronize do
    @__safe_memo_shared_cache__ = {}
    @__safe_memo_shared_lru_order__ = {}
  end
end

#reset_shared_memo(method_name, *args, **kwargs) ⇒ void

This method returns an undefined value.

Clears one or all entries from the class-level shared cache.

With no positional args after +method_name+, clears all shared entries for that method. With args/kwargs, clears only the matching entry.

Parameters:

  • method_name (Symbol, String) —

    the memoized method

  • args (Array) —

    positional arguments identifying the entry to clear

  • kwargs (Hash) —

    keyword arguments identifying the entry to clear



646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
 
# File 'lib/safe_memoize/class_methods.rb', line 646

def reset_shared_memo(method_name, *args, **kwargs)
  method_name = method_name.to_sym
  effective = __safe_memo_effective_key_name__(method_name)
  specific_key = (args.empty? && kwargs.empty?) ? nil : [effective, args, kwargs]

  __safe_memo_shared_mutex__.synchronize do
    if specific_key
      __safe_memo_shared_cache__.delete(specific_key)
      __safe_memo_shared_lru_order__[method_name]&.delete(specific_key)
    else
      __safe_memo_shared_cache__.delete_if { |key, _| key[0] == effective }
      __safe_memo_shared_lru_order__.delete(method_name)
    end
  end
end

#safe_memoize_namespace ⇒ String?

Returns the class-level namespace prefix, or +nil+ if not set.

When set, this prefix is prepended to every cache key produced by +memoize+ calls on this class that do not specify their own +namespace:+ option. The global SafeMemoize::Configuration#namespace is the final fallback.

Returns:

  • (String, nil) 


554
555
556
 
# File 'lib/safe_memoize/class_methods.rb', line 554

def safe_memoize_namespace
  @__safe_memoize_namespace__
end

#safe_memoize_namespace=(ns) ⇒ String?

Sets the class-level namespace prefix.

Parameters:

  • ns (String, nil) —

    a non-empty string without +:+, or +nil+ to clear

Returns:

  • (String, nil)

Raises:

  • (ArgumentError) —

    if +ns+ is not a valid namespace string



563
564
565
566
567
568
569
570
 
# File 'lib/safe_memoize/class_methods.rb', line 563

def safe_memoize_namespace=(ns)
  if ns
    raise ArgumentError, "safe_memoize_namespace= must be a String (got #{ns.class})" unless ns.is_a?(String)
    raise ArgumentError, "safe_memoize_namespace= must not be empty" if ns.empty?
    raise ArgumentError, "safe_memoize_namespace= must not contain ':'" if ns.include?(":")
  end
  @__safe_memoize_namespace__ = ns
end

#safe_memoize_options(**opts) ⇒ Hash

Sets class-wide default options applied to every subsequent #memoize call on this class. Per-call options take precedence; class defaults take precedence over global SafeMemoize::Configuration defaults.

Call with no arguments (or an empty hash) to clear all class-level defaults.

Examples:

Apply a TTL and LRU cap to every memoized method on the class

class ApiClient
  prepend SafeMemoize
  safe_memoize_options ttl: 60, max_size: 200

  def fetch(id) = http.get(id)
  memoize :fetch                     # uses ttl: 60, max_size: 200

  def list = http.get("/all")
  memoize :list, ttl: 300            # uses max_size: 200, ttl: 300
end

Protect all cached values from mutation

safe_memoize_options copy_on_read: true

Parameters:

  • opts (Hash) —

    any subset of #memoize options except mode-switch options (+shared:+, +fiber_local:+, +ractor_safe:+, +shared_cache:+)

Returns:

  • (Hash) —

    the stored defaults

Raises:

  • (ArgumentError) —

    for disallowed options



597
598
599
600
601
602
603
604
605
 
# File 'lib/safe_memoize/class_methods.rb', line 597

def safe_memoize_options(**opts)
  disallowed = %i[shared fiber_local ractor_safe shared_cache]
  bad = opts.keys & disallowed
  unless bad.empty?
    raise ArgumentError,
      "safe_memoize_options does not accept #{bad.map { |k| ":#{k}" }.join(", ")} — pass mode-switch options per memoize call"
  end
  @__safe_memoize_defaults__ = opts.empty? ? nil : opts
end

#safe_memoize_store ⇒ Stores::Base?

Returns the class-level default cache store, or +nil+ if not set.

Set this to any Stores::Base instance to route every +memoize+ call on this class through that store, without needing to pass +store:+ to each individual +memoize+ call. A per-method +store:+ option still takes precedence, and the global SafeMemoize::Configuration#default_store is the final fallback.

Returns:



530
531
532
 
# File 'lib/safe_memoize/class_methods.rb', line 530

def safe_memoize_store
  @__safe_memoize_store__
end

#safe_memoize_store=(store) ⇒ Stores::Base?

Sets the class-level default cache store.

Parameters:

  • store (Stores::Base, nil) —

    a store instance, or +nil+ to clear

Returns:

Raises:

  • (ArgumentError) —

    if +store+ is not a Stores::Base instance (and not +nil+)



539
540
541
542
543
544
545
 
# File 'lib/safe_memoize/class_methods.rb', line 539

def safe_memoize_store=(store)
  if store && !store.is_a?(SafeMemoize::Stores::Base)
    raise ArgumentError,
      "safe_memoize_store= must be a SafeMemoize::Stores::Base instance (got #{store.class})"
  end
  @__safe_memoize_store__ = store
end

#shared_memo_age(method_name, *args, **kwargs) ⇒ Float?

Returns how many seconds ago the shared entry was cached, or +nil+ if not cached or already expired.

Parameters:

  • method_name (Symbol, String)
  • args (Array)
  • kwargs (Hash)

Returns:

  • (Float, nil) 


719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
 
# File 'lib/safe_memoize/class_methods.rb', line 719

def shared_memo_age(method_name, *args, **kwargs)
  method_name = method_name.to_sym
  effective = __safe_memo_effective_key_name__(method_name)
  cache_key = [effective, args, kwargs]

  __safe_memo_shared_mutex__.synchronize do
    cache = @__safe_memo_shared_cache__
    return nil unless cache

    record = cache[cache_key]
    return nil unless record

    now = Process.clock_gettime(Process::CLOCK_MONOTONIC)
    return nil if record[:expires_at] && record[:expires_at] <= now

    cached_at = record[:cached_at]
    return nil unless cached_at

    (now - cached_at).round(6)
  end
end

#shared_memo_count(method_name = nil) ⇒ Integer

Returns the number of live entries in the class-level shared cache.

Parameters:

  • method_name (Symbol, String, nil) (defaults to: nil) —

    when given, counts only entries for that method; when +nil+, counts all methods.

Returns:

  • (Integer) 


698
699
700
701
702
703
704
705
706
707
708
709
710
 
# File 'lib/safe_memoize/class_methods.rb', line 698

def shared_memo_count(method_name = nil)
  __safe_memo_shared_mutex__.synchronize do
    cache = @__safe_memo_shared_cache__ || {}
    now = Process.clock_gettime(Process::CLOCK_MONOTONIC)
    live = cache.reject { |_, r| r[:expires_at] && r[:expires_at] <= now }
    if method_name
      effective = __safe_memo_effective_key_name__(method_name.to_sym)
      live.count { |key, _| key[0] == effective }
    else
      live.count
    end
  end
end

#shared_memo_stale?(method_name, *args, **kwargs) ⇒ Boolean

Returns +true+ if the shared entry exists but its TTL has elapsed.

Parameters:

  • method_name (Symbol, String)
  • args (Array)
  • kwargs (Hash)

Returns:

  • (Boolean) 


747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
 
# File 'lib/safe_memoize/class_methods.rb', line 747

def shared_memo_stale?(method_name, *args, **kwargs)
  method_name = method_name.to_sym
  effective = __safe_memo_effective_key_name__(method_name)
  cache_key = [effective, args, kwargs]

  __safe_memo_shared_mutex__.synchronize do
    cache = @__safe_memo_shared_cache__
    return false unless cache

    record = cache[cache_key]
    return false unless record

    expires_at = record[:expires_at]
    return false unless expires_at

    expires_at <= Process.clock_gettime(Process::CLOCK_MONOTONIC)
  end
end

#shared_memoized?(method_name, *args, **kwargs) ⇒ Boolean

Returns +true+ if a live shared cache entry exists for the given call signature.

Parameters:

  • method_name (Symbol, String)
  • args (Array) —

    positional arguments

  • kwargs (Hash) —

    keyword arguments

Returns:

  • (Boolean) 


677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
 
# File 'lib/safe_memoize/class_methods.rb', line 677

def shared_memoized?(method_name, *args, **kwargs)
  method_name = method_name.to_sym
  effective = __safe_memo_effective_key_name__(method_name)
  cache_key = [effective, args, kwargs]

  __safe_memo_shared_mutex__.synchronize do
    cache = @__safe_memo_shared_cache__
    return false unless cache

    record = cache[cache_key]
    return false unless record

    record[:expires_at].nil? || record[:expires_at] > Process.clock_gettime(Process::CLOCK_MONOTONIC)
  end
end