kicks 3.0.0 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 62b5aae734e0e7237bed20813f45ab770136c2f1a4f5f0c137fabbb7daadacd9
-  data.tar.gz: 2ca16ea532e55ac103d746d13be9a47584f4eecbfbd0c06b4d00e98c52cf3fad
+  metadata.gz: 5ccc9ea63784a73fbeddcce04080502702a7313867998bd41ef1322654a97a88
+  data.tar.gz: f986416420a86a75817fa8ae44750543349b19d1cce5db162d68da9c7d261f8f
 SHA512:
-  metadata.gz: 290d6959875e848c3020237cb0bfc6a0c5da65ee031b25425f1f628f4c9059ae5a2d72e340cc9d6682416ff5c2dbf47d3174c58ecedae82fbdde6c50e80804df
-  data.tar.gz: 8637779203b7f44d6ec0b506c9fba2de3d8ac6419d2772635a6f81044ba925a2d0acbbbd8103b58c090735b86cea8a92608d73550b4d07c862eb1f7916953c7c
+  metadata.gz: ff97a24291dde8fb237d6e54318de1dfdf53a40361dc4172ec117a93027ffc49082e5c041a46617c628073004367985cfc866be356e7592e6fd5913e57ac2a1c
+  data.tar.gz: 819e52775f26c55fede5697467cd7154db41e5ce86f7e00eddeb260e8b1f0e922688bb241b4c71e08fb0a17f98541989fa23963867fd4cbaab6d8f7f2a20339c

data/ChangeLog.md

@@ -1,10 +1,45 @@
 # Change Log
 
-## Changes Between 2.12.0 and 2.13.0 (unreleased)
+## Changes Between 3.1.0 and 3.1.1 (Nov 1, 2024)
+
+### ActiveJob Adapter Compatibility with Ruby on Rails Older Than 7.2
+
+Contributed by @dixpac.
+
+GitHub issue: [#19](https://github.com/ruby-amqp/kicks/pull/19)
+
+
+## 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 +49,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/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

data/kicks.gemspec

@@ -25,12 +25,14 @@ Gem::Specification.new do |gem|
   gem.require_paths = ['lib']
 
   gem.add_dependency 'serverengine', '~> 2.1'
-  gem.add_dependency 'bunny', '~> 2.23'
+  gem.add_dependency 'bunny', '~> 2.19'
   gem.add_dependency 'concurrent-ruby', '~> 1.0'
   gem.add_dependency 'thor'
   gem.add_dependency 'rake', '>= 12.3', '< 14.0'
 
   # for integration environment (see .travis.yml and integration_spec)
+  gem.add_development_dependency 'activejob', '>= 7.2'
+  gem.add_development_dependency 'activesupport', '>= 7.2'
   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,41 @@
+if defined?(ActiveJob) && ActiveJob.version >= "7.2"
+  module ActiveJob
+    module QueueAdapters
+      # Explicitly remove the implementation existing in older Rails versions'.
+      remove_const(:SneakersAdapter) if defined?("::#{name}::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
+end

data/lib/sneakers/version.rb

@@ -1,3 +1,3 @@
 module Sneakers
-  VERSION = "3.0.0"
+  VERSION = "3.1.1"
 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
+  version: 3.1.1
 platform: ruby
 authors:
 - Dotan Nahum
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-19 00:00:00.000000000 Z
+date: 2024-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: serverengine
@@ -31,14 +31,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.23'
+        version: '2.19'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.23'
+        version: '2.19'
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -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.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.2'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.2'
 - !ruby/object:Gem::Dependency
   name: rabbitmq_http_api_client
   requirement: !ruby/object:Gem::Requirement
@@ -258,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
@@ -289,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
@@ -334,7 +365,9 @@ 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