kicks 3.1.1 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ccc9ea63784a73fbeddcce04080502702a7313867998bd41ef1322654a97a88
-  data.tar.gz: f986416420a86a75817fa8ae44750543349b19d1cce5db162d68da9c7d261f8f
+  metadata.gz: 7899bb171d5e5399547c0b02c33753e23bc8cfaec63e614baa84cd473448a45d
+  data.tar.gz: 3b5b708557aae6c815a2ad23cf86115e5d39ad397cd1e52099ed2e621b26848a
 SHA512:
-  metadata.gz: ff97a24291dde8fb237d6e54318de1dfdf53a40361dc4172ec117a93027ffc49082e5c041a46617c628073004367985cfc866be356e7592e6fd5913e57ac2a1c
-  data.tar.gz: 819e52775f26c55fede5697467cd7154db41e5ce86f7e00eddeb260e8b1f0e922688bb241b4c71e08fb0a17f98541989fa23963867fd4cbaab6d8f7f2a20339c
+  metadata.gz: 57565fbb9e74e4b990f62e482293ff41cdffebb0b75875b4c654a34e4bb6ed037e2cc9305f15c1c6920e789749a484403badbc2f7aad58b811d614b0d2e51080
+  data.tar.gz: e6516ab5c10e167a1e94b0a80f82b68dbe330be53603d4cc7132104e0827f013c3cc930b1f3fe2ecc5f2f65a6cbf140707ccd3bd709fbae5ae0eae0747e2b8d7

data/ChangeLog.md

@@ -1,12 +1,29 @@
 # Change Log
 
-## Changes Between 3.1.0 and 3.1.1 (Nov 1, 2024)
+## Changes Between 3.2.0 and 3.3.0 (in development)
+
+No (documented) changes yet.
+
+
+## Changes Between 3.1.0 and 3.2.0 (Jan 26, 2025)
+
+### Improved Support for Bring-Your-Own-Connection (BYOC)
+
+Kicks now supports a callable (e.g. a proc) to be passed for an externally-initialized
+and managed Bunny connection. In this case, it is entirely up to the caller
+to configure the connection and call `Bunny::Session#start` on it
+at the right moment.
+
+Contributed by @tie.
+
+GitHub issue: [#29](https://github.com/ruby-amqp/kicks/pull/29)
+
 
 ### 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)
+GitHub issues: [#19](https://github.com/ruby-amqp/kicks/pull/19), [#28](https://github.com/ruby-amqp/kicks/pull/28)
 
 
 ## Changes Between 3.0.0 and 3.1.0 (Oct 20, 2024)
@@ -15,7 +32,7 @@ GitHub issue: [#19](https://github.com/ruby-amqp/kicks/pull/19)
 
 Kicks now ships with an ActiveJob adapter for Ruby on Rails.
 
-Contributed by @dixpac.
+Contributed by dixpac.
 
 GitHub issue: [#12](https://github.com/ruby-amqp/kicks/pull/12)
 

data/README.md

@@ -212,5 +212,6 @@ See [LICENSE](LICENSE.txt) for further details.
 
 ## Copyright
 
-Copyright (c) 2023-2024 Kicks contributors
+Copyright (c) 2023-2024 Kicks contributors.
+
 Copyright (c) 2015-2023 [Dotan Nahum](http://gplus.to/dotan) [@jondot](http://twitter.com/jondot).

data/lib/active_job/queue_adapters/sneakers_adapter.rb

@@ -1,39 +1,37 @@
-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")
+module ActiveJob
+  module QueueAdapters
+    # Explicitly remove the implementation existing in older Rails versions'.
+    remove_const(:SneakersAdapter) if const_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
+    # = 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
+      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
+      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
+      def enqueue_at(job, timestamp)
+        raise NotImplementedError, 'This queueing backend does not support scheduling jobs.'
+      end
 
-        class JobWrapper
-          include Sneakers::Worker
-          from_queue 'default'
+      class JobWrapper
+        include Sneakers::Worker
+        from_queue 'default'
 
-          def work(msg)
-            job_data = ActiveSupport::JSON.decode(msg)
-            Base.execute job_data
-            ack!
-          end
+        def work(msg)
+          job_data = ActiveSupport::JSON.decode(msg)
+          Base.execute job_data
+          ack!
         end
       end
     end

data/lib/sneakers/configuration.rb

@@ -5,7 +5,7 @@ module Sneakers
   class Configuration
 
     extend Forwardable
-    def_delegators :@hash, :to_hash, :[], :[]=, :==, :fetch, :delete, :has_key?
+    def_delegators :@hash, :to_hash, :[], :[]=, :==, :fetch, :delete, :has_key?, :dig
 
     EXCHANGE_OPTION_DEFAULTS = {
       :type               => :direct,

data/lib/sneakers/handlers/maxretry.rb

@@ -84,8 +84,12 @@ module Sneakers
 
       def self.configure_queue(name, opts)
         retry_name = opts.fetch(:retry_exchange, "#{name}-retry")
-        opt_args = opts[:queue_options][:arguments] ? opts[:queue_options][:arguments].inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo} : {}
-        opts[:queue_options][:arguments] = { :'x-dead-letter-exchange' => retry_name }.merge(opt_args)
+        opt_args = if opts.dig(:queue_options, :arguments).blank?
+                    {}
+                   else
+                    opts.dig(:queue_options, :arguments).transform_keys(&:to_sym)
+                   end
+        opts[:queue_options][:arguments] = { :'x-dead-letter-exchange' => retry_name }.merge!(opt_args)
         opts[:queue_options]
       end
 

data/lib/sneakers/publisher.rb

@@ -6,9 +6,6 @@ module Sneakers
     def initialize(opts = {})
       @mutex = Mutex.new
       @opts = Sneakers::CONFIG.merge(opts)
-      # If we've already got a bunny object, use it.  This allows people to
-      # specify all kinds of options we don't need to know about (e.g. for ssl).
-      @bunny = @opts[:connection]
     end
 
     def publish(msg, options = {})
@@ -29,8 +26,15 @@ module Sneakers
 
   private
     def connect!
-      @bunny ||= create_bunny_connection
-      @bunny.start
+      # If we've already got a bunny object, use it.  This allows people to
+      # specify all kinds of options we don't need to know about (e.g. for ssl).
+      @bunny = @opts[:connection]
+      if @bunny.respond_to?(:call)
+        @bunny = @bunny.call
+      else
+        @bunny ||= create_bunny_connection
+        @bunny.start
+      end
       @channel = @bunny.create_channel
       @exchange = @channel.exchange(@opts[:exchange], **@opts[:exchange_options])
     end

data/lib/sneakers/queue.rb

@@ -19,8 +19,12 @@ class Sneakers::Queue
     # If we've already got a bunny object, use it.  This allows people to
     # specify all kinds of options we don't need to know about (e.g. for ssl).
     @bunny = @opts[:connection]
-    @bunny ||= create_bunny_connection
-    @bunny.start
+    if @bunny.respond_to?(:call)
+      @bunny = @bunny.call
+    else
+      @bunny ||= create_bunny_connection
+      @bunny.start
+    end
 
     @channel = @bunny.create_channel
     @channel.prefetch(@opts[:prefetch])

data/lib/sneakers/version.rb

@@ -1,3 +1,3 @@
 module Sneakers
-  VERSION = "3.1.1"
+  VERSION = "3.2.0"
 end

data/spec/sneakers/publisher_spec.rb

@@ -122,19 +122,44 @@ describe Sneakers::Publisher do
           durable: false
         )
         @existing_session = existing_session
+        @exchange = exchange
+        @channel = channel
       end
 
-      it 'can handle an existing connection that is offline' do
+      it 'can handle an existing connection object' do
         p = Sneakers::Publisher.new
         p.publish('test msg', my_vars)
         _(p.instance_variable_get(:@bunny)).must_equal @existing_session
       end
 
+      it 'can handle an existing connection function' do
+        @existing_session.start
+        p = Sneakers::Publisher.new(connection: ->() { @existing_session })
+        p.publish('test msg', my_vars)
+        _(p.instance_variable_get(:@bunny)).must_equal @existing_session
+      end
+
       it 'can handle an existing connection that is online' do
+        p = Sneakers::Publisher.new
+        p.publish('test msg', my_vars)
+        _(p.instance_variable_get(:@bunny)).must_equal @existing_session
         mock(@existing_session).connected? { true }
+        mock(@exchange).publish('test msg 2', my_vars)
+        p.publish('test msg 2', my_vars)
+      end
+
+      it 'can handle an existing connection that goes offline' do
         p = Sneakers::Publisher.new
         p.publish('test msg', my_vars)
         _(p.instance_variable_get(:@bunny)).must_equal @existing_session
+        mock(@existing_session).connected? { false }
+        mock(@existing_session).start
+        mock(@existing_session).create_channel { @channel }
+        mock(@channel).exchange('another_exchange', type: :topic, durable: false, :auto_delete => false, arguments: { 'x-arg' => 'value' }) do
+          @exchange
+        end
+        mock(@exchange).publish('test msg 2', my_vars)
+        p.publish('test msg 2', my_vars)
       end
     end
 

data/spec/sneakers/queue_spec.rb

@@ -150,19 +150,24 @@ describe Sneakers::Queue do
                                :type => :direct,
                                :durable => true,
                                :arguments => { 'x-arg' => 'value' }){ @mkex }
-
-        queue_name = 'foo'
-        mock(@mkchan).queue(queue_name, :durable => true) { @mkqueue }
-        mock(@mkqueue).bind(@mkex, :routing_key => queue_name)
+        mock(@mkchan).queue('foo', :durable => true) { @mkqueue }
+        mock(@mkqueue).bind(@mkex, :routing_key => 'foo')
         mock(@mkqueue).subscribe(:block => false, :manual_ack => true)
-
-        my_vars = queue_vars.merge(:connection => @external_connection)
-        @q = Sneakers::Queue.new(queue_name, my_vars)
       end
 
       it 'uses that object' do
-        @q.subscribe(@mkworker)
-        _(@q.instance_variable_get(:@bunny)).must_equal @external_connection
+        q = Sneakers::Queue.new('foo',
+                                queue_vars.merge(:connection => @external_connection))
+        q.subscribe(@mkworker)
+        _(q.instance_variable_get(:@bunny)).must_equal @external_connection
+      end
+
+      it 'uses that function' do
+        @external_connection.start
+        q = Sneakers::Queue.new('foo',
+                                queue_vars.merge(:connection => ->() { @external_connection }))
+        q.subscribe(@mkworker)
+        _(q.instance_variable_get(:@bunny)).must_equal @external_connection
       end
     end
   end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kicks
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.2.0
 platform: ruby
 authors:
 - Dotan Nahum
 - Michael Klishin
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-01 00:00:00.000000000 Z
+date: 2025-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: serverengine
@@ -343,7 +342,6 @@ licenses:
 - MIT
 metadata:
   source_code_uri: https://github.com/ruby-amqp/kicks
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -358,8 +356,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Fast background processing framework for Ruby and RabbitMQ
 test_files: