typed_cache 0.1.1 → 0.2.0

data/sig/generated/typed_cache/decorators/instrumented.rbs

@@ -0,0 +1,35 @@
+# Generated from lib/typed_cache/decorators/instrumented.rb with RBS::Inline
+
+module TypedCache
+  # Decorator that adds instrumentation to any Store implementation
+  # This decorator can wrap any store to add ActiveSupport::Notifications
+  # @rbs generic V
+  class Decorators::Instrumented[V]
+    include Decorator[V]
+
+    extend Forwardable
+
+    attr_reader store: TypedCache::Store[V]
+
+    attr_reader instrumenter: Instrumenter
+
+    # @rbs (Symbol, ?operation: String) ?{ (*untyped, **untyped) -> String } -> void
+    private def self.instrument: (Symbol, ?operation: String) ?{ (*untyped, **untyped) -> String } -> void
+
+    # : (TypedCache::Store[V], instrumenter: Instrumenter) -> void
+    def initialize: (TypedCache::Store[V], instrumenter: Instrumenter) -> void
+
+    # @rbs override
+    # : -> String
+    def store_type: ...
+
+    # @rbs override
+    # @rbs (key) -> CacheRef[V]
+    def ref: ...
+
+    # Additional methods that might exist on the wrapped store
+    def respond_to_missing?: (untyped method_name, ?untyped include_private) -> untyped
+
+    def method_missing: (untyped method_name, *untyped args) ?{ (?) -> untyped } -> untyped
+  end
+end

data/sig/generated/typed_cache/decorators.rbs

@@ -13,12 +13,14 @@ module TypedCache
   #              .with_decorator(:my_decorator)
   #              .build.value
   module Decorators
+    # @api private
     # Default decorator set – starts with instrumentation only, but this registry
     # lets end-users register their own via `Decorators.register`.
     REGISTRY: untyped
 
     extend Forwardable
 
+    # @api private
     # @rbs () -> Registry[Store[untyped]]
     def self.registry: () -> Registry[Store[untyped]]
   end

data/sig/generated/typed_cache/errors.rbs

@@ -3,6 +3,8 @@
 module TypedCache
   # Base error class for TypedCache operations
   class Error < StandardError
+    # @rbs (*untyped) -> void
+    def initialize: (*untyped) -> void
   end
 
   # Store operation errors (network, I/O, etc.)

data/sig/generated/typed_cache/instrumenter.rbs

@@ -0,0 +1,31 @@
+# Generated from lib/typed_cache/instrumenter.rb with RBS::Inline
+
+module TypedCache
+  # Instrumenter for cache operations
+  module Instrumenter
+    type event = Dry::Events::Event | ActiveSupport::Notifications::Event
+
+    # @rbs [R](String, String, **untyped) { -> R } -> R
+    def instrument: [R] (String, String, **untyped) { () -> R } -> R
+
+    # @rbs (String, **untyped) { (event) -> void } -> void
+    def subscribe: (String, **untyped) { (event) -> void } -> void
+
+    # : -> String
+    def namespace: () -> String
+
+    # @rbs (String, String, **untyped) -> Hash[Symbol, untyped]
+    def build_payload: (String, String, **untyped) -> Hash[Symbol, untyped]
+
+    # @rbs () -> bool
+    def enabled?: () -> bool
+
+    # @rbs (String) -> String
+    def event_name: (String) -> String
+
+    private
+
+    # @rbs () -> TypedCache::_TypedCacheInstrumentationConfig
+    def config: () -> TypedCache::_TypedCacheInstrumentationConfig
+  end
+end

data/sig/generated/typed_cache/instrumenters/active_support.rbs

@@ -0,0 +1,20 @@
+# Generated from lib/typed_cache/instrumenters/active_support.rb with RBS::Inline
+
+module TypedCache
+  module Instrumenters
+    # Instrumenter for ActiveSupport::Notifications
+    class ActiveSupport
+      include Instrumenter
+
+      include Mixins::NamespacedSingleton
+
+      # @rbs override
+      # : [R] (String, String, Hash[Symbol, untyped]) { -> R } -> R
+      def instrument: ...
+
+      # @rbs override
+      # @rbs (String, **top) { (event) -> void } -> void
+      def subscribe: ...
+    end
+  end
+end

data/sig/generated/typed_cache/instrumenters/mixins/namespaced_singleton.rbs

@@ -0,0 +1,33 @@
+# Generated from lib/typed_cache/instrumenters/mixins/namespaced_singleton.rb with RBS::Inline
+
+module TypedCache
+  module Instrumenters
+    module Mixins
+      module NamespacedSingleton
+        # @rbs () -> Array[Class[Instrumenter & NamespacedSingleton]]
+        def self.all: () -> Array[Class[Instrumenter & NamespacedSingleton]]
+
+        # @rbs (Class[Instrumenter & NamespacedSingleton]) -> void
+        def self.included: (Class[Instrumenter & NamespacedSingleton]) -> void
+
+        # @rbs override
+        # @rbs () -> String
+        def namespace: ...
+
+        # @rbs (String | Namespace) -> void
+        def initialize: (String | Namespace) -> void
+
+        module ClassMethods
+          # @rbs (String | Namespace) -> class
+          def new: (String | Namespace) -> class
+
+          # @rbs (String) -> maybe[class]
+          def get: (String) -> maybe[class]
+
+          # @rbs () -> Concurrent::Map[String, Class[Instrumenter & NamespacedSingleton]]
+          def namespace_cache: () -> Concurrent::Map[String, Class[Instrumenter & NamespacedSingleton]]
+        end
+      end
+    end
+  end
+end

data/sig/generated/typed_cache/instrumenters/mixins.rbs

@@ -0,0 +1,8 @@
+# Generated from lib/typed_cache/instrumenters/mixins.rb with RBS::Inline
+
+module TypedCache
+  module Instrumenters
+    module Mixins
+    end
+  end
+end

data/sig/generated/typed_cache/instrumenters/monitor.rbs

@@ -0,0 +1,19 @@
+# Generated from lib/typed_cache/instrumenters/monitor.rb with RBS::Inline
+
+module TypedCache
+  module Instrumenters
+    class Monitor
+      include Instrumenter
+
+      include Mixins::NamespacedSingleton
+
+      # @rbs override
+      # : [R] (String, String, **untyped) { -> R } -> R
+      def instrument: ...
+
+      # @rbs override
+      # @rbs (String, **top) { (event) -> void } -> void
+      def subscribe: ...
+    end
+  end
+end

data/sig/generated/typed_cache/instrumenters/null.rbs

@@ -0,0 +1,21 @@
+# Generated from lib/typed_cache/instrumenters/null.rb with RBS::Inline
+
+module TypedCache
+  module Instrumenters
+    # A no-op implementation used when instrumentation is disabled.
+    # It fulfils the Instrumenter contract but simply yields.
+    class Null
+      include Instrumenter
+
+      include Mixins::NamespacedSingleton
+
+      # @rbs override
+      # [R] (String, String, **untyped) { -> R } -> R
+      def instrument: ...
+
+      # @rbs override
+      # @rbs (String, **top) { (event) -> void } -> void
+      def subscribe: ...
+    end
+  end
+end

data/sig/generated/typed_cache/instrumenters.rbs

@@ -0,0 +1,24 @@
+# Generated from lib/typed_cache/instrumenters.rb with RBS::Inline
+
+module TypedCache
+  module Instrumenters
+    # @api private
+    # Registry mapping symbols to instrumenter classes. We can't reuse the generic
+    # Registry class directly because many instrumenters mix in `Singleton`,
+    # making `.new` inaccessible. Instead we implement a thin facade that
+    # returns either the singleton instance (preferred) or a fresh instance.
+    REGISTRY: Registry[Symbol, Class[Instrumenter]]
+
+    extend Forwardable
+
+    # @api private
+    # @rbs () -> Registry[Symbol, Class[Instrumenter]]
+    def self.registry: () -> Registry[Symbol, Class[Instrumenter]]
+
+    def resolve: (Symbol, **untyped) -> either[Error, Instrumenter]
+
+    def available: () -> Array[Symbol]
+
+    def registered?: (Symbol) -> Boolean
+  end
+end

data/sig/generated/typed_cache/registry.rbs

@@ -7,6 +7,12 @@ module TypedCache
     # @rbs (String, Hash[Symbol, Class[T]]) -> void
     def initialize: (String, Hash[Symbol, Class[T]]) -> void
 
+    # @rbs (Registry[T]) -> Registry[T]
+    def initialize_copy: (Registry[T]) -> Registry[T]
+
+    # @rbs () -> void
+    def clear: () -> void
+
     # @rbs (Symbol, *untyped, **untyped) -> either[Error, T]
     def resolve: (Symbol, *untyped, **untyped) -> either[Error, T]
 
@@ -21,5 +27,7 @@ module TypedCache
 
     # @rbs (Symbol) -> bool
     def registered?: (Symbol) -> bool
+
+    attr_reader registry: Hash[Symbol, Class[T]]
   end
 end

data/sig/generated/typed_cache/store/instrumented.rbs

@@ -14,8 +14,8 @@ module TypedCache
     # @rbs (Symbol, ?operation: String) ?{ (*untyped, **untyped) -> String } -> void
     private def self.instrument: (Symbol, ?operation: String) ?{ (*untyped, **untyped) -> String } -> void
 
-    # : (TypedCache::Store[V]) -> void
-    def initialize: (TypedCache::Store[V]) -> void
+    # : (TypedCache::Store[V], instrumenter: Instrumenter) -> void
+    def initialize: (TypedCache::Store[V], instrumenter: Instrumenter) -> void
 
     # @rbs override
     # : -> String
@@ -25,10 +25,6 @@ module TypedCache
     # : -> String
     def store_type: ...
 
-    # @rbs override
-    # : (cache_key) -> either[Error, CacheRef[V]]
-    def ref: ...
-
     # Additional methods that might exist on the wrapped store
     def respond_to_missing?: (untyped method_name, ?untyped include_private) -> untyped
 

data/sig/generated/typed_cache/store.rbs

@@ -72,6 +72,9 @@ module TypedCache
     # @rbs (cache_key) { () -> V } -> either[Error, Snapshot[V]]
     def fetch: (cache_key) { () -> V } -> either[Error, Snapshot[V]]
 
+    # @rbs () -> Instrumenter
+    def instrumenter: () -> Instrumenter
+
     # Returns the namespace for this store (for instrumentation/debugging)
     # @rbs () -> Namespace
     def namespace: () -> Namespace

data/sig/generated/typed_cache.rbs

@@ -23,12 +23,12 @@ module TypedCache
 
   def config: () -> _TypedCacheConfig
 
-  # @rbs () -> singleton(Instrumentation)
-  def self.instrumentation: () -> singleton(Instrumentation)
+  # @rbs () -> singleton(Backends)
+  def self.backends: () -> singleton(Backends)
 
-  # @rbs () -> Registry[backend[untyped]]
-  def self.backends: () -> Registry[backend[untyped]]
+  # @rbs () -> singleton(Decorators)
+  def self.decorators: () -> singleton(Decorators)
 
-  # @rbs () -> Register[decorator[untyped]]
-  def self.decorators: () -> Register[decorator[untyped]]
+  # @rbs () -> singleton(Instrumenters)
+  def self.instrumenters: () -> singleton(Instrumenters)
 end

data/typed_cache.gemspec

@@ -29,13 +29,14 @@ Gem::Specification.new do |spec|
   spec.cert_chain = [Gem.default_cert_path]
 
   spec.required_ruby_version = '>= 3.2.0'
-  spec.add_dependency('concurrent-ruby', '~> 1.3.5')
-  spec.add_dependency('concurrent-ruby-edge', '~>0.7.2')
+
+  spec.add_dependency('concurrent-ruby', '~> 1.0')
+
   spec.add_dependency('dry-configurable', '~> 1.0')
+  spec.add_dependency('dry-monitor', '~>1.0')
   spec.add_dependency('dry-struct', '~> 1.0')
   spec.add_dependency('dry-types', '~>1.0')
   spec.add_dependency('multi_json', '~> 1.17')
-  spec.add_dependency('zeitwerk', '~> 2.7')
 
   spec.extra_rdoc_files = Dir['README*', 'LICENSE*', 'examples*']
   spec.files = Dir['*.gemspec', 'lib/**/*', 'sig/**/*']

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: typed_cache
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Autumn Winter
@@ -35,7 +35,7 @@ cert_chain:
   uuhUq525FXA3gYeLAfnCSHNm7D1H7whsXYd3z+gKvEhSEQPb3mSBQ+31TDFmA5k7
   q7YL3dwhxKPXtnAboI+30XBImpdizFG9Nyqgzgj/kD0QwVzL0QsVdVWnNTJXrm4n
   -----END CERTIFICATE-----
-date: 2025-07-21 00:00:00.000000000 Z
+date: 2025-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -43,30 +43,30 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.5
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.5
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: concurrent-ruby-edge
+  name: dry-configurable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.2
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.2
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: dry-configurable
+  name: dry-monitor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -121,20 +121,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.17'
-- !ruby/object:Gem::Dependency
-  name: zeitwerk
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.7'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.7'
 description: |
   TypedCache is a Ruby caching library designed to eliminate common caching pitfalls by providing a monadic, type-safe API that makes cache operations explicit and predictable. Cache interactions are first-class operations with
   comprehensive error handling and transparent state management. The library supports wrapping other caching libraries via custom backends and ActiveSupport::Cache is supported out of the box.
@@ -161,15 +147,21 @@ files:
 - lib/typed_cache/clock.rb
 - lib/typed_cache/decorator.rb
 - lib/typed_cache/decorators.rb
+- lib/typed_cache/decorators/instrumented.rb
 - lib/typed_cache/either.rb
 - lib/typed_cache/errors.rb
-- lib/typed_cache/instrumentation.rb
+- lib/typed_cache/instrumenter.rb
+- lib/typed_cache/instrumenters.rb
+- lib/typed_cache/instrumenters/active_support.rb
+- lib/typed_cache/instrumenters/mixins.rb
+- lib/typed_cache/instrumenters/mixins/namespaced_singleton.rb
+- lib/typed_cache/instrumenters/monitor.rb
+- lib/typed_cache/instrumenters/null.rb
 - lib/typed_cache/maybe.rb
 - lib/typed_cache/namespace.rb
 - lib/typed_cache/registry.rb
 - lib/typed_cache/snapshot.rb
 - lib/typed_cache/store.rb
-- lib/typed_cache/store/instrumented.rb
 - lib/typed_cache/version.rb
 - sig/generated/typed_cache.rbs
 - sig/generated/typed_cache/backend.rbs
@@ -182,9 +174,16 @@ files:
 - sig/generated/typed_cache/clock.rbs
 - sig/generated/typed_cache/decorator.rbs
 - sig/generated/typed_cache/decorators.rbs
+- sig/generated/typed_cache/decorators/instrumented.rbs
 - sig/generated/typed_cache/either.rbs
 - sig/generated/typed_cache/errors.rbs
-- sig/generated/typed_cache/instrumentation.rbs
+- sig/generated/typed_cache/instrumenter.rbs
+- sig/generated/typed_cache/instrumenters.rbs
+- sig/generated/typed_cache/instrumenters/active_support.rbs
+- sig/generated/typed_cache/instrumenters/mixins.rbs
+- sig/generated/typed_cache/instrumenters/mixins/namespaced_singleton.rbs
+- sig/generated/typed_cache/instrumenters/monitor.rbs
+- sig/generated/typed_cache/instrumenters/null.rbs
 - sig/generated/typed_cache/maybe.rbs
 - sig/generated/typed_cache/namespace.rbs
 - sig/generated/typed_cache/registry.rbs
@@ -192,14 +191,13 @@ files:
 - sig/generated/typed_cache/store.rbs
 - sig/generated/typed_cache/store/instrumented.rbs
 - sig/generated/typed_cache/version.rbs
-- sig/handwritten/gems/zeitwerk/2.7/zeitwerk.rbs
 - typed_cache.gemspec
 homepage: https://github.com/glossawy/typed_cache
 licenses:
 - Apache-2.0
 metadata:
   issue_tracker_uri: https://github.com/glossawy/typed_cache/issues
-  changelog_uri: https://github.com/glossawy/typed_cache/blob/main/VERSIONS.adoc#011
+  changelog_uri: https://github.com/glossawy/typed_cache/blob/main/VERSIONS.adoc#020
   license_uri: https://github.com/glossawy/typed_cache/blob/main/LICENSE
   label: caching
   labels: typed_cache,ruby,caching,type-safety,rails,rbs

data/lib/typed_cache/instrumentation.rb

@@ -1,112 +0,0 @@
-# frozen_string_literal: true
-
-require 'dry/configurable'
-
-module TypedCache
-  # Instrumentation hooks for ActiveSupport::Notifications integration
-  # All instrumentation is explicit and opt-in - no automatic behavior
-  module Instrumentation
-    class << self
-      # @rbs! type config = TypedCache::_TypedCacheInstrumentationConfig
-
-      # @rbs () -> config
-      def config
-        TypedCache.config.instrumentation
-      end
-
-      # Check if ActiveSupport::Notifications is available
-      # @rbs () -> bool
-      def notifications_available?
-        defined?(ActiveSupport::Notifications)
-      end
-
-      # Main instrumentation method
-      #: [T] (String, String, String, Hash[Symbol, untyped]) { -> T } -> T
-      def instrument(operation, namespace, key, payload = {})
-        return yield unless config.enabled && notifications_available?
-
-        event_name = "#{operation}.#{config.namespace}"
-        start_time = current_time
-
-        begin
-          result = yield
-
-          # Determine success and extract metadata
-          success, snapshot_data = extract_result_metadata(result)
-
-          final_payload = base_payload(namespace, key, start_time).merge(payload).merge({
-            success: success,
-            **snapshot_data,
-          })
-
-          ActiveSupport::Notifications.instrument(event_name, final_payload) do
-            # This block is called by subscribers who want the result
-            result
-          end
-
-          result
-        rescue => error
-          error_payload = base_payload(namespace, key, start_time).merge(payload).merge({
-            success: false,
-            error: error.class.name,
-            error_message: error.message,
-          })
-
-          ActiveSupport::Notifications.instrument(event_name, error_payload)
-          raise
-        end
-      end
-
-      private
-
-      # Cross-platform current time helper (uses Time.current when available)
-      #: -> Time
-      def current_time
-        if Time.respond_to?(:current)
-          Time.current
-        else
-          Time.now
-        end
-      end
-
-      # @rbs (String, String, Time) -> Hash[Symbol, untyped]
-      def base_payload(namespace, key, start_time)
-        {
-          namespace: namespace,
-          key: key,
-          duration: (current_time - start_time) * 1000.0, # milliseconds
-          store_type: nil, # Will be set by caller if available
-        }
-      end
-
-      # @rbs (Either[StandardError, Snapshot]) -> [bool, Hash[Symbol, untyped]]
-      def extract_result_metadata(result)
-        case result
-        when Either
-          if result.right?
-            snapshot = result.value
-            if snapshot.is_a?(Snapshot)
-              [true, {
-                cache_hit: snapshot.from_cache?,
-                cache_miss: !snapshot.from_cache?,
-                source: snapshot.source,
-                snapshot_age: snapshot.age,
-              },]
-            else
-              [true, { cache_hit: false, cache_miss: true }]
-            end
-          else
-            error_data = {
-              cache_hit: false,
-              cache_miss: true,
-              error_type: result.error.class.name,
-            }
-            [false, error_data]
-          end
-        else
-          [true, {}]
-        end
-      end
-    end
-  end
-end

data/sig/generated/typed_cache/instrumentation.rbs

@@ -1,30 +0,0 @@
-# Generated from lib/typed_cache/instrumentation.rb with RBS::Inline
-
-module TypedCache
-  # Instrumentation hooks for ActiveSupport::Notifications integration
-  # All instrumentation is explicit and opt-in - no automatic behavior
-  module Instrumentation
-    type config = TypedCache::_TypedCacheInstrumentationConfig
-
-    # @rbs () -> config
-    def self.config: () -> config
-
-    # Check if ActiveSupport::Notifications is available
-    # @rbs () -> bool
-    def self.notifications_available?: () -> bool
-
-    # Main instrumentation method
-    # : [T] (String, String, String, Hash[Symbol, untyped]) { -> T } -> T
-    def self.instrument: [T] (String, String, String, Hash[Symbol, untyped]) { () -> T } -> T
-
-    # Cross-platform current time helper (uses Time.current when available)
-    # : -> Time
-    private def self.current_time: () -> Time
-
-    # @rbs (String, String, Time) -> Hash[Symbol, untyped]
-    private def self.base_payload: (String, String, Time) -> Hash[Symbol, untyped]
-
-    # @rbs (Either[StandardError, Snapshot]) -> [bool, Hash[Symbol, untyped]]
-    private def self.extract_result_metadata: (Either[StandardError, Snapshot]) -> [ bool, Hash[Symbol, untyped] ]
-  end
-end

data/sig/handwritten/gems/zeitwerk/2.7/zeitwerk.rbs

@@ -1,9 +0,0 @@
-
-
-module Zeitwerk
-  class Loader
-    def self.for_gem: -> instance
-
-    def setup: -> void
-  end
-end