que-scheduler 3.1.1 → 3.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 06b6f5ebd900c51a93128ec3927fecfa21b94121941ea24bf6b1fab012108ef2
-  data.tar.gz: ce6d5d824bbb0861eadafe00d3a0984e8f9fd3dfabd7491a73def267ece8162a
+SHA1:
+  metadata.gz: 6f254bc8751dac98fee9686fd5c239e9e57582fb
+  data.tar.gz: 4aa6fddb651b9f99b02bb75fcd2a2e8aa4f904f4
 SHA512:
-  metadata.gz: 8cb8c5cf44d7363503c2f9a6960fbb8363d2e69401680d7b8fc0a3648fe902d7f5748663e4bfa14558664ddb3e2d3337cae0e5e1456d6577a867b7714cd221c6
-  data.tar.gz: f12ac6c79a998c5c4b868ef9fd2bf847a64d99f8d10853f39c2b3f1e0021cab5dda5c945d0b94aa1581f4a2f7f55cda4c06d25f5133aadf945bd0788db9ec623
+  metadata.gz: 68aa99ec22631df458f58dc2c76bd57ecbf580982e7cb4389e703cdfcb90a4850099ca7a958ae96c80f089804d0ed200419536e123639efc56000da51ab8614c
+  data.tar.gz: f3a19e704d97f15b84d0b550c2220a2beeb475b36d9bb8c499794f0f655cd42922d9a9472e09be93462705d7022e85b6ba81ca44fa95131346d3ab5d04b2b4c3

data/README.md

@@ -180,7 +180,7 @@ As of migration `4`, two elements are added to the DB for que-scheduler to run.
 1. The first is the scheduler job itself, which runs forever, re-enqueuing itself to performs its 
    duties.
 1. The second part comprises the audit table `que_scheduler_audit` and the "enqueued" table 
-  `que_scheduler_audit`. The first tracks when the scheduler calculated what was necessary to run 
+  `que_scheduler_audit_enqueued`. The first tracks when the scheduler calculated what was necessary to run 
   (if anything). The second then logs every job that the scheduler enqueues. 
 
 ## Upgrading
@@ -195,6 +195,7 @@ the root of the project.
 #### Versions 3.x 
   - Addition of a config initializer.
   - Addition of numerous extra columns to the audit table.
+  - Drop support for ruby 2.1 and rails 3.x
   - Required cumulative migration: `Que::Scheduler::Migrations.migrate!(version: 4)`
 #### Versions 2.x 
   - Introduction of the audit table.

data/lib/que/scheduler/db.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
 
+require_relative 'config'
+
 module Que
   module Scheduler
     module Db
       SCHEDULER_COUNT_SQL =
-        "SELECT COUNT(*) FROM que_jobs WHERE job_class = '#{Que::Scheduler::SchedulerJob.name}'"
+        "SELECT COUNT(*) FROM que_jobs WHERE job_class = 'Que::Scheduler::SchedulerJob'"
       NOW_SQL = 'SELECT now()'
 
       class << self

data/lib/que/scheduler/migrations.rb

@@ -24,9 +24,8 @@ module Que
         end
 
         def db_version
-          return 0 if Que::Scheduler::Db.count_schedulers.zero?
-          return 1 unless audit_table_exists?
-          Que.execute(TABLE_COMMENT).first[:description].to_i
+          return Que.execute(TABLE_COMMENT).first[:description].to_i if audit_table_exists?
+          Que::Scheduler::Db.count_schedulers.zero? ? 0 : 1
         end
 
         private

data/lib/que/scheduler/scheduler_job.rb

@@ -3,6 +3,7 @@ require 'que'
 require_relative 'defined_job'
 require_relative 'enqueueing_calculator'
 require_relative 'scheduler_job_args'
+require_relative 'state_checks'
 
 # The main job that runs every minute, determining what needs to be enqueued, enqueues the required
 # jobs, then re-enqueues itself.
@@ -16,7 +17,8 @@ module Que
 
       def run(options = nil)
         Que::Scheduler::Db.transaction do
-          assert_one_scheduler_job
+          Que::Scheduler::StateChecks.check
+
           scheduler_job_args = SchedulerJobArgs.build(options)
           logs = ["que-scheduler last ran at #{scheduler_job_args.last_run_time}."]
 
@@ -61,12 +63,6 @@ module Que
         end
       end
 
-      def assert_one_scheduler_job
-        schedulers = Que::Scheduler::Db.count_schedulers
-        return if schedulers == 1
-        raise "Only one #{self.class.name} should be enqueued. #{schedulers} were found."
-      end
-
       def enqueue_self_again(scheduler_job_args, last_full_execution, job_dictionary, enqueued_jobs)
         next_run_at = scheduler_job_args.as_time.beginning_of_minute + SCHEDULER_FREQUENCY
         SchedulerJob.enqueue(

data/lib/que/scheduler/state_checks.rb

@@ -0,0 +1,63 @@
+require_relative 'audit'
+require_relative 'db'
+require_relative 'migrations'
+
+module Que
+  module Scheduler
+    module StateChecks
+      class << self
+        def check
+          assert_db_migrated
+          assert_one_scheduler_job
+        end
+
+        private
+
+        def assert_db_migrated
+          db_version = Que::Scheduler::Migrations.db_version
+          return if db_version == Que::Scheduler::Migrations::MAX_VERSION
+          raise(<<-ERR)
+            The que-scheduler db migration state was found to be #{db_version}. It should be #{Que::Scheduler::Migrations::MAX_VERSION}.
+
+            que-scheduler adds some tables to the DB to provide an audit history of what was
+            enqueued when, and with what options and arguments. The structure of these tables is
+            versioned, and should match that version required by the gem.
+
+            The currently migrated version of the audit tables is held in a table COMMENT (much like
+            how que keeps track of its DB versions). You can check the current DB version by
+            querying the COMMENT on the #{Que::Scheduler::Audit::TABLE_NAME} table like this:
+
+            #{Que::Scheduler::Migrations::TABLE_COMMENT}
+
+            Or you can use ruby:
+
+              Que::Scheduler::Migrations.db_version
+
+            To bring the db version up to the current one required, add a migration like this. It
+            is cumulative, so one line is sufficient to perform all necessary steps.
+
+            class UpdateQueSchedulerSchema < ActiveRecord::Migration
+              def change
+                Que::Scheduler::Migrations.migrate!(version: #{Que::Scheduler::Migrations::MAX_VERSION})
+              end
+            end
+          ERR
+        end
+
+        def assert_one_scheduler_job
+          schedulers = Que::Scheduler::Db.count_schedulers
+          return if schedulers == 1
+          raise(<<-ERR)
+            Only one #{Que::Scheduler::SchedulerJob.name} should be enqueued. #{schedulers} were found.
+
+            que-scheduler works by running a self-enqueueing version of itself that determines which
+            jobs should be enqueued based on the provided config. If two or more que-schedulers were
+            to run at once, then duplicate jobs would occur.
+
+            To resolve this problem, please remove any duplicate scheduler jobs from the que_jobs table.
+          ERR
+        end
+      end
+    end
+  end
+end

data/lib/que/scheduler/version.rb

@@ -1,5 +1,5 @@
 module Que
   module Scheduler
-    VERSION = '3.1.1'.freeze
+    VERSION = '3.2.1'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: que-scheduler
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.2.1
 platform: ruby
 authors:
 - Harry Lascelles
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-05 00:00:00.000000000 Z
+date: 2018-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: backports
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +86,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  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: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -316,6 +330,7 @@ files:
 - lib/que/scheduler/migrations/4/up.sql
 - lib/que/scheduler/scheduler_job.rb
 - lib/que/scheduler/scheduler_job_args.rb
+- lib/que/scheduler/state_checks.rb
 - lib/que/scheduler/version.rb
 homepage: https://github.com/hlascelles/que-scheduler
 licenses:
@@ -342,7 +357,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.6.14.1
 signing_key: 
 specification_version: 4
 summary: A cron scheduler for Que