cache_stache 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 601e9576e81fb4405ca36fe64b4a98ffd4d91f4d599fd77c9f96eec3d3547c18
-  data.tar.gz: a726a516a2cfafb77d404df75276fc7ede6f2534f1f43d56dc0209d6bd805f11
+  metadata.gz: 6d78eea9e2e19c6f95024644eaea2dc942993225c42ca636473e19e46fd6f449
+  data.tar.gz: 6156b5fe4adc1756b1ebf1fe92e413ab16bba3589557e26d17efe3ef2fa18dbf
 SHA512:
-  metadata.gz: 902ed8597f65c59c98f5148923246db46fbd5a97a44bda6bf108c589cd647720d37c75ae67b60f840af1abf40872cf7028d2f9905484d9fa7f980fba8cf90645
-  data.tar.gz: 40f535b5e0e95de053886976858cc2bead62cb8b44246a3e4dcd2ce271b7538dafa7ff0f893bee72b364e29b1a2e98524cd67415545f809dfbe8f99b5413b8f5
+  metadata.gz: b976afa17c53451ea8b6aa57e6d15d88f097f9fd72bc8bd420b91911f06af686f7f7693eee76f9981fd1644b3abd3694c942c6a1e28e764ec97b4148a8062f47
+  data.tar.gz: d31764e21a67a0b2006a59593f1b4757f95a731817d3c8cf0d6af802bef0e7afcbc9e5d0b30f1069d77b6606b60a1f62b6f24315ee9fafb8b77e20a6c71a2ff1

data/README.md

@@ -2,9 +2,9 @@
 
 [![CI](https://github.com/speedshop/cache_stache/actions/workflows/ci.yml/badge.svg)](https://github.com/speedshop/cache_stache/actions/workflows/ci.yml)
 
-CacheStache tracks cache hit rates for Rails apps. It counts how often your cache has data (hits) and how often it does not (misses). You can view these counts on a web page.
+Have you ever had to work with a Redis cache provider which doesn't provide hitrate stats? It's a bummer. Use this gem!
 
-A higher hit rate means your app finds data in the cache more often. This means fewer slow calls to your database or other services. CacheStache helps you see this rate over time and spot problems.
+CacheStache tracks cache hit rates for Rails apps. It counts how often your cache has data (hits) and how often it does not (misses). You can view these counts on a web page.
 
 ## Features
 
@@ -42,7 +42,7 @@ A higher hit rate means your app finds data in the cache more often. This means
 
 4. Restart Rails and go to `/cache-stache`.
 
-### Add a Password (Optional)
+### Add Authentication
 
 You can add a password to the web page:
 
@@ -104,7 +104,7 @@ end
 | `bucket_seconds` | 5 minutes | Size of each time bucket |
 | `retention_seconds` | 7 days | How long to keep data |
 | `max_buckets` | 288 | Maximum number of buckets to query |
-| `sample_rate` | 1.0 | Not yet active |
+| `sample_rate` | 1.0 | Sample events |
 | `enabled` | true | Turn tracking on or off |
 | `use_rack_after_reply` | false | Wait to write until after response |
 
@@ -126,37 +126,6 @@ end
 
 A cache key can match more than one keyspace.
 
-## Web Page
-
-The web page shows:
-
-- Total hit rate
-- Hit rate for each keyspace
-- Current settings
-- Size of stored data
-
-Time windows: 5m, 15m, 1h (default), 6h, 1d, 1w.
-
-Click a keyspace name to see more detail.
-
-## How It Works
-
-```
-Rails.cache.fetch(...)
-  -> Rails sends an event
-  -> CacheStache counts it
-  -> CacheStache stores the count
-  -> Web page shows the counts
-```
-
-1. **Counting**: CacheStache listens for cache events. It skips its own cache calls.
-
-2. **Buckets**: Times are rounded down to `bucket_seconds`. Each event adds to hit or miss counts.
-
-3. **Storage**: Counts are stored with keys like `cache_stache:v1:production:1234567890`. Each bucket expires after `retention_seconds`.
-
-4. **Reading**: The web page reads all buckets and adds them up.
-
 ## Query Stats in Code
 
 You can get stats from Ruby code:
@@ -171,61 +140,7 @@ results[:overall][:misses]            # => 210
 results[:keyspaces][:profiles][:hit_rate_percent]  # => 92.1
 ```
 
-## Test Data
-
-Make fake data with:
-
-```bash
-rails runner lib/cache_stache/bin/test_day_simulation.rb
-```
-
-This makes 24 hours of fake cache events. Then go to `/cache-stache` to see it.
-
 ## Limits
 
-- The `sample_rate` setting does nothing yet.
 - Only cache reads are tracked. Writes and deletes are not.
-- If you have two cache stores of the same type, their events will be mixed.
-
-## Files
-
-```
-lib/cache_stache/
-├── app/               # Web page views and code
-├── bin/               # Test scripts
-├── config/            # Routes
-├── lib/               # Gem/engine Ruby code
-│   ├── cache_stache.rb
-│   ├── cache_stache/
-│   └── generators/
-├── Gemfile            # Standalone bundler entrypoint
-├── cache_stache.gemspec
-├── Rakefile
-├── spec/              # Tests
-├── tasks/             # Rake tasks
-```
-
-## Running Specs (Standalone)
-
-CacheStache can be tested independently from the host Rails app:
-
-```bash
-cd lib/cache_stache
-bundle install
-bundle exec rspec
-```
-
-From the host app root, you can also run the engine suite without `cd`:
-
-```bash
-BUNDLE_GEMFILE=lib/cache_stache/Gemfile bundle exec rspec --options lib/cache_stache/.rspec lib/cache_stache/spec
-```
-
-## Run Tests
-
-```bash
-cd lib/cache_stache
-bundle exec rspec
-```
-
-Tests are in `lib/cache_stache/spec/`. They do not need Redis.
+- If you have two cache stores of the same type (redis, memcached, etc), their events will be mixed.

data/lib/cache_stache/version.rb

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

data/spec/cache_stache_helper.rb

@@ -55,6 +55,7 @@ module CacheStacheTestHelpers
       c.retention_seconds = options.fetch(:retention_seconds, 3600)
       c.sample_rate = options.fetch(:sample_rate, 1.0)
       c.use_rack_after_reply = options.fetch(:use_rack_after_reply, false)
+      c.enabled = options.fetch(:enabled, true)
 
       keyspaces.each do |name, keyspace_config|
         c.keyspace(name) do

data/spec/unit/configuration_spec.rb

@@ -11,6 +11,7 @@ RSpec.describe CacheStache::Configuration do
     before do
       allow(ENV).to receive(:fetch).and_call_original
       allow(ENV).to receive(:fetch).with("CACHE_STACHE_REDIS_URL").and_return(default_redis_url)
+      allow(ENV).to receive(:fetch).with("RAILS_ENV", "development").and_return("development")
     end
 
     it { expect(config.bucket_seconds).to eq(5.minutes.to_i) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cache_stache
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - CacheStache contributors
@@ -13,14 +13,14 @@ dependencies:
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '7.0'
 - !ruby/object:Gem::Dependency