safe_memoize 1.1.0 → 1.3.0

data/sig/safe_memoize.rbs

@@ -18,11 +18,36 @@ module SafeMemoize
   @__safe_memo_shared_mutex__: Mutex?
   @__safe_memo_shared_lru_order__: Hash[Symbol, Hash[memo_key, true]]?
 
+  SHARED_CACHE_REGISTRY: Hash[String, Stores::Base]
+  SHARED_CACHE_MUTEX: Mutex
+  EXTENSION_REGISTRY: Hash[Symbol, untyped]
+  EXTENSION_MUTEX: Mutex
+
   def self.prepended: (Class base) -> void
   def self.configure: () { (Configuration) -> void } -> void
   def self.configuration: () -> Configuration
   def self.reset_configuration!: () -> Configuration
   def self.deprecate: (String subject, message: String, horizon: String) -> void
+  def self.shared_cache: (String name) -> Stores::Base
+  def self.register_shared_cache: (String name, Stores::Base store) -> Stores::Base
+  def self.clear_shared_cache: (String name) -> void
+  def self.drop_shared_cache: (String name) -> Stores::Base?
+  def self.shared_caches: () -> Hash[String, Stores::Base]
+  def self.reset_shared_caches!: () -> void
+  def self.register_extension: (Symbol | String name, untyped extension) -> untyped
+  def self.unregister_extension: (Symbol | String name) -> untyped?
+  def self.extensions: () -> Hash[Symbol, untyped]
+  def self.reset_extensions!: () -> void
+  def self.extension_for_option: (Symbol option_name) -> untyped?
+  def self.dispatch_extension_events: (Symbol event_type, Class klass, Symbol method_name, untyped cache_key, untyped record) -> void
+
+  module Extension
+    def handles_option: (Symbol option_name) { (untyped value, Symbol method_name, Hash[Symbol, untyped] all_options) -> Hash[Symbol, untyped]? } -> void
+    def on_cache_event: (*Symbol event_types) { (Class klass, Symbol method_name, untyped cache_key, untyped record) -> void } -> void
+    def handled_options: () -> Array[Symbol]
+    def process_memoize_option: (Symbol option_name, untyped value, Symbol method_name, Hash[Symbol, untyped] all_options) -> Hash[Symbol, untyped]
+    def dispatch_cache_event: (Symbol event_type, Class klass, Symbol method_name, untyped cache_key, untyped record) -> void
+  end
 
   class Configuration
     attr_accessor default_ttl: Numeric?
@@ -33,13 +58,18 @@ module SafeMemoize
     attr_accessor statsd_client: untyped
     attr_accessor opentelemetry_tracer: untyped
     attr_accessor default_store: Stores::Base?
+    attr_accessor namespace: String?
 
     def initialize: () -> void
   end
 
   module ClassMethods
-    def memoize: (Symbol | String method_name, ?ttl: Numeric?, ?max_size: Integer?, ?ttl_refresh: bool, ?if: (^(untyped result) -> boolish)?, ?unless: (^(untyped result) -> boolish)?, ?shared: bool, ?key: (^(*untyped args, **untyped kwargs) -> untyped)?, ?store: Stores::Base?) -> void
-    def memoize_all: (?except: Array[Symbol | String], ?only: Array[Symbol | String], ?include_protected: bool, ?include_private: bool, ?ttl: Numeric?, ?max_size: Integer?, ?if: (^(untyped result) -> boolish)?, ?unless: (^(untyped result) -> boolish)?, ?shared: bool, ?key: (^(*untyped args, **untyped kwargs) -> untyped)?) -> void
+    def memoize: (Symbol | String method_name, ?ttl: Numeric?, ?max_size: Integer?, ?ttl_refresh: bool, ?if: (^(untyped result) -> boolish)?, ?unless: (^(untyped result) -> boolish)?, ?shared: bool, ?key: (^(*untyped args, **untyped kwargs) -> untyped)?, ?store: Stores::Base?, ?fiber_local: bool, ?ractor_safe: bool, ?namespace: String?, ?shared_cache: String?, ?cache_bust: (^() -> untyped) | Symbol | nil, **untyped extension_options) -> void
+    def safe_memoize_store: () -> Stores::Base?
+    def safe_memoize_store=: (Stores::Base?) -> Stores::Base?
+    def safe_memoize_namespace: () -> String?
+    def safe_memoize_namespace=: (String?) -> String?
+    def memoize_all: (?except: Array[Symbol | String], ?only: Array[Symbol | String], ?include_protected: bool, ?include_private: bool, ?ttl: Numeric?, ?max_size: Integer?, ?if: (^(untyped result) -> boolish)?, ?unless: (^(untyped result) -> boolish)?, ?shared: bool, ?key: (^(*untyped args, **untyped kwargs) -> untyped)?, ?fiber_local: bool, ?namespace: String?, ?shared_cache: String?) -> void
     def reset_shared_memo: (Symbol | String method_name, *untyped args, **untyped kwargs) -> void
     def reset_all_shared_memos: () -> void
     def shared_memoized?: (Symbol | String method_name, *untyped args, **untyped kwargs) -> bool
@@ -53,6 +83,8 @@ module SafeMemoize
     def __safe_memo_shared_mutex__: () -> Mutex
     def __safe_memo_shared_lru_order__: () -> Hash[Symbol, Hash[memo_key, true]]
     def __safe_memo_class_key_generators__: () -> Hash[Symbol, Proc]
+    def __safe_memo_method_namespaces__: () -> Hash[Symbol, String]
+    def __safe_memo_class_cache_bust_generators__: () -> Hash[Symbol, Proc | Symbol]
     def memoized_method_visibility: (Symbol method_name) -> Symbol
   end
 
@@ -187,6 +219,37 @@ module SafeMemoize
     def lru_clear_all: () -> void
   end
 
+  module FiberLocalMethods
+    FIBER_STORE_KEY: Symbol
+
+    def fiber_local_memoized?: (Symbol | String method_name, *untyped args, **untyped kwargs) ?{ () -> untyped } -> bool
+    def reset_fiber_memo: (Symbol | String method_name, *untyped args, **untyped kwargs) -> void
+    def reset_all_fiber_memos: () -> void
+
+    private
+
+    def fiber_root_store!: () -> Hash[untyped, untyped]
+    def fiber_memo_store!: () -> { cache: Hash[memo_key, memo_record], lru: Hash[Symbol, Hash[memo_key, true]] }
+    def fiber_memo_cache!: () -> Hash[memo_key, memo_record]
+    def fiber_memo_lru!: () -> Hash[Symbol, Hash[memo_key, true]]
+    def fiber_root_store_or_nil: () -> Hash[untyped, untyped]?
+    def fiber_memo_store_or_nil: () -> { cache: Hash[memo_key, memo_record], lru: Hash[Symbol, Hash[memo_key, true]] }?
+    def fiber_memo_cache_or_nil: () -> Hash[memo_key, memo_record]?
+    def fiber_memo_lru_or_nil: () -> Hash[Symbol, Hash[memo_key, true]]?
+  end
+
+  module RactorSharedMethods
+    def reset_ractor_memo: (Symbol | String method_name, *untyped args, **untyped kwargs) -> void
+    def reset_all_ractor_memos: () -> void
+    def ractor_memoized?: (Symbol | String method_name, *untyped args, **untyped kwargs) -> bool
+    def ractor_memo_count: (?(Symbol | String) method_name) -> Integer
+
+    private
+
+    def __ractor_cache_send__: (untyped supervisor, Symbol op, *untyped args) -> untyped
+    def __safe_memo_ractor_supervisor__: () -> untyped
+  end
+
   module InstanceMethods
     include PublicMethods
     include CacheStoreMethods
@@ -198,6 +261,7 @@ module SafeMemoize
     include CustomKeyMethods
     include PublicCustomKeyMethods
     include LruMethods
+    include FiberLocalMethods
   end
 
   module Stores
@@ -237,6 +301,17 @@ module SafeMemoize
       SPAN_NAME: String
       def self.trace: (untyped tracer, Symbol | String method_name, String? class_name) { () -> untyped } -> untyped
     end
+
+    class ConcurrentRuby < Stores::Base
+      def initialize: () -> void
+      def read: (untyped key) -> untyped
+      def write: (untyped key, untyped value, ?expires_in: Numeric?) -> void
+      def delete: (untyped key) -> void
+      def clear: () -> void
+      def keys: () -> Array[untyped]
+      private
+      def expired?: ({ expires_at: Float?, value: untyped, cached_at: Float }) -> bool
+    end
   end
 
   module Rails

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: safe_memoize
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Chuck Smith
@@ -52,6 +52,7 @@ files:
 - benchmarks/benchmark.rb
 - codecov.yml
 - lib/safe_memoize.rb
+- lib/safe_memoize/adapters/concurrent_ruby.rb
 - lib/safe_memoize/adapters/opentelemetry.rb
 - lib/safe_memoize/adapters/statsd.rb
 - lib/safe_memoize/cache_metrics_methods.rb
@@ -60,6 +61,8 @@ files:
 - lib/safe_memoize/class_methods.rb
 - lib/safe_memoize/configuration.rb
 - lib/safe_memoize/custom_key_methods.rb
+- lib/safe_memoize/extension.rb
+- lib/safe_memoize/fiber_local_methods.rb
 - lib/safe_memoize/hooks_methods.rb
 - lib/safe_memoize/inspection_methods.rb
 - lib/safe_memoize/instance_methods.rb
@@ -67,6 +70,7 @@ files:
 - lib/safe_memoize/public_custom_key_methods.rb
 - lib/safe_memoize/public_methods.rb
 - lib/safe_memoize/public_metrics_methods.rb
+- lib/safe_memoize/ractor_shared_methods.rb
 - lib/safe_memoize/rails.rb
 - lib/safe_memoize/rails/middleware.rb
 - lib/safe_memoize/rails/request_scoped.rb