que-scheduler 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 34c186335cf0386ab154de58d4ca489dbb186ce5
-  data.tar.gz: 8dea367b4b83245873e6657ec4191fa778d4698b
+  metadata.gz: a8bac5ee368ed1c96b3564c96c4e3622b9ab2277
+  data.tar.gz: ddef04872cbf3640dcb498c80b59eb3e6093e766
 SHA512:
-  metadata.gz: e5fa939bcc60786ac68de29c384165a7cdb21a054095e185f748bbd2732e24fd70d2f9ae49ee1b20251034600268567610df7e148867ec5e47fce84dbc69efd0
-  data.tar.gz: bc60257fed3c568e362a030277f32a033a36cbdb1a4cf7b1ab3b1e7307d49935d0d25615b0ad215b4edf4633805e3b65e7a5d78d1118dcc48fdf7ddeffa41e46
+  metadata.gz: 7f0aa8fde4d885e5f4cd2dc12798ccf304069e7f30775242ee4c70e3f16feb649f0a36e32be5146033bc66477605717da193ae3335217e292492908f3fc7b68d
+  data.tar.gz: ea10b8a5de1a8008ce79c1ce1da40decf618b9f8e2ec13f0379b93c54ac7d95e1ae23df2095fbed1fd44bad7f357304cb3664cfef7749adc3add9f5dc5bf57d1

data/README.md

@@ -2,7 +2,7 @@ que-scheduler
 ================
 
 [![Build Status](https://travis-ci.org/resque/que-scheduler.svg?branch=master)](https://travis-ci.org/hlascelles/que-scheduler)
-[![Code Climate](https://codeclimate.com/github/hlascelles/sque-scheduler/badges/gpa.svg)](https://codeclimate.com/github/hlascelles/que-scheduler)
+[![Code Climate Maintainability](https://api.codeclimate.com/v1/badges/710d2fc5202f95d76e8a/maintainability)](https://codeclimate.com/github/hlascelles/que-scheduler/maintainability)
 
 ### Description
 
@@ -12,28 +12,21 @@ needs to be run, enqueueing those jobs, then enqueueing itself to check again la
 
 ### Installation
 
-To install, add the gem to your Gemfile:
+1. To install, add the gem to your Gemfile:
+    ```ruby
+    gem 'que-scheduler'
+    ```
+1. Specify a schedule config in a yml file (see below). The default location that que-scheduler will 
+look for it is `config/que_schedule.yml`. They are essentially the same as resque-scheduler config
+files, but with additional features.
 
-```ruby
-gem 'que-scheduler'
-```
-
-You will need to specify a schedule config (see below). The default location that que-scheduler will 
-look for it is `config/que_schedule.yml`
-
-Finally, add a migration to start the job scheduler.
-
-```ruby
-Que::Scheduler::SchedulerJob.enqueue
-```
-
-### Environment Variables
-
-You can configure some aspects of the gem with environment variables.
-
-* `QUE_SCHEDULER_CONFIG_LOCATION` - The location of the schedule configuration (default config/que_schedule.yml)
+1. Add a migration to start the job scheduler.
 
-#### Schedule configuration
+    ```ruby
+    Que::Scheduler::SchedulerJob.enqueue
+    ```
+    
+### Schedule configuration
 
 The schedule file is a list of que job classes with arguments and a schedule frequency (in crontab 
 syntax). The format is a superset of the resque-scheduler config format, so it they can be used
@@ -55,7 +48,7 @@ queue_documents_for_indexing:
   # If you want to have a different job name and class name, provide the 'class' option
   class: "QueueDocuments"
   queue: high
-  args:
+  args: ['reports', 'expenses']
 
 clear_leaderboards_contributors:
   cron: "30 6 * * 1"
@@ -66,24 +59,33 @@ clear_leaderboards_contributors:
 DailyBatchReport:
   cron: "0 3 * * *"
   # This job will be run every day, and if workers are offline for several days, then the backlog
-  # will all be scheduled when they are restored, each with that events timestamp. 
+  # will all be scheduled when they are restored, each with that events timestamp as the first arg.
   unmissable: true
 ```
 
+### Environment Variables
+
+You can configure some aspects of the gem with environment variables.
+
+* `QUE_SCHEDULER_CONFIG_LOCATION` - The location of the schedule configuration (default `config/que_schedule.yml`)
+
 ### Redundancy and Fail-Over
 
 Because of the way que-scheduler works, it requires no additional processes. It is, itself, a Que job.
-As long as there are Que workers functioning, then jobs will continue to be scheduled correctly. 
+As long as there are Que workers functioning, then jobs will continue to be scheduled correctly. There
+are no HA concerns to worry about and no namespace collisions between different databases. 
+
+Additionally, like Que, when your database is backed up, your scheduling state is stored too.
 
 ### How it works
 
-que-scheduler is a job that reads a config file, then schedules itself endlessly on a delay, enqueueing 
-any jobs it determines that need to be run. The flow is as follows
+que-scheduler is a job that reads a config file, enqueues any jobs it determines that need to be run,
+then reschedules itself. The flow is as follows:
 
-1. The job for the very first time.
-1. que-scheduler loads the config file, and notices it is new. It will not schedule any other jobs, except itself.
-1. Some time later it runs again. It knows what jobs it should be monitoring, and notices that some have are due. It enqueues those jobs and itself.
-1. After a deploy that changes the config, it notices a new job to monitor, and one to forget.
+1. The que-scheduler job runs for the very first time.
+1. que-scheduler loads the schedule config file. It will not schedule any other jobs, except itself, as it has never run before.
+1. Some time later it runs again. It knows what jobs it should be monitoring, and notices that some have are due. It enqueues those jobs and then itself. Repeat.
+1. After a deploy that changes the config, the job notices any new jobs to schedule, and knows which ones to forget. It does not need to be re-enqueued or restarted.
 
 ### Thanks
 

data/lib/que/scheduler/schedule_parser.rb

@@ -55,7 +55,7 @@ module Que
         def next_run_time(cron, from, to)
           fugit_cron = Fugit::Cron.parse(cron)
           next_time = fugit_cron.next_time(from)
-          next_run = next_time.to_local_time
+          next_run = next_time.to_local_time.in_time_zone(next_time.zone)
           next_run <= to ? next_run : nil
         end
       end

data/lib/que/scheduler/scheduler_job.rb

@@ -10,7 +10,7 @@ module Que
 
       def run(last_time = nil, known_jobs = [])
         ::ActiveRecord::Base.transaction do
-          last_time = last_time.nil? ? Time.now : Time.parse(last_time)
+          last_time = last_time.nil? ? Time.now : Time.zone.parse(last_time)
           as_time = Time.now
 
           result =

data/lib/que/scheduler/version.rb

@@ -1,5 +1,5 @@
 module Que
   module Scheduler
-    VERSION = '0.1.0'.freeze
+    VERSION = '0.2.0'.freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: que-scheduler
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Harry Lascelles
@@ -164,6 +164,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: zonebie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
 description: A lightweight cron scheduler for the async job worker Que
 email:
 - harry@harrylascelles.com