philiprehberger-cache_kit 0.1.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 969b99417559919665d91aea64820dd9373d787020b4d966b2443d0099864da0
-  data.tar.gz: '09e639031c7c4b3864e45dfe35ece4e29d109d062c4b0ebca424f06269f5b14b'
+  metadata.gz: b4acd246ec80526d77eb23a49ecac10bcb00cbeaed209e279381099b14346f19
+  data.tar.gz: de8a6c3c962e0836c859dd97042b1885cc553e2edb41ee633707e431d3f73480
 SHA512:
-  metadata.gz: f15036e4a4f6cd77fd5e9f6af3c8f668eb4dee397415bbdeeda94d8acac24e7e7f81cfc6cc06721b4621ea4f1f043b0f468d1c44bef745ec14b8c01600b545f9
-  data.tar.gz: 771c1d2c89759a190c242c1cf6b12fca3673050d8ddca0e0cdee746d7daa73be7fe81b945dc945f69a7eae43aef3e991d32c4cb0c51d4304f79faa27af6ad0ba
+  metadata.gz: 9b3269a4eeebbb1b2020b421b8288e45a2aa78f48f61d55cc4fbf470b052137f85fea597ae215b83ea68ae862c8da326bbd6b4a82238d81511ce5a9f5a190572
+  data.tar.gz: '08dbc8a4505fbf216efede795a81ea828eb16e5f7a8a27793f8022225508ed58d8a11fbe68eeaae60212a0dbbb88136c087c538a2ef24bea82358063720de955'

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 0.2.2
+
+- Add License badge to README
+- Add bug_tracker_uri to gemspec
+
 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/),
@@ -7,6 +12,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.2.1] - 2026-03-13
+
+### Fixed
+- Fix SyntaxError: setter method `[]=` cannot use endless method definition
+
+## [0.2.0] - 2026-03-13
+
+### Added
+- `keys` method returns all non-expired cache keys
+- `[]` and `[]=` hash-like accessors for get/set
+- `stats` method returns size, hits, misses, and eviction counts
+- `prune` method removes all expired entries and returns count removed
+- Hit/miss/eviction tracking counters (thread-safe)
+
 ## [0.1.0] - 2026-03-10
 
 ### Added

data/README.md

@@ -2,6 +2,7 @@
 
 [![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)
+[![License](https://img.shields.io/github/license/philiprehberger/rb-cache-kit)](LICENSE)
 
 In-memory LRU cache with TTL, tags, and thread safety for Ruby.
 
@@ -68,6 +69,13 @@ cache.set("post:1", data3, tags: ["posts"])
 cache.invalidate_tag("users") # removes user:1 and user:2, keeps post:1
 ```
 
+### Hash-like Access
+
+```ruby
+cache["user:1"] = { name: "Alice" }
+cache["user:1"] # => { name: "Alice" }
+```
+
 ### LRU Eviction
 
 ```ruby
@@ -82,6 +90,27 @@ cache.get("a") # => nil
 cache.get("d") # => 4
 ```
 
+### Pruning Expired Entries
+
+```ruby
+cache.set("a", 1, ttl: 1)
+cache.set("b", 2, ttl: 1)
+cache.set("c", 3)
+# ... after TTL expires ...
+cache.prune # => 2 (removed expired entries)
+```
+
+### Stats
+
+```ruby
+cache.set("a", 1)
+cache.get("a")       # hit
+cache.get("missing") # miss
+
+cache.stats
+# => { size: 1, hits: 1, misses: 1, evictions: 0 }
+```
+
 ## API
 
 | Method | Description |
@@ -95,6 +124,11 @@ cache.get("d") # => 4
 | `Store#clear` | Remove all entries |
 | `Store#size` | Number of entries |
 | `Store#key?(key)` | Check if a key exists and is not expired |
+| `Store#keys` | Returns all non-expired keys |
+| `Store#[](key)` | Hash-like read (alias for `get`) |
+| `Store#[]=(key, value)` | Hash-like write (alias for `set` without TTL/tags) |
+| `Store#stats` | Returns `{ size:, hits:, misses:, evictions: }` |
+| `Store#prune` | Remove all expired entries, returns count removed |
 
 ## Development
 

data/lib/philiprehberger/cache_kit/store.rb

@@ -10,6 +10,9 @@ module Philiprehberger
         @data = {}
         @order = []
         @mutex = Mutex.new
+        @hits = 0
+        @misses = 0
+        @evictions = 0
       end
 
       # Get a value by key. Returns nil if missing or expired.
@@ -17,18 +20,7 @@ module Philiprehberger
       # @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
+        @mutex.synchronize { fetch_entry(key) }
       end
 
       # Store a value.
@@ -65,16 +57,9 @@ module Philiprehberger
         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
+        @mutex.synchronize { @data.key?(key).tap { remove_entry(key) } }
       end
 
       # Invalidate all entries with a given tag.
@@ -90,14 +75,9 @@ module Philiprehberger
         end
       end
 
-      # Clear all entries.
-      #
       # @return [void]
       def clear
-        @mutex.synchronize do
-          @data.clear
-          @order.clear
-        end
+        @mutex.synchronize { @data.clear && @order.clear }
       end
 
       # @return [Integer] number of entries (including expired ones not yet evicted)
@@ -105,15 +85,39 @@ module Philiprehberger
         @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?
+          entry ? !entry.expired? : false
+        end
+      end
+
+      # @return [Array<String>] list of valid keys
+      def keys
+        @mutex.synchronize { @data.reject { |_, entry| entry.expired? }.keys }
+      end
 
-          true
+      # @param key [String]
+      def [](key) = get(key)
+
+      # @param key [String]
+      # @param value the value to cache
+      def []=(key, value)
+        set(key, value)
+      end
+
+      # @return [Hash] stats with :size, :hits, :misses, :evictions
+      def stats
+        @mutex.synchronize { { size: @data.size, hits: @hits, misses: @misses, evictions: @evictions } }
+      end
+
+      # @return [Integer] number of entries removed
+      def prune
+        @mutex.synchronize do
+          expired_keys = @data.select { |_, entry| entry.expired? }.keys
+          expired_keys.each { |k| remove_entry(k) }
+          expired_keys.size
         end
       end
 
@@ -124,9 +128,31 @@ module Philiprehberger
         @order.push(key)
       end
 
+      def fetch_entry(key)
+        entry = @data[key]
+        return record_miss unless entry
+
+        if entry.expired?
+          remove_entry(key)
+          return record_miss
+        end
+
+        @hits += 1
+        touch(key)
+        entry.value
+      end
+
+      def record_miss
+        @misses += 1
+        nil
+      end
+
       def evict
         oldest = @order.first
-        remove_entry(oldest) if oldest
+        return unless oldest
+
+        remove_entry(oldest)
+        @evictions += 1
       end
 
       def remove_entry(key)

data/lib/philiprehberger/cache_kit/version.rb

@@ -2,6 +2,6 @@
 
 module Philiprehberger
   module CacheKit
-    VERSION = "0.1.0"
+    VERSION = "0.2.2"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: philiprehberger-cache_kit
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Philip Rehberger
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-03-10 00:00:00.000000000 Z
+date: 2026-03-16 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.