workhorse 1.0.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b381576f799a0b69cf90e0df551cae0f967b1462bb744383933ca3e82be785d
-  data.tar.gz: c298d93548baee24c30a739b8ff3ea60ce61e91fcaf4c40cead630b29bb024d9
+  metadata.gz: 6b800130ba7bb86469ae68e005113eec61b3dee92b546d1a74872d6f6b850901
+  data.tar.gz: 63decc2511cc7bcf6d216fe3e98bea5081e6b5a8a8069ac9a5501e0b8332871a
 SHA512:
-  metadata.gz: cc45be8c2c2ee319867798427b6994d5eba4ad6623419f54c13ed500f2a722b90acc8c5dffbd5d0e92ec6a82b4de9484559eed6798e845159210eaaf00fb324a
-  data.tar.gz: 8d7926b6c830b94aad5e1e77f4951ebd68c6d0cfd4baccd4d004d63fa9aa4701673114b97371f72f05806a2616bc5fcf633e747441e860aff13fd4b90bf4d158
+  metadata.gz: f5e01457fccbe2e08db47413f6b9682a4048722f19877e6a54f7e1bcf73b21e59d92fe3575ada90405b0f287c0deb917b72b0259b988faceed0faf31a6e49ba1
+  data.tar.gz: 3edcb2482bc77266a934faf729314389561ff7c8d24aadc8ff25c2785248efdaa03aa705803ad86aeecf0c24bf7ac4ee4a6e8a2a112c0679b4a5bc181bdaea2e

data/CHANGELOG.md

@@ -1,5 +1,48 @@
 # Workhorse Changelog
 
+## 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
+
+## 1.1.0 - 2020-12-24
+
+* Add `description` column to `DbJob`.
+
+If you're upgrading from a previous version, add the `description` column
+to your `DbJob` table, e.g. with such a migration:
+
+```ruby
+class AddDescriptionToWorkhorseDbJobs < ActiveRecord::Migration[6.0]
+  def change
+    add_column :jobs, :description, :string, after: :perform_at, null: true
+  end
+end
+```
+
 ## 1.0.1 - 2020-12-15
 
 * Fix handling of empty pid files

data/README.md

@@ -81,7 +81,7 @@ GRANT execute ON DBMS_LOCK TO <schema-name>;
 
 Workhorse can handle any jobs that support the `perform` method and are
 serializable. To queue a basic job, use the static method `Workhorse.enqueue`.
-You can optionally pass a queue name and a priority.
+You can optionally pass a queue name, a priority and a description (as a string).
 
 ```ruby
 class MyJob
@@ -94,7 +94,7 @@ class MyJob
   end
 end
 
-Workhorse.enqueue MyJob.new('John'), queue: :test, priority: 2
+Workhorse.enqueue MyJob.new('John'), queue: :test, priority: 2, description: 'Basic Job'
 ```
 
 ### RailsOps operations
@@ -381,7 +381,7 @@ configuration or else using `self.queue_adapter` in a job class inheriting from
 Per default, jobs remain in the database, no matter in which state. This can
 eventually lead to a very large jobs database. You are advised to clean your
 jobs database on a regular interval. Workhorse provides the job
-`Workhose::Jobs::CleanupSucceededJobs` for this purpose that cleans up all
+`Workhorse::Jobs::CleanupSucceededJobs` for this purpose that cleans up all
 succeeded jobs. You can run this using your scheduler in a specific interval.
 
 ## Caveats
@@ -421,4 +421,4 @@ Please consult the [FAQ](FAQ.md).
 
 ## Copyright
 
-Copyright © 2020 Sitrox. See `LICENSE` for further details.
+Copyright © 2021 Sitrox. See `LICENSE` for further details.

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.0.1
+1.2.2

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/generators/workhorse/templates/create_table_jobs.rb

@@ -17,6 +17,8 @@ class CreateTableJobs < ActiveRecord::Migration
       t.integer :priority, null: false
       t.datetime :perform_at, null: true
 
+      t.string :description, null: true
+
       t.timestamps null: false
     end
 

data/lib/workhorse/daemon/shell_handler.rb

@@ -1,6 +1,6 @@
 module Workhorse
   class Daemon::ShellHandler
-    def self.run(options = {}, &block)
+    def self.run(**options, &block)
       unless ARGV.count == 1
         usage
         exit 99
@@ -10,7 +10,7 @@ module Workhorse
       lockfile = File.open(lockfile_path, 'a')
       lockfile.flock(File::LOCK_EX || File::LOCK_NB)
 
-      daemon = Workhorse::Daemon.new(options, &block)
+      daemon = Workhorse::Daemon.new(**options, &block)
 
       begin
         case ARGV.first

data/lib/workhorse/db_job.rb

@@ -7,7 +7,7 @@ module Workhorse
     STATE_FAILED    = :failed
 
     if respond_to?(:attr_accessible)
-      attr_accessible :queue, :priority, :perform_at, :handler
+      attr_accessible :queue, :priority, :perform_at, :handler, :description
     end
 
     self.table_name = 'jobs'

data/lib/workhorse/enqueuer.rb

@@ -1,20 +1,27 @@
 module Workhorse
   module Enqueuer
     # Enqueue any object that is serializable and has a `perform` method
-    def enqueue(job, queue: nil, priority: 0, perform_at: Time.now)
+    def enqueue(job, queue: nil, priority: 0, perform_at: Time.now, description: nil)
       return DbJob.create!(
         queue: queue,
         priority: priority,
         perform_at: perform_at,
+        description: description,
         handler: Marshal.dump(job)
       )
     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

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/lib/workhorse/worker.rb

@@ -13,8 +13,8 @@ module Workhorse
 
     # Instantiates and starts a new worker with the given arguments and then
     # waits for its completion (i.e. an interrupt).
-    def self.start_and_wait(*args)
-      worker = new(*args)
+    def self.start_and_wait(**args)
+      worker = new(**args)
       worker.start
       worker.wait
     end

data/test/lib/db_schema.rb

@@ -18,6 +18,8 @@ ActiveRecord::Schema.define do
     t.integer :priority, null: false
     t.datetime :perform_at, null: true
 
+    t.string :description, null: true
+
     t.timestamps null: false
   end
 

data/test/workhorse/enqueuer_test.rb

@@ -33,6 +33,15 @@ class Workhorse::EnqueuerTest < WorkhorseTest
     assert_equal 1, Workhorse::DbJob.first.priority
   end
 
+  def test_with_description
+    assert_equal 0, Workhorse::DbJob.all.count
+    Workhorse.enqueue BasicJob.new, description: 'Lorem ipsum'
+    assert_equal 1, Workhorse::DbJob.all.count
+
+    db_job = Workhorse::DbJob.first
+    assert_equal 'Lorem ipsum', db_job.description
+  end
+
   def test_op
     Workhorse.enqueue_op DummyRailsOpsOp, { queue: :q1 }, foo: :bar
 

data/workhorse.gemspec

@@ -1,14 +1,14 @@
 # -*- encoding: utf-8 -*-
-# stub: workhorse 1.0.1 ruby lib
+# stub: workhorse 1.2.2 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "workhorse".freeze
-  s.version = "1.0.1"
+  s.version = "1.2.2"
 
   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 = "2020-12-15"
+  s.date = "2021-01-27"
   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.0.1
+  version: 1.2.2
 platform: ruby
 authors:
 - Sitrox
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-15 00:00:00.000000000 Z
+date: 2021-01-27 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