Merge pull request #4 from azutoolkit/updates

Adds adds run method

Author: eliasjpr

README.md

@@ -1,12 +1,12 @@
 # JoobQ
 
-![Crystal CI](https://github.com/eliasjpr/joobq/workflows/Crystal%20CI/badge.svg?branch=master) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/757ebd7d1db942da8eb9f8392415b1a6)](https://www.codacy.com/manual/eliasjpr/joobq?utm_source=github.com&utm_medium=referral&utm_content=eliasjpr/joobq&utm_campaign=Badge_Grade)
+![Crystal CI](https://github.com/eliasjpr/joobq/workflows/Crystal%20CI/badge.svg?branch=master)
 
 JoobQ is a fast, efficient asynchronous reliable job queue scheduler library processing. Jobs are submitted
 to a job queue, where they reside until they are able to be scheduled to run in a
 compute environment.
 
-**Features:**
+#### Features:
 
 - [x] Priority queues based on number of workers
 - [x] Reliable queue
@@ -41,6 +41,7 @@ shards install
 ## Requirements
 
 This project uses REDIS with the TimeSeries module loaded. The Redis TimeSeries is used to monitor stats of job execution the module is free for use and easy to configure. Follow the guidelines at [redistimeseries.io](https://oss.redislabs.com/redistimeseries/)
+
 ### Loading and Configuring Redis TimeSeries
 
 Use **DUPLICATE POLICY FIRST** to ignore duplicate stats entries
@@ -73,31 +74,13 @@ Defining Queues: Queues are of type `Hash(String, Queue(T))` where the name of t
 - **Name:** `queue:email`
 - **Number Workers:** 10
 
-```crystal
-require "joobq"
-```
-
-**Environment variables**
-
-```shell
-REDIS_HOST=localhost
-REDIS_PORT=6379
-REDIS_POOL_SIZE=50
-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.
-
-### Properties
-
--   **Name:** `queue:email`
--   **Number Workers:** 10
+### Example
 
 ```crystal
 module JoobQ
-  QUEUES = { "queue:email" => Queue(EmailJob).new("queue:email", 10)}
+  QUEUES = { "queue:priority:high" => Queue(EmailJob).new("queue:priority:high", 20)}
+  QUEUES = { "queue:priority:medium" => Queue(EmailJob).new("queue:priority:medium", 10)}
+  QUEUES = { "queue:priority:low" => Queue(EmailJob).new("queue:priority:low", 2)}
 end
 ```
 
@@ -128,9 +111,19 @@ end
 ### Executing Job
 
 ```crystal
-    EmailJob.perform(email_address: "[email protected]")
-    EmailJob.perform(within: 1.hour, email_address: "[email protected]")
+  # Perform Immediately
+  EmailJob.new(email_address: "[email protected]").perform
+
+  # Async - Adds to Queue
+  EmailJob.perform(email_address: "[email protected]")
+  
+  # Delayed 
+  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

spec/job_spec.cr

@@ -1,5 +1,18 @@
 require "./spec_helper"
 
+class TestJob
+  include JoobQ::Job
+  getter x
+  @queue = "example"
+
+  def initialize(@x : Int32 = 0)
+  end
+
+  def perform
+    @x += 1
+  end
+end
+
 module JoobQ
   describe Job do
     it "performs jobs at later time" do
@@ -8,5 +21,11 @@ module JoobQ
 
       REDIS.zcard(Sets::Delayed.to_s).should eq 1
     end
+
+    it "performs jobs every one second" do
+      job = TestJob.run(every: 1.second, x: 1)
+      sleep 3.seconds
+      job.x.should eq 3
+    end
   end
 end

src/joobq/job.cr

@@ -25,6 +25,15 @@ module JoobQ
         JoobQ.scheduler.delay(job, within)
         job.jid
       end
+
+      # Allows for scheduling Jobs at an interval time span. 
+      #
+      # ```crystal
+      # TestJob.run(every: 1.second, x: 1)
+      # ```
+      def self.run(every : Time::Span, **args)
+        JoobQ.scheduler.every every, self, **args
+      end
     end
 
     abstract def perform

src/joobq/scheduler.cr

@@ -34,6 +34,8 @@ module JoobQ
           spawn { job_instance.perform }
         end
       end
+
+      job_instance
     end
 
     def cron(pattern, &block : ->)