kicks 3.0.0.pre → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff0690a8caadf3b1b4c80039e0893f8f2484f29fec0a19278f9d855ace73355a
-  data.tar.gz: 4d69ee1e6a93f08df18cd2abbc8969bb2f7a854be45405a1be0c3c770c2bdd2f
+  metadata.gz: b553911947a5b50df9d2576610c02c448873a359bf8641116c3bdaeb10539fd4
+  data.tar.gz: 8fd78e33555ba42a001781c204ca22e9e875a22d96eb53374dcc1a3d0af2ac06
 SHA512:
-  metadata.gz: e8991f96df285bfff54de0a9ce2bbcee0c8233fc81b8fc66d1ba617061650ea3badd5cc5270aaf2c95ec5103b85079e95e3095f05c7335b9681861cb44f90f0f
-  data.tar.gz: 43d85d3b660bd36802487769b0c518e60998227b418d427c0c69e9ce3748fc2516d574e34e5014fab3d06141d54d707f15d895e6a5648c6558a374e786e4c276
+  metadata.gz: cf96bb1a274d3ad4da6f904c6395156541b750a78d20130226e3404f00f97853a71a0327db11b96193affe54a94217b909600ffb9c9e8527c3bcb5b88e51590b
+  data.tar.gz: 0244cdda5904875397992237239b67649c6c4ef2affb0962a040d8f06849549b816a371280ef870fb04e16db9c768b948c8b96196e75337c3303131b5c333122

data/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

data/.github/workflows/ci.yml

@@ -8,17 +8,15 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: [3.0, 3.1, 3.2]
+        ruby-version: [3.0, 3.1, 3.2, 3.3]
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Install Ruby ${{ matrix.ruby-version }}
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby-version }}
-
-      - name: Install dependencies
-        run: bundle install
+          bundler-cache: true # 'bundle install', cache gems
 
       - name: Run tests
         run: bundle exec rake

data/ChangeLog.md

@@ -1,10 +1,41 @@
 # Change Log
 
-## Changes Between 2.12.0 and 2.13.0 (unreleased)
+## Changes Between 3.1.0 and 3.2.0 (in development)
+
+No changes yet.
+
+
+## Changes Between 3.0.0 and 3.1.0 (Oct 20, 2024)
+
+### ActiveJob Adapter
+
+Kicks now ships with an ActiveJob adapter for Ruby on Rails.
+
+Contributed by dixpac.
+
+GitHub issue: [#12](https://github.com/ruby-amqp/kicks/pull/12)
+
+### Make Queue Binding Optional
+
+It is now possible to opt out of binding of the Kicks-declared exchange and queue.
+
+Contributed by @texpert.
+
+GitHub issue: [#13](https://github.com/ruby-amqp/kicks/pull/13)
+
+
+## Changes Between 2.12.0 and 3.0.0 (Oct 19, 2024)
+
+### New Project Name and Major Version
+
+Kicks was originally developed by @jondot under the [name of Sneakers](https://github.com/jondot/sneakers).
+
+After a group of users and a RabbitMQ core team member have taken over maintenance, it was renamed
+to Kicks and the version was bumped to 3.0 to clearly indicate the split.
 
 ### Minimum Required Ruby Version
 
-Sneakers now requires Ruby 2.5 or later.
+Kicks now requires Ruby 2.5 or later.
 
 ### Content Encoding Support
 
@@ -14,6 +45,7 @@ Contributed by @ansoncat.
 
 GitHub issue: [#449](https://github.com/jondot/sneakers/pull/449)
 
+
 ## Changes Between 2.10.0 and 2.11.0
 
 This releases includes bug fixes, support for more queue-binding options, better

data/Gemfile

@@ -3,6 +3,6 @@ source 'https://rubygems.org'
 gem 'ruby-prof', platforms: [:ruby_22, :ruby_23, :ruby_24]
 
 gem 'rake', '>= 12.3', '< 14.0'
-gem 'metric_fu', github: 'metricfu/metric_fu', branch: 'main'
+gem 'metric_fu', git: 'https://github.com/metricfu/metric_fu', branch: 'main'
 
 gemspec

data/LICENSE.txt

@@ -1,4 +1,5 @@
-Copyright (c) 2013-2016 Dotan Nahum
+Copyright (c) 2013-2023 Dotan Nahum
+Copyright (c) 2023-2024 Kicks Contributors
 
 MIT License
 

data/README.md

@@ -25,20 +25,19 @@ By virtue of its Sneakers lineage, Kicks is a mature project that has been aroun
 Add this line to your application's Gemfile:
 
 ```ruby
-# Important: this name will change once Kicks 3.0.0 (the initial release) is published
-gem 'sneakers'
+gem 'kicks'
 ```
 
 And then execute:
 
 ```shell-session
-$ bundle
+bundle
 ```
 
 Or install it yourself as:
 
 ```shell-session
-$ gem install sneakers
+gem install kicks
 ```
 
 ## Documentation
@@ -57,7 +56,7 @@ Set up a Gemfile
 
 ```ruby
 source 'https://rubygems.org'
-gem 'sneakers'
+gem 'kicks'
 gem 'json'
 gem 'redis'
 ```
@@ -68,6 +67,7 @@ then create a worker named as `Processor`.
 > touch boot.rb
 
 ```ruby
+# Note: the files still use "sneakers" for the name
 require 'sneakers'
 require 'redis'
 require 'json'
@@ -191,7 +191,9 @@ environment needed locally on your development box.
 
 # Compatibility
 
-* Sneakers main branch: Ruby 3.0+
+* Kicks main branch: Ruby 3.0+
+* Kicks 3.1.x branch: Ruby 3.0+
+* Kicks 3.0.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
@@ -204,6 +206,11 @@ Fork, implement, add tests, pull request, get my everlasting thanks and a respec
 
 To all Sneakers [Contributors](https://github.com/jondot/sneakers/graphs/contributors) - you make this happen, thanks!
 
-# Copyright
+## License
 
-Copyright (c) 2015-2018 [Dotan Nahum](http://gplus.to/dotan) [@jondot](http://twitter.com/jondot). See [LICENSE](LICENSE.txt) for further details.
+See [LICENSE](LICENSE.txt) for further details.
+
+## Copyright
+
+Copyright (c) 2023-2024 Kicks contributors
+Copyright (c) 2015-2023 [Dotan Nahum](http://gplus.to/dotan) [@jondot](http://twitter.com/jondot).

data/kicks.gemspec

@@ -13,6 +13,7 @@ Gem::Specification.new do |gem|
   gem.description   = %q( Fast background processing framework for Ruby and RabbitMQ )
   gem.summary       = %q( Fast background processing framework for Ruby and RabbitMQ )
   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")
 
@@ -30,6 +31,8 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'rake', '>= 12.3', '< 14.0'
 
   # for integration environment (see .travis.yml and integration_spec)
+  gem.add_development_dependency 'activejob', '>= 7.1'
+  gem.add_development_dependency 'activesupport', '>= 7.1'
   gem.add_development_dependency 'rabbitmq_http_api_client'
   gem.add_development_dependency 'redis'
 

data/lib/active_job/queue_adapters/sneakers_adapter.rb

@@ -0,0 +1,39 @@
+module ActiveJob
+  module QueueAdapters
+    # Explicitly remove the implementation existing in older rails'.
+    remove_const(:SneakersAdapter) if defined?(:SneakersAdapter)
+
+    # = Sneakers adapter for Active Job
+    #
+    # To use Sneakers set the queue_adapter config to +:sneakers+.
+    #
+    #   Rails.application.config.active_job.queue_adapter = :sneakers
+    class SneakersAdapter < ::ActiveJob::QueueAdapters::AbstractAdapter
+      def initialize
+        @monitor = Monitor.new
+      end
+
+      def enqueue(job)
+        @monitor.synchronize do
+          JobWrapper.from_queue job.queue_name
+          JobWrapper.enqueue ActiveSupport::JSON.encode(job.serialize)
+        end
+      end
+
+      def enqueue_at(job, timestamp)
+        raise NotImplementedError, 'This queueing backend does not support scheduling jobs.'
+      end
+
+      class JobWrapper
+        include Sneakers::Worker
+        from_queue 'default'
+
+        def work(msg)
+          job_data = ActiveSupport::JSON.decode(msg)
+          Base.execute job_data
+          ack!
+        end
+      end
+    end
+  end
+end

data/lib/sneakers/queue.rb

@@ -39,7 +39,8 @@ class Sneakers::Queue
 
     queue = @channel.queue(@name, **@opts[:queue_options])
 
-    if exchange_name.length > 0
+    should_bind = @opts.fetch(:bind, true)
+    if should_bind && exchange_name.length > 0
       routing_keys.each do |key|
         if @opts[:bind_arguments]
           queue.bind(@exchange, routing_key: key, arguments: @opts[:bind_arguments])

data/lib/sneakers/version.rb

@@ -1,3 +1,3 @@
 module Sneakers
-  VERSION = "3.0.0.pre"
+  VERSION = "3.1.0"
 end

data/lib/sneakers.rb

@@ -22,6 +22,8 @@ require 'sneakers/content_encoding'
 require 'sneakers/middleware/config'
 require 'sneakers/worker'
 require 'sneakers/publisher'
+require 'active_job/queue_adapters/sneakers_adapter' if defined?(ActiveJob)
+
 
 module Sneakers
   extend self

data/spec/fixtures/test_job.rb

@@ -0,0 +1,13 @@
+require 'sneakers'
+require 'redis'
+
+redis_addr = compose_or_localhost('redis')
+puts "REDIS is at #{redis_addr}"
+$redis = Redis.new(host: redis_addr)
+
+
+class TestJob < ActiveJob::Base
+  def perform(message)
+    $redis.incr('rails_active_job')
+  end
+end

data/spec/sneakers/active_job_integration_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+require 'sneakers'
+require 'sneakers/runner'
+require 'rabbitmq/http/client'
+require 'active_job'
+require 'active_job/queue_adapters/sneakers_adapter'
+require 'fixtures/test_job'
+
+describe 'ActiveJob integration' do
+  before :each do
+    skip unless ENV['INTEGRATION']
+    prepare
+  end
+
+  def integration_log(msg)
+    puts msg if ENV['INTEGRATION_LOG']
+  end
+
+  def rmq_addr
+    @rmq_addr ||= compose_or_localhost('rabbitmq')
+  end
+
+  def prepare
+    ActiveJob::Base.queue_adapter = :sneakers
+
+    Sneakers.clear!
+    Sneakers.configure(amqp: "amqp://guest:guest@#{rmq_addr}:5672")
+    Sneakers.logger.level = Logger::ERROR
+
+    redis_addr = compose_or_localhost('redis')
+    @redis = Redis.new(host: redis_addr)
+    @redis.del('rails_active_job')
+  end
+
+  def wait_for_jobs_to_finish
+    sleep 5
+  end
+
+  def start_active_job_workers
+    integration_log 'starting ActiveJob workers.'
+    runner = Sneakers::Runner.new([ActiveJob::QueueAdapters::SneakersAdapter::JobWrapper], {})
+
+    pid = fork { runner.run }
+
+    integration_log 'waiting for workers to stabilize (5s).'
+    sleep 5
+
+    yield if block_given?
+  ensure
+    Process.kill('TERM', pid) rescue nil
+  end
+
+  it 'runs jobs enqueued on a listening queue' do
+    start_active_job_workers do
+      TestJob.perform_later('Hello Rails!')
+      wait_for_jobs_to_finish
+      assert_equal @redis.get('rails_active_job').to_i, 1
+    end
+  end
+
+  it 'scheduling jobs are not supported' do
+    assert_raises NotImplementedError, 'This queueing backend does not support scheduling jobs.' do
+      TestJob.set(wait: 1.second).perform_later('Say Hello to Rails later!')
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kicks
 version: !ruby/object:Gem::Version
-  version: 3.0.0.pre
+  version: 3.1.0
 platform: ruby
 authors:
 - Dotan Nahum
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-27 00:00:00.000000000 Z
+date: 2024-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: serverengine
@@ -87,6 +87,34 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '14.0'
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: rabbitmq_http_api_client
   requirement: !ruby/object:Gem::Requirement
@@ -235,6 +263,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
 - ".github/workflows/ci.yml"
 - ".gitignore"
 - ChangeLog.md
@@ -257,6 +286,7 @@ files:
 - examples/title_scraper.rb
 - examples/workflow_worker.rb
 - kicks.gemspec
+- lib/active_job/queue_adapters/sneakers_adapter.rb
 - lib/sneakers.rb
 - lib/sneakers/cli.rb
 - lib/sneakers/concerns/logging.rb
@@ -288,7 +318,9 @@ files:
 - scripts/local_worker
 - spec/fixtures/integration_worker.rb
 - spec/fixtures/require_worker.rb
+- spec/fixtures/test_job.rb
 - spec/gzip_helper.rb
+- spec/sneakers/active_job_integration_spec.rb
 - spec/sneakers/cli_spec.rb
 - spec/sneakers/concerns/logging_spec.rb
 - spec/sneakers/concerns/metrics_spec.rb
@@ -309,7 +341,8 @@ files:
 homepage: https://github.com/ruby-amqp/kicks
 licenses:
 - MIT
-metadata: {}
+metadata:
+  source_code_uri: https://github.com/ruby-amqp/kicks
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -325,14 +358,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Fast background processing framework for Ruby and RabbitMQ
 test_files:
 - spec/fixtures/integration_worker.rb
 - spec/fixtures/require_worker.rb
+- spec/fixtures/test_job.rb
 - spec/gzip_helper.rb
+- spec/sneakers/active_job_integration_spec.rb
 - spec/sneakers/cli_spec.rb
 - spec/sneakers/concerns/logging_spec.rb
 - spec/sneakers/concerns/metrics_spec.rb