shoryuken 3.2.3 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 947fa421a7ad3a686cff9069cc08bb2955279d2d
-  data.tar.gz: 72a4493b5a3a509e82542a374189c1b4502c917c
+SHA256:
+  metadata.gz: 68aa225742d398731903e759938a4c3a8ae662ab6a0846b91252a9a381f29bd5
+  data.tar.gz: 0e93f5155fbfeef146adb1f9e26b9943c0e60da6b314b1d1b5f507adcbbbed10
 SHA512:
-  metadata.gz: 445b25ba5392c9e53b70c99249459ff69fa2fa8eada5ac7db287acc7caecb9fe85357c81afbff15238f4e13487884ccf53a4ccaa365459e5bdb31618f6b72a82
-  data.tar.gz: 146f3c31f6f085dc3d3833d43597c7e61bf0bcdb6a7333962095bf6c141435383baedb2edf94f604bbad8a3ca8d3987d5c70c605c90cb37c1e2e14515b2316f2
+  metadata.gz: f7b70803c03bf5aebc3215f0b2f6b4275bd56e738bf10133b9c67ae0a3675335eee1bd818b38667cec4ea6c5b57032a6ab35a2fe6cc5d336d2247ea30b4cdc1e
+  data.tar.gz: a874aaa3f126760d6ac6b95c9e32bd97a6aa173bb3e8a1a4064084d10fc88883d0ec2e5e8e0cee57b27f70d3225cc62ad4317735d76df2f19ee349886eefc720

data/.rubocop.yml

@@ -1,13 +1,61 @@
 AllCops:
+  Exclude:
+    - '**/Gemfile'
   TargetRubyVersion: 2.1
 
-Style/SignalException:
+Metrics/PerceivedComplexity:
   Enabled: false
 
-Style/DoubleNegation:
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  # Disable "Assignment Branch Condition size for update_attributes is too high" from houndci
+  # because codeclimate already give that for us with more details
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 125
+
+Style/Alias:
   Enabled: false
 
-Style/SpaceAroundEqualsInParameterDefault:
+Style/PerlBackrefs:
+  Enabled: false
+
+Style/TrailingBlankLines:
+  Enabled: false
+
+# Override the HoundCI custom rules (they do not use Rubocop defaults)
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: single_quotes
+
+Style/ExtraSpacing:
+  # disabling that in favour of using:
+  # long_field_test_1 = 1
+  # field_test_2      = 2
+  # etc               = 3
+  Enabled: false
+
+Style/BlockDelimiters:
+  Enabled: false
+
+Style/CollectionMethods:
+  Enabled: false
+
+Style/SignalException:
   Enabled: false
 
 Style/Documentation:
@@ -16,41 +64,59 @@ Style/Documentation:
 Style/ClassAndModuleChildren:
   Enabled: false
 
-Metrics/PerceivedComplexity:
+Style/CommentAnnotation:
   Enabled: false
 
-Metrics/CyclomaticComplexity:
+Style/DotPosition:
+  EnforcedStyle: leading
+
+Style/GuardClause:
   Enabled: false
 
-Style/CommentAnnotation:
+Style/RegexpLiteral:
   Enabled: false
 
-Metrics/ClassLength:
+Lint/HandleExceptions:
   Enabled: false
 
-Metrics/ParameterLists:
+Lint/AssignmentInCondition:
   Enabled: false
 
-Metrics/LineLength:
-  Max: 130
+Style/DoubleNegation:
+  Enabled: false
 
-Metrics/MethodLength :
+Style/AndOr:
   Enabled: false
 
-Style/PerlBackrefs:
+Style/ClassVars:
   Enabled: false
 
-Style/StringLiterals:
-  EnforcedStyle: single_quotes
-  SupportedStyles:
-    - single_quotes
-    - double_quotes
+Style/GlobalVars:
+  Enabled: false
 
-Style/StringLiteralsInInterpolation:
-  EnforcedStyle: single_quotes
-  SupportedStyles:
-    - single_quotes
-    - double_quotes
+Style/SingleLineBlockParams:
+  Enabled: false
+
+Style/RescueModifier:
+  Enabled: false
+
+Style/ColonMethodCall:
+  Enabled: false
+
+Style/FileName:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/RescueStandardError:
+  Enabled: false
+
+Security/YAMLLoad:
+  Enabled: false
+
+Naming/MemoizedInstanceVariableName:
+  Enabled: false
 
-Lint/UnusedMethodArgument:
+Performance/RedundantBlockCall:
   Enabled: false

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [v3.3.0] - 2018-09-30
+
+- Add support for TSTP
+  - [#492](https://github.com/phstc/shoryuken/pull/492)
+
+- Support an empty list of queues as a CLI argument
+  - [#507](https://github.com/phstc/shoryuken/pull/507)
+
+- Add batch support for inline workers
+  - [#514](https://github.com/phstc/shoryuken/pull/514)
+
+- Make InlineExecutor to behave as the DefaultExecutor when calling perform_in
+  - [#518](https://github.com/phstc/shoryuken/pull/518)
+
 ## [v3.2.3] - 2018-03-25
 
 - Don't force eager load for Rails 5

data/Gemfile

@@ -12,3 +12,7 @@ group :test do
   gem 'multi_xml'
   gem 'simplecov'
 end
+
+group :development do
+  gem 'rubocop'
+end

data/Rakefile

@@ -12,7 +12,7 @@ task :console do
   require 'pry'
   require 'shoryuken'
 
-  config_file = File.join File.expand_path('..', __FILE__), 'shoryuken.yml'
+  config_file = File.join File.expand_path(__dir__), 'shoryuken.yml'
 
   if File.exist? config_file
     config = YAML.load File.read(config_file)

data/bin/cli/base.rb

@@ -1,4 +1,3 @@
-# rubocop:disable Metrics/BlockLength
 module Shoryuken
   module CLI
     class Base < Thor

data/bin/cli/sqs.rb

@@ -1,6 +1,6 @@
 require 'date'
 
-# rubocop:disable Metrics/AbcSize, Metrics/BlockLength
+# rubocop:disable Metrics/BlockLength
 module Shoryuken
   module CLI
     class SQS < Base
@@ -51,7 +51,7 @@ module Shoryuken
           end
         end
 
-        def find_all(url, limit, &block)
+        def find_all(url, limit)
           count = 0
           batch_size = limit > 10 ? 10 : limit
 
@@ -78,7 +78,7 @@ module Shoryuken
         end
 
         def list_and_print_queues(urls)
-          attrs = %w(QueueArn ApproximateNumberOfMessages ApproximateNumberOfMessagesNotVisible LastModifiedTimestamp)
+          attrs = %w[QueueArn ApproximateNumberOfMessages ApproximateNumberOfMessagesNotVisible LastModifiedTimestamp]
 
           entries = urls.map { |u| sqs.get_queue_attributes(queue_url: u, attribute_names: attrs).attributes }.map do |q|
             [

data/bin/shoryuken

@@ -7,8 +7,6 @@ require 'aws-sdk-core'
 require_relative 'cli/base'
 require_relative 'cli/sqs'
 require_relative '../lib/shoryuken/runner'
-
-# rubocop:disable Metrics/AbcSize
 module Shoryuken
   module CLI
     class Runner < Base
@@ -32,18 +30,14 @@ module Shoryuken
       def start
         opts = options.to_h.symbolize_keys
 
-        if opts[:config_file]
-          say '[DEPRECATED] Please use --config instead of --config-file', :yellow
-        end
+        say '[DEPRECATED] Please use --config instead of --config-file', :yellow if opts[:config_file]
 
         opts[:config_file] = opts.delete(:config) if opts[:config]
 
         # Keep compatibility with old CLI queue format
-        opts[:queues] = options[:queues].map { |q| q.split(',') } if options[:queues]
+        opts[:queues] = opts[:queues].reject(&:empty?).map { |q| q.split(',') } if opts[:queues]
 
-        if options[:daemon] && options[:logfile].nil?
-          fail_task "You should set a logfile if you're going to daemonize"
-        end
+        fail_task "You should set a logfile if you're going to daemonize" if opts[:daemon] && opts[:logfile].nil?
 
         Shoryuken::Runner.instance.run(opts.freeze)
       end

data/examples/bootstrap_queues.rb

@@ -2,7 +2,7 @@ require 'yaml'
 require 'shoryuken'
 
 # load SQS credentials
-config = YAML.load File.read(File.join(File.expand_path('..', __FILE__), 'shoryuken.yml'))
+config = YAML.load File.read(File.join(File.expand_path(__dir__), 'shoryuken.yml'))
 
 Aws.config = config['aws']
 
@@ -18,11 +18,11 @@ if sqs.config['endpoint'] =~ /amazonaws.com/
 
   dead_letter_queue_arn = sqs.get_queue_attributes(
     queue_url: dead_letter_queue_url,
-    attribute_names: %w(QueueArn)
+    attribute_names: %w[QueueArn]
   ).attributes['QueueArn']
 
   attributes = {}
-  attributes['RedrivePolicy'] = %Q({"maxReceiveCount":"7", "deadLetterTargetArn":"#{dead_letter_queue_arn}"})
+  attributes['RedrivePolicy'] = %({"maxReceiveCount":"7", "deadLetterTargetArn":"#{dead_letter_queue_arn}"})
 
   sqs.set_queue_attributes queue_url: default_queue_url, attributes: attributes
 end

data/examples/default_worker.rb

@@ -3,7 +3,7 @@ class DefaultWorker
 
   shoryuken_options queue: 'default', auto_delete: true
 
-  def perform(sqs_msg, body)
+  def perform(_sqs_msg, body)
     Shoryuken.logger.debug("Received message: #{body}")
   end
 end

data/lib/shoryuken.rb

@@ -38,7 +38,6 @@ require 'shoryuken/body_parser'
 require 'shoryuken/fetcher'
 require 'shoryuken/options'
 
-
 module Shoryuken
   extend SingleForwardable
 

data/lib/shoryuken/core_ext.rb

@@ -34,7 +34,7 @@ module Shoryuken
   module StringExt
     module Constantize
       def constantize
-        names = self.split('::')
+        names = split('::')
         names.shift if names.empty? || names.first.empty?
 
         constant = Object

data/lib/shoryuken/extensions/active_job_adapter.rb

@@ -84,7 +84,7 @@ module ActiveJob
 
         shoryuken_options body_parser: :json, auto_delete: true
 
-        def perform(sqs_msg, hash)
+        def perform(_sqs_msg, hash)
           Base.execute hash
         end
       end

data/lib/shoryuken/fetcher.rb

@@ -25,7 +25,7 @@ module Shoryuken
 
     private
 
-    def fetch_with_auto_retry(max_attempts, &block)
+    def fetch_with_auto_retry(max_attempts)
       attempts = 0
 
       begin
@@ -48,8 +48,8 @@ module Shoryuken
       options = receive_options(queue)
 
       options[:max_number_of_messages]  = max_number_of_messages(limit, options)
-      options[:message_attribute_names] = %w(All)
-      options[:attribute_names]         = %w(All)
+      options[:message_attribute_names] = %w[All]
+      options[:attribute_names]         = %w[All]
 
       options.merge!(queue.options)
 

data/lib/shoryuken/logging.rb

@@ -5,7 +5,7 @@ module Shoryuken
   module Logging
     class Pretty < Logger::Formatter
       # Provide a call() method that returns the formatted message.
-      def call(severity, time, program_name, message)
+      def call(severity, time, _program_name, message)
         "#{time.utc.iso8601} #{Process.pid} TID-#{Thread.current.object_id.to_s(36)}#{context} #{severity}: #{message}\n"
       end
 

data/lib/shoryuken/middleware/server/active_record.rb

@@ -2,7 +2,7 @@ module Shoryuken
   module Middleware
     module Server
       class ActiveRecord
-        def call(*args)
+        def call(*_args)
           yield
         ensure
           ::ActiveRecord::Base.clear_active_connections!

data/lib/shoryuken/middleware/server/auto_delete.rb

@@ -2,7 +2,7 @@ module Shoryuken
   module Middleware
     module Server
       class AutoDelete
-        def call(worker, queue, sqs_msg, body)
+        def call(worker, queue, sqs_msg, _body)
           yield
 
           return unless worker.class.auto_delete?

data/lib/shoryuken/middleware/server/auto_extend_visibility.rb

@@ -25,7 +25,7 @@ module Shoryuken
         class MessageVisibilityExtender
           include Util
 
-          def auto_extend(worker, queue, sqs_msg, body)
+          def auto_extend(_worker, queue, sqs_msg, _body)
             queue_visibility_timeout = Shoryuken::Client.queues(queue).visibility_timeout
 
             Concurrent::TimerTask.new(execution_interval: queue_visibility_timeout - EXTEND_UPFRONT_SECONDS) do

data/lib/shoryuken/middleware/server/exponential_backoff_retry.rb

@@ -4,7 +4,7 @@ module Shoryuken
       class ExponentialBackoffRetry
         include Util
 
-        def call(worker, queue, sqs_msg, body)
+        def call(worker, _queue, sqs_msg, _body)
           return yield unless worker.class.exponential_backoff?
 
           if sqs_msg.is_a?(Array)

data/lib/shoryuken/middleware/server/timing.rb

@@ -4,25 +4,23 @@ module Shoryuken
       class Timing
         include Util
 
-        def call(worker, queue, sqs_msg, body)
-          begin
-            started_at = Time.now
+        def call(_worker, queue, _sqs_msg, _body)
+          started_at = Time.now
 
-            logger.info { "started at #{started_at}" }
+          logger.info { "started at #{started_at}" }
 
-            yield
+          yield
 
-            total_time = elapsed(started_at)
+          total_time = elapsed(started_at)
 
-            if (total_time / 1000.0) > (timeout = Shoryuken::Client.queues(queue).visibility_timeout)
-              logger.warn { "exceeded the queue visibility timeout by #{total_time - (timeout * 1000)} ms" }
-            end
-
-            logger.info { "completed in: #{total_time} ms" }
-          rescue
-            logger.info { "failed in: #{elapsed(started_at)} ms" }
-            raise
+          if (total_time / 1000.0) > (timeout = Shoryuken::Client.queues(queue).visibility_timeout)
+            logger.warn { "exceeded the queue visibility timeout by #{total_time - (timeout * 1000)} ms" }
           end
+
+          logger.info { "completed in: #{total_time} ms" }
+        rescue
+          logger.info { "failed in: #{elapsed(started_at)} ms" }
+          raise
         end
       end
     end

data/lib/shoryuken/polling/base.rb

@@ -36,7 +36,7 @@ module Shoryuken
         fail NotImplementedError
       end
 
-      def messages_found(queue, messages_found)
+      def messages_found(_queue, _messages_found)
         fail NotImplementedError
       end
 

data/lib/shoryuken/polling/strict_priority.rb

@@ -4,13 +4,13 @@ module Shoryuken
       def initialize(queues)
         # Priority ordering of the queues, highest priority first
         @queues = queues
-        .group_by { |q| q }
-        .sort_by { |_, qs| -qs.count }
-        .map(&:first)
+                  .group_by { |q| q }
+                  .sort_by { |_, qs| -qs.count }
+                  .map(&:first)
 
         # Pause status of the queues, default to past time (unpaused)
         @paused_until = queues
-        .each_with_object(Hash.new) { |queue, h| h[queue] = Time.at(0) }
+                        .each_with_object({}) { |queue, h| h[queue] = Time.at(0) }
 
         # Start queues at 0
         reset_next_queue
@@ -31,10 +31,10 @@ module Shoryuken
 
       def active_queues
         @queues
-        .reverse
-        .map.with_index(1)
-        .reject { |q, _| queue_paused?(q) }
-        .reverse
+          .reverse
+          .map.with_index(1)
+          .reject { |q, _| queue_paused?(q) }
+          .reverse
       end
 
       private