rails-cache-debugger 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d044780076ea1a5444001c65e272ea04c23de3343be4dd80f88b0ae53610a3ca
+  data.tar.gz: 809334f959a100c0cef799cff3f8f7ef356bff39809954e175bba41265d074b0
+SHA512:
+  metadata.gz: e5d889ea1be88fda518f43d646366bdb0744cba581861e8034f46aa8252a7b9b971770c78e2997ee3a277fd24a9eec703aca3d0c921ee538c81705576491aa4b
+  data.tar.gz: 8a2625f6a3faa57d2eaf539f1b9d683a477cb79f29dddb8725a37cc37fe081e0371bb09ba36bdc9bbcfbcbf663e36616add8ad88f0fb5941df787f71d280576b

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-05-22
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Eduardo Wanderley de Siqueira Araújo
+
+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,96 @@
+# Rails Cache Debugger
+
+A gem to help debug Rails cache operations by providing visibility into cache hits, misses, writes, and deletes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails-cache-debugger'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install rails-cache-debugger
+```
+
+## Usage
+
+### Basic Usage
+
+```ruby
+# Configure the debugger (optional)
+Rails::Cache::Debugger.configure do |config|
+  config.enabled = true
+  config.log_events = [
+    "cache_read.active_support",
+    "cache_write.active_support",
+    "cache_fetch_hit.active_support"
+  ]
+end
+
+# Use the debugger
+cache = Rails.cache
+debugger = Rails::Cache::Debugger.new(cache)
+
+# Your cache operations will be automatically logged
+debugger.write("key", "value")
+debugger.read("key")
+debugger.fetch("key") { "value" }
+```
+
+### Output Example
+
+```
+[CacheDebugger] WRITE key: key (1.23ms)
+[CacheDebugger] HIT key: key (0.45ms)
+[CacheDebugger] FETCH_HIT key: key (0.67ms)
+```
+
+### Available Operations
+
+The debugger supports all standard Rails cache operations:
+
+- `read(key, **options)`
+- `write(key, value, **options)`
+- `delete(key, **options)`
+- `exist?(key, **options)`
+- `fetch(key, **options) { block }`
+
+### Configuration Options
+
+```ruby
+Rails::Cache::Debugger.configure do |config|
+  # Enable/disable the debugger
+  config.enabled = true
+
+  # Configure which events to log
+  config.log_events = [
+    "cache_read.active_support",
+    "cache_write.active_support",
+    "cache_fetch_hit.active_support"
+  ]
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at <https://github.com/eduardowanderleyde/rails-cache-debugger>.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/rails/cache/debugger/configuration.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Rails
+  module Cache
+    class Debugger
+      class Configuration
+        attr_accessor :enabled, :log_events
+
+        def initialize
+          @enabled = true
+          @log_events = %w[
+            cache_read.active_support
+            cache_write.active_support
+            cache_fetch_hit.active_support
+          ]
+        end
+      end
+    end
+  end
+end 

data/lib/rails/cache/debugger/railtie.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "rails"
+
+module Rails
+  module Cache
+    class Debugger
+      class Railtie < Rails::Railtie
+        initializer "rails-cache-debugger.setup" do
+          subscriber = Subscriber.new
+
+          %w[
+            cache_read.active_support
+            cache_write.active_support
+            cache_fetch_hit.active_support
+          ].each do |event|
+            ActiveSupport::Notifications.subscribe(event, subscriber)
+          end
+        end
+      end
+    end
+  end
+end 

data/lib/rails/cache/debugger/subscriber.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Rails
+  module Cache
+    class Debugger
+      class Subscriber
+        def call(name, start, finish, _id, payload)
+          return unless configuration.enabled
+          return unless configuration.log_events.include?(name)
+
+          key = payload[:key]
+          duration = ((finish - start) * 1000).round(2)
+
+          case name
+          when "cache_read.active_support"
+            hit = payload[:hit]
+            Debugger.log "#{hit ? 'HIT' : 'MISS'} key: #{key} (#{duration}ms)"
+          when "cache_write.active_support"
+            Debugger.log "WRITE key: #{key} (#{duration}ms)"
+          when "cache_fetch_hit.active_support"
+            Debugger.log "FETCH_HIT key: #{key} (#{duration}ms)"
+          end
+        end
+
+        private
+
+        def configuration
+          Debugger.configuration
+        end
+      end
+    end
+  end
+end 

data/lib/rails/cache/debugger/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Rails
+  module Cache
+    class Debugger
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/rails/cache/debugger.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+require "active_support/cache"
+require "active_support/notifications"
+require_relative "debugger/configuration"
+require_relative "debugger/subscriber"
+require_relative "debugger/railtie"
+
+module Rails
+  module Cache
+    class Debugger
+      class << self
+        def log(message)
+          puts message
+        end
+
+        def configuration
+          @configuration ||= Configuration.new
+        end
+
+        def configure
+          yield configuration
+        end
+      end
+
+      def initialize(cache)
+        @cache = cache
+      end
+
+      def read(key, **options)
+        start_time = Time.now
+        value = @cache.read(key, **options)
+        duration = ((Time.now - start_time) * 1000).round(2)
+        log_cache_event(
+          event: value.nil? ? "cache_read.miss" : "cache_read.hit",
+          key: key,
+          value: value,
+          duration: duration
+        )
+        value
+      end
+
+      def write(key, value, **options)
+        start_time = Time.now
+        result = @cache.write(key, value, **options)
+        duration = ((Time.now - start_time) * 1000).round(2)
+        log_cache_event(
+          event: "cache_write",
+          key: key,
+          value: value,
+          duration: duration
+        )
+        result
+      end
+
+      def delete(key, **options)
+        start_time = Time.now
+        result = @cache.delete(key, **options)
+        duration = ((Time.now - start_time) * 1000).round(2)
+        log_cache_event(
+          event: "cache_delete",
+          key: key,
+          duration: duration
+        )
+        result
+      end
+
+      def exist?(key, **options)
+        start_time = Time.now
+        exists = @cache.exist?(key, **options)
+        duration = ((Time.now - start_time) * 1000).round(2)
+        log_cache_event(
+          event: "cache_exist",
+          key: key,
+          exists: exists,
+          duration: duration
+        )
+        exists
+      end
+
+      def fetch(key, **options)
+        start_time = Time.now
+        value = @cache.read(key, **options)
+        if value.nil?
+          value = yield
+          @cache.write(key, value, **options)
+          duration = ((Time.now - start_time) * 1000).round(2)
+          log_cache_event(
+            event: "cache_fetch.miss",
+            key: key,
+            value: value,
+            duration: duration
+          )
+        else
+          duration = ((Time.now - start_time) * 1000).round(2)
+          log_cache_event(
+            event: "cache_fetch.hit",
+            key: key,
+            value: value,
+            duration: duration
+          )
+        end
+        value
+      end
+
+      private
+
+      def log_cache_event(event:, key:, **details)
+        ActiveSupport::Notifications.instrument(
+          "cache_debugger.#{event}",
+          { key: key }.merge(details)
+        )
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: rails-cache-debugger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Eduardo Wanderley de Siqueira Araújo
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-05-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Provides visibility into Rails cache operations by logging cache hits,
+  misses, writes, and deletes
+email:
+- wanderley.eduardo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/rails/cache/debugger.rb
+- lib/rails/cache/debugger/configuration.rb
+- lib/rails/cache/debugger/railtie.rb
+- lib/rails/cache/debugger/subscriber.rb
+- lib/rails/cache/debugger/version.rb
+homepage: https://github.com/yourusername/rails-cache-debugger
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/yourusername/rails-cache-debugger
+  source_code_uri: https://github.com/yourusername/rails-cache-debugger
+  changelog_uri: https://github.com/yourusername/rails-cache-debugger/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.4.10
+signing_key:
+specification_version: 4
+summary: A gem to help debug Rails cache operations
+test_files: []