sucker_punch 3.0.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5dfa20a18d1c51b637e21b3b7aa657979a73036964ed8e6542e2b759ebd5adce
-  data.tar.gz: 95aea0e08f0a4a3e9048836c820cd4bde237ac067aa3ad71c2de728fd3ffb8cf
+  metadata.gz: 0d35871de54ea5289b5ab0fe2fe36765ca86832dd94d5d698e210978f5d67523
+  data.tar.gz: 1ada244fd85ae889316949e711762a9f95fce4518c903f710ec1d7170a900409
 SHA512:
-  metadata.gz: e2bcf61e16203c7cd4c2eab46d35ae5f1da65e640564ad65beba14b2b9b4579023546432553c0d75b571265a0e60f0ff71a48bd4c3519f809e42628aec298791
-  data.tar.gz: 8b660145d51fa187b63ad897a9342dc8955f1cf045b0b03e1138720f912762b35b624fe292d2c0adb9b3a6bf961ad9cae6e29f4044226b37d0c654e257f2353d
+  metadata.gz: 8354e67033ac6730b2ea8a3ee7d3f4a0de96787a422707c7ab1ddfff5d04808eae96bb6d220d79cfa9a1c315350cead21cb677a1c34f65034aa6d4a89b8a3d79
+  data.tar.gz: cc05894c3e572180f115d8100ab7c4a6992dc399400ee9a47ebbc66c79ddc987ddc81bd74ae7ff81063fa020ed5f940f08d31939ebc36e14376ccdbb7de8334d

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', '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
+      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,7 @@
+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/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.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sucker_punch
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.1.0
 platform: ruby
 authors:
 - Brandon Hilkert
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-17 00:00:00.000000000 Z
+date: 2022-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake