cache_inspector 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 72b484d154e9c4745bbe02887ca73aeef4db58a0f9261edc1b1e62602a1413e7
+  data.tar.gz: db5cce0ba7e6eee21e744efdffc83a9882003d3fe7acb05a5269ffab06b07d17
+SHA512:
+  metadata.gz: 8d16b5ba5b95487cd95ef0471514f2ae21efc462f5145c2af582490869e34c2b3e88145e7cd1298964a9a7070599f1f2c6af61b2dca00d22affabfdcf32ae28c
+  data.tar.gz: d136d30fd716f880241935603a0ee28e5657236c09c28e7d3c8bbc40d921ca9b3efc693a67400954c98127a181c323035c0b7d65e234385522206d20df7d71d3

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-11-02
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Chitradevi36
+
+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,13 @@
+# 🧠 CacheInspector
+
+Track and debug cache usage in Rails — see every cache hit, miss, and write.
+
+---
+
+## 💎 Installation
+
+Add to your Gemfile:
+
+```ruby
+gem "cache_inspector"
+```

data/Rakefile

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+desc "Build gem"
+task :build do
+  sh "gem build cache_inspector.gemspec"
+end
+
+desc "Release gem to RubyGems"
+task :release do
+  version = File.read("lib/cache_inspector/version.rb")[/VERSION\s*=\s*["'](.+?)["']/, 1]
+  abort("Version not found") unless version
+  sh "gem build cache_inspector.gemspec"
+  sh "git add . && git commit -m 'Release v#{version}' || true"
+  sh "git tag v#{version}"
+  sh "git push origin main --tags"
+  sh "gem push cache_inspector-#{version}.gem"
+end

data/config/initializers/cache_inspector.rb

@@ -0,0 +1,6 @@
+CacheInspector.configure do |config|
+  config.enabled_environments = %i[development test]
+  config.warn_large_size_kb   = 100   # warn if payload > 100KB
+  config.log_payloads         = false
+  config.log_prefix           = "[CacheInspector]"
+end

data/lib/cache_inspector/config.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+module CacheInspector
+  class Config
+    attr_accessor :enabled_environments, :log_prefix, :warn_large_size_kb, :log_payloads
+
+    def initialize
+      @enabled_environments = %i[development test]
+      @log_prefix           = "[CacheInspector]"
+      @warn_large_size_kb   = 100  # warn if payload > 100 KB
+      @log_payloads         = false
+    end
+
+    def enabled?(env)
+      @enabled_environments.map(&:to_sym).include?(env.to_sym)
+    end
+  end
+end

data/lib/cache_inspector/subscriber.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+require "active_support/notifications"
+
+module CacheInspector
+  module Subscriber
+    EVENTS = %w[
+      cache_read.active_support
+      cache_generate.active_support
+      cache_write.active_support
+      cache_delete.active_support
+      cache_fetch_hit.active_support
+    ].freeze
+
+    def self.install!(config)
+      return if @installed
+
+      @config = config
+
+      EVENTS.each do |event|
+        ActiveSupport::Notifications.subscribe(event) do |*args|
+          event_obj = ActiveSupport::Notifications::Event.new(*args)
+          handle_event(event, event_obj)
+        end
+      end
+
+      @installed = true
+    end
+
+    def self.handle_event(event, e)
+      env = rails_env
+      return unless @config.enabled?(env)
+
+      key = e.payload[:key]
+      value = e.payload[:value]
+      size_kb = value.to_s.bytesize / 1024.0 if value
+
+      msg = "#{@config.log_prefix} #{event} key=#{key}"
+
+      case event
+      when "cache_fetch_hit.active_support"
+        msg << " (hit)"
+      when "cache_generate.active_support"
+        msg << " (miss -> generating)"
+      when "cache_write.active_support"
+        msg << " (write)"
+        if size_kb && size_kb > @config.warn_large_size_kb
+          msg << " ⚠️ large write: #{size_kb.round(1)}KB"
+        end
+      end
+
+      if @config.log_payloads && value
+        msg << " payload=#{truncate(value.inspect)}"
+      end
+
+      logger.info(msg)
+    end
+
+    def self.truncate(str, max = 150)
+      str.length > max ? "#{str[0..max]}..." : str
+    end
+
+    def self.logger
+      if defined?(Rails) && Rails.respond_to?(:logger)
+        Rails.logger
+      else
+        @logger ||= Logger.new($stdout)
+      end
+    end
+
+    def self.rails_env
+      if defined?(Rails)
+        Rails.env.to_sym
+      else
+        (ENV["RACK_ENV"] || "development").to_sym
+      end
+    end
+  end
+end

data/lib/cache_inspector/version.rb

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

data/lib/cache_inspector.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+require "cache_inspector/version"
+require "cache_inspector/config"
+require "cache_inspector/subscriber"
+
+module CacheInspector
+  class << self
+    def config
+      @config ||= Config.new
+    end
+
+    def configure
+      yield config
+      self
+    end
+
+    def install!
+      Subscriber.install!(config)
+      self
+    end
+  end
+end
+
+# Auto-install in Rails
+if defined?(Rails::Railtie)
+  class CacheInspector::Railtie < Rails::Railtie
+    initializer "cache_inspector.install" do
+      CacheInspector.install!
+    end
+  end
+end

data/sig/cache_inspector.rbs

@@ -0,0 +1,4 @@
+module CacheInspector
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: cache_inspector
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chitradevi36
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2025-11-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.2'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+description: CacheInspector hooks into Rails cache events to log hits, misses, and
+  large writes for debugging and performance tuning.
+email:
+- chitra.rajaguru123@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- config/initializers/cache_inspector.rb
+- lib/cache_inspector.rb
+- lib/cache_inspector/config.rb
+- lib/cache_inspector/subscriber.rb
+- lib/cache_inspector/version.rb
+- sig/cache_inspector.rbs
+homepage: https://github.com/Chitradevi36/cache_inspector
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/Chitradevi36/cache_inspector
+  source_code_uri: https://github.com/Chitradevi36/cache_inspector
+  changelog_uri: https://github.com/Chitradevi36/cache_inspector/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key: 
+specification_version: 4
+summary: Inspect and monitor cache hits, misses, and writes in Rails.
+test_files: []