kicks 3.3.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7bbca9eba169dacb7dc06c6536049d59ccf469f7c006918850dff45e7f6248a
-  data.tar.gz: a9c635d5d1404a4b090df86217c5ffbd28c7dd2dabf3bed1a7d3403236513528
+  metadata.gz: c3ecabfdb6983f2a20237a579d28d78cf868ada1979b4cd4b0b697d36b02a260
+  data.tar.gz: b8734c3b4a29ee2e2f5d735b0bbf9862391006506372f29b608af46470ec05fe
 SHA512:
-  metadata.gz: 13a7f0407c737d4a263283bd07b44bdba929c23b0e3fe2a724e4c900b9edc5ab60fe1d9695e1fca1b9deba4e6ed435b4a80794ed8f3bf9188335ba1b58c1b373
-  data.tar.gz: 8a0bc7b766d90f3d0789cf5948d2046e7096d9b8ffecd6af9f3dff80166dfcaa948b21b91e10e0172b5a311d2b51b16085f0f0a3e34e2412fc944dfd7a2073a8
+  metadata.gz: 337a21db50e4ff7f8931abdf9eb1ab91a3a3f30d66b242e823e2a62bb93b162260aaab6c1d1b09f239fac46f1f837c2d8d0c9624e21b9500adc64076c20f123d
+  data.tar.gz: 342e9a4ba8bed410c80211cac9df5e1558cbae7e03cf774b3c5d559a3daa75096c3748a2242cb09e35f2194aa2086995cd6f0d6e44058def877b7d83ed6163eb

data/.github/workflows/ci.yml

@@ -1,26 +1,51 @@
 name: CI
 
-on: [push, pull_request]
+on:
+  push:
+    branches:
+      - "main"
+  pull_request:
+    branches:
+      - "main"
 
 jobs:
   tests:
-    name: Ruby ${{ matrix.ruby-version }}
+    name: RabbitMQ ${{ matrix.rabbitmq }}, Ruby ${{ matrix.ruby }}
     runs-on: ubuntu-latest
+
     strategy:
+      fail-fast: false
       matrix:
-        ruby-version:
-          - "3.4.2"
-          - "3.3.7"
-          - "3.2.7"
-          - "3.1.6"
+        ruby:
+          - "4.0"
+          - "3.4"
+          - "3.3"
+          - "3.2"
+          - "3.1"
+        rabbitmq:
+          - "4.2"
+          - "4.1"
+          - "4.0"
+          - "3.13"
+
+    services:
+      rabbitmq:
+        image: rabbitmq:${{ matrix.rabbitmq }}-management
+        ports:
+          - 5672:5672
+          - 15672:15672
+
     steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v7
 
-      - name: Install Ruby ${{ matrix.ruby-version }}
+      - name: Set up Ruby ${{ matrix.ruby }}
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: ${{ matrix.ruby-version }}
-          bundler-cache: true # 'bundle install', cache gems
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Wait for RabbitMQ to start
+        run: sleep 10
 
       - name: Run tests
         run: bundle exec rake

data/AGENTS.md

@@ -2,39 +2,69 @@
 
 ## Overview
 
-Kicks is a high-performance RabbitMQ background processing framework for Ruby,
-a community-driven continuation of the original [Sneakers](https://github.com/jondot/sneakers) project.
-The internal module name is still `Sneakers`.
+Kicks is a fast background processing framework for Ruby and RabbitMQ.
+It was originally developed under the name [Sneakers](https://github.com/jondot/sneakers)
+and later renamed and moved to [`ruby-amqp/kicks`](https://github.com/ruby-amqp/kicks).
 
-Its key dependencies are [Bunny](https://github.com/ruby-amqp/bunny) (a RabbitMQ client that uses AMQP 0-9-1)
-and [ServerEngine](https://github.com/treasure-data/serverengine) for process management.
+Its key dependency is [Bunny](https://github.com/ruby-amqp/bunny), a Ruby AMQP 0-9-1 client for RabbitMQ.
 
 ## Target Ruby Version
 
-This library targets Ruby 3.0 and later versions.
+This library targets Ruby 3.1 and later versions.
 
 ## Build and Test
 
 ```bash
 bundle install
 
-bundle exec rake
+bundle exec rake test
 ```
 
-Tests use Minitest. The default Rake task runs `spec/**/*_spec.rb`.
+To run a specific test file:
+
+```bash
+bundle exec ruby -Ilib -Ispec spec/sneakers/queue_spec.rb
+```
 
 ## Key Files
 
- * `lib/sneakers/worker.rb`: the core `Sneakers::Worker` module (work processing, [delivery acknowledgements](https://www.rabbitmq.com/docs/confirms))
- * `lib/sneakers/configuration.rb`: configuration and defaults
- * `lib/sneakers/queue.rb`: queue declaration and consumer registration
- * `lib/sneakers/runner.rb`: the main runner that spawns and manages workers
- * `lib/sneakers/publisher.rb`: message publishing
- * `lib/sneakers/cli.rb`: CLI, based on Thor
- * `lib/sneakers/handlers/maxretry.rb`: retry handler with error queue support
- * `lib/sneakers/handlers/oneshot.rb`: the default handler
- * `lib/sneakers/version.rb`: `Sneakers::VERSION` constant
- * `lib/active_job/queue_adapters/sneakers_adapter.rb`: an `ActiveJob` adapter for Ruby on Rails
+### Core
+
+ * `lib/sneakers.rb`: top-level module, global configuration, logger setup
+ * `lib/sneakers/queue.rb`: Bunny connection and channel lifecycle, queue and exchange declaration, consumer subscription
+ * `lib/sneakers/worker.rb`: `Sneakers::Worker` module included by worker classes; message dispatch, acknowledgement, error handling
+ * `lib/sneakers/publisher.rb`: message publishing with its own Bunny connection
+ * `lib/sneakers/runner.rb`: worker process runner built on ServerEngine
+ * `lib/sneakers/spawner.rb`: forks worker groups into separate processes
+ * `lib/sneakers/workergroup.rb`: manages a group of workers sharing a connection
+ * `lib/sneakers/configuration.rb`: configuration defaults and option merging
+ * `lib/sneakers/content_type.rb`: pluggable content type serialization/deserialization
+ * `lib/sneakers/content_encoding.rb`: pluggable content encoding (e.g. gzip)
+ * `lib/sneakers/error_reporter.rb`: error reporting interface
+ * `lib/sneakers/cli.rb`: Thor-based CLI (`sneakers work`)
+ * `lib/sneakers/tasks.rb`: Rake tasks for running workers
+ * `lib/sneakers/version.rb`: the `Sneakers::VERSION` constant
+
+### Handlers
+
+ * `lib/sneakers/handlers/oneshot.rb`: basic handler that acks/rejects once (default)
+ * `lib/sneakers/handlers/maxretry.rb`: dead-letter-based retry with configurable max attempts
+
+### Metrics
+
+ * `lib/sneakers/metrics/null_metrics.rb`: no-op (default)
+ * `lib/sneakers/metrics/logging_metrics.rb`: logs metric events
+ * `lib/sneakers/metrics/statsd_metrics.rb`: StatsD integration
+ * `lib/sneakers/metrics/newrelic_metrics.rb`: New Relic integration
+
+### ActiveJob
+
+ * `lib/active_job/queue_adapters/sneakers_adapter.rb`: Rails ActiveJob adapter
+
+### Testing
+
+ * `spec/sneakers/`: test files that mirror the `lib/sneakers/` structure
+ * `spec/sneakers/integration_spec.rb`: integration tests requiring a running RabbitMQ node and `INTEGRATION=1`
 
 ## Comments
 
@@ -52,23 +82,35 @@ existing writing style.
 ### How to Roll (Produce) a New Release
 
 Suppose the current development version in `ChangeLog.md` has
-a `## Changes Between Kicks X.Y.0 and X.(Y+1).0 (in development)` section at the top.
+a `## Changes Between X.Y.0 and X.(Y+1).0 (in development)` section at the top.
 
 To produce a new release:
 
  1. Update `ChangeLog.md`: replace `(in development)` with today's date, e.g. `(Mar 30, 2026)`. Make sure all notable changes since the previous release are listed
  2. Update the version in `lib/sneakers/version.rb` to match (remove the `.pre` suffix)
  3. Commit with the message `X.(Y+1).0` (just the version number, nothing else)
- 4. Tag the commit: `git tag X.(Y+1).0`
- 5. Bump the dev version: add a new `## Changes Between Kicks X.(Y+1).0 and X.(Y+2).0 (in development)` section to `ChangeLog.md` with `No changes yet.` underneath, and update `lib/sneakers/version.rb` to the next dev version with a `.pre` suffix
- 6. Commit with the message `Bump dev version`
- 7. Push: `git push && git push --tags`
+ 4. Tag the commit: `git tag vX.(Y+1).0`
+ 5. Bump the dev version: add a new `## Changes Between X.(Y+1).0 and X.(Y+2).0 (in development)` section to `ChangeLog.md` with `No (documented) changes yet.` underneath, and update `lib/sneakers/version.rb` to the next dev version with a `.pre` suffix
+ 6. Commit with the message `Back to dev version`
+ 7. Push: `git push && git push origin vX.(Y+1).0`
 
 ## Git Instructions
 
+ * Do not commit changes automatically without explicit permission to do so
  * Never add yourself to the list of commit co-authors
  * Never mention yourself in commit messages in any way (no "Generated by", no AI tool links, etc)
 
 ## Style Guide
 
  * Never add full stops to Markdown list items
+
+## After Completing a Task
+
+### Iterative Reviews
+
+After completing a task, perform up to thirty iterative reviews of your changes.
+In every iteration, look for meaningful improvements that were missed, for gaps in test coverage,
+and for deviations from the instructions in this file.
+
+If no meaningful improvements are found for three iterations in a row,
+report it and stop iterating.

data/CLAUDE.md

@@ -0,0 +1 @@
+AGENTS.md

data/ChangeLog.md

@@ -1,5 +1,22 @@
 # Change Log
 
+## Changes Between 3.3.0 and 3.4.0 (Jul 31, 2026)
+
+### Bunny 3.x
+
+Kicks now depends on Bunny `3.x`.
+
+Bunny 3.0 removed `Bunny::VersionedDeliveryTag`, changed the third argument of
+`Bunny::Channel#initialize` to an options hash, and moved topology recovery to
+`Bunny::Session`. None of these affect the Kicks API.
+
+GitHub issue: [#45](https://github.com/ruby-amqp/kicks/issues/45)
+
+### Minimum Required Ruby Version
+
+Kicks now requires Ruby `3.1` or later.
+
+
 ## Changes Between 3.2.0 and 3.3.0 (Mar 31, 2026)
 
 ### Queue Type Inheritance for Retry and Error Queues

data/GEMINI.md

@@ -0,0 +1 @@
+AGENTS.md

data/README.md

@@ -20,6 +20,11 @@ to this "fork" (continuation) under the new name.
 By virtue of its Sneakers lineage, Kicks is a mature project that has been around since 2016.
 
 
+## Supported Ruby Versions
+
+Kicks `3.4.x` and later series target Ruby `3.1` and later versions.
+
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -191,9 +196,9 @@ environment needed locally on your development box.
 
 # Compatibility
 
-* Kicks main branch: Ruby 3.0+
-* Kicks 3.1.x branch: Ruby 3.0+
-* Kicks 3.0.x: Ruby 2.5+
+* Kicks main branch: Ruby 3.1+
+* Kicks 3.4.x and later (using Bunny 3.x): Ruby 3.1+
+* Kicks 3.0.x through 3.3.x (using Bunny 2.x): Ruby 2.5+
 * Sneakers 2.7.x and later (using Bunny 2.9): Ruby 2.2.x
 * Sneakers 1.1.x and later (using Bunny 2.x): Ruby 2.x
 * Sneakers 1.x.x and earlier: Ruby 1.9.x, 2.x
@@ -212,6 +217,6 @@ See [LICENSE](LICENSE.txt) for further details.
 
 ## Copyright
 
-Copyright (c) 2023-2024 Kicks contributors.
+Copyright (c) 2023-2026 Kicks contributors.
 
 Copyright (c) 2015-2023 [Dotan Nahum](http://gplus.to/dotan) [@jondot](http://twitter.com/jondot).

data/kicks.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |gem|
   gem.homepage      = 'https://github.com/ruby-amqp/kicks'
   gem.metadata      = { "source_code_uri" => "https://github.com/ruby-amqp/kicks" }
   gem.license       = 'MIT'
-  gem.required_ruby_version = Gem::Requirement.new(">= 2.5")
+  gem.required_ruby_version = Gem::Requirement.new(">= 3.1")
 
   gem.files         = `git ls-files`.split($/).reject { |f| f == 'Gemfile.lock' }
   gem.executables   = gem.files.grep(/^bin/).
@@ -25,7 +25,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ['lib']
 
   gem.add_dependency 'serverengine', '~> 2.1'
-  gem.add_dependency 'bunny', '~> 2.24'
+  gem.add_dependency 'bunny', '~> 3.0'
   gem.add_dependency 'concurrent-ruby', '~> 1.0'
   gem.add_dependency 'thor'
   gem.add_dependency 'rake', '>= 12.3', '< 14.0'

data/lib/sneakers/version.rb

@@ -1,3 +1,3 @@
 module Sneakers
-  VERSION = "3.3.0"
+  VERSION = "3.4.0"
 end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kicks
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.4.0
 platform: ruby
 authors:
 - Dotan Nahum
 - Michael Klishin
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-04-01 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: serverengine
@@ -31,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.24'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.24'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -267,9 +266,11 @@ files:
 - ".github/workflows/ci.yml"
 - ".gitignore"
 - AGENTS.md
+- CLAUDE.md
 - ChangeLog.md
 - Dockerfile
 - Dockerfile.slim
+- GEMINI.md
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -344,7 +345,6 @@ licenses:
 - MIT
 metadata:
   source_code_uri: https://github.com/ruby-amqp/kicks
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -352,15 +352,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
-signing_key:
+rubygems_version: 4.0.10
 specification_version: 4
 summary: Fast background processing framework for Ruby and RabbitMQ
 test_files: