ruby_method_tracer 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 673fbc66c79fb1b2466d43fad6be1f738a8978630073283cda616b179beb8c8d
-  data.tar.gz: 92d557e3061f52f950747fd6a314c22facbd89ff3be790c223f71316ca50a69f
+  metadata.gz: 0065736cb0a7ab6630033102a0d8ac8b1f580247af2a2d900fef370d20c47dd6
+  data.tar.gz: a1570a748f6efab75db30022ae009f0dae2a32a899ce7471f92ba995c34e72ac
 SHA512:
-  metadata.gz: cba38cde9f2ddf19a523abb9b1409832620ad9568b43dfb131bf0243119052134ec7b21e097fa8568d04801d32bf3918747844d87bbff54a4e06a39be3fecc74
-  data.tar.gz: c2f90be756be60ce89ba83348a38feb797922923bbe5434c2f421a492c890f3d51b8eff32b53506958fb554baafed58d7e15758803bbead740ef53b759390c0f
+  metadata.gz: 23e09c2e3c206e25155bbfa5ee4b62fd1e5fc19d02fce8d3c004c6ac5ead1145077c78a87a597b67c06d9f2e06f542b9a8bae3cee7cdb484a8e2bc4319d53824
+  data.tar.gz: bcfdcb7a8a975596b8a7de6b7f91927c6ab3f3060d8f94cac82a289dde0af024cb5efce8736a2a9860551526bd620b53fe1f1f35d89f4185538cd78121b19c16

data/CHANGELOG.md

@@ -1,6 +1,25 @@
 ## [Unreleased]
 
+## [0.2.0] - 2025-11-19
+
+### Added
+- Memory management with `max_calls` option (default: 1000) to prevent unbounded memory growth
+- `clear_results` public method to manually free stored trace data
+- Configurable logger via `logger` option for custom log destinations and formatting
+- Comprehensive test coverage for memory management and logger configuration
+
+### Fixed
+- Removed unnecessary `logger` gem dependency (now uses Ruby standard library)
+- Fixed gemspec URL casing inconsistencies for GitHub links
+
+### Changed
+- Default behavior now automatically limits stored calls to 1000 entries (oldest removed when exceeded)
+- Documentation updated with new configuration options and advanced usage examples
+
+## [0.1.1] - 2025-09-16
+
+- Bug fixes and improvements
+
 ## [0.1.0] - 2025-09-03
-## [0.1.0] - 2025-09-16
 
 - Initial release

data/README.md

@@ -12,35 +12,38 @@ RubyMethodTracer is a lightweight Ruby mixin for targeted method tracing. It wra
 
 ## Installation
 
-This project has not yet been published to RubyGems.
-
-Add it to your Gemfile directly from GitHub:
+Add this line to your application's Gemfile:
 
 ```ruby
-# Gemfile
-gem "ruby_method_tracer", github: "Seunadex/ruby_method_tracer"
+gem "ruby_method_tracer"
 ```
 
-Then install:
+And then execute:
 
 ```bash
 bundle install
 ```
 
+Or install it yourself as:
+
+```bash
+gem install ruby_method_tracer
+```
+
 For local development or experimentation:
 
 ```bash
 git clone https://github.com/Seunadex/ruby_method_tracer.git
-cd method_tracer
+cd ruby_method_tracer
 bundle exec rake install
 ```
 
 ## Usage
 
+### Example 1
 Include `RubyMethodTracer` in any class whose instance methods you want to observe. Register the target methods with optional settings.
 
 ```ruby
-require "ruby_method_tracer"
 
 class Worker
   include RubyMethodTracer
@@ -83,12 +86,52 @@ pp tracer.fetch_results
 #        { method_name: "Worker#perform", execution_time: 0.0063, status: :success, ... }
 #      ]
 #    }
+
+# Clear results when needed to free memory
+tracer.clear_results
+```
+
+### Example 2
+
+```ruby
+class OrderProcessor
+  include RubyMethodTracer
+
+  def process_order(order)
+    # ... perform work ...
+  end
+
+  trace_methods :process_order, auto_output: true
+end
 ```
 
+### Example 3: Advanced Configuration
+
+```ruby
+# Use a custom logger to write traces to a file
+custom_logger = Logger.new('trace.log')
+custom_logger.level = Logger::INFO
+
+tracer = RubyMethodTracer::SimpleTracer.new(
+  MyService,
+  threshold: 0.01,           # Only record calls over 10ms
+  auto_output: true,         # Log each call
+  max_calls: 500,            # Keep only last 500 calls in memory
+  logger: custom_logger      # Use custom logger
+)
+tracer.trace_method(:expensive_operation)
+
+# Later, clear results to free memory
+tracer.clear_results
+```
+
+
 ### Options
 
 - `threshold` (Float, default `0.001`): minimum duration (in seconds) to record.
 - `auto_output` (Boolean, default `false`): emit a log line using `Logger` for each recorded call.
+- `max_calls` (Integer, default `1000`): maximum number of calls to store in memory. When exceeded, the oldest calls are automatically removed to prevent memory leaks.
+- `logger` (Logger, default `Logger.new($stdout)`): custom logger instance for output. Useful for directing logs to files or custom log handlers.
 
 ## Development
 

data/lib/ruby_method_tracer/simple_tracer.rb

@@ -12,6 +12,8 @@ module RubyMethodTracer
   # Options:
   # - :threshold (Float): Minimum duration in seconds to record; defaults to 0.001 (1ms).
   # - :auto_output (Boolean): When true, prints each call summary; defaults to false.
+  # - :max_calls (Integer): Maximum number of calls to store; defaults to 1000. When exceeded, oldest calls are removed.
+  # - :logger (Logger): Custom logger instance; defaults to Logger.new($stdout).
   #
   # Usage:
   #   tracer = RubyMethodTracer::SimpleTracer.new(MyClass, threshold: 0.005)
@@ -24,7 +26,7 @@ module RubyMethodTracer
       @calls = []
       @lock  = Mutex.new # Mutex to make writes to @calls thread safe.
       @wrapped_methods = Set.new
-      @logger = Logger.new($stdout)
+      @logger = @options[:logger] || Logger.new($stdout)
     end
 
     def trace_method(name)
@@ -56,7 +58,11 @@ module RubyMethodTracer
         timestamp: Time.now
       }
 
-      @lock.synchronize { @calls << call_details } # Thread safe append to shared results arrray.
+      @lock.synchronize do
+        @calls << call_details
+        # Enforce max_calls limit by removing oldesst entries
+        @calls.shift if @calls.size > @options[:max_calls]
+      end
 
       output_call(call_details) if @options[:auto_output]
     end
@@ -72,12 +78,18 @@ module RubyMethodTracer
       }
     end
 
+    def clear_results
+      @lock.synchronize { @calls.clear }
+    end
+
     private
 
     def default_options
       {
         threshold: 0.001,
-        auto_output: false
+        auto_output: false,
+        max_calls: 1000,
+        logger: nil
       }
     end
 

data/lib/ruby_method_tracer/version.rb

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

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: ruby_method_tracer
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Seun Adekunle
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-10-12 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: logger
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.7.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.7.0
+date: 2025-11-19 00:00:00.000000000 Z
+dependencies: []
 description: A developer-friendly gem for tracing method calls, execution times, with
   minimal overhead.
 email:
@@ -43,14 +29,14 @@ files:
 - lib/ruby_method_tracer/simple_tracer.rb
 - lib/ruby_method_tracer/version.rb
 - sig/ruby_method_tracer.rbs
-homepage: https://github.com/seunadex/ruby_method_tracer
+homepage: https://github.com/Seunadex/ruby_method_tracer
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/Seunadex/ruby_method_tracer/blob/main/README.md
-  source_code_uri: https://github.com/seunadex/ruby_method_tracer
-  changelog_uri: https://github.com/seunadex/ruby_method_tracer/blob/main/CHANGELOG.md
+  source_code_uri: https://github.com/Seunadex/ruby_method_tracer
+  changelog_uri: https://github.com/Seunadex/ruby_method_tracer/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []