sucker_punch 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1edad787473a077f23f2fae95150cdb92e3834a12150fbd4d910fade5692516
-  data.tar.gz: 4ba7b7fa6cf3a1c99706a3bda43b0fd2fc291ae1825a23466b00a5b7a3354003
+  metadata.gz: 5dfa20a18d1c51b637e21b3b7aa657979a73036964ed8e6542e2b759ebd5adce
+  data.tar.gz: 95aea0e08f0a4a3e9048836c820cd4bde237ac067aa3ad71c2de728fd3ffb8cf
 SHA512:
-  metadata.gz: a8184cafe29937ad818920951c3c760e8435b4e35a348e27629053bae1b56e2f44ab412154fb3769e6878034a9351ad5e60fb44d9385bf5bb4f2bf58cc91c71c
-  data.tar.gz: fde16057612312085f59a955e783007b6a0cf0b4ff7d08312963bc0c76b3be2e5d254e5eb1df1625db3c554403485e5df8a1c995ab50b71dda4e1358b00e8d23
+  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,7 @@
+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/).

data/lib/sucker_punch/async_syntax.rb

@@ -10,8 +10,9 @@ module SuckerPunch
       @job = job
     end
 
-    def perform(*args, **kwargs)
-      @job.class.perform_async(*args, **kwargs)
+    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

@@ -32,20 +32,22 @@ module SuckerPunch
     end
 
     module ClassMethods
-      def perform_async(*args, **kwargs)
+      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 { __run_perform(*args, **kwargs) }
+        queue.post { __run_perform(*args) }
       end
+      ruby2_keywords(:perform_async) if respond_to?(:ruby2_keywords, true)
 
-      def perform_in(interval, *args, **kwargs)
+      def perform_in(interval, *args)
         return unless SuckerPunch::RUNNING.true?
         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, **kwargs)
+          __run_perform(*args)
         end
         job.pending?
       end
+      ruby2_keywords(:perform_in) if respond_to?(:ruby2_keywords, true)
 
       def workers(num)
         self.num_workers = num
@@ -55,23 +57,20 @@ module SuckerPunch
         self.num_jobs_max = num
       end
 
-      def __run_perform(*args, **kwargs)
+      def __run_perform(*args)
         SuckerPunch::Counter::Busy.new(self.to_s).increment
 
-        result = if RUBY_VERSION >= '2.5'
-                   self.new.perform(*args, **kwargs)
-                 else
-                   self.new.perform(*args, *(kwargs.any? ? [kwargs] : nil))
-                 end
+        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, **kwargs])
+        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

@@ -165,15 +165,16 @@ module SuckerPunch
       SuckerPunch::Counter::Failed.new(name).value
     end
 
-    def post(*args, **kwargs, &block)
+    def post(*args, &block)
       synchronize do
         if @running
-          @pool.post(*args, **kwargs, &block)
+          @pool.post(*args, &block)
         else
           false
         end
       end
     end
+    ruby2_keywords(:post) if respond_to?(:ruby2_keywords, true)
 
     def kill
       @pool.kill

data/lib/sucker_punch/testing/inline.rb

@@ -25,13 +25,15 @@ require 'sucker_punch'
 module SuckerPunch
   module Job
     module ClassMethods
-      def perform_async(*args, **kwargs)
-        self.new.perform(*args, **kwargs)
+      def perform_async(*args)
+        self.new.perform(*args)
       end
+      ruby2_keywords(:perform_async) if respond_to?(:ruby2_keywords, true)
 
-      def perform_in(_, *args, **kwargs)
-        self.new.perform(*args, **kwargs)
+      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 = "3.0.0"
+  VERSION = "3.0.1"
 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)

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
@@ -136,9 +143,9 @@ module SuckerPunch
         @signals = []
       end
 
-      def post(*args, **kwargs, &block)
+      def post(*args, &block)
         if block_given?
-          block.call(args, **kwargs)
+          block.call(args)
         end
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sucker_punch
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
 platform: ruby
 authors:
 - Brandon Hilkert
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-15 00:00:00.000000000 Z
+date: 2021-02-17 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,7 +114,7 @@ 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:
   - - ">="

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