shoryuken 3.1.8 → 3.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b0666812a472f98087bf90ff23f4420b0ba78bb9
-  data.tar.gz: fe0c97e16e371afed0895bc8560d77503c2c8962
+  metadata.gz: 17dbef4b25b83a6c3529947b5fabf45ff89e868d
+  data.tar.gz: aab8f0e8521732396865abbcb5394ad6e21ed317
 SHA512:
-  metadata.gz: ee9e3b82feb7124d3ef165c632c0b2078d22be7939bb2eaef7da036812859a13529f08c09b2b6c1b0eccf24f1c06ed6be9310415e894d59d1363d7574ce5764f
-  data.tar.gz: 65b44b013c44cf6521ab9cb6a4d21095d6475ba2cf8bb196436807ec0269fe56ef3e6ddd7a3d0efd0cdf04c2408f06fdea89688aea1da12ef1e609d413f2eed2
+  metadata.gz: 54c17164557879edcc48b053dad99009989a7be515a0d8e38bd7eb47e95d5f7629389a54d92dfa137494966168d0e34a2a95f1c6e3ee29ff6950bdd8f970bf96
+  data.tar.gz: eca828404986cc2aa5dcf22f01ccb3552591f676c299efac6139ce46dfc9f078d8fcdc1d4dbc5c0269361929f1b0673084733c09fbd23ded26c11142605cb7d4

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## [v3.1.9] - 2017-08-24
+
+- Add support for dispatch fire event
+ - [#426](https://github.com/phstc/shoryuken/pull/426)
+
+- Add support for adding a middleware to the front of chain
+ - [#427](https://github.com/phstc/shoryuken/pull/427)
+
 ## [v3.1.8] - 2017-08-17
 
 - Make Polling strategy backward compatibility

data/lib/shoryuken/manager.rb

@@ -37,7 +37,7 @@ module Shoryuken
         return sleep(MIN_DISPATCH_INTERVAL)
       end
 
-      fire_event(:dispatch)
+      fire_event(:dispatch, false, queue_name: queue.name)
 
       logger.debug { "Ready: #{ready}, Busy: #{busy}, Active Queues: #{@polling_strategy.active_queues}" }
 

data/lib/shoryuken/middleware/chain.rb

@@ -61,6 +61,10 @@ module Shoryuken
         entries << Entry.new(klass, *args) unless exists?(klass)
       end
 
+      def prepend(klass, *args)
+        entries.insert(0, Entry.new(klass, *args)) unless exists?(klass)
+      end
+
       def insert_before(oldklass, newklass, *args)
         i = entries.index { |entry| entry.klass == newklass }
         new_entry = i.nil? ? Entry.new(newklass, *args) : entries.delete_at(i)

data/lib/shoryuken/util.rb

@@ -4,13 +4,13 @@ module Shoryuken
       Shoryuken.logger
     end
 
-    def fire_event(event, reverse = false)
+    def fire_event(event, reverse = false, event_options = {})
       logger.debug { "Firing '#{event}' lifecycle event" }
       arr = Shoryuken.options[:lifecycle_events][event]
       arr.reverse! if reverse
       arr.each do |block|
         begin
-          block.call
+          block.call(event_options)
         rescue => ex
           logger.warn(event: event)
           logger.warn "#{ex.class.name}: #{ex.message}"

data/lib/shoryuken/version.rb

@@ -1,3 +1,3 @@
 module Shoryuken
-  VERSION = '3.1.8'.freeze
+  VERSION = '3.1.9'.freeze
 end

data/spec/shoryuken/manager_spec.rb

@@ -70,7 +70,7 @@ RSpec.describe Shoryuken::Manager do
       q = Shoryuken::Polling::QueueConfiguration.new(queue, {})
 
       expect(fetcher).to receive(:fetch).with(q, concurrency).and_return(messages)
-      expect(subject).to receive(:fire_event).with(:dispatch)
+      expect(subject).to receive(:fire_event).with(:dispatch, false, queue_name: q.name)
       expect(Shoryuken::Processor).to receive(:process).with(q, message)
       expect(Shoryuken.logger).to_not receive(:info)
 
@@ -83,7 +83,7 @@ RSpec.describe Shoryuken::Manager do
         q = Shoryuken::Polling::QueueConfiguration.new(queue, {})
 
         expect(fetcher).to receive(:fetch).with(q, described_class::BATCH_LIMIT).and_return(messages)
-        expect(subject).to receive(:fire_event).with(:dispatch)
+        expect(subject).to receive(:fire_event).with(:dispatch, false, queue_name: q.name)
         allow(subject).to receive(:batched_queue?).with(q).and_return(true)
         expect(Shoryuken::Processor).to receive(:process).with(q, messages)
         expect(Shoryuken.logger).to_not receive(:info)

data/spec/shoryuken/middleware/chain_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Shoryuken::Middleware::Chain do
+RSpec.describe Shoryuken::Middleware::Chain do
   class CustomMiddleware
     def initialize(name, recorder)
       @name     = name
@@ -14,20 +14,32 @@ describe Shoryuken::Middleware::Chain do
     end
   end
 
+  class CustomMiddlewareB < CustomMiddleware; end
+
   it 'supports custom middleware' do
     subject.add CustomMiddleware, 1, []
 
     expect(CustomMiddleware).to eq subject.entries.last.klass
   end
 
+  it 'can add middleware to the front of chain' do
+    subject.prepend CustomMiddleware, 1, []
+
+    expect([CustomMiddleware]).to eq subject.entries.map(&:klass)
+
+    subject.prepend CustomMiddlewareB, 1, []
+
+    expect([CustomMiddlewareB, CustomMiddleware]).to eq subject.entries.map(&:klass)
+  end
+
   it 'invokes a middleware' do
     recorder = []
-    subject.add CustomMiddleware, 'Pablo', recorder
+    subject.add CustomMiddleware, 'custom', recorder
 
     final_action = nil
     subject.invoke { final_action = true }
     expect(final_action).to eq true
-    expect(recorder).to eq [%w[Pablo before], %w[Pablo after]]
+    expect(recorder).to eq [%w(custom before), %w(custom after)]
   end
 
   class NonYieldingMiddleware
@@ -37,7 +49,7 @@ describe Shoryuken::Middleware::Chain do
   it 'allows middleware to abruptly stop processing rest of chain' do
     recorder = []
     subject.add NonYieldingMiddleware
-    subject.add CustomMiddleware, 'Pablo', recorder
+    subject.add CustomMiddleware, 'custom', recorder
 
     final_action = nil
     subject.invoke { final_action = true }

data/spec/shoryuken/util_spec.rb

@@ -9,7 +9,7 @@ describe 'Shoryuken::Util' do
 
   describe '#unparse_queues' do
     it 'returns queues and weights' do
-      queues = %w[queue1 queue1 queue2 queue3 queue4 queue4 queue4]
+      queues = %w(queue1 queue1 queue2 queue3 queue4 queue4 queue4)
 
       expect(subject.unparse_queues(queues)).to eq([['queue1', 2], ['queue2', 1], ['queue3', 1], ['queue4', 3]])
     end
@@ -26,4 +26,28 @@ describe 'Shoryuken::Util' do
 
     it 'returns ActiveJob worker name'
   end
+
+  describe '#fire_event' do
+    let(:value_holder) { Object.new }
+    let(:callback_without_options) { proc { value_holder.value = :without_options } }
+    let(:callback_with_options) { proc { |options| value_holder.value = [:with_options, options] } }
+
+    after :all do
+      Shoryuken.options[:lifecycle_events].delete(:some_event)
+    end
+
+    it 'triggers callbacks that do not accept arguments' do
+      Shoryuken.options[:lifecycle_events][:some_event] = [callback_without_options]
+
+      expect(value_holder).to receive(:value=).with(:without_options)
+      subject.fire_event(:some_event)
+    end
+
+    it 'triggers callbacks that accept an argument' do
+      Shoryuken.options[:lifecycle_events][:some_event] = [callback_with_options]
+
+      expect(value_holder).to receive(:value=).with([:with_options, { my_option: :some_option }])
+      subject.fire_event(:some_event, false, my_option: :some_option)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shoryuken
 version: !ruby/object:Gem::Version
-  version: 3.1.8
+  version: 3.1.9
 platform: ruby
 authors:
 - Pablo Cantero
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-17 00:00:00.000000000 Z
+date: 2017-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -220,7 +220,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Shoryuken is a super efficient AWS SQS thread based message processor