when-do 1.1.4 → 1.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3103ad14eb23f6def0e7b2fd98e12be3440156f1
-  data.tar.gz: 83020598edfaaaf6d5f12c5209c3e4646981a181
+  metadata.gz: d7344050b98b79dee12e165ab840351ca4dd7ce9
+  data.tar.gz: db99f14c49e9bea72e747fc8d8c92b1376e1b6e4
 SHA512:
-  metadata.gz: 030dd5ea2f710542554d6d06104e64286037e516e3edeb9e49457eb89f37b339e8b555c5bad49000a79379a946cc5998d065a84d9011e391a89c9161760bb53d
-  data.tar.gz: ae300f1e1d87441b9b8d406e7c6690bee2be3df8ac49b8438604ca9c4ba6a803f20e716f05d807c4fa9edba0e72476f0c8b061d38eb3dce2d09ecc51c43af939
+  metadata.gz: 2b9a2ef9663eb74715e5d64fd195a418f039fb0d73538c9590088764d0335bb412a74e237d9ab616148fdf3beeeb90906820634d8945314b2b203e54001a712a
+  data.tar.gz: 6b3504daa5753f736ba81218a770579f48b9643d708dde31842f4d87d2e87ebeb18d259cd992f207836260b5257cbfd9bd1fb307e5950dd70aa2ac5036665e38

data/lib/when-do.rb

@@ -3,7 +3,12 @@ require 'json'
 require 'yaml'
 require 'logger'
 
+require 'when-cron'
+
 module When
+  class Error < StandardError; end
+  class InvalidCron < Error; end
+
   DEFAULT_CONFIG = {
     schedule_key:      'when:schedules',
     worker_queue_key:  'when:queue:default',
@@ -11,11 +16,16 @@ module When
   }
 
   def self.schedule(name, cron, klass, *args)
+    raise InvalidCron, "\"#{cron}\" is invalid" unless valid_cron?(cron)
     schedule = {'class' => klass.to_s, 'cron' => cron, 'args' => args}
     redis.hset(schedule_key, name.to_s, schedule.to_json)
     logger.info("Scheduled '#{name}' => #{schedule}.")
   end
 
+  def self.valid_cron?(cron)
+    When::Cron.valid?(cron)
+  end
+
   def self.unschedule(name)
     json_sched = redis.hget(schedule_key, name.to_s)
     schedule = JSON.parse(json_sched) if json_sched

data/lib/when-do/do.rb

@@ -117,9 +117,12 @@ module When
       logger.info("Analyzing #{schedules.count} schedules.")
       scheduled_jobs = schedules.inject([]) do |jobs, s|
         schedule = JSON.parse(s)
-        cron = When::Cron.new(schedule['cron'])
-        if cron == started_at
-          jobs << { 'jid' => SecureRandom.uuid, 'class' => schedule['class'], 'args' => schedule['args'] }.to_json
+        if cron = When::Cron.valid(schedule['cron'])
+          if cron == started_at
+            jobs << { 'jid' => SecureRandom.uuid, 'class' => schedule['class'], 'args' => schedule['args'] }.to_json
+          end
+        else
+          logger.error { "Could not interpret cron for #{schedule.inspect}" }
         end
         jobs
       end

data/spec/lib/when-do/do_spec.rb

@@ -74,7 +74,7 @@ describe When::Do do
 
     context 'a scheduled item does not have a matching cron' do
       before do
-        When.schedule('test schedule', '0 0 0 0 0', String)
+        When.schedule('test schedule', '0 0 1 1 0', String)
       end
 
       it 'does not add an item to the queue' do
@@ -83,6 +83,20 @@ describe When::Do do
           .from(nil)
       end
     end
+
+    context 'a scheduled item has an erroneous cron' do
+      before do
+        schedule = {'class' => String.to_s, 'cron' => 'this cron is totally wrong', 'args' => []}
+        redis.hset(When.schedule_key, 'test_schedule', schedule.to_json)
+      end
+
+      it 'does not add an item to the queue' do
+        expect(When.schedules.count).to eq 1
+        expect { when_do.queue_scheduled(started_at) }
+          .not_to change { redis.lpop(when_do.worker_queue_key) }
+          .from(nil)
+      end
+    end
   end
 
   describe '#queue_delayed' do

data/spec/lib/when-do_spec.rb

@@ -15,12 +15,35 @@ describe When do
   end
 
   describe '#schedule' do
-    it 'adds data to the schedules hash in redis' do
-      When.schedule('test_schedule', '* * * * *',  Object, 'arg1', 'arg2')
-      expect(redis.hget(When.schedule_key, 'test_schedule')).to eq "{\"class\":\"Object\",\"cron\":\"* * * * *\",\"args\":[\"arg1\",\"arg2\"]}"
+    context 'scheduling a valid cron' do
+      it 'adds data to the schedules hash in redis' do
+        When.schedule('test_schedule', '* * * * *',  Object, 'arg1', 'arg2')
+        expect(redis.hget(When.schedule_key, 'test_schedule')).to eq "{\"class\":\"Object\",\"cron\":\"* * * * *\",\"args\":[\"arg1\",\"arg2\"]}"
+      end
+    end
+
+    context 'scheduling an invalid cron' do
+      it 'raises a When::InvalidCron error' do
+        expect {
+          When.schedule('test_schedule', '0 0 0 0 0',  Object, 'arg1', 'arg2')
+        }.to raise_error When::InvalidCron
+      end
     end
   end
 
+  describe '.valid_cron?' do
+    context 'when cron is valid' do
+      it 'returns true' do
+        expect(When.valid_cron?('* * * * *')).to eq true
+      end
+    end
+
+    context 'when cron is not valid' do
+      it 'returns false' do
+        expect(When.valid_cron?('* * * a* *')).to eq false
+      end
+    end
+  end
   describe '#unschedule' do
     it 'removes data from the schedules hash in redis' do
       When.schedule('test_schedule', '* * * * *', Object)

data/when-do.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "when-do"
-  spec.version       = '1.1.4'
+  spec.version       = '1.1.6'
   spec.authors       = ["TH"]
   spec.email         = ["tylerhartland7@gmail.com"]
   spec.description   = %q{Queues jobs when you want.}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: when-do
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.1.6
 platform: ruby
 authors:
 - TH