typed_cache 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9beff9345d3d58fb92c4cb77467271af9f8bc1212529dd7d6d21d13fa4e285ad
+  data.tar.gz: 0aef7f30f5f5029e8667944c4b6724694f5cf8e1bae1a7358a4c0a6c0931902b
+SHA512:
+  metadata.gz: a848cd77e148388fc0624acdd2f5b5826c573fc418d13dc15ce1f7b75acf365d8860cff1ceb123bb0b3b8f374fba100e25b5d818f51b66ac3aea0f3e6c6fe745
+  data.tar.gz: 9e0929925806d7449462bb70deb7773eb19301d268cb93fc0fb321ca5ff38619c724f9e305c40e255a21a3b85e44fd80d4bed69ac97d13f4385af878a25c9f8d

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,168 @@
+# TypedCache
+
+TypedCache is a lightweight, type-safe façade around your favourite Ruby cache
+stores. It adds three things on top of the raw back-end implementation:
+
+1. **Namespacing** – hierarchical `Namespace` helpers prevent key collisions.
+2. **Stronger types** – RBS signatures as well as monadic types like `Either`, `Maybe`, and `Snapshot` wrap cache results so you always know whether you have a value, an error, or a cache-miss.
+3. **Composable decorators** – behaviours like instrumentation can be layered
+   on without touching the underlying store.
+
+> **TL;DR** – Think _Faraday_ or _Rack_ middlewares, but for caching.
+
+---
+
+## Installation
+
+```bash
+bundle add typed_cache && bundle install
+# or
+gem install typed_cache
+```
+
+This gem does is also cryptographically signed, if you want to ensure the gem was not tampered with, make sure to use these commands:
+
+```bash
+bundle add typed_cache && bundle install --trust-policy=HighSecurity
+# or
+gem install typed_cache -P HighSecurity
+```
+
+If there are issues with unsigned gems, use `MediumSecurity` instead.
+
+## Quick start
+
+```ruby
+require "typed_cache"
+
+# Build an in-memory cache with ActiveSupport-style instrumentation
+store = TypedCache.builder
+            .with_backend(:memory, shared: true)
+            .with_instrumentation      # or .with_decorator(:instrumented)
+            .build                     # => Either[Error, Store]
+            .value
+
+users_key   = store.namespace.key("users")   # => CacheKey
+snapshot    = store.set(users_key, [1, 2, 3]) # => Either[Error, Snapshot]
+puts snapshot.value           # => [1, 2, 3]
+```
+
+## Builder API
+
+| Step                          | Purpose                                                        |
+| ----------------------------- | -------------------------------------------------------------- |
+| `with_backend(:name, **opts)` | Mandatory. Configure the concrete **Backend** and its options. |
+| `with_decorator(:key)`        | Optional. Add a decorator by registry key.                     |
+| `with_instrumentation`        | Convenience alias for `with_decorator(:instrumented)`.         |
+| `build`                       | Returns `Either[Error, Store]`.                                |
+
+### Back-ends vs Decorators
+
+- **Back-end** (`TypedCache::Backend`) – persists data (Memory, Redis, etc.).
+- **Decorator** (`TypedCache::Decorator`) – wraps an existing store to add
+  behaviour (Instrumentation, Logging, Circuit-Breaker …).
+
+Both include the same public `Store` interface, so they can be composed
+freely. Registries keep them separate:
+
+```ruby
+TypedCache::Backends.available   # => [:memory, :active_support]
+TypedCache::Decorators.available # => [:instrumented]
+```
+
+### Register your own
+
+```ruby
+class RedisBackend
+  include TypedCache::Backend
+  # … implement #get, #set, etc.
+end
+
+TypedCache::Backends.register(:redis, RedisBackend)
+```
+
+```ruby
+class LogDecorator
+  include TypedCache::Decorator
+  def initialize(store) = @store = store
+  def set(key, value)
+    puts "[cache] SET #{key}"
+    @store.set(key, value)
+  end
+  # delegate the rest …
+end
+
+TypedCache::Decorators.register(:logger, LogDecorator)
+```
+
+## Error handling
+
+All operations return one of:
+
+- `Either.right(Snapshot)` – success
+- `Either.left(CacheMissError)` – key not present
+- `Either.left(StoreError)` – transport / serialization failure
+
+Use the monad directly or pattern-match:
+
+```ruby
+result.fold(
+  ->(err)      { warn err.message },
+  ->(snapshot) { puts snapshot.value },
+)
+```
+
+## Instrumentation
+
+Decorators publish ActiveSupport notifications when
+`TypedCache.config.instrumentation.enabled = true`:
+
+```
+<operation>.<namespace>  # e.g. get.typed_cache
+```
+
+Payload keys: `:namespace, :key, :duration, :cache_hit`, …
+
+## Further examples
+
+For more advanced scenarios—including Rails integration, pattern matching, custom back-ends, and testing—see [examples.md](examples.md).
+
+## License
+
+This work is licensed under the [Apache-2.0](./LICENSE) license.
+
+### Apache 2.0 License Key Terms
+
+#### Grants
+
+- Perpetual, worldwide, non-exclusive, royalty-free license to:
+  - Reproduce the work
+  - Prepare derivative works
+  - Distribute the work
+  - Use and sell the work
+
+#### Requirements
+
+- Include a copy of the Apache 2.0 License with any distribution
+- Provide attribution
+- Clearly mark any modifications made to the original work
+- Retain all original copyright and license notices
+
+#### Permissions
+
+- Commercial use allowed
+- Modification permitted
+- Distribution of original and modified work permitted
+- Patent use granted
+- Private use allowed
+
+#### Limitations
+
+- No warranty or liability protection
+- Trademark rights not transferred
+- Contributors not liable for damages
+
+#### Compatibility
+
+- Can be used in closed-source and commercial projects
+- Requires preserving original license and attribution

data/examples.md

@@ -0,0 +1,190 @@
+# TypedCache Examples
+
+This document provides practical examples of using TypedCache in real applications.
+
+## Basic Memory Cache
+
+The simplest way to create a type-safe cache:
+
+```ruby
+user_namespace = TypedCache::Namespace.at("users")
+
+cache_result = TypedCache.builder
+  .with_backend(:memory, shared: true)
+  .with_instrumentation
+  .build(user_namespace)            # => Either[Error, Store]
+
+store = cache_result.value          # unwrap for brevity
+key   = store.namespace.key("123")  # => CacheKey
+store.set(key, { id: 123, name: "Jane" })
+```
+
+## Rails Integration
+
+Using TypedCache with `Rails.cache` and ActiveSupport notifications:
+
+```ruby
+cache_result = TypedCache.builder
+  .with_backend(:active_support, Rails.cache)
+  .with_instrumentation
+  .build                                     # defaults to TypedCache.config.default_namespace
+
+cache = cache_result.value
+cache.fetch(cache.namespace.key("header")) { render_header }
+```
+
+## Pattern Matching
+
+Clean error handling with Ruby 3 pattern matching:
+
+```ruby
+result = TypedCache.builder
+  .with_backend(:memory)
+  .build
+
+case result
+in TypedCache::Either::Right(store)
+  store.set(store.namespace.key("greeting"), "Hello")
+in TypedCache::Either::Left(error)
+  warn "Failed to set up cache: #{error.message}"
+end
+```
+
+## Multiple Caches
+
+Reuse a preconfigured builder for several namespaces:
+
+```ruby
+base_builder = TypedCache.builder
+  .with_backend(:memory, shared: true)
+
+users_store  = base_builder.build(TypedCache::Namespace.at("users")).value
+posts_store  = base_builder.build(TypedCache::Namespace.at("posts")).value
+comments_store = base_builder.build(TypedCache::Namespace.at("comments")).value
+```
+
+## Cache Operations
+
+Working with cache values using the monadic interface:
+
+```ruby
+# Set a value
+cache.set({ id: 1, name: "John" })
+
+# Get with error handling
+cache.get.fold(
+  ->(error) { puts "Cache miss: #{error.message}" },
+  ->(snapshot) { puts "Found: #{snapshot.value}" }
+)
+
+# Get with Maybe semantics (no error details)
+user = cache.peek.value_or({ id: 0, name: "Anonymous" })
+
+# Fetch with computation
+result = cache.fetch do
+  # This block runs only on cache miss
+  expensive_user_lookup(user_id)
+end
+```
+
+## Custom Backend
+
+Registering and using a custom cache backend:
+
+```ruby
+class SimpleStore
+  include TypedCache::Backend
+
+  def initialize(namespace)
+    @namespace = namespace
+    @data      = {}
+  end
+
+  def get(key)
+    value = @data[key]
+    value ? TypedCache::Either.right(value) : TypedCache::Either.left(TypedCache::CacheMissError.new(key))
+  end
+
+  def set(key, value)
+    @data[key] = value
+    TypedCache::Either.right(value)
+  end
+
+  def delete(key)
+    value = @data.delete(key)
+    value ? TypedCache::Either.right(value) : TypedCache::Either.left(TypedCache::CacheMissError.new(key))
+  end
+
+  attr_reader :namespace
+  def store_type = "simple"
+end
+
+TypedCache::Backends.register(:simple, SimpleStore)
+
+cache = TypedCache.builder
+  .with_backend(:simple)
+  .build.value
+```
+
+## Instrumentation Only
+
+```ruby
+TypedCache.configure_instrumentation do |config|
+  config.enabled = true
+  config.namespace = "my_app_cache"
+end
+
+cache = TypedCache.builder
+  .with_backend(:memory)
+  .with_instrumentation
+  .build.value
+
+cache.set(cache.namespace.key("metrics"), 42)
+```
+
+## Configuration Snippet
+
+```ruby
+TypedCache.configure do |config|
+  config.default_namespace = "my_app"
+end
+```
+
+You can register additional decorators or back-ends as needed:
+
+```ruby
+TypedCache::Decorators.register(:logger, MyLoggerDecorator)
+TypedCache::Backends.register(:redis,   MyRedisBackend)
+```
+
+## Thread Safety
+
+The shared in-memory back-end is thread-safe:
+
+```ruby
+shared_store = TypedCache.builder
+  .with_backend(:memory, shared: true)
+  .build.value
+
+threads = 10.times.map do |i|
+  Thread.new { shared_store.set(shared_store.namespace.key(i.to_s), "data_") }
+end
+threads.each(&:join)
+```
+
+## Testing
+
+Using TypedCache in tests:
+
+```ruby
+spec_store = TypedCache.builder
+  .with_backend(:memory)
+  .build(TypedCache::Namespace.at("specs")).value
+
+RSpec.describe "cache" do
+  it "stores data" do
+    result = spec_store.set(spec_store.namespace.key("id"), 1)
+    expect(result).to be_right
+  end
+end
+```

data/lib/typed_cache/backend.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module TypedCache
+  # Marker mixin for concrete cache back-ends.
+  # A Backend *is* a Store, but the reverse is not necessarily true (decorators also
+  # include Store). By tagging back-ends with this module we can type-check and
+  # register them separately from decorators.
+  #
+  # Back-ends should *not* assume they wrap another store – they are the leaf nodes
+  # that actually persist data.
+  # @rbs generic V
+  module Backend
+    include Store #[V]
+    # @rbs! include Store::_Store[V]
+  end
+end

data/lib/typed_cache/backends/active_support.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+module TypedCache
+  module Backends
+    # Adapter that wraps any ActiveSupport::Cache::Store to work with TypedCache
+    # @rbs generic V
+    class ActiveSupport
+      include Backend #[V]
+
+      attr_reader :namespace #: Namespace
+      attr_reader :cache_store #: ::ActiveSupport::Cache::Store
+      attr_reader :default_options #: Hash[Symbol, top]
+
+      #: (Namespace, ::ActiveSupport::Cache::Store, ?Hash[Symbol, top]) -> void
+      def initialize(namespace, cache_store, default_options = {})
+        @namespace = namespace
+        @cache_store = cache_store
+        @default_options = default_options
+      end
+
+      # @rbs override
+      #: (cache_key) -> either[Error, Snapshot[V]]
+      def get(key)
+        cache_key_str = namespaced_key(key).to_s
+        raw_value = cache_store.read(cache_key_str, default_options)
+        return Either.left(CacheMissError.new(key)) if raw_value.nil?
+
+        Either.right(Snapshot.new(raw_value, source: :cache))
+      rescue => e
+        Either.left(StoreError.new(:get, key, "Failed to read from cache: #{e.message}", e))
+      end
+
+      # @rbs override
+      #: (cache_key, V) -> either[Error, Snapshot[V]]
+      def set(key, value)
+        cache_key_str = namespaced_key(key).to_s
+        success = cache_store.write(cache_key_str, value, default_options)
+
+        if success
+          Either.right(Snapshot.new(value, source: :cache))
+        else
+          Either.left(StoreError.new(:set, key, 'Failed to write to cache', nil))
+        end
+      rescue => e
+        Either.left(StoreError.new(:set, key, "Failed to write to cache: #{e.message}", e))
+      end
+
+      # @rbs override
+      #: (cache_key) -> either[Error, Snapshot[V]]
+      def delete(key)
+        get(key).fold(
+          ->(error) { Either.left(error) },
+          ->(snapshot) {
+            cache_key_str = namespaced_key(key).to_s
+            cache_store.delete(cache_key_str, default_options)
+            Either.right(snapshot)
+          },
+        )
+      rescue => e
+        Either.left(StoreError.new(:delete, key, "Failed to delete from cache: #{e.message}", e))
+      end
+
+      # @rbs override
+      #: (cache_key) -> bool
+      def key?(key)
+        cache_store.exist?(namespaced_key(key).to_s, default_options)
+      rescue => _e
+        false
+      end
+
+      # @rbs override
+      #: -> maybe[Error]
+      def clear
+        if cache_store.respond_to?(:delete_matched)
+          namespace_prefix_patterns.each do |pattern|
+            cache_store.delete_matched(pattern, default_options)
+          end
+        elsif cache_store.respond_to?(:clear)
+          cache_store.clear(default_options)
+        end
+        Maybe.none
+      rescue => e
+        Maybe.some(e)
+      end
+
+      # @rbs override
+      #: -> String
+      def store_type
+        'active_support'
+      end
+
+      #: (Hash[Symbol, top]) -> ActiveSupport[V]
+      def with_options(new_options)
+        self.class.new(namespace, cache_store, new_options)
+      end
+
+      #: -> ::ActiveSupport::Cache::Store
+      def raw_cache
+        cache_store
+      end
+
+      private
+
+      # Regex patterns that match keys for this namespace (with trailing colon)
+      #: -> Array[Regexp]
+      def namespace_prefix_patterns
+        [
+          /\A#{Regexp.escape(namespace.to_s)}:/,
+        ]
+      end
+    end
+  end
+end