Merge a7c65d4 into 712d5a1

.gitignore

@@ -21,3 +21,6 @@ tmp
 *.o
 *.a
 mkmf.log
+.ruby-version
+.ruby-gemset
+.idea

.travis.yml

@@ -1,11 +1,16 @@
 language: ruby
+sudo: false
+cache: bundler
+script: bundle exec rspec
+bundler_args: --without=extras
 before_script:
   - bundle exec sidekiq -r ./spec/dummy_app/app.rb -L /tmp/sidekiq.log &
   - sleep 1
-script: rspec spec
-bundler_args: --without=extras
 services:
   - redis-server
 rvm:
-  - '2.4.0'
-  - jruby-9.1.6.0
+  - 2.2.10
+  - 2.3.7
+  - 2.4.4
+  - 2.5.1
+  - jruby-9.1.17.0

CHANGELOG.md

@@ -0,0 +1,10 @@
+## [Unreleased]
+
+### Added
+- sidekiq 5 compatibility (closes [#11](https://github.com/krisleech/wisper-sidekiq/issues/11))
+- support for optional `sidekiq_options` per subscriber class (closes [#15](https://github.com/krisleech/wisper-sidekiq/issues/15))
+
+## [0.0.1] - 06-10-2014
+
+### Added
+- Initial release

Gemfile

@@ -11,5 +11,5 @@ gem 'psych', platforms: :rbx
 
 group :extras do
   gem 'rerun'
-  gem 'pry'
+  gem 'pry-byebug'
 end

README.md

@@ -39,6 +39,10 @@ use its id instead.
 See the [Sidekiq best practices](https://github.com/mperham/sidekiq/wiki/Best-Practices)
 for more information.
 
+### Passing down sidekiq options
+
+In order to define custom [sidekiq_options](https://github.com/mperham/sidekiq/wiki/Advanced-Options#workers) you can add `sidekiq_options` class method in your subscriber definition - those options will be passed to Sidekiq's `set` method just before scheduling the asynchronous worker.
+
 ## Compatibility
 
 The same Ruby versions as Sidekiq are offically supported, but it should work

lib/wisper/sidekiq.rb

@@ -1,12 +1,22 @@
+require 'yaml'
 require 'wisper'
 require 'sidekiq'
-
 require 'wisper/sidekiq/version'
 
 module Wisper
+
+  # based on Sidekiq 4.x #delay method, which is not enabled by default in Sidekiq 5.x
+  # https://github.com/mperham/sidekiq/blob/4.x/lib/sidekiq/extensions/generic_proxy.rb
+  # https://github.com/mperham/sidekiq/blob/4.x/lib/sidekiq/extensions/class_methods.rb
+
   class SidekiqBroadcaster
-    def broadcast(subscriber, publisher, event, args)
-      subscriber.delay.public_send(event, *args)
+    class Worker
+      include ::Sidekiq::Worker
+
+      def perform(yml)
+        (subscriber, event, args) = ::YAML.load(yml)
+        subscriber.public_send(event, *args)
+      end
     end
 
     def self.register
@@ -15,6 +25,17 @@ def self.register
         config.broadcaster :async,   SidekiqBroadcaster.new
       end
     end
+
+    def broadcast(subscriber, publisher, event, args)
+      options = sidekiq_options(subscriber)
+      Worker.set(options).perform_async(::YAML.dump([subscriber, event, args]))
+    end
+
+    private
+
+    def sidekiq_options(subscriber)
+      subscriber.respond_to?(:sidekiq_options) ? subscriber.sidekiq_options : {}
+    end
   end
 end
 

spec/dummy_app/app.rb

@@ -1,3 +1,4 @@
 # This is loaded by Sidekiq
 
+require 'wisper/sidekiq'
 require_relative 'subscriber'

spec/dummy_app/subscriber.rb

@@ -2,6 +2,7 @@ class Subscriber
   def self.it_happened(message)
     File.open('/tmp/shared', 'w') do |file|
       file.puts "pid: #{Process.pid}"
+      file.puts message.inspect
     end
   end
 end

spec/integration_spec.rb

@@ -9,29 +9,40 @@
       include Wisper::Publisher
 
       def run
-        broadcast(:it_happened, 'hello, world')
+        broadcast(:it_happened, { hello: 'world' })
       end
     end.new
   end
+  let(:shared_content) { File.read('/tmp/shared') }
+
+  def ensure_sidekiq_was_running
+    Timeout.timeout(10) do
+      while !File.exist?('/tmp/shared')
+        sleep(0.1)
+      end
+    end
+  end
 
   before do
+    Sidekiq::Testing.disable!
     Sidekiq::Queue.new.clear
     Sidekiq::RetrySet.new.clear
     File.delete('/tmp/shared') if File.exist?('/tmp/shared')
   end
 
   it 'performs event in a different process' do
     publisher.subscribe(Subscriber, async: Wisper::SidekiqBroadcaster.new)
-
     publisher.run
+    ensure_sidekiq_was_running
 
-    Timeout.timeout(10) do
-      while !File.exist?('/tmp/shared')
-        sleep(0.1)
-      end
-    end
+    expect(shared_content).not_to include("pid: #{Process.pid}\n")
+  end
+
+  it 'performs event' do
+    publisher.subscribe(Subscriber, async: Wisper::SidekiqBroadcaster.new)
+    publisher.run
+    ensure_sidekiq_was_running
 
-    shared_content = File.read('/tmp/shared')
-    expect(shared_content).not_to eq "pid: #{Process.pid}\n"
+    expect(shared_content).to include('{:hello=>"world"}')
   end
 end

spec/spec_helper.rb

@@ -1,5 +1,7 @@
 require 'coveralls'
 require 'simplecov'
+require 'pry' unless ENV['CI']
+require 'sidekiq/testing'
 
 SimpleCov.formatter = Coveralls::SimpleCov::Formatter
 

spec/wisper/sidekiq_broadcaster_spec.rb

@@ -0,0 +1,60 @@
+require 'wisper/sidekiq'
+
+RSpec.describe Wisper::SidekiqBroadcaster do
+  class PublisherUnderTest
+    include Wisper::Publisher
+
+    def run
+      broadcast(:it_happened)
+    end
+  end
+
+  class RegularSubscriberUnderTest
+    def self.it_happened(*_)
+    end
+  end
+
+  class CustomizedSubscriberUnderTest
+    def self.it_happened
+    end
+
+    def self.sidekiq_options
+      { queue: "my_queue" }
+    end
+  end
+
+  let(:publisher) { PublisherUnderTest.new }
+
+  before { Sidekiq::Testing.fake! }
+  after { Sidekiq::Testing.disable! }
+
+  describe '#broadcast' do
+    it 'schedules a sidekiq job' do
+      publisher.subscribe(RegularSubscriberUnderTest, async: described_class.new)
+
+      expect { publisher.run }
+        .to change(Sidekiq::Queues["default"], :size).by(1)
+    end
+
+    it 'can respect custom sidekiq_options' do
+      publisher.subscribe(CustomizedSubscriberUnderTest, async: described_class.new)
+
+      expect { publisher.run }
+        .to change(Sidekiq::Queues["my_queue"], :size).by(1)
+    end
+
+    context 'when provides subscriber with args' do
+      let(:subscriber) { RegularSubscriberUnderTest }
+      let(:event) { 'it_happened' }
+      let(:args) { [1,2,3] }
+
+      subject(:broadcast_event) { described_class.new.broadcast(subscriber, nil, event, args) }
+
+      it 'subscriber receives event with corrects args' do
+        expect(RegularSubscriberUnderTest).to receive(event).with(*args)
+
+        Sidekiq::Testing.inline! { broadcast_event }
+      end
+    end
+  end
+end