activejob-cancel 0.1.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 99ba1ad25092d81d1e814585fd026fd68f813c2a
-  data.tar.gz: 272ae21271e5ddc2b5081b2de32756885dfb5352
+SHA256:
+  metadata.gz: 7d137650d5f9e3142121de7b9efbdf937eea716cdf6eda01054940e335c32573
+  data.tar.gz: 94e4e662426e767f06ca11c8fb66d22d1c0fef96547c6c374759c17f81bfb649
 SHA512:
-  metadata.gz: 9c5f55cf87d82c363d00148021bcf08f481723f58da89c91d4f445d8289ce87eba3a0c39167c6dd355ff0830357aef3480f392f738d1cabbbb76bced0f3097d9
-  data.tar.gz: ca5b5d7aae41db84ff5d4ea694f01bebfbd155ded00073c2dac1dc591a4f436b7584b53022cc4042f35c391610c8e0ffe2282dd64475d63dad051c133a0d7c19
+  metadata.gz: '039780d23836f10354b116a560a25696e22fa5c287e62a0cec116b7d95253539f9f9c0a25ae8ac65034714b816a9acf644b6dd0e050c7a2e4b7e56e5c266ba28'
+  data.tar.gz: 119419d1a4f806f798d671e4b384eb97730c6165bbb474c3ed5fc644c487f1f9c46aa90c4e3110c2d36c7e1fffba6a4d7307d0a40535f9b7259cec5b32e61e75

data/.github/workflows/ci.yml

@@ -0,0 +1,46 @@
+name: CI
+
+on: [push]
+
+jobs:
+  build:
+    name: Ruby ${{ matrix.ruby }}, Rails ${{ matrix.gemfile }}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [ "2.7", "2.3" ]
+        gemfile: [ "active_job_60.gemfile", "active_job_52.gemfile", "active_job_51.gemfile", "active_job_50.gemfile", "active_job_42.gemfile" ]
+        exclude:
+          - ruby: "2.3"
+            gemfile: "active_job_60.gemfile"
+          - ruby: "2.7"
+            gemfile: "active_job_42.gemfile"
+          - ruby: "2.6"
+            gemfile: "active_job_42.gemfile"
+
+    services:
+      redis:
+        image: redis
+        ports:
+          - 6379:6379
+        # Wait for starting Redis
+        options: >-
+          --health-cmd "redis-cli ping"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+
+    env:
+      BUNDLE_GEMFILE: gemfiles/${{ matrix.gemfile}}
+
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: Install dependencies
+      run: |
+        gem install bundler --no-document
+        bundle install
+    - name: Run test
+      run: bundle exec rake

data/CHANGELOG.md

@@ -0,0 +1,20 @@
+## master
+
+Nothing
+
+## 0.3.2
+
+* Use same keys and key types as other QueueAdapters do, to not break ActiveJob test helpers #33 [Brian Moran]
+
+## 0.3.1
+
+* Fix `NoMethodError` when using the cancel methods with the default queue name
+
+## 0.3.0
+
+* Add support for Active Job `TestAdapter` #19 [Hermann Mayer]
+
+## 0.2.0
+
+* Add support for `resque`
+* Fix(SidekiqAdapter): fix case when worker's first argument is not a Hash #21 [Nguyễn Đức Long]

data/README.md

@@ -1,8 +1,8 @@
 # ActiveJob::Cancel
 
-`activejob-cancel` provides cancel method to Active Job. Currently it supports only `Sidekiq` and `Delayed Job`.
+`activejob-cancel` provides cancel method to Active Job. Currently it supports only `Sidekiq`, `Delayed Job`, `resque` and the Active Job `TestAdapter`.
 
-[![Build Status](https://travis-ci.org/y-yagi/activejob-cancel.svg?branch=master)](https://travis-ci.org/y-yagi/activejob-cancel)
+![Build Status](https://github.com/y-yagi/activejob-cancel/workflows/CI/badge.svg)
 [![Gem Version](https://badge.fury.io/rb/activejob-cancel.svg)](http://badge.fury.io/rb/activejob-cancel)
 [![Code Climate](https://codeclimate.com/github/y-yagi/activejob-cancel/badges/gpa.svg)](https://codeclimate.com/github/y-yagi/activejob-cancel)
 [![Coverage Status](https://coveralls.io/repos/github/y-yagi/activejob-cancel/badge.svg?branch=master)](https://coveralls.io/github/y-yagi/activejob-cancel?branch=master)

data/Rakefile

@@ -5,6 +5,8 @@ Rake::TestTask.new(:test) do |t|
   t.libs << "test"
   t.libs << "lib"
   t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
+  t.warning = true
 end
 
 task :default => :test

data/activejob-cancel.gemspec

@@ -19,13 +19,15 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'activejob', '>= 4.2.0'
   spec.add_dependency 'activesupport', '>= 4.2.0'
-  spec.add_development_dependency "bundler", "~> 1.11"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
   spec.add_development_dependency "sidekiq"
   spec.add_development_dependency "activerecord", '>= 4.2.0'
   spec.add_development_dependency "delayed_job"
   spec.add_development_dependency "delayed_job_active_record"
+  spec.add_development_dependency "resque"
+  spec.add_development_dependency "resque-scheduler"
   spec.add_development_dependency "sqlite3"
   spec.add_development_dependency "byebug"
 end

data/gemfiles/active_job_42.gemfile

@@ -5,7 +5,9 @@ gem 'rake'
 gem 'sidekiq'
 gem 'delayed_job'
 gem 'delayed_job_active_record'
-gem 'sqlite3'
+gem 'resque'
+gem 'resque-scheduler'
+gem 'sqlite3', '~> 1.3.6'
 gem 'activesupport', '~> 4.2.0'
 gem 'activejob', '~> 4.2.0'
 gem 'activerecord', '~> 4.2.0'

data/gemfiles/active_job_50.gemfile

@@ -5,7 +5,9 @@ gem 'rake'
 gem 'sidekiq'
 gem 'delayed_job'
 gem 'delayed_job_active_record'
-gem 'sqlite3'
+gem 'resque'
+gem 'resque-scheduler'
+gem 'sqlite3', '~> 1.3.6'
 gem 'activesupport', '~> 5.0.0'
 gem 'activejob', '~> 5.0.0'
 gem 'activerecord', '~> 5.0.0'

data/gemfiles/active_job_51.gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+gem 'coveralls', require: false
+gem 'rake'
+gem 'sidekiq'
+gem 'delayed_job'
+gem 'delayed_job_active_record', '>= 4.1.2'
+gem 'resque'
+gem 'resque-scheduler'
+gem 'sqlite3', '~> 1.3.6'
+gem 'activesupport', '~> 5.1.0'
+gem 'activejob', '~> 5.1.0'
+gem 'activerecord', '~> 5.1.0'

data/gemfiles/active_job_52.gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+gem 'coveralls', require: false
+gem 'rake'
+gem 'sidekiq'
+gem 'delayed_job'
+gem 'delayed_job_active_record', '>= 4.1.2'
+gem 'resque'
+gem 'resque-scheduler'
+gem 'sqlite3', '~> 1.3.6'
+gem 'activesupport', '~> 5.2.0'
+gem 'activejob', '~> 5.2.0'
+gem 'activerecord', '~> 5.2.0'

data/gemfiles/active_job_60.gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+gem 'coveralls', require: false
+gem 'rake'
+gem 'sidekiq'
+gem 'delayed_job'
+gem 'delayed_job_active_record', '>= 4.1.2'
+gem 'resque'
+gem 'resque-scheduler'
+gem 'sqlite3'
+gem 'activesupport', '~> 6.0.0'
+gem 'activejob', '~> 6.0.0'
+gem 'activerecord', '~> 6.0.0'

data/gemfiles/active_job_master.gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+gem 'coveralls', require: false
+gem 'rake'
+gem 'sidekiq'
+gem 'delayed_job'
+gem 'delayed_job_active_record'
+gem 'resque'
+gem 'resque-scheduler'
+gem 'sqlite3'
+gem 'arel', github: 'rails/arel'
+gem 'activesupport', github: 'rails/rails'
+gem 'activejob', github: 'rails/rails'
+gem 'activerecord', github: 'rails/rails'

data/lib/active_job/cancel.rb

@@ -1,13 +1,14 @@
 require 'active_support'
 require 'active_job'
 require 'active_job/cancel/queue_adapters'
+require 'active_job/cancel/queue_adapters/test_adapter'
 require 'active_job/cancel/version'
 
 module ActiveJob
   module Cancel
     extend ActiveSupport::Concern
 
-    SUPPORTED_ADAPTERS = %w(Sidekiq DelayedJob).freeze
+    SUPPORTED_ADAPTERS = %w(Sidekiq DelayedJob Resque Test).freeze
 
     def cancel
       if self.class.can_cancel?
@@ -20,7 +21,7 @@ module ActiveJob
     module ClassMethods
       def cancel(job_id)
         if can_cancel?
-          cancel_adapter_class.new.cancel(job_id, self.queue_name)
+          cancel_adapter_class.new.cancel(job_id, self.new.queue_name)
         else
           raise NotImplementedError, 'This queueing backend does not support cancel.'
         end
@@ -28,7 +29,7 @@ module ActiveJob
 
       def cancel_by(opts)
         if can_cancel?
-          cancel_adapter_class.new.cancel_by(opts, self.queue_name)
+          cancel_adapter_class.new.cancel_by(opts, self.new.queue_name)
         else
           raise NotImplementedError, 'This queueing backend does not support cancel_by.'
         end
@@ -54,4 +55,6 @@ module ActiveJob
   end
 end
 
-ActiveJob::Base.include(ActiveJob::Cancel)
+ActiveSupport.on_load(:active_job) do
+  include(ActiveJob::Cancel)
+end

data/lib/active_job/cancel/queue_adapters.rb

@@ -5,6 +5,8 @@ module ActiveJob
 
       autoload :SidekiqAdapter
       autoload :DelayedJobAdapter
+      autoload :ResqueAdapter
+      autoload :TestAdapter
     end
   end
 end

data/lib/active_job/cancel/queue_adapters/delayed_job_adapter.rb

@@ -6,6 +6,7 @@ module ActiveJob
     module QueueAdapters
       class DelayedJobAdapter
         def cancel(job_id, queue_name)
+          queue_name = queue_name.call if queue_name.is_a?(Proc)
           job = find_job(job_id, queue_name)
           if job
             job.destroy

data/lib/active_job/cancel/queue_adapters/resque_adapter.rb

@@ -0,0 +1,40 @@
+require 'resque'
+
+module ActiveJob
+  module Cancel
+    module QueueAdapters
+      class ResqueAdapter
+        def cancel(job_id, queue_name)
+          queue_name = queue_name.call if queue_name.is_a?(Proc)
+          job = find_job(job_id, queue_name)
+
+          if job
+            Resque.redis.lrem(redis_key_for_queue(queue_name), 0, Resque.encode(job))
+            return true
+          else
+            if defined?(Resque.remove_delayed_selection)
+              removed_count = Resque.remove_delayed_selection { |target| target[0]["job_id"] == job_id }
+              return true if removed_count > 0
+            end
+          end
+
+          false
+        end
+
+        private
+          def find_job(job_id, queue_name)
+            jobs = Resque.list_range(redis_key_for_queue(queue_name), 0, Resque.size(queue_name))
+            jobs = [jobs] if jobs.is_a?(Hash)
+
+            jobs.find do |job|
+              job["args"][0]["job_id"] == job_id
+            end
+          end
+
+          def redis_key_for_queue(queue)
+            "queue:#{queue}"
+          end
+      end
+    end
+  end
+end

data/lib/active_job/cancel/queue_adapters/sidekiq_adapter.rb

@@ -5,6 +5,7 @@ module ActiveJob
     module QueueAdapters
       class SidekiqAdapter
         def cancel(job_id, queue_name)
+          queue_name = queue_name.call if queue_name.is_a?(Proc)
           job = find_job_by_job_id(job_id, queue_name)
 
           if job
@@ -18,6 +19,7 @@ module ActiveJob
         def cancel_by(opts, queue_name)
           raise ArgumentError, 'Please specify ":provider_job_id"' unless opts[:provider_job_id]
 
+          queue_name = queue_name.call if queue_name.is_a?(Proc)
           job = find_job_by_provider_job_id(opts[:provider_job_id], queue_name)
           if job
             job.delete
@@ -40,17 +42,17 @@ module ActiveJob
 
           def find_job_from_queue(job_id, queue_name)
             queue = Sidekiq::Queue.new(queue_name)
-            queue.detect { |j| j.args.first['job_id'] == job_id }
+            queue.detect { |j| j.args.first.is_a?(Hash) && j.args.first['job_id'] == job_id }
           end
 
           def find_job_from_scheduled_set(job_id)
             scheduled_set = Sidekiq::ScheduledSet.new
-            scheduled_set.detect { |j| j.args.first['job_id'] == job_id }
+            scheduled_set.detect { |j| j.args.first.is_a?(Hash) && j.args.first['job_id'] == job_id }
           end
 
           def find_job_from_retry_set(job_id)
             scheduled_set = Sidekiq::RetrySet.new
-            scheduled_set.detect { |j| j.args.first['job_id'] == job_id }
+            scheduled_set.detect { |j| j.args.first.is_a?(Hash) && j.args.first['job_id'] == job_id }
           end
       end
     end

data/lib/active_job/cancel/queue_adapters/test_adapter.rb

@@ -0,0 +1,48 @@
+require 'active_job'
+
+module ActiveJob
+  module QueueAdapters
+    # Unfortunately we need to monkey patch the Rails TestAdapter class,
+    # because it does not save the job id on the enqueued_jobs array. We rely
+    # on a persisted id to fulfill the canceling of any given job id.
+    class TestAdapter
+      def initialize
+        if Gem::Requirement.new('>= 5.0').satisfied_by? ActiveJob.version
+          require 'active_job/cancel/queue_adapters/test_adapter/rails'
+        elsif Gem::Requirement.new('~> 4.2').satisfied_by? ActiveJob.version
+          require 'active_job/cancel/queue_adapters/test_adapter/rails_4'
+        end
+
+        super
+      end
+    end
+  end
+
+  module Cancel
+    module QueueAdapters
+      class TestAdapter
+        def cancel(job_id, queue_name)
+          original_count = adapter.enqueued_jobs.count
+          adapter.enqueued_jobs = reject_job_from_enqueued_jobs(job_id)
+          (original_count == adapter.enqueued_jobs.count) ? false : true
+        end
+
+        def cancel_by(opts, queue_name)
+          unless opts[:provider_job_id]
+            raise ArgumentError, 'Please specify ":provider_job_id"'
+          end
+          self.cancel(opts[:provider_job_id], queue_name)
+        end
+
+        private
+          def adapter
+            ActiveJob::Base.queue_adapter
+          end
+
+          def reject_job_from_enqueued_jobs(job_id)
+            adapter.enqueued_jobs.reject { |job| job[:id] == job_id }
+          end
+      end
+    end
+  end
+end

data/lib/active_job/cancel/queue_adapters/test_adapter/rails.rb

@@ -0,0 +1,16 @@
+module ActiveJob
+  module QueueAdapters
+    class TestAdapter
+      alias original_job_to_hash job_to_hash
+
+      def job_to_hash(job, extras = {})
+        original_job_to_hash(job, extras).merge!({
+          id: job.job_id,
+          job: job.class,
+          args: job.serialize.fetch('arguments'),
+          queue: job.queue_name
+        })
+      end
+    end
+  end
+end

data/lib/active_job/cancel/queue_adapters/test_adapter/rails_4.rb

@@ -0,0 +1,25 @@
+module ActiveJob
+  module QueueAdapters
+    class TestAdapter
+      alias original_enqueue enqueue
+      alias original_enqueue_at enqueue_at
+
+      def fixup_last_job(job)
+        list = perform_enqueued_jobs ? performed_jobs : enqueued_jobs
+        list.last[:id] = job.job_id
+      end
+
+      def enqueue(job)
+        result = original_enqueue(job)
+        fixup_last_job(job)
+        result
+      end
+
+      def enqueue_at(job, timestamp)
+        result = original_enqueue_at(job, timestamp)
+        fixup_last_job(job)
+        result
+      end
+    end
+  end
+end

data/lib/active_job/cancel/version.rb

@@ -1,5 +1,5 @@
 module ActiveJob
   module Cancel
-    VERSION = "0.1.0"
+    VERSION = "0.3.2"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activejob-cancel
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.2
 platform: ruby
 authors:
 - Yuji Yaginuma
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-25 00:00:00.000000000 Z
+date: 2021-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -42,44 +42,44 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
@@ -136,6 +136,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: resque-scheduler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -171,8 +199,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
-- ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -183,10 +212,18 @@ files:
 - bin/setup
 - gemfiles/active_job_42.gemfile
 - gemfiles/active_job_50.gemfile
+- gemfiles/active_job_51.gemfile
+- gemfiles/active_job_52.gemfile
+- gemfiles/active_job_60.gemfile
+- gemfiles/active_job_master.gemfile
 - lib/active_job/cancel.rb
 - lib/active_job/cancel/queue_adapters.rb
 - lib/active_job/cancel/queue_adapters/delayed_job_adapter.rb
+- lib/active_job/cancel/queue_adapters/resque_adapter.rb
 - lib/active_job/cancel/queue_adapters/sidekiq_adapter.rb
+- lib/active_job/cancel/queue_adapters/test_adapter.rb
+- lib/active_job/cancel/queue_adapters/test_adapter/rails.rb
+- lib/active_job/cancel/queue_adapters/test_adapter/rails_4.rb
 - lib/active_job/cancel/version.rb
 - lib/activejob/cancel.rb
 homepage: https://github.com/y-yagi/activejob-cancel
@@ -208,10 +245,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: activejob-cancel provides cancel method to Active Job
 test_files: []
-has_rdoc: 

data/.travis.yml

@@ -1,13 +0,0 @@
-language: ruby
-rvm:
-  - 2.2.5
-  - 2.3.1
-
-gemfile:
-  - gemfiles/active_job_42.gemfile
-  - gemfiles/active_job_50.gemfile
-
-before_install: gem install bundler -v 1.11.2
-
-services:
-  - redis