philiprehberger-cache_kit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 969b99417559919665d91aea64820dd9373d787020b4d966b2443d0099864da0
+  data.tar.gz: '09e639031c7c4b3864e45dfe35ece4e29d109d062c4b0ebca424f06269f5b14b'
+SHA512:
+  metadata.gz: f15036e4a4f6cd77fd5e9f6af3c8f668eb4dee397415bbdeeda94d8acac24e7e7f81cfc6cc06721b4621ea4f1f043b0f468d1c44bef745ec14b8c01600b545f9
+  data.tar.gz: 771c1d2c89759a190c242c1cf6b12fca3673050d8ddca0e0cdee746d7daa73be7fe81b945dc945f69a7eae43aef3e991d32c4cb0c51d4304f79faa27af6ad0ba

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+
+All notable changes to this gem will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2026-03-10
+
+### Added
+- Initial release
+- Thread-safe in-memory LRU cache
+- TTL expiration per entry
+- Tag-based bulk invalidation
+- `get`, `set`, `fetch`, `delete`, `clear` operations
+- Configurable max size with LRU eviction

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 philiprehberger
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,109 @@
+# philiprehberger-cache_kit
+
+[![Tests](https://github.com/philiprehberger/rb-cache-kit/actions/workflows/ci.yml/badge.svg)](https://github.com/philiprehberger/rb-cache-kit/actions/workflows/ci.yml)
+[![Gem Version](https://badge.fury.io/rb/philiprehberger-cache_kit.svg)](https://rubygems.org/gems/philiprehberger-cache_kit)
+
+In-memory LRU cache with TTL, tags, and thread safety for Ruby.
+
+## Requirements
+
+- Ruby >= 3.1
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem "philiprehberger-cache_kit"
+```
+
+Then run:
+
+```bash
+bundle install
+```
+
+Or install directly:
+
+```bash
+gem install philiprehberger-cache_kit
+```
+
+## Usage
+
+```ruby
+require "philiprehberger/cache_kit"
+
+cache = Philiprehberger::CacheKit::Store.new(max_size: 500)
+
+# Basic get/set
+cache.set("user:1", { name: "Alice" }, ttl: 300)
+cache.get("user:1") # => { name: "Alice" }
+```
+
+### Fetch (get or compute)
+
+```ruby
+user = cache.fetch("user:1", ttl: 300) do
+  User.find(1)
+end
+```
+
+### TTL Expiration
+
+```ruby
+cache.set("session", "abc", ttl: 60) # expires in 60 seconds
+cache.get("session")                  # => "abc"
+# ... 60 seconds later ...
+cache.get("session")                  # => nil
+```
+
+### Tag-based Invalidation
+
+```ruby
+cache.set("user:1", data1, tags: ["users"])
+cache.set("user:2", data2, tags: ["users"])
+cache.set("post:1", data3, tags: ["posts"])
+
+cache.invalidate_tag("users") # removes user:1 and user:2, keeps post:1
+```
+
+### LRU Eviction
+
+```ruby
+cache = Philiprehberger::CacheKit::Store.new(max_size: 3)
+
+cache.set("a", 1)
+cache.set("b", 2)
+cache.set("c", 3)
+cache.set("d", 4) # evicts "a" (least recently used)
+
+cache.get("a") # => nil
+cache.get("d") # => 4
+```
+
+## API
+
+| Method | Description |
+|--------|-------------|
+| `Store.new(max_size: 1000)` | Create a cache with max entries |
+| `Store#get(key)` | Get a value (nil if missing/expired) |
+| `Store#set(key, value, ttl:, tags:)` | Store a value |
+| `Store#fetch(key, ttl:, tags:, &block)` | Get or compute a value |
+| `Store#delete(key)` | Delete a key |
+| `Store#invalidate_tag(tag)` | Remove all entries with a tag |
+| `Store#clear` | Remove all entries |
+| `Store#size` | Number of entries |
+| `Store#key?(key)` | Check if a key exists and is not expired |
+
+## Development
+
+```bash
+bundle install
+bundle exec rspec      # Run tests
+bundle exec rubocop    # Check code style
+```
+
+## License
+
+MIT

data/lib/philiprehberger/cache_kit/entry.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Philiprehberger
+  module CacheKit
+    # Internal cache entry with value, TTL, and tags.
+    class Entry
+      attr_reader :value, :tags, :created_at
+
+      # @param value the cached value
+      # @param ttl [Numeric, nil] time-to-live in seconds (nil = no expiry)
+      # @param tags [Array<String>] tags for bulk invalidation
+      def initialize(value, ttl: nil, tags: [])
+        @value = value
+        @ttl = ttl
+        @tags = tags.map(&:to_s)
+        @created_at = Time.now
+      end
+
+      # Check if the entry has expired.
+      #
+      # @return [Boolean]
+      def expired?
+        return false if @ttl.nil?
+
+        (Time.now - @created_at) >= @ttl
+      end
+    end
+  end
+end

data/lib/philiprehberger/cache_kit/store.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+module Philiprehberger
+  module CacheKit
+    # Thread-safe in-memory LRU cache with TTL and tag-based invalidation.
+    class Store
+      # @param max_size [Integer] maximum number of entries (LRU eviction when exceeded)
+      def initialize(max_size: 1000)
+        @max_size = max_size
+        @data = {}
+        @order = []
+        @mutex = Mutex.new
+      end
+
+      # Get a value by key. Returns nil if missing or expired.
+      #
+      # @param key [String] the cache key
+      # @return the cached value, or nil
+      def get(key)
+        @mutex.synchronize do
+          entry = @data[key]
+          return nil unless entry
+
+          if entry.expired?
+            remove_entry(key)
+            return nil
+          end
+
+          touch(key)
+          entry.value
+        end
+      end
+
+      # Store a value.
+      #
+      # @param key [String] the cache key
+      # @param value the value to cache
+      # @param ttl [Numeric, nil] time-to-live in seconds
+      # @param tags [Array<String>] tags for bulk invalidation
+      # @return the stored value
+      def set(key, value, ttl: nil, tags: [])
+        @mutex.synchronize do
+          remove_entry(key) if @data.key?(key)
+          evict if @data.size >= @max_size
+
+          @data[key] = Entry.new(value, ttl: ttl, tags: tags)
+          @order.push(key)
+          value
+        end
+      end
+
+      # Get or compute a value.
+      #
+      # @param key [String] the cache key
+      # @param ttl [Numeric, nil] TTL for newly computed values
+      # @param tags [Array<String>] tags for newly computed values
+      # @yield computes the value if not cached
+      # @return the cached or computed value
+      def fetch(key, ttl: nil, tags: [], &block)
+        value = get(key)
+        return value unless value.nil?
+
+        computed = block.call
+        set(key, computed, ttl: ttl, tags: tags)
+        computed
+      end
+
+      # Delete a specific key.
+      #
+      # @param key [String] the cache key
+      # @return [Boolean] true if the key existed
+      def delete(key)
+        @mutex.synchronize do
+          removed = @data.key?(key)
+          remove_entry(key)
+          removed
+        end
+      end
+
+      # Invalidate all entries with a given tag.
+      #
+      # @param tag [String] the tag to invalidate
+      # @return [Integer] number of entries removed
+      def invalidate_tag(tag)
+        @mutex.synchronize do
+          tag_s = tag.to_s
+          keys = @data.select { |_, entry| entry.tags.include?(tag_s) }.keys
+          keys.each { |k| remove_entry(k) }
+          keys.size
+        end
+      end
+
+      # Clear all entries.
+      #
+      # @return [void]
+      def clear
+        @mutex.synchronize do
+          @data.clear
+          @order.clear
+        end
+      end
+
+      # @return [Integer] number of entries (including expired ones not yet evicted)
+      def size
+        @mutex.synchronize { @data.size }
+      end
+
+      # @param key [String]
+      # @return [Boolean] true if the key exists and is not expired
+      def key?(key)
+        @mutex.synchronize do
+          entry = @data[key]
+          return false unless entry
+          return false if entry.expired?
+
+          true
+        end
+      end
+
+      private
+
+      def touch(key)
+        @order.delete(key)
+        @order.push(key)
+      end
+
+      def evict
+        oldest = @order.first
+        remove_entry(oldest) if oldest
+      end
+
+      def remove_entry(key)
+        @data.delete(key)
+        @order.delete(key)
+      end
+    end
+  end
+end

data/lib/philiprehberger/cache_kit/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Philiprehberger
+  module CacheKit
+    VERSION = "0.1.0"
+  end
+end

data/lib/philiprehberger/cache_kit.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative "cache_kit/version"
+require_relative "cache_kit/entry"
+require_relative "cache_kit/store"
+
+module Philiprehberger
+  module CacheKit
+    class Error < StandardError; end
+  end
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: philiprehberger-cache_kit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Philip Rehberger
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-03-10 00:00:00.000000000 Z
+dependencies: []
+description: A lightweight, thread-safe in-memory LRU cache with TTL expiration and
+  tag-based bulk invalidation for Ruby applications.
+email:
+- me@philiprehberger.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/philiprehberger/cache_kit.rb
+- lib/philiprehberger/cache_kit/entry.rb
+- lib/philiprehberger/cache_kit/store.rb
+- lib/philiprehberger/cache_kit/version.rb
+homepage: https://github.com/philiprehberger/rb-cache-kit
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/philiprehberger/rb-cache-kit
+  source_code_uri: https://github.com/philiprehberger/rb-cache-kit
+  changelog_uri: https://github.com/philiprehberger/rb-cache-kit/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: In-memory LRU cache with TTL, tags, and thread safety
+test_files: []