sucker_punch 2.1.2 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b584388415071f977d554aa3d9e8128521c08a3b4299492e349bfbc5dc865f5
-  data.tar.gz: c77e1a8b773e712f2ec67c311e3f00bfe16fbcd8c79afc028c44b879d93c943d
+  metadata.gz: 0d35871de54ea5289b5ab0fe2fe36765ca86832dd94d5d698e210978f5d67523
+  data.tar.gz: 1ada244fd85ae889316949e711762a9f95fce4518c903f710ec1d7170a900409
 SHA512:
-  metadata.gz: 67bb1e1d9b05432f8e868451cfbd846ea29871887ee807fc398067e10e9db2305abdf891c44e9453e822063f7599bb2f7f45535b3440287ecbdf0e7e8e688b9a
-  data.tar.gz: e6e86dccf04e992c61369369e78e6ff7a7ab1239e9713800c7fcda1f62ed7996e451ed0053bfe1b595e6d1dd268c7853cf6aa5da8efcd8e852e2319e4a36c57c
+  metadata.gz: 8354e67033ac6730b2ea8a3ee7d3f4a0de96787a422707c7ab1ddfff5d04808eae96bb6d220d79cfa9a1c315350cead21cb677a1c34f65034aa6d4a89b8a3d79
+  data.tar.gz: cc05894c3e572180f115d8100ab7c4a6992dc399400ee9a47ebbc66c79ddc987ddc81bd74ae7ff81063fa020ed5f940f08d31939ebc36e14376ccdbb7de8334d

data/.github/workflows/build.yml

@@ -0,0 +1,34 @@
+# 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.4', '2.5', '2.6', '2.7', '3.0', '3.1', 'jruby', 'truffleruby', 'truffleruby-head']
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Ruby ${{ matrix.ruby-version }}
+      uses: ruby/setup-ruby@v1
+      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,15 @@
+3.1.0
+-------
+- Add a blocking `SuckerPunch::Queue.wait` which waits for all queues to become idle.
+
+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

data/README.md

@@ -1,6 +1,6 @@
 # Sucker Punch
 
-[![Build Status](https://travis-ci.org/brandonhilkert/sucker_punch.svg?branch=master)](https://travis-ci.org/brandonhilkert/sucker_punch)
+[![Build](https://github.com/brandonhilkert/sucker_punch/actions/workflows/build.yml/badge.svg)](https://github.com/brandonhilkert/sucker_punch/actions/workflows/build.yml)
 [![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.
@@ -28,19 +28,25 @@ etc.).
 
 Add this line to your application's Gemfile:
 
-    gem 'sucker_punch', '~> 2.0'
+    gem 'sucker_punch', '~> 3.0'
 
 And then execute:
 
     $ bundle
 
+You can also run (same as two steps above):
+
+    bundle add sucker_punch
+
 Or install it yourself as:
 
     $ gem install sucker_punch
 
 ## Backwards Compatibility
 
-In version `~> 2.0.0`, the syntax to enqueue an asynchronous background job has changed from:
+No breaking changes were introduced in version 3.x.
+
+In version `~> 2.0.0`, the syntax to enqueue an asynchronous background job was changed from:
 
 ```ruby
 LogJob.new.async.perform(...)
@@ -237,6 +243,15 @@ To configure something other than the default 8 sec.:
   SuckerPunch.shutdown_timeout = 15 # # of sec. to wait before killing threads
 ```
 
+#### Queue Class Methods
+
+Sucker Punch leverages concurrent-friendly queues per-process. These class methods operating on all queues might be helpful in some edge cases.
+
+- `SuckerPunch::Queue.stats` - Returns a hash keyed by each queue's name with total, busy, and timeout statistics for each queue's `workers` and `jobs`.
+- `SuckerPunch::Queue.clear` - Calls `clear` for each queue. Susceptible to race conditions. Only use in testing.
+- `SuckerPunch::Queue.shutdown_all` - Used with SuckerPunch's `at_exit` hook. Waits for all queues to be idle using the [shutdown timeout](#shutdown-timeout) configuration above.
+- `SuckerPunch::Queue.wait` - Waits for all queues to become idle with no timeout. 
+
 #### Timeouts
 
 Using `Timeout` causes persistent connections to
@@ -315,6 +330,13 @@ to include the backwards compatibility module in an initializer:
 require 'sucker_punch/async_syntax'
 ```
 
+## FAQ
+
+**What is the difference between `sucker_punch` and `ActiveJob::QueueAdapters::AsyncAdapter`?**
+
+Not much at this point. SuckerPunch existed before ActiveJob, but ultimately uses similar code under the covers. I'd recommend using `AsyncAdapter` if you're using Rails.
+
+
 ## Troubleshooting
 
 ### Initializers for forking servers (Unicorn, Passenger, etc.)

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

@@ -35,8 +35,9 @@ module SuckerPunch
       def perform_async(*args)
         return unless SuckerPunch::RUNNING.true?
         queue = SuckerPunch::Queue.find_or_create(self.to_s, num_workers, num_jobs_max)
-        queue.post(args) { |job_args| __run_perform(*job_args) }
+        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?
@@ -46,6 +47,7 @@ module SuckerPunch
         end
         job.pending?
       end
+      ruby2_keywords(:perform_in) if respond_to?(:ruby2_keywords, true)
 
       def workers(num)
         self.num_workers = num
@@ -57,15 +59,18 @@ module SuckerPunch
 
       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

@@ -24,7 +24,7 @@ module SuckerPunch
             max_threads: num_workers,
             max_queue: num_jobs_max || DEFAULT_MAX_QUEUE_SIZE
           )
-        Concurrent::ThreadPoolExecutor.new(options)
+        Concurrent::ThreadPoolExecutor.new(**options)
       end
 
       new(name, pool)
@@ -108,6 +108,19 @@ module SuckerPunch
         queues.each { |queue| queue.kill }
       end
     end
+    
+    def self.wait
+      queues = all
+      
+      # return if every queue is empty and workers in every queue are idle
+      return if queues.all? { |queue| queue.idle? }
+
+      SuckerPunch.logger.info("Pausing to allow workers to finish...")
+
+      while queues.any? { |queue| !queue.idle? }
+        sleep PAUSE_TIME
+      end
+    end
 
     attr_reader :name
 
@@ -174,6 +187,7 @@ module SuckerPunch
         end
       end
     end
+    ruby2_keywords(:post) if respond_to?(:ruby2_keywords, true)
 
     def kill
       @pool.kill
@@ -191,4 +205,3 @@ module SuckerPunch
     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/testing.rb

@@ -30,7 +30,7 @@ module SuckerPunch
   end
 
   class Queue
-    def self.find_or_create(name, number_workers = 2, num_jobs_max = nil)
+    def self.find_or_create(name, _number_workers = 2, _num_jobs_max = nil)
       QUEUES.fetch_or_store(name) do
         []
       end

data/lib/sucker_punch/version.rb

@@ -1,3 +1,3 @@
 module SuckerPunch
-  VERSION = "2.1.2"
+  VERSION = "3.1.0"
 end

data/sucker_punch.gemspec

@@ -3,32 +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"
-  
-  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'
+  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

@@ -122,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
@@ -142,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)
@@ -182,4 +206,3 @@ module SuckerPunch
     end
   end
 end
-

data/test/sucker_punch/queue_test.rb

@@ -70,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
@@ -100,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.1.2
+  version: 3.1.0
 platform: ruby
 authors:
 - Brandon Hilkert
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-05-16 00:00:00.000000000 Z
+date: 2022-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -73,8 +73,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/build.yml"
 - ".gitignore"
-- ".travis.yml"
 - CHANGES.md
 - Gemfile
 - LICENSE.txt
@@ -106,9 +106,7 @@ 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.
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -116,15 +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: []
-rubygems_version: 3.0.3
-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