activejob-cancel 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5132b8b0de9b2367ec64975fd45bb3f28a6e0e9d
-  data.tar.gz: 9ed3b9b10a9bd8717421eb2054b95a93aa203e9f
+  metadata.gz: d2bba860770d4be5139149e0069cbb365c89759a
+  data.tar.gz: f5c3be4e786cef71c20449657dd3b8033ff0d44f
 SHA512:
-  metadata.gz: 2da9918d434cc04329d3dfb0089373eac2762737f39b7b5a488dec2db45432b7412bcdf5188b7ec83d63e9b9c26cd3a02a60236719208f9c778be7d4b53825bf
-  data.tar.gz: 732622b3d8e2777ddb3f4c3126f678230579759ebe8ed35fe6d5d5331d26b9a2d962fd59cd66683e078a8e87aee18711ee2fb34f8c7fed012911a0abd0cd8605
+  metadata.gz: db5990d551d0e973b8646b898d2c4a924d3b6724a0ded9eb7ab40b6ccb6d28baa8e994ce10926e73564ceba40b0c9ea6d342b877f36e1cb951852b9a2d88e0a0
+  data.tar.gz: 50024aa15719cc7e313186bbbc734eadbfee1b90297febc889ed68f6c583cae5af18059a05515f1b68756fd7ab1c0d9edfdf459ae0620fb44f86aac32055fad4

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 Nothing
 
+## 0.3.0
+
+* Add support for Active Job `TestAdapter` #19 [Hermann Mayer]
+
 ## 0.2.0
 
 * Add support for `resque`

data/README.md

@@ -1,6 +1,6 @@
 # ActiveJob::Cancel
 
-`activejob-cancel` provides cancel method to Active Job. Currently it supports only `Sidekiq`, `Delayed Job` and `resque`.
+`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)
 [![Gem Version](https://badge.fury.io/rb/activejob-cancel.svg)](http://badge.fury.io/rb/activejob-cancel)

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 Resque).freeze
+    SUPPORTED_ADAPTERS = %w(Sidekiq DelayedJob Resque Test).freeze
 
     def cancel
       if self.class.can_cancel?

data/lib/active_job/cancel/queue_adapters.rb

@@ -6,6 +6,7 @@ module ActiveJob
       autoload :SidekiqAdapter
       autoload :DelayedJobAdapter
       autoload :ResqueAdapter
+      autoload :TestAdapter
     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_5'
+        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_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/queue_adapters/test_adapter/rails_5.rb

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

data/lib/active_job/cancel/version.rb

@@ -1,5 +1,5 @@
 module ActiveJob
   module Cancel
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activejob-cancel
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Yuji Yaginuma
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-08 00:00:00.000000000 Z
+date: 2017-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -219,6 +219,9 @@ files:
 - 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_4.rb
+- lib/active_job/cancel/queue_adapters/test_adapter/rails_5.rb
 - lib/active_job/cancel/version.rb
 - lib/activejob/cancel.rb
 homepage: https://github.com/y-yagi/activejob-cancel