workhorse 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: da01b73fc0a4be6598393d2c4b0fbbd917c83233
-  data.tar.gz: 637033b135c6f8fb1c4ad178c05954ba3d495a22
+  metadata.gz: 988bad51b4a7ea3316129ee6119d4a4ad5412cb5
+  data.tar.gz: 188a0a4f98ec7ae2a144de341764547ccec7d76a
 SHA512:
-  metadata.gz: cb5a848ac259293e090c931d3faed8baa23a96087a5724802855340f60a85256e0da57ca30c4b2b600694330fa35d760f2320cd41a6ed3f7a2c88b253f50c8ed
-  data.tar.gz: 8d20351d7fcd8bde6f05eb186efd3b9f64e488d1e3da91b62b489e2564b6df7a2a23983cdb74243c1fc086ec97d504088a2ee5b430b661feb8c2c08065205651
+  metadata.gz: 0f04fd7e1a186d9ffd196a803e2e251c71812e922e4bd1f5b7f8ceb21b2d816c8b031b4c031bde83de5dc210df362d88e2af5593ea94c6f8b9531d42b3e9cd0b
+  data.tar.gz: a1253139820afa9e4035b85c61ed663e8f8caf6eefa3aec2c040ad3e36e5859d195c3bed6133d46c07fb9751af766e78db1252e6f6fb4857095429dfffefc100

data/.rubocop.yml

@@ -82,3 +82,6 @@ Style/ClassAndModuleChildren:
 
 Style/NumericPredicate:
   Enabled: false
+
+Layout/IndentHeredoc:
+  Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Workhorse Change log
 
+## 0.3.1 – 2018-02-22
+
+* Adds support for Ruby >= 2.0.0 / Rails >= 3.2
+
 ## 0.3.0 – 2017-12-27
 
 ### Added

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017 Sitrox
+Copyright (c) 2018 Sitrox
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -33,6 +33,8 @@ What it does not do:
 
 ### Requirements
 
+* Ruby `>= 2.0.0`
+* Rails `>= 3.2`
 * A database and table handler that properly supports row-level locking (such as
   MySQL with InnoDB, PostgreSQL, or Oracle).
 * If you are planning on using the daemons handler:
@@ -148,26 +150,26 @@ achieving regular execution:
 
    ```ruby
    #!/usr/bin/env ruby
-   
+
    require './config/environment'
-   
+
    Workhorse::Daemon::ShellHandler.run do
      worker = Workhorse::Worker.new(pool_size: 5, polling_interval: 10, logger: Rails.logger)
      scheduler = Rufus::Scheduler.new
-   
+
      worker.start
-   
+
      scheduler.cron '0/10 * * * *' do
        Workhorse.enqueue Workhorse::Jobs::CleanupSucceededJobs.new
      end
-   
+
      Signal.trap 'TERM' do
        scheduler.shutdown
        Thread.new do
          worker.shutdown
        end.join
      end
-   
+
      scheduler.join
      worker.wait
    end
@@ -248,4 +250,4 @@ Please consult the [FAQ](FAQ.md).
 
 ## Copyright
 
-Copyright © 2017 Sitrox. See `LICENSE` for further details.
+Copyright © 2018 Sitrox. See `LICENSE` for further details.

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.3.1

data/lib/generators/workhorse/templates/create_table_jobs.rb

@@ -1,9 +1,9 @@
-class CreateTableJobs < ActiveRecord::Migration[4.2]
+class CreateTableJobs < ActiveRecord::Migration
   def change
     create_table :jobs, force: true do |t|
       t.string :state, null: false, default: 'waiting'
       t.string :queue, null: true
-      t.text :handler, null: false, limit: 4_294_967_295
+      t.blob :handler, null: false, limit: 4_294_967_295
 
       t.string :locked_by
       t.datetime :locked_at

data/lib/workhorse.rb

@@ -5,6 +5,9 @@ require 'active_record'
 require 'workhorse/enqueuer'
 
 module Workhorse
+  # Check if the available Arel version is greater or equal than 7.0.0
+  AREL_GTE_7 = Gem::Version.new(Arel::VERSION) >= Gem::Version.new('7.0.0')
+
   extend Workhorse::Enqueuer
 
   @set_up = false
@@ -16,12 +19,12 @@ module Workhorse
       || fail('No performer is associated with the current thread. This method must always be called inside of a job.')
   end
 
-  cattr_accessor :tx_callback
+  mattr_accessor :tx_callback
   self.tx_callback = proc do |&block|
     ActiveRecord::Base.transaction(&block)
   end
 
-  cattr_accessor :perform_jobs_in_tx
+  mattr_accessor :perform_jobs_in_tx
   self.perform_jobs_in_tx = true
 
   def self.setup

data/lib/workhorse/daemon/shell_handler.rb

@@ -41,36 +41,36 @@ module Workhorse
     end
 
     def self.usage
-      warn <<~USAGE
-        Usage: #{$PROGRAM_NAME} start|stop|status|watch|restart|usage
+      warn <<USAGE
+Usage: #{$PROGRAM_NAME} start|stop|status|watch|restart|usage
 
-        Options:
+Options:
 
-          start
-            Start the daemon
+  start
+    Start the daemon
 
-          stop
-            Stop the daemon
+  stop
+    Stop the daemon
 
-          status
-            Query the status of the daemon. Exit with status 1 if any worker is
-            not running.
+  status
+    Query the status of the daemon. Exit with status 1 if any worker is
+    not running.
 
-          watch
-            Checks the status (running or stopped) and whether it is as
-            expected. Starts the daemon if it is expected to run but is not.
+  watch
+    Checks the status (running or stopped) and whether it is as
+    expected. Starts the daemon if it is expected to run but is not.
 
-          restart
-            Shortcut for consecutive 'stop' and 'start'.
+  restart
+    Shortcut for consecutive 'stop' and 'start'.
 
-          usage
-            Show this message
+  usage
+    Show this message
 
-        Exit status:
-         0  if OK,
-         1  if at least one worker has an unexpected status,
-         99 on all other errors.
-      USAGE
+Exit status:
+ 0  if OK,
+ 1  if at least one worker has an unexpected status,
+ 99 on all other errors.
+USAGE
     end
   end
 end

data/lib/workhorse/poller.rb

@@ -122,7 +122,11 @@ module Workhorse
       union_query_sql += ') subselect'
 
       # Create a new SelectManager to work with, using the UNION as data source
-      select = Arel::SelectManager.new(Arel.sql(union_query_sql))
+      if AREL_GTE_7
+        select = Arel::SelectManager.new(Arel.sql(union_query_sql))
+      else
+        select = Arel::SelectManager.new(ActiveRecord::Base, Arel.sql(union_query_sql))
+      end
       select = order(select.project(Arel.star))
 
       # Limit number of records
@@ -186,7 +190,8 @@ module Workhorse
       # Restrict queues that are currently in progress
       bad_queries_select = table.project(table[:queue])
                                 .where(table[:state].in(%i[locked running]))
-                                .distinct
+      # .distinct is not chainable in older Arel versions
+      bad_queries_select.distinct
       select = select.where(table[:queue].not_in(bad_queries_select))
 
       # Restrict queues to valid ones as indicated by the options given to the

data/workhorse.gemspec

@@ -1,16 +1,16 @@
 # -*- encoding: utf-8 -*-
-# stub: workhorse 0.3.0 ruby lib
+# stub: workhorse 0.3.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "workhorse".freeze
-  s.version = "0.3.0"
+  s.version = "0.3.1"
 
   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 = "2017-12-27"
+  s.date = "2018-02-22"
   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/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/run_rails_op.rb".freeze, "lib/workhorse/performer.rb".freeze, "lib/workhorse/poller.rb".freeze, "lib/workhorse/pool.rb".freeze, "lib/workhorse/worker.rb".freeze, "test/lib/db_schema.rb".freeze, "test/lib/jobs.rb".freeze, "test/lib/test_helper.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 = "2.7.2".freeze
+  s.rubygems_version = "2.6.6".freeze
   s.summary = "Multi-threaded job backend with database queuing for ruby.".freeze
   s.test_files = ["test/lib/db_schema.rb".freeze, "test/lib/jobs.rb".freeze, "test/lib/test_helper.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]
 

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: workhorse
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Sitrox
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-27 00:00:00.000000000 Z
+date: 2018-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   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
@@ -56,98 +56,98 @@ dependencies:
   name: minitest
   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: mysql2
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.3.13
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.3.13
 - !ruby/object:Gem::Dependency
   name: benchmark-ips
   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: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !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
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: 
@@ -156,10 +156,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".releaser_config"
-- ".rubocop.yml"
-- ".travis.yml"
+- .gitignore
+- .releaser_config
+- .rubocop.yml
+- .travis.yml
 - CHANGELOG.md
 - FAQ.md
 - Gemfile
@@ -202,17 +202,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Multi-threaded job backend with database queuing for ruby.