workhorse 1.1.1 → 1.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5958b8fe7db7f321dd981b409b217b90cc53ec31115b64b12b1d5c70afcf6d86
-  data.tar.gz: aa4f0a87290e36b884d54b8a9bc56889249d32808e80aa7e671c6ae120ec4a6c
+  metadata.gz: e00bf821fc0315533d96961d5688b12f6ce20aa70ea84ddb336bbd2a5dac3991
+  data.tar.gz: 28e9bd8f95d29eb080746ecfa7b9021a4488af1edf9b2023a68f0e98950d9d98
 SHA512:
-  metadata.gz: 74be8af063fa45182bd30b9b94e6fbc13e1ba84a6da75ca10ba8356c345105ee7b8613c83c55b9d6df8236f5320c919ce101ce8342f7bf8ce2ab9052c54fdac9
-  data.tar.gz: 5b48f0bd62fca831890141ea0e4c7e8b206104873b1c95d0db0da8d737731e6732a416ffb31a54f7057244edc109e291355fb63d6619bbc6e5e2ca1e62c23372
+  metadata.gz: c1d9ce641718690cafd39d79e795d487e90aba85c46c46d1a3fbffde99527041160d02831c7da36fbfebca1feff38873e9f6ab31491e6e35aaba9fea5ba06363
+  data.tar.gz: 92174a5e2ee2882a2ed5f0f46530d773c029e60eb9632cb189e6b7b6bbe3684b3f5e52f35a710aaf013ed6e698ee63962f5b6d9f220cb0fe42ab7305253bec95

data/CHANGELOG.md

@@ -1,5 +1,37 @@
 # Workhorse Changelog
 
+## 1.2.4 - 2021-06-08
+
+* Add `workhorse_db_job` load hook
+
+## 1.2.3 - 2021-02-09
+
+* Fix warning with ruby 2.7
+
+## 1.2.2 - 2021-01-27
+
+* Remove unused gem dependency to `schemacop`
+
+## 1.2.1 - 2021-01-27
+
+* Log job description (if given) when performing job
+
+## 1.2.0 - 2021-01-27
+
+* `Workhorse.enqueue_active_job`
+  * Change `perform_at` to a keyword arument
+  * Allow passing `:description` and `:queue`
+
+Note that when upgrading, change:
+
+```ruby
+# From
+Workhorse.enqueue_active_job MyJob, 5.minutes.from_now
+
+# To
+Workhorse.enqueue_active_job MyJob, perform_at: 5.minutes.from_now
+```
+
 ## 1.1.1 - 2021-01-19
 
 * Remove deprecation warnings with Ruby 2.7

data/README.md

@@ -384,6 +384,21 @@ jobs database on a regular interval. Workhorse provides the job
 `Workhorse::Jobs::CleanupSucceededJobs` for this purpose that cleans up all
 succeeded jobs. You can run this using your scheduler in a specific interval.
 
+## Load hooks
+
+Using the load hook `:workhorse_db_job`, you can inject custom code into the
+Gem-internal model class `Workhorse::DbJob`, for example:
+
+```ruby
+# config/initializers/workhorse.rb
+
+ActiveSupport.on_load :workhorse_db_job do
+  # Code within this block will be run inside of the model class
+  # Workhorse::DbJob.
+  belongs_to :user
+end
+```
+
 ## Caveats
 
 ### Errors during polling / crashed workers

data/Rakefile

@@ -22,7 +22,6 @@ task :gemspec do
     spec.add_development_dependency 'pry'
     spec.add_dependency 'activesupport'
     spec.add_dependency 'activerecord'
-    spec.add_dependency 'schemacop', '~> 2.0'
     spec.add_dependency 'concurrent-ruby'
   end
 

data/VERSION

@@ -1 +1 @@
-1.1.1
+1.2.4

data/lib/active_job/queue_adapters/workhorse_adapter.rb

@@ -14,8 +14,8 @@ module ActiveJob
         Workhorse.enqueue_active_job(job)
       end
 
-      def enqueue_at(job, timestamp) #:nodoc:
-        Workhorse.enqueue_active_job(job, timestamp)
+      def enqueue_at(job, timestamp = Time.now) #:nodoc:
+        Workhorse.enqueue_active_job(job, perform_at: timestamp)
       end
     end
   end

data/lib/workhorse/db_job.rb

@@ -120,4 +120,6 @@ module Workhorse
       end
     end
   end
+
+  ActiveSupport.run_load_hooks(:workhorse_db_job, DbJob)
 end

data/lib/workhorse/enqueuer.rb

@@ -12,10 +12,16 @@ module Workhorse
     end
 
     # Enqueue an ActiveJob job
-    def enqueue_active_job(job, perform_at = Time.now)
+    def enqueue_active_job(job, perform_at: Time.now, queue: nil, description: nil)
       wrapper_job = Jobs::RunActiveJob.new(job.serialize)
-      queue = job.queue_name.blank? ? nil : job.queue_name
-      db_job = enqueue(wrapper_job, queue: queue, priority: job.priority || 0, perform_at: Time.at(perform_at))
+      queue ||= job.queue_name if job.queue_name.present?
+      db_job = enqueue(
+        wrapper_job,
+        queue:       queue,
+        priority:    job.priority || 0,
+        perform_at:  Time.at(perform_at),
+        description: description
+      )
       job.provider_job_id = db_job.id
       return db_job
     end
@@ -36,7 +42,7 @@ module Workhorse
       end
 
       job = Workhorse::Jobs::RunRailsOp.new(cls, op_args)
-      enqueue job, workhorse_args
+      enqueue job, **workhorse_args
     end
   end
 end

data/lib/workhorse/performer.rb

@@ -59,6 +59,7 @@ module Workhorse
       # Deserialize and perform job
       # ---------------------------------------------------------------
       log 'Performing', :info
+      log "Description: #{@db_job.description}", :info unless @db_job.description.blank?
 
       if Workhorse.perform_jobs_in_tx
         Workhorse.tx_callback.call do

data/workhorse.gemspec

@@ -1,14 +1,14 @@
 # -*- encoding: utf-8 -*-
-# stub: workhorse 1.1.1 ruby lib
+# stub: workhorse 1.2.4 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "workhorse".freeze
-  s.version = "1.1.1"
+  s.version = "1.2.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Sitrox".freeze]
-  s.date = "2021-01-19"
+  s.date = "2021-06-08"
   s.files = [".gitignore".freeze, ".releaser_config".freeze, ".rubocop.yml".freeze, ".travis.yml".freeze, "CHANGELOG.md".freeze, "FAQ.md".freeze, "Gemfile".freeze, "LICENSE".freeze, "README.md".freeze, "RUBY_VERSION".freeze, "Rakefile".freeze, "VERSION".freeze, "bin/rubocop".freeze, "lib/active_job/queue_adapters/workhorse_adapter.rb".freeze, "lib/generators/workhorse/install_generator.rb".freeze, "lib/generators/workhorse/templates/bin/workhorse.rb".freeze, "lib/generators/workhorse/templates/config/initializers/workhorse.rb".freeze, "lib/generators/workhorse/templates/create_table_jobs.rb".freeze, "lib/workhorse.rb".freeze, "lib/workhorse/daemon.rb".freeze, "lib/workhorse/daemon/shell_handler.rb".freeze, "lib/workhorse/db_job.rb".freeze, "lib/workhorse/enqueuer.rb".freeze, "lib/workhorse/jobs/cleanup_succeeded_jobs.rb".freeze, "lib/workhorse/jobs/detect_stale_jobs_job.rb".freeze, "lib/workhorse/jobs/run_active_job.rb".freeze, "lib/workhorse/jobs/run_rails_op.rb".freeze, "lib/workhorse/performer.rb".freeze, "lib/workhorse/poller.rb".freeze, "lib/workhorse/pool.rb".freeze, "lib/workhorse/scoped_env.rb".freeze, "lib/workhorse/worker.rb".freeze, "test/active_job/queue_adapters/workhorse_adapter_test.rb".freeze, "test/lib/db_schema.rb".freeze, "test/lib/jobs.rb".freeze, "test/lib/test_helper.rb".freeze, "test/workhorse/db_job_test.rb".freeze, "test/workhorse/enqueuer_test.rb".freeze, "test/workhorse/performer_test.rb".freeze, "test/workhorse/poller_test.rb".freeze, "test/workhorse/pool_test.rb".freeze, "test/workhorse/worker_test.rb".freeze, "workhorse.gemspec".freeze]
   s.rubygems_version = "3.0.3".freeze
   s.summary = "Multi-threaded job backend with database queuing for ruby.".freeze
@@ -29,7 +29,6 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<pry>.freeze, [">= 0"])
       s.add_runtime_dependency(%q<activesupport>.freeze, [">= 0"])
       s.add_runtime_dependency(%q<activerecord>.freeze, [">= 0"])
-      s.add_runtime_dependency(%q<schemacop>.freeze, ["~> 2.0"])
       s.add_runtime_dependency(%q<concurrent-ruby>.freeze, [">= 0"])
     else
       s.add_dependency(%q<bundler>.freeze, [">= 0"])
@@ -43,7 +42,6 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<pry>.freeze, [">= 0"])
       s.add_dependency(%q<activesupport>.freeze, [">= 0"])
       s.add_dependency(%q<activerecord>.freeze, [">= 0"])
-      s.add_dependency(%q<schemacop>.freeze, ["~> 2.0"])
       s.add_dependency(%q<concurrent-ruby>.freeze, [">= 0"])
     end
   else
@@ -58,7 +56,6 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<pry>.freeze, [">= 0"])
     s.add_dependency(%q<activesupport>.freeze, [">= 0"])
     s.add_dependency(%q<activerecord>.freeze, [">= 0"])
-    s.add_dependency(%q<schemacop>.freeze, ["~> 2.0"])
     s.add_dependency(%q<concurrent-ruby>.freeze, [">= 0"])
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: workhorse
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.4
 platform: ruby
 authors:
 - Sitrox
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-19 00:00:00.000000000 Z
+date: 2021-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -164,20 +164,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: schemacop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -192,8 +178,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
-email:
+description: 
+email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -241,10 +227,10 @@ files:
 - test/workhorse/pool_test.rb
 - test/workhorse/worker_test.rb
 - workhorse.gemspec
-homepage:
+homepage: 
 licenses: []
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -259,8 +245,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key:
+rubygems_version: 3.0.3
+signing_key: 
 specification_version: 4
 summary: Multi-threaded job backend with database queuing for ruby.
 test_files: