sucker_punch 3.0.1 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5dfa20a18d1c51b637e21b3b7aa657979a73036964ed8e6542e2b759ebd5adce
-  data.tar.gz: 95aea0e08f0a4a3e9048836c820cd4bde237ac067aa3ad71c2de728fd3ffb8cf
+  metadata.gz: 1d7065c0464318a0f91ea674f8ea6a0bb1591bdbbc78d0a1aceed831e90a287a
+  data.tar.gz: 6494c8eb952d5633d678f4a47e566bc6121138edcc68ca7857ffcdc872a1ab85
 SHA512:
-  metadata.gz: e2bcf61e16203c7cd4c2eab46d35ae5f1da65e640564ad65beba14b2b9b4579023546432553c0d75b571265a0e60f0ff71a48bd4c3519f809e42628aec298791
-  data.tar.gz: 8b660145d51fa187b63ad897a9342dc8955f1cf045b0b03e1138720f912762b35b624fe292d2c0adb9b3a6bf961ad9cae6e29f4044226b37d0c654e257f2353d
+  metadata.gz: 8d0f522105d3b3d038e34aa66aef6e25c03d6e3ef1618df5c8c595e418b1c8f01468cbab9e8437908338e1fc32ea7e86eba321525a9d984f74ba81053fe78497
+  data.tar.gz: 8de430d10421a3889088493e50266d5b18da1f6311e18847bb3d7d34829f188bce8d9590dfe50853cd814dcb51364028ae27b7fac5197fb16d08afcb20992205

data/.github/workflows/build.yml

@@ -19,16 +19,13 @@ jobs:
     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']
+        ruby-version: ['2.4', '2.5', '2.6', '2.7', '3.0', '3.1', '3.2', 'jruby', 'truffleruby', 'truffleruby-head']
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
 
     - 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
+      uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby-version }}
         bundler-cache: true # runs 'bundle install' and caches installed gems automatically

data/CHANGES.md

@@ -1,3 +1,11 @@
+3.2.0
+-------
+- Rename `singleton_class?` method to allow for usage with Ruby 3
+
+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.

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

@@ -18,7 +18,7 @@ rescue LoadError
               define_method(:#{name}) { val }
             end
 
-            if singleton_class?
+            if sucker_punch_is_singleton_class?
               class_eval do
                 def #{name}
                   defined?(@#{name}) ? @#{name} : singleton_class.#{name}
@@ -42,7 +42,8 @@ rescue LoadError
     end
 
     private
-    def singleton_class?
+
+    def sucker_punch_is_singleton_class?
       ancestors.first != self
     end
   end

data/lib/sucker_punch/queue.rb

@@ -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
 

data/lib/sucker_punch/version.rb

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

data/sucker_punch.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.0.0'
 
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "minitest"
   spec.add_development_dependency "pry"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sucker_punch
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.2.0
 platform: ruby
 authors:
 - Brandon Hilkert
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-17 00:00:00.000000000 Z
+date: 2023-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement