Scheduler config

Author: eliasjpr

README.md

@@ -61,7 +61,8 @@ REDIS_TIMEOUT=0.2
 
 ## Defining Queues
 
-Defining Queues: Queues are of type `Hash(String, Queue(T))` where the name of the key matches the name of the Queue.
+Defining Queues: Queues are of type `Hash(String, Queue(T))` where the name of
+the key matches the name of the Queue.
 
 ### Properties
 
@@ -73,9 +74,15 @@ Defining Queues: Queues are of type `Hash(String, Queue(T))` where the name of t
 
 ```crystal
 JoobQ.configure do
-  queue "queue:Email", 1, EmailJob
-  queue "queue:Fail", 1, FailJob
-  queue "queue:Test", 1, TestJob
+  queue "single", 10, Job1
+  queue "example", 10, ExampleJob | FailJob
+
+  # Scheduling Recurring Jobs
+  scheduler do
+    cron("*/1 * * * *") { # Do Something }
+    cron("*/5 20-23 * * *") { # Do Something }
+    every 1.hour, ExampleJob, x: 1
+  end
 end
 ```
 
@@ -94,7 +101,7 @@ struct EmailJob
   @expires = 1.days.total_seconds.to_i
 
   # Initialize as normal with or without named tuple arguments
-  def initialize(email_address : String)
+  def initialize(@email_address : String)
   end
 
   def perform
@@ -116,19 +123,7 @@ end
   EmailJob.perform(within: 1.hour, email_address: "[email protected]")
 
   # Recurring at given interval
-  EmailJob.run(every: 1.second, x: 1)
-```
-
-## Defining And Scheduling Recurring Jobs
-
-```crystal
-module JoobQ
-  scheduler.register do
-    cron "5 4 * * *" { Somejob.perform }
-    delay job_instance, for: 1.minute
-    every 1.hour, EmailJob, email_address: "[email protected]"
-  end
-end
+  EmailJob.run(every: 1.second, email_address: "[email protected]")
 ```
 
 ## Running JoobQ

shard.yml

@@ -1,5 +1,5 @@
 name: joobq
-version: 0.2.5
+version: 0.2.6
 
 authors:
   - Elias J. Perez <[email protected]>

spec/jobs/jobs.cr

@@ -0,0 +1,40 @@
+struct FailJob
+  include JoobQ::Job
+
+  @queue = "example"
+  @retries = 0
+
+  def initialize
+  end
+
+  def perform
+    raise "Bad"
+  end
+end
+
+struct ExampleJob
+  include JoobQ::Job
+
+  property x : Int32
+  @retries = 3
+
+  def initialize(@x : Int32)
+    @queue = "example"
+  end
+
+  def perform
+    x + 1
+  end
+end
+
+struct Job1
+  include JoobQ::Job
+  @retries = 0
+  @queue = "single"
+
+  def initialize
+  end
+
+  def perform
+  end
+end

spec/jobbq_spec.cr spec/joobq_spec.cr

@@ -9,4 +9,12 @@ describe JoobQ do
     JoobQ["example"].should be_a JoobQ::Queue(ExampleJob | FailJob)
     JoobQ["single"].should be_a JoobQ::Queue(Job1)
   end
+
+  it "registers recurring jobs at specific time" do
+    jobs = JoobQ.scheduler.jobs
+
+    jobs["*/1 * * * *"].should_not be_nil
+    jobs["*/5 20-23 * * *"].should_not be_nil
+    jobs[ExampleJob.name].should_not be_nil
+  end
 end

spec/scheduler_spec.cr

@@ -30,13 +30,6 @@ module JoobQ
     end
 
     describe "#cron" do
-      it "registers recurring jobs at specific time" do
-        scheduler.register do
-          cron("*/1 * * * *") { }
-          cron("*/5 20-23 * * *") { }
-        end
-      end
-
       it "schedules a new recurring job" do
         scheduler.cron("*/1 * * * *") { }
       end

spec/spec_helper.cr

@@ -1,48 +1,14 @@
 require "spec"
 require "../src/joobq"
-
-struct FailJob
-  include JoobQ::Job
-
-  @queue = "example"
-  @retries = 0
-
-  def initialize
-  end
-
-  def perform
-    raise "Bad"
-  end
-end
-
-struct ExampleJob
-  include JoobQ::Job
-
-  property x : Int32
-  @retries = 3
-
-  def initialize(@x : Int32)
-    @queue = "example"
-  end
-
-  def perform
-    x + 1
-  end
-end
-
-struct Job1
-  include JoobQ::Job
-  @retries = 0
-  @queue = "single"
-
-  def initialize
-  end
-
-  def perform
-  end
-end
+require "./jobs/*"
 
 JoobQ.configure do
   queue "single", 10, Job1
   queue "example", 10, ExampleJob | FailJob
+
+  scheduler do
+    cron("*/1 * * * *") { }
+    cron("*/5 20-23 * * *") { }
+    every 1.hour, ExampleJob, x: 1
+  end
 end

src/joobq/configure.cr

@@ -16,5 +16,9 @@ module JoobQ
       queues[{{name}}] = JoobQ::Queue({{kind.id}}).new({{name}}, {{workers}})
       {% end %}
     end
+
+    def scheduler
+      with Scheduler.instance yield
+    end
   end
 end

src/joobq/scheduler.cr

@@ -16,10 +16,6 @@ module JoobQ
       @periodic_jobs.clear
     end
 
-    def register(&block)
-      with self yield
-    end
-
     def delay(job : JoobQ::Job, for till : Time::Span)
       REDIS.zadd(delayed_queue, till.from_now.to_unix_f, job.to_json)
     end