sucker_punch 2.0.4 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 02222eadf72ce92d2552755c7bfb66332397c33e
-  data.tar.gz: d3d339c4ad293760b2dd6f4e3eb3675758fc3a2f
+SHA256:
+  metadata.gz: 5dfa20a18d1c51b637e21b3b7aa657979a73036964ed8e6542e2b759ebd5adce
+  data.tar.gz: 95aea0e08f0a4a3e9048836c820cd4bde237ac067aa3ad71c2de728fd3ffb8cf
 SHA512:
-  metadata.gz: eca020b9b49c2df52d474ba4d18b801c8f0723bda7a4a55bdecb23eb8fe886047b6765cf06939a8289a78a46471eebde8776b2a4caad96781013dc1ca589be8c
-  data.tar.gz: d05ec8872904d0d9720b6d150375ad42d5a4c06aad5d271f58fa782e3171e26a8c01868b6e816d779e2c762c8dbddc12ec8f674a026108537af67e591ba2157b
+  metadata.gz: e2bcf61e16203c7cd4c2eab46d35ae5f1da65e640564ad65beba14b2b9b4579023546432553c0d75b571265a0e60f0ff71a48bd4c3519f809e42628aec298791
+  data.tar.gz: 8b660145d51fa187b63ad897a9342dc8955f1cf045b0b03e1138720f912762b35b624fe292d2c0adb9b3a6bf961ad9cae6e29f4044226b37d0c654e257f2353d

data/.github/workflows/build.yml

@@ -0,0 +1,37 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Build
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.1', '2.2', '2.3', '2.4', '2.5', '2.6', '2.7', '3.0', 'head', 'jruby', 'truffleruby', 'truffleruby-head']
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Ruby ${{ matrix.ruby-version }}
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+
+    - name: Run tests
+      run: bundle exec rake

data/CHANGES.md

@@ -1,3 +1,38 @@
+3.0.1
+-------
+- Opt for keyword parsing using `ruby2_keywords` for compatibility.
+
+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

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/async_syntax.rb

@@ -13,6 +13,6 @@ module SuckerPunch
     def perform(*args)
       @job.class.perform_async(*args)
     end
+    ruby2_keywords(:perform) if respond_to?(:ruby2_keywords, true)
   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
@@ -32,34 +34,43 @@ module SuckerPunch
     module ClassMethods
       def perform_async(*args)
         return unless SuckerPunch::RUNNING.true?
-        queue = SuckerPunch::Queue.find_or_create(self.to_s, num_workers)
-        queue.post(args) { |job_args| __run_perform(*job_args) }
+        queue = SuckerPunch::Queue.find_or_create(self.to_s, num_workers, num_jobs_max)
+        queue.post { __run_perform(*args) }
       end
+      ruby2_keywords(:perform_async) if respond_to?(:ruby2_keywords, true)
 
       def perform_in(interval, *args)
         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)
         end
         job.pending?
       end
+      ruby2_keywords(:perform_in) if respond_to?(:ruby2_keywords, true)
 
       def workers(num)
         self.num_workers = num
       end
 
+      def max_jobs(num)
+        self.num_jobs_max = num
+      end
+
       def __run_perform(*args)
         SuckerPunch::Counter::Busy.new(self.to_s).increment
+
         result = self.new.perform(*args)
+
         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])
       ensure
         SuckerPunch::Counter::Busy.new(self.to_s).decrement
       end
+      ruby2_keywords(:__run_perform) if respond_to?(:ruby2_keywords, true)
     end
   end
 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#,
@@ -170,6 +174,7 @@ module SuckerPunch
         end
       end
     end
+    ruby2_keywords(:post) if respond_to?(:ruby2_keywords, true)
 
     def kill
       @pool.kill
@@ -187,4 +192,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
@@ -28,10 +28,12 @@ module SuckerPunch
       def perform_async(*args)
         self.new.perform(*args)
       end
+      ruby2_keywords(:perform_async) if respond_to?(:ruby2_keywords, true)
 
       def perform_in(_, *args)
         self.new.perform(*args)
       end
+      ruby2_keywords(:perform_in) if respond_to?(:ruby2_keywords, true)
     end
   end
 end

data/lib/sucker_punch/version.rb

@@ -1,3 +1,3 @@
 module SuckerPunch
-  VERSION = "2.0.4"
+  VERSION = "3.0.1"
 end

data/sucker_punch.gemspec

@@ -3,26 +3,32 @@ lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'sucker_punch/version'
 
-Gem::Specification.new do |gem|
-  gem.name          = "sucker_punch"
-  gem.version       = SuckerPunch::VERSION
-  gem.authors       = ["Brandon Hilkert"]
-  gem.email         = ["brandonhilkert@gmail.com"]
-  gem.description   = %q{Asynchronous processing library for Ruby}
-  gem.summary       = %q{Sucker Punch is a Ruby asynchronous processing using concurrent-ruby, heavily influenced by Sidekiq and girl_friday.}
-  gem.homepage      = "https://github.com/brandonhilkert/sucker_punch"
-  gem.license       = "MIT"
+Gem::Specification.new do |spec|
+  spec.name          = "sucker_punch"
+  spec.version       = SuckerPunch::VERSION
+  spec.authors       = ["Brandon Hilkert"]
+  spec.email         = ["brandonhilkert@gmail.com"]
+  spec.description   = %q{Asynchronous processing library for Ruby}
+  spec.summary       = %q{Sucker Punch is a Ruby asynchronous processing using concurrent-ruby, heavily influenced by Sidekiq and girl_friday.}
+  spec.homepage      = "https://github.com/brandonhilkert/sucker_punch"
+  spec.license       = "MIT"
 
-  gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ["lib"]
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
 
-  gem.post_install_message = "Sucker Punch v2.0 introduces backwards-incompatible changes.\nPlease see https://github.com/brandonhilkert/sucker_punch/blob/master/CHANGES.md#200 for details."
+  spec.required_ruby_version = '>= 2.0.0'
 
-  gem.add_development_dependency "rake", "~> 10.0"
-  gem.add_development_dependency "minitest"
-  gem.add_development_dependency "pry"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "pry"
 
-  gem.add_dependency "concurrent-ruby", "~> 1.0.0"
+  spec.add_dependency "concurrent-ruby", "~> 1.0"
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['changelog_uri'] = 'https://github.com/brandonhilkert/sucker_punch/blob/master/CHANGES.md'
+    spec.metadata['source_code_uri'] = 'https://github.com/brandonhilkert/sucker_punch'
+    spec.metadata['bug_tracker_uri'] = 'https://github.com/brandonhilkert/sucker_punch/issues'
+  end
 end

data/test/sucker_punch/async_syntax_test.rb

@@ -19,6 +19,14 @@ module SuckerPunch
       assert_equal 1, arr.size
     end
 
+    def test_perform_async_works_with_keywords
+      arr = Concurrent::Array.new
+      latch = Concurrent::CountDownLatch.new
+      FakeKeywordLatchJob.new.async.perform(arr: arr, latch: latch)
+      latch.wait(0.2)
+      assert_equal 1, arr.size
+    end
+
     private
 
     class FakeLatchJob
@@ -29,5 +37,14 @@ module SuckerPunch
         latch.count_down
       end
     end
+
+    class FakeKeywordLatchJob
+      include SuckerPunch::Job
+
+      def perform(arr: Concurrent::Array.new, latch: Concurrent::CountDownLatch.new)
+        arr.push true
+        latch.count_down
+      end
+    end
   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
@@ -117,6 +122,22 @@ module SuckerPunch
       assert SuckerPunch::Counter::Processed.new(job_class.to_s).value == 1
     end
 
+    def test_perform_async_handles_keyword_arguments
+      arr = Concurrent::Array.new
+      latch = Concurrent::CountDownLatch.new
+      FakeKeywordLatchJob.perform_async(arr: arr, latch: latch)
+      latch.wait(1)
+      assert_equal 1, arr.size
+    end
+
+    def test_perform_in_handles_keyword_arguments
+      arr = Concurrent::Array.new
+      latch = Concurrent::CountDownLatch.new
+      FakeKeywordLatchJob.perform_in(0.1, arr: arr, latch: latch)
+      latch.wait(1)
+      assert_equal 1, arr.size
+    end
+
     def test_failed_jobs_is_incremented_when_job_raises
       job_class = Class.new(FakeErrorJob)
       jobs = 3
@@ -137,6 +158,14 @@ module SuckerPunch
       end
     end
 
+    class FakeKeywordLatchJob
+      include SuckerPunch::Job
+      def perform(arr: Concurrent::Array.new, latch: Concurrent::CountDownLatch.new)
+        arr.push true
+        latch.count_down
+      end
+    end
+
     class FakeBusyJob
       include SuckerPunch::Job
       def perform(latch1, latch2)
@@ -177,4 +206,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)
@@ -65,7 +70,6 @@ module SuckerPunch
       all_stats = SuckerPunch::Queue.stats
       stats = all_stats[FakeLatchJob.to_s]
       assert stats["workers"]["total"] > 0
-      assert stats["workers"]["busy"] == 0
       assert stats["workers"]["idle"] > 0
       assert stats["jobs"]["processed"] > 0
       assert stats["jobs"]["failed"] == 0
@@ -95,6 +99,14 @@ module SuckerPunch
       assert_equal [1, 2], arr.first
     end
 
+    def test_jobs_can_be_posted_to_pool_with_keyword_args
+      arr = []
+      fake_pool = FakePool.new
+      queue     = SuckerPunch::Queue.new "fake", fake_pool
+      queue.post(a: 1, b: 2) { |args| arr.push args }
+      assert_equal [{a: 1, b: 2}], arr.first
+    end
+
     def test_kill_sends_kill_to_pool
       fake_pool = FakePool.new
       queue     = SuckerPunch::Queue.new "fake", fake_pool

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.4
+  version: 3.0.1
 platform: ruby
 authors:
 - Brandon Hilkert
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-09-15 00:00:00.000000000 Z
+date: 2021-02-17 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
@@ -73,8 +73,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/build.yml"
 - ".gitignore"
-- ".travis.yml"
 - CHANGES.md
 - Gemfile
 - LICENSE.txt
@@ -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,10 +102,11 @@ files:
 homepage: https://github.com/brandonhilkert/sucker_punch
 licenses:
 - MIT
-metadata: {}
-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.
+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:
 rdoc_options: []
 require_paths:
 - lib
@@ -112,16 +114,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
-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.

data/.travis.yml

@@ -1,13 +0,0 @@
-language: ruby
-rvm:
-  - rbx-2
-  - 2.0.0
-  - 2.1.8
-  - 2.2.4
-  - 2.3.4
-  - 2.4.1
-  - ruby-head
-
-matrix:
-  allow_failures:
-    - rvm: rbx-2