philiprehberger-retry_queue 0.2.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0600c2766fa5f18cddf3e2d1287d416798eb18a71a157b822b1857165e01dbb
-  data.tar.gz: db7a3b1b6974ea377786afc0f13fc1a146096e47a123a39c52234b9c027cef5e
+  metadata.gz: 933efd4881279b847d651e774a565205b246ae3859b624cc2715373549664d58
+  data.tar.gz: c24e1b713702a4775248ca23b4e88d08dab9b2e077c0f78ca866ad08ec50a629
 SHA512:
-  metadata.gz: 90c3abf8b7263c80b1ca4537bd3012edd6fbe3c21355cc827288be506bb2d06d0201897d83c24fe038d74fc26b4bf136ac07cf05f9e3565885ad77dbbf931742
-  data.tar.gz: a9561a49edbfaa6c1df8b08c9310cb3074de873f60e225426f57d70e40493c9f3f3d78e1711ce13e9475958fb6570e6476bbc7add8317f9c31f0c8b3a79ed7ff
+  metadata.gz: d17e2e333cbf2cf723ea0bbb2519186a24487fc5fe1fc4410302791ba211292b8092f9d84120a713951d433a3dfb1a237d051a7f5ebe6d31cd47c3f102b93462
+  data.tar.gz: 408fb3f24b0928ecf0438a5773c5fafc6404b73139cecbfe470235bcb5476741197bb402054e8b96b1e480b74f3ac19d6564f569db9bfa0c57e4d7e512c22f72

data/CHANGELOG.md

@@ -7,6 +7,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.4.0] - 2026-04-19
+
+### Added
+- `Result#success_rate` — ratio of succeeded to total items as a Float in `[0.0, 1.0]`; returns `0.0` for empty batches
+
+## [0.3.0] - 2026-04-17
+
+### Added
+- `on_failure:` callback for `process` and `Processor`, invoked with `(item, error)` when an item exhausts retries; hook exceptions are swallowed
+
 ## [0.2.1] - 2026-03-31
 
 ### Changed

data/README.md

@@ -67,6 +67,20 @@ result = Philiprehberger::RetryQueue.process(items, max_retries: 3, on_retry: [l
 end
 ```
 
+### Dead-letter Notifications
+
+```ruby
+on_failure = ->(item, error) { Rails.logger.error("Dead-lettered #{item}: #{error.message}") }
+
+result = Philiprehberger::RetryQueue.process(items, max_retries: 3, on_failure: on_failure) do |item|
+  process_item(item)
+end
+```
+
+The hook fires once per item that exhausts its retries, just as the item is recorded in
+`Result#failed`. Exceptions raised inside the hook are swallowed so a faulty callback cannot
+break the queue.
+
 ### DLQ Reprocessing
 
 ```ruby
@@ -93,14 +107,23 @@ stats = result.stats
 # => { total: 100, succeeded: 97, failed: 3, success_rate: 0.97, elapsed: 1.23 }
 ```
 
+### Success rate
+
+```ruby
+result = Philiprehberger::RetryQueue.process(items, max_retries: 3) { |item| call(item) }
+result.success_rate # => 0.92
+```
+
 ## API
 
 | Method | Description |
 |--------|-------------|
-| `.process(items, max_retries:, concurrency:, backoff:, retry_on:, on_retry:) { \|item\| }` | Process items with retry logic |
+| `.process(items, max_retries:, concurrency:, backoff:, retry_on:, on_retry:, on_failure:) { \|item\| }` | Process items with retry logic |
+| `on_failure:` | Callable `(item, error)` invoked once per item that exhausts retries; hook errors are swallowed |
 | `Result#succeeded` | Array of successfully processed items |
 | `Result#failed` | Array of hashes with `:item`, `:error`, `:attempts` |
 | `Result#stats` | Hash with `:total`, `:succeeded`, `:failed`, `:success_rate`, `:elapsed` |
+| `Result#success_rate` | Float in `[0.0, 1.0]`; ratio of succeeded to total items (`0.0` for empty batches) |
 | `Result#reprocess_failed { \|item, error\| }` | Reprocess failed items, returns a new Result |
 
 ## Development

data/lib/philiprehberger/retry_queue/processor.rb

@@ -12,7 +12,10 @@ module Philiprehberger
       # @param backoff [Proc, nil] proc receiving attempt number, returns sleep duration
       # @param retry_on [Array<Class>, nil] exception classes to retry on; nil means retry all
       # @param on_retry [Array<Proc>, Proc, nil] callbacks fired before each retry attempt
-      def initialize(max_retries: 3, concurrency: 1, backoff: nil, retry_on: nil, on_retry: nil)
+      # @param on_failure [Proc, nil] callable invoked with `(item, error)` once per item that
+      #   exhausts retries and moves to the dead-letter list; exceptions raised by the hook are
+      #   swallowed so a faulty hook cannot break the queue
+      def initialize(max_retries: 3, concurrency: 1, backoff: nil, retry_on: nil, on_retry: nil, on_failure: nil)
         raise Error, 'max_retries must be non-negative' unless max_retries.is_a?(Integer) && max_retries >= 0
 
         @max_retries = max_retries
@@ -20,6 +23,7 @@ module Philiprehberger
         @backoff = backoff || DEFAULT_BACKOFF
         @retry_on = retry_on
         @on_retry_hooks = Array(on_retry)
+        @on_failure = on_failure
       end
 
       # Process a collection of items with retry logic.
@@ -54,6 +58,7 @@ module Philiprehberger
         rescue StandardError => e
           if !retryable?(e) || attempts > @max_retries
             failed << { item: item, error: e, attempts: attempts }
+            fire_on_failure_hook(item, e)
             return
           end
 
@@ -74,6 +79,16 @@ module Philiprehberger
         @on_retry_hooks.each { |hook| hook.call(item, error, attempt) }
       end
 
+      def fire_on_failure_hook(item, error)
+        return if @on_failure.nil?
+
+        @on_failure.call(item, error)
+      rescue StandardError
+        # Swallow hook errors — this is a best-effort notification and must never
+        # break the queue. Intentionally silent; users can log inside their hook.
+        nil
+      end
+
       def now
         Process.clock_gettime(Process::CLOCK_MONOTONIC)
       end

data/lib/philiprehberger/retry_queue/result.rb

@@ -28,11 +28,23 @@ module Philiprehberger
           total: total,
           succeeded: @succeeded.size,
           failed: @failed.size,
-          success_rate: total.zero? ? 0.0 : @succeeded.size.to_f / total,
+          success_rate: success_rate,
           elapsed: @elapsed
         }
       end
 
+      # Ratio of succeeded items to total processed items.
+      #
+      # Returns 0.0 for an empty batch to avoid ZeroDivisionError.
+      #
+      # @return [Float] ratio in the range [0.0, 1.0]
+      def success_rate
+        total = @succeeded.size + @failed.size
+        return 0.0 if total.zero?
+
+        @succeeded.size.to_f / total
+      end
+
       # Reprocess failed items by yielding each item and its last error to the block.
       # Returns a new Result with the reprocessing outcomes.
       #

data/lib/philiprehberger/retry_queue/version.rb

@@ -2,6 +2,6 @@
 
 module Philiprehberger
   module RetryQueue
-    VERSION = '0.2.1'
+    VERSION = '0.4.0'
   end
 end

data/lib/philiprehberger/retry_queue.rb

@@ -16,15 +16,20 @@ module Philiprehberger
     # @param backoff [Proc, nil] custom backoff strategy
     # @param retry_on [Array<Class>, nil] exception classes to retry on; others go straight to failed
     # @param on_retry [Array<Proc>, nil] callbacks fired before each retry attempt
+    # @param on_failure [Proc, nil] callable invoked with `(item, error)` once per item that
+    #   exhausts retries and moves to the dead-letter list; exceptions raised by the hook are
+    #   swallowed so a faulty hook cannot break the queue
     # @yield [item] block that processes a single item
     # @return [Result] processing result
-    def self.process(items, max_retries: 3, concurrency: 1, backoff: nil, retry_on: nil, on_retry: nil, &block)
+    def self.process(items, max_retries: 3, concurrency: 1, backoff: nil, retry_on: nil, on_retry: nil,
+                     on_failure: nil, &block)
       processor = Processor.new(
         max_retries: max_retries,
         concurrency: concurrency,
         backoff: backoff,
         retry_on: retry_on,
-        on_retry: on_retry
+        on_retry: on_retry,
+        on_failure: on_failure
       )
       processor.call(items, &block)
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: philiprehberger-retry_queue
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Philip Rehberger
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-03-31 00:00:00.000000000 Z
+date: 2026-04-20 00:00:00.000000000 Z
 dependencies: []
 description: Processes collections of items with configurable per-item retry logic,
   exponential backoff, and dead letter collection for failed items. Returns detailed
@@ -26,11 +26,11 @@ files:
 - lib/philiprehberger/retry_queue/processor.rb
 - lib/philiprehberger/retry_queue/result.rb
 - lib/philiprehberger/retry_queue/version.rb
-homepage: https://github.com/philiprehberger/rb-retry-queue
+homepage: https://philiprehberger.com/open-source-packages/ruby/philiprehberger-retry_queue
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/philiprehberger/rb-retry-queue
+  homepage_uri: https://philiprehberger.com/open-source-packages/ruby/philiprehberger-retry_queue
   source_code_uri: https://github.com/philiprehberger/rb-retry-queue
   changelog_uri: https://github.com/philiprehberger/rb-retry-queue/blob/main/CHANGELOG.md
   bug_tracker_uri: https://github.com/philiprehberger/rb-retry-queue/issues