cache_stache 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d75f242cecde072c5db6fe680a47fcb3b98165a4d12cf46738d64b0c0956c7ef
-  data.tar.gz: 86c3c5b676cb94ea1427cbed332f8fc97b2dac235ce22c031511a8ad1014d8b8
+  metadata.gz: 3b3e76904376faf81f690f9b8fd24d63c368295e9c133304b3c16bf0f6e48c6d
+  data.tar.gz: 3b23acace11232c359d8d9185946fcb595315ce89e4eacd5b9386de8290e9e71
 SHA512:
-  metadata.gz: a4997e8c87c2cb1b974eeac87489b5ad6344adef9dd632d0c1f80429f4aae49edbe76ca4b70557d201a309575f8369a9f361207556c7bb6758630adf6240d174
-  data.tar.gz: 623d1edd5b5a304e7839133d9bc4ae9fc9d8f1d67ec76d893df77c6ff506e6c5322b37c657eac5f42d9cbe617f689def250b4974f150f0a0d668348f00766709
+  metadata.gz: 0ed34798119cada11fbbf64f51a61a291e725288dba4fd4bc82353a1feca9adfbf3f654c1070c7664b3e4397f0d2f48cb6ca504cb4963d2a62d7af639fd68c16
+  data.tar.gz: 49d081eec0e40ae8d2dddb6159aef9b5524d369770d7826981b0e6a2da2c3cae90c50e6ae34ce7b263f76487ea6aa59a51d55a788c2884caa4f7a35108a685ef

data/CHANGELOG.md

@@ -0,0 +1,34 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.2.1]
+
+### Fixed
+
+- Fixed Redis calls when `bucket_seconds` or `retention_seconds` are configured with `ActiveSupport::Duration` values
+
+## [0.2.0]
+
+### Changed
+
+- **Breaking:** Replaced `redis_url` config option with `redis`, which accepts a Proc, String URL, or Redis-compatible object
+
+## [0.1.1]
+
+- Fixed Rails dependency to be >=, not ~>
+
+## [0.1.0]
+
+### Added
+
+- Initial release
+- Cache hit/miss rate tracking via Rails instrumentation
+- Redis-backed statistics storage
+- Dashboard UI for viewing cache metrics
+- Keyspace breakdown view
+- Configurable time windows (minute, hour, day)
+- Rake tasks for cache statistics

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Nate Berkopec
+
+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/lib/cache_stache/cache_client.rb

@@ -39,7 +39,7 @@ module CacheStache
           redis.eval(
             INCR_AND_EXPIRE_SCRIPT,
             keys: [key],
-            argv: [@config.retention_seconds, increments.to_json]
+            argv: [retention_seconds, increments.to_json]
           )
         end
       end
@@ -79,16 +79,16 @@ module CacheStache
     def store_config_metadata
       key = "cache_stache:v1:#{@config.rails_env}:config"
       metadata = {
-        bucket_seconds: @config.bucket_seconds,
-        retention_seconds: @config.retention_seconds,
+        bucket_seconds: @config.bucket_seconds.to_i,
+        retention_seconds: retention_seconds,
         updated_at: Time.current.to_i
       }
 
       without_instrumentation do
         @pool.with do |redis|
           # Use SETEX for atomic set-with-expiry (single command)
-          Rails.logger.debug { "CacheStache: Redis SETEX #{key} #{@config.retention_seconds}" }
-          redis.setex(key, @config.retention_seconds, metadata.to_json)
+          Rails.logger.debug { "CacheStache: Redis SETEX #{key} #{retention_seconds}" }
+          redis.setex(key, retention_seconds, metadata.to_json)
         end
       end
     rescue => e
@@ -164,6 +164,10 @@ module CacheStache
       end
     end
 
+    def retention_seconds
+      @config.retention_seconds.to_i
+    end
+
     def bucket_key(timestamp)
       "cache_stache:v1:#{@config.rails_env}:#{timestamp}"
     end

data/lib/cache_stache/configuration.rb

@@ -7,13 +7,13 @@ module CacheStache
   class Configuration
     DEFAULT_REDIS_OPTIONS = {reconnect_attempts: 0}.freeze
 
-    attr_accessor :bucket_seconds, :retention_seconds, :sample_rate, :enabled,
-      :redis, :redis_pool_size, :use_rack_after_reply, :max_buckets
-    attr_reader :keyspaces
+    attr_accessor :sample_rate, :enabled, :redis, :redis_pool_size,
+      :use_rack_after_reply, :max_buckets
+    attr_reader :bucket_seconds, :retention_seconds, :keyspaces
 
     def initialize
-      @bucket_seconds = 5.minutes.to_i
-      @retention_seconds = 7.days.to_i
+      self.bucket_seconds = 5.minutes
+      self.retention_seconds = 7.days
       @sample_rate = 1.0
       @enabled = rails_env != "test"
       @use_rack_after_reply = false
@@ -33,6 +33,14 @@ module CacheStache
     #   :redis  String  ->  Redis.new(url: redis)
     #   :redis  Object  ->  redis (assumed to be a Redis-compatible client)
     #
+    def bucket_seconds=(value)
+      @bucket_seconds = value.to_i
+    end
+
+    def retention_seconds=(value)
+      @retention_seconds = value.to_i
+    end
+
     def build_redis
       case redis
       when Proc

data/lib/cache_stache/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CacheStache
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/spec/unit/cache_client_spec.rb

@@ -75,6 +75,17 @@ RSpec.describe CacheStache::CacheClient do
       expect(ttl).to be <= config.retention_seconds
     end
 
+    it "increments stats when retention is configured with ActiveSupport::Duration" do
+      duration_config = build_test_config(retention_seconds: 7.days)
+      duration_client = described_class.new(duration_config)
+
+      duration_client.increment_stats(bucket_ts, increments)
+
+      buckets = duration_client.fetch_buckets(bucket_ts - 100, bucket_ts + 100)
+      expect(buckets.size).to eq(1)
+      expect(buckets.first[:stats]["overall:hits"]).to eq(1.0)
+    end
+
     it "handles errors gracefully" do
       # Create client, then make the pool raise errors
       test_client = described_class.new(config)
@@ -168,6 +179,17 @@ RSpec.describe CacheStache::CacheClient do
       expect(metadata["updated_at"]).to be_a(Integer)
     end
 
+    it "stores configuration metadata when durations use ActiveSupport::Duration" do
+      duration_config = build_test_config(bucket_seconds: 5.minutes, retention_seconds: 7.days)
+      duration_client = described_class.new(duration_config)
+
+      duration_client.store_config_metadata
+      metadata = duration_client.fetch_config_metadata
+
+      expect(metadata["bucket_seconds"]).to eq(5.minutes.to_i)
+      expect(metadata["retention_seconds"]).to eq(7.days.to_i)
+    end
+
     it "handles errors gracefully" do
       # Create client, then make the pool raise errors
       test_client = described_class.new(config)

data/spec/unit/configuration_spec.rb

@@ -24,6 +24,20 @@ RSpec.describe CacheStache::Configuration do
     it { expect(config.keyspaces).to eq([]) }
   end
 
+  describe "duration settings" do
+    it "coerces bucket_seconds to integer seconds" do
+      config.bucket_seconds = 5.minutes
+
+      expect(config.bucket_seconds).to eq(300)
+    end
+
+    it "coerces retention_seconds to integer seconds" do
+      config.retention_seconds = 7.days
+
+      expect(config.retention_seconds).to eq(604_800)
+    end
+  end
+
   describe "#build_redis" do
     it "calls the proc when redis is a Proc" do
       redis_instance = instance_double(Redis)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cache_stache
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - CacheStache contributors
@@ -155,6 +155,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- LICENSE.txt
 - README.md
 - app/assets/stylesheets/cache_stache/application.css
 - app/assets/stylesheets/cache_stache/pico.css