sucker_punch 2.0.3 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f9888e735e4566c4c0d789d328c78553caa09e35
-  data.tar.gz: 5e70f216542d0bc65fb5fbb1757dfce2ce529100
+SHA256:
+  metadata.gz: e1edad787473a077f23f2fae95150cdb92e3834a12150fbd4d910fade5692516
+  data.tar.gz: 4ba7b7fa6cf3a1c99706a3bda43b0fd2fc291ae1825a23466b00a5b7a3354003
 SHA512:
-  metadata.gz: 295aceab156ca6df316d095be72b2052591a0a4895893ce75e4751db160b8eb675dac3385757c94f0776b90587c292bcf4a1b666df6a3c387d471a4569e1c520
-  data.tar.gz: 49db7fbff4f68c9015566162ba26794365d535a5dfc0a9957dc107e4006ec7baae125ad52c1b0ff29c813f080aaf1919c0b2b0bec4e8ac6498adda43fa254d18
+  metadata.gz: a8184cafe29937ad818920951c3c760e8435b4e35a348e27629053bae1b56e2f44ab412154fb3769e6878034a9351ad5e60fb44d9385bf5bb4f2bf58cc91c71c
+  data.tar.gz: fde16057612312085f59a955e783007b6a0cf0b4ff7d08312963bc0c76b3be2e5d254e5eb1df1625db3c554403485e5df8a1c995ab50b71dda4e1358b00e8d23

data/CHANGES.md

@@ -1,3 +1,38 @@
+3.0.0
+-------
+- Add support for keyword arguments in ruby `>= 3.0`. More details in [release notes](https://www.ruby-lang.org/en/news/2020/12/25/ruby-3-0-0-released/).
+
+2.1.1
+-------
+- Relax versioning constraint of `concurrent-ruby` to make way for 1.1 release
+
+2.1.0
+-------
+- Add `max_jobs` configuration option to set the maximum number of tasks that
+  may be waiting in the work queue
+
+    ```ruby
+    class JobWithLimit
+      include SuckerPunch::Job
+      max_jobs 2
+
+      def perform(data)
+        # work...
+      end
+    end
+
+    10.times do
+      begin
+        JobWithLimit.perform_async('work') }
+      rescue Concurrent::RejectedExecutionError => e
+        # Queue maxed out, this job didn't get queued
+      end
+    end
+
+2.0.4
+-------
+- Better initialization of variables and names to remove warnings
+
 2.0.3
 -------
 - Rewrite shutdown strategy to fix bug related to premature shutdown when only

data/README.md

@@ -1,7 +1,7 @@
 # Sucker Punch
 
-[![Build Status](https://travis-ci.org/brandonhilkert/sucker_punch.png?branch=master)](https://travis-ci.org/brandonhilkert/sucker_punch)
-[![Code Climate](https://codeclimate.com/github/brandonhilkert/sucker_punch.png)](https://codeclimate.com/github/brandonhilkert/sucker_punch)
+[![Build Status](https://travis-ci.org/brandonhilkert/sucker_punch.svg?branch=master)](https://travis-ci.org/brandonhilkert/sucker_punch)
+[![Code Climate](https://codeclimate.com/github/brandonhilkert/sucker_punch.svg)](https://codeclimate.com/github/brandonhilkert/sucker_punch)
 
 Sucker Punch is a single-process Ruby asynchronous processing library.
 This reduces costs
@@ -114,6 +114,22 @@ class LogJob
 end
 ```
 
+#### Configure the Queue Size
+
+The default number of jobs that can be queued is unlimited. If you wish to restrict this you can set
+max\_jobs as follows:
+
+```Ruby
+class LogJob
+  include SuckerPunch::Job
+  max_jobs 10
+
+  def perform(event)
+    Log.new(event).track
+  end
+end
+```
+
 #### Executing Jobs in the Future
 
 Many background processing libraries have methods to perform operations after a
@@ -131,7 +147,7 @@ class DataJob
 end
 
 DataJob.perform_async("asdf") # immediately perform asynchronously
-DataJob.perform_in(60, "asdf") # `perform` will be excuted 60 sec. later
+DataJob.perform_in(60, "asdf") # `perform` will be executed 60 sec. later
 ```
 
 #### `ActiveRecord` Connection Pool Connections
@@ -254,6 +270,19 @@ $ rails g sucker_punch:job logger
 would create the file `app/jobs/logger_job.rb` with a unimplemented `#perform`
 method.
 
+## Sinatra
+
+If you're using Sucker Punch with Sinatra, you must require Sucker Punch before Sinatra:
+
+```ruby
+# app.rb
+
+require 'sucker_punch'
+require 'sinatra'
+```
+
+This will ensure Sucker Punch's `at_exit()` handler to clean up and shutdown queues does not happen **before** Sinatra *starts up* via its own `at_exit()` handler.
+
 ## Active Job
 
 Sucker Punch has been added as an Active Job adapter in Rails 4.2.

data/lib/sucker_punch.rb

@@ -10,12 +10,12 @@ module SuckerPunch
   RUNNING = Concurrent::AtomicBoolean.new(true)
 
   class << self
-    def exception_handler=(handler)
-      @exception_handler = handler
+    def exception_handler
+      @exception_handler ||= method(:default_exception_handler)
     end
 
-    def exception_handler
-      @exception_handler || method(:default_exception_handler)
+    def exception_handler=(handler)
+      @exception_handler = handler
     end
 
     def default_exception_handler(ex, klass, args)
@@ -26,11 +26,7 @@ module SuckerPunch
     end
 
     def logger
-      @logger || default_logger
-    end
-
-    def logger=(log)
-      @logger = (log ? log : Logger.new('/dev/null'))
+      @logger ||= default_logger
     end
 
     def default_logger
@@ -39,9 +35,13 @@ module SuckerPunch
       l
     end
 
+    def logger=(log)
+      @logger = (log ? log : Logger.new('/dev/null'))
+    end
+
     def shutdown_timeout
       # 10 seconds on heroku, minus a grace period
-      @shutdown_timeout || 8
+      @shutdown_timeout ||= 8
     end
 
     def shutdown_timeout=(timeout)

data/lib/sucker_punch/async_syntax.rb

@@ -10,9 +10,8 @@ module SuckerPunch
       @job = job
     end
 
-    def perform(*args)
-      @job.class.perform_async(*args)
+    def perform(*args, **kwargs)
+      @job.class.perform_async(*args, **kwargs)
     end
   end
 end
-

data/lib/sucker_punch/job.rb

@@ -14,15 +14,17 @@ module SuckerPunch
   # To trigger asynchronous job:
   #
   #   LogJob.perform_async(1, 2, 3)
-  #   LogJob.perform_in(60, 1, 2, 3) # `perform` will be excuted 60 sec. later
+  #   LogJob.perform_in(60, 1, 2, 3) # `perform` will be executed 60 sec. later
   #
   # Note that perform_async is a class method, perform is an instance method.
   module Job
     def self.included(base)
       base.extend(ClassMethods)
       base.class_attribute :num_workers
+      base.class_attribute :num_jobs_max
 
       base.num_workers = 2
+      base.num_jobs_max = nil
     end
 
     def logger
@@ -30,17 +32,17 @@ module SuckerPunch
     end
 
     module ClassMethods
-      def perform_async(*args)
+      def perform_async(*args, **kwargs)
         return unless SuckerPunch::RUNNING.true?
-        queue = SuckerPunch::Queue.find_or_create(self.to_s, num_workers)
-        queue.post(args) { |args| __run_perform(*args) }
+        queue = SuckerPunch::Queue.find_or_create(self.to_s, num_workers, num_jobs_max)
+        queue.post { __run_perform(*args, **kwargs) }
       end
 
-      def perform_in(interval, *args)
+      def perform_in(interval, *args, **kwargs)
         return unless SuckerPunch::RUNNING.true?
-        queue = SuckerPunch::Queue.find_or_create(self.to_s, num_workers)
+        queue = SuckerPunch::Queue.find_or_create(self.to_s, num_workers, num_jobs_max)
         job = Concurrent::ScheduledTask.execute(interval.to_f, args: args, executor: queue) do
-          __run_perform(*args)
+          __run_perform(*args, **kwargs)
         end
         job.pending?
       end
@@ -49,14 +51,24 @@ module SuckerPunch
         self.num_workers = num
       end
 
-      def __run_perform(*args)
+      def max_jobs(num)
+        self.num_jobs_max = num
+      end
+
+      def __run_perform(*args, **kwargs)
         SuckerPunch::Counter::Busy.new(self.to_s).increment
-        result = self.new.perform(*args)
+
+        result = if RUBY_VERSION >= '2.5'
+                   self.new.perform(*args, **kwargs)
+                 else
+                   self.new.perform(*args, *(kwargs.any? ? [kwargs] : nil))
+                 end
+
         SuckerPunch::Counter::Processed.new(self.to_s).increment
         result
       rescue => ex
         SuckerPunch::Counter::Failed.new(self.to_s).increment
-        SuckerPunch.exception_handler.call(ex, self, args)
+        SuckerPunch.exception_handler.call(ex, self, [*args, **kwargs])
       ensure
         SuckerPunch::Counter::Busy.new(self.to_s).decrement
       end

data/lib/sucker_punch/queue.rb

@@ -5,23 +5,26 @@ module SuckerPunch
     extend Forwardable
     include Concurrent::ExecutorService
 
+    DEFAULT_MAX_QUEUE_SIZE = 0 # Unlimited
+
     DEFAULT_EXECUTOR_OPTIONS = {
       min_threads:     2,
       max_threads:     2,
       idletime:        60, # 1 minute
-      max_queue:       0, # unlimited
       auto_terminate:  false # Let shutdown modes handle thread termination
     }.freeze
 
     QUEUES = Concurrent::Map.new
 
-    def self.find_or_create(name, num_workers = 2)
+    def self.find_or_create(name, num_workers = 2, num_jobs_max = nil)
       pool = QUEUES.fetch_or_store(name) do
-        options = DEFAULT_EXECUTOR_OPTIONS.merge({
-          min_threads: num_workers,
-          max_threads: num_workers
-        })
-        Concurrent::ThreadPoolExecutor.new(options)
+        options = DEFAULT_EXECUTOR_OPTIONS
+          .merge(
+            min_threads: num_workers,
+            max_threads: num_workers,
+            max_queue: num_jobs_max || DEFAULT_MAX_QUEUE_SIZE
+          )
+        Concurrent::ThreadPoolExecutor.new(**options)
       end
 
       new(name, pool)
@@ -111,6 +114,7 @@ module SuckerPunch
     def_delegators :@pool,
       :max_length,
       :min_length,
+      :max_queue,
       :length,
       :queue_length,
       :wait_for_termination#,
@@ -161,10 +165,10 @@ module SuckerPunch
       SuckerPunch::Counter::Failed.new(name).value
     end
 
-    def post(*args, &block)
+    def post(*args, **kwargs, &block)
       synchronize do
         if @running
-          @pool.post(*args, &block)
+          @pool.post(*args, **kwargs, &block)
         else
           false
         end
@@ -187,4 +191,3 @@ module SuckerPunch
     end
   end
 end
-

data/lib/sucker_punch/testing.rb

@@ -0,0 +1,44 @@
+require 'sucker_punch'
+
+# Include this in your tests to simulate
+# a fake job queue. Jobs won't be executed
+# as they normal would be the thread pool.
+# They'll instead be pushed to a fake queue
+# to be checked in a test environment.
+#
+# Include in your test_helper.rb:
+#
+# require 'sucker_punch/testing'
+#
+# In your application code:
+#
+#   LogJob.perform_async(1, 2, 3)
+#
+# In your tests:
+#
+#   LogJob.jobs => [{ "args" => [1, 2, 3]]
+
+module SuckerPunch
+  module Job
+    def self.jobs
+      SuckerPunch::Queue.find_or_create(self.to_s)
+    end
+
+    def self.clear_all
+
+    end
+  end
+
+  class Queue
+    def self.find_or_create(name, _number_workers = 2, _num_jobs_max = nil)
+      QUEUES.fetch_or_store(name) do
+        []
+      end
+    end
+
+
+    def kill
+      true
+    end
+  end
+end

data/lib/sucker_punch/testing/inline.rb

@@ -17,7 +17,7 @@ require 'sucker_punch'
 #
 # Include inline testing lib:
 #
-# require 'sucker_punch/testing/inline"
+# require 'sucker_punch/testing/inline'
 #
 # LogJob.perform_async(1, 2, 3) is now synchronous
 # LogJob.perform_in(1, 2, 3) is now synchronous
@@ -25,12 +25,12 @@ require 'sucker_punch'
 module SuckerPunch
   module Job
     module ClassMethods
-      def perform_async(*args)
-        self.new.perform(*args)
+      def perform_async(*args, **kwargs)
+        self.new.perform(*args, **kwargs)
       end
 
-      def perform_in(_, *args)
-        self.new.perform(*args)
+      def perform_in(_, *args, **kwargs)
+        self.new.perform(*args, **kwargs)
       end
     end
   end

data/lib/sucker_punch/version.rb

@@ -1,3 +1,3 @@
 module SuckerPunch
-  VERSION = "2.0.3"
+  VERSION = "3.0.0"
 end

data/sucker_punch.gemspec

@@ -24,5 +24,11 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "minitest"
   gem.add_development_dependency "pry"
 
-  gem.add_dependency "concurrent-ruby", "~> 1.0.0"
+  gem.add_dependency "concurrent-ruby", "~> 1.0"
+  
+  if gem.respond_to?(:metadata)
+    gem.metadata['changelog_uri'] = 'https://github.com/brandonhilkert/sucker_punch/blob/master/CHANGES.md'
+    gem.metadata['source_code_uri'] = 'https://github.com/brandonhilkert/sucker_punch'
+    gem.metadata['bug_tracker_uri'] = 'https://github.com/brandonhilkert/sucker_punch/issues'
+  end
 end

data/test/sucker_punch/job_test.rb

@@ -55,6 +55,11 @@ module SuckerPunch
       FakeLogJob.workers(2)
     end
 
+    def test_can_set_max_jobs
+      FakeLogJob.max_jobs(10)
+      assert_equal 10, FakeLogJob.num_jobs_max
+    end
+
     def test_logger_is_accessible_from_instance
       SuckerPunch.logger = SuckerPunch.default_logger
       assert_equal SuckerPunch.logger, FakeLogJob.new.logger
@@ -177,4 +182,3 @@ module SuckerPunch
     end
   end
 end
-

data/test/sucker_punch/queue_test.rb

@@ -29,6 +29,11 @@ module SuckerPunch
       assert_equal 4, queue.min_length
     end
 
+    def test_queue_max_queue_can_be_set
+      queue = SuckerPunch::Queue.find_or_create(@queue, 4, 10)
+      assert_equal(10, queue.max_queue)
+    end
+
     def test_same_queue_is_returned_on_subsequent_queries
       queue = SuckerPunch::Queue.find_or_create(@queue)
       assert_equal queue, SuckerPunch::Queue.find_or_create(@queue)
@@ -131,9 +136,9 @@ module SuckerPunch
         @signals = []
       end
 
-      def post(*args, &block)
+      def post(*args, **kwargs, &block)
         if block_given?
-          block.call(args)
+          block.call(args, **kwargs)
         end
       end
 

data/test/sucker_punch_test.rb

@@ -41,7 +41,7 @@ class SuckerPunchTest < Minitest::Test
   end
 
   def test_exception_handler_can_be_set
-    SuckerPunch.exception_handler = -> (ex, _, _) { raise "bad stuff" }
+    SuckerPunch.exception_handler = -> (_ex, _, _) { raise "bad stuff" }
     assert_raises(::RuntimeError) { SuckerPunch.exception_handler.call(StandardError.new("bad"), nil, nil) }
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sucker_punch
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 3.0.0
 platform: ruby
 authors:
 - Brandon Hilkert
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-08-23 00:00:00.000000000 Z
+date: 2021-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.0'
 description: Asynchronous processing library for Ruby
 email:
 - brandonhilkert@gmail.com
@@ -89,6 +89,7 @@ files:
 - lib/sucker_punch/job.rb
 - lib/sucker_punch/queue.rb
 - lib/sucker_punch/railtie.rb
+- lib/sucker_punch/testing.rb
 - lib/sucker_punch/testing/inline.rb
 - lib/sucker_punch/version.rb
 - sucker_punch.gemspec
@@ -101,7 +102,10 @@ files:
 homepage: https://github.com/brandonhilkert/sucker_punch
 licenses:
 - MIT
-metadata: {}
+metadata:
+  changelog_uri: https://github.com/brandonhilkert/sucker_punch/blob/master/CHANGES.md
+  source_code_uri: https://github.com/brandonhilkert/sucker_punch
+  bug_tracker_uri: https://github.com/brandonhilkert/sucker_punch/issues
 post_install_message: |-
   Sucker Punch v2.0 introduces backwards-incompatible changes.
   Please see https://github.com/brandonhilkert/sucker_punch/blob/master/CHANGES.md#200 for details.
@@ -119,9 +123,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Sucker Punch is a Ruby asynchronous processing using concurrent-ruby, heavily
   influenced by Sidekiq and girl_friday.