clockwork 0.3.1 → 0.3.2

data/README.md

@@ -35,6 +35,31 @@ Run it with the clockwork binary:
     Starting clock for 4 events: [ frequent.job less.frequent.job hourly.job midnight.job ]
     Triggering frequent.job
 
+If you would not like to taint the namespace with `include Clockwork`, you can use
+it as the module (thanks to [hoverlover](https://github.com/hoverlover/clockwork/)).
+
+    require 'clockwork'
+
+    module Clockwork
+      handler do |job|
+        puts "Running #{job}"
+      end
+
+      every(10.seconds, 'frequent.job')
+      every(3.minutes, 'less.frequent.job')
+      every(1.hour, 'hourly.job')
+
+      every(1.day, 'midnight.job', :at => '00:00')
+    end
+
+Quickstart for Heroku
+---------------------
+
+Clockwork fits well with heroku's cedar stack.
+
+Consider to use [clockwork-init.sh](https://gist.github.com/1312172) to create
+a new project for heroku.
+
 Use with queueing
 -----------------
 
@@ -70,6 +95,31 @@ enqueue methods.  For example, with DJ/Rails:
     every(1.hour, 'feeds.refresh') { Feed.send_later(:refresh) }
     every(1.day, 'reminders.send', :at => '01:30') { Reminder.send_later(:send_reminders) }
 
+Parameters
+----------
+
+### :at
+
+`:at` parameter the hour and minute specifies when the event occur.
+
+The simplest example:
+
+    every(1.day, 'reminders.send', :at => '01:30')
+
+You can omit 0 of the hour:
+
+    every(1.day, 'reminders.send', :at => '1:30')
+
+The wildcard for hour is supported:
+
+    every(1.hour, 'reminders.send', :at => '**:30')
+
+You can set more than one timing:
+
+    every(1.hour, 'reminders.send', :at => ['12:00', '18:00'])
+    # send reminders at noon and evening
+
+
 Anatomy of a clock file
 -----------------------
 

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.3.2

data/bin/clockwork

@@ -3,7 +3,6 @@
 STDERR.sync = STDOUT.sync = true
 
 require File.expand_path('../../lib/clockwork', __FILE__)
-include Clockwork
 
 usage = "clockwork <clock.rb>"
 file = ARGV.shift or abort usage
@@ -17,4 +16,4 @@ trap('INT') do
 	exit
 end
 
-run
+Clockwork::run

data/lib/clockwork.rb

@@ -49,12 +49,12 @@ module Clockwork
 		def parse_at(at)
 			return unless at
 			case at
-			when /^(\d\d):(\d\d)$/
+			when /^(\d{1,2}):(\d\d)$/
 				hour = $1.to_i
 				min  = $2.to_i
 				raise FailedToParse, at if hour >= 24 || min >= 60
 				[hour, min]
-			when /^\*\*:(\d\d)$/
+			when /^\*{1,2}:(\d\d)$/
 				min = $1.to_i
 				raise FailedToParse, at if min >= 60
 				[nil, min]

data/test/clockwork_test.rb

@@ -16,10 +16,16 @@ class ClockworkTest < Test::Unit::TestCase
 	end
 
 	def assert_will_run(t)
+		if t.is_a? String
+			t = Time.parse(t)
+		end
 		assert_equal 1, Clockwork.tick(t).size
 	end
 
 	def assert_wont_run(t)
+		if t.is_a? String
+			t = Time.parse(t)
+		end
 		assert_equal 0, Clockwork.tick(t).size
 	end
 
@@ -50,33 +56,49 @@ class ClockworkTest < Test::Unit::TestCase
 	test "once a day at 16:20" do
 		Clockwork.every(1.day, 'myjob', :at => '16:20')
 
-		assert_wont_run Time.parse('jan 1 2010 16:19:59')
-		assert_will_run Time.parse('jan 1 2010 16:20:00')
-		assert_wont_run Time.parse('jan 1 2010 16:20:01')
-		assert_wont_run Time.parse('jan 2 2010 16:19:59')
-		assert_will_run Time.parse('jan 2 2010 16:20:00')
+		assert_wont_run 'jan 1 2010 16:19:59'
+		assert_will_run 'jan 1 2010 16:20:00'
+		assert_wont_run 'jan 1 2010 16:20:01'
+		assert_wont_run 'jan 2 2010 16:19:59'
+		assert_will_run 'jan 2 2010 16:20:00'
+	end
+
+	test ":at also accepts 8:20" do
+		Clockwork.every(1.hour, 'myjob', :at => '8:20')
+
+		assert_wont_run 'jan 1 2010 08:19:59'
+		assert_will_run 'jan 1 2010 08:20:00'
+		assert_wont_run 'jan 1 2010 08:20:01'
 	end
 
 	test "twice a day at 16:20 and 18:10" do
 		Clockwork.every(1.day, 'myjob', :at => ['16:20', '18:10'])
 
-		assert_wont_run Time.parse('jan 1 2010 16:19:59')
-		assert_will_run Time.parse('jan 1 2010 16:20:00')
-		assert_wont_run Time.parse('jan 1 2010 16:20:01')
+		assert_wont_run 'jan 1 2010 16:19:59'
+		assert_will_run 'jan 1 2010 16:20:00'
+		assert_wont_run 'jan 1 2010 16:20:01'
 
-		assert_wont_run Time.parse('jan 1 2010 18:09:59')
-		assert_will_run Time.parse('jan 1 2010 18:10:00')
-		assert_wont_run Time.parse('jan 1 2010 18:10:01')
+		assert_wont_run 'jan 1 2010 18:09:59'
+		assert_will_run 'jan 1 2010 18:10:00'
+		assert_wont_run 'jan 1 2010 18:10:01'
 	end
 
 	test "once an hour at **:20" do
 		Clockwork.every(1.hour, 'myjob', :at => '**:20')
 
-		assert_wont_run Time.parse('jan 1 2010 15:19:59')
-		assert_will_run Time.parse('jan 1 2010 15:20:00')
-		assert_wont_run Time.parse('jan 1 2010 15:20:01')
-		assert_wont_run Time.parse('jan 2 2010 16:19:59')
-		assert_will_run Time.parse('jan 2 2010 16:20:00')
+		assert_wont_run 'jan 1 2010 15:19:59'
+		assert_will_run 'jan 1 2010 15:20:00'
+		assert_wont_run 'jan 1 2010 15:20:01'
+		assert_wont_run 'jan 2 2010 16:19:59'
+		assert_will_run 'jan 2 2010 16:20:00'
+	end
+
+	test ":at also accepts *:20" do
+		Clockwork.every(1.hour, 'myjob', :at => '*:20')
+
+		assert_wont_run 'jan 1 2010 15:19:59'
+		assert_will_run 'jan 1 2010 15:20:00'
+		assert_wont_run 'jan 1 2010 15:20:01'
 	end
 
 	test "aborts when no handler defined" do

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: clockwork
 version: !ruby/object:Gem::Version 
-  hash: 17
   prerelease: 
-  segments: 
-  - 0
-  - 3
-  - 1
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors: 
 - Adam Wiggins
@@ -15,50 +10,41 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-18 00:00:00 +09:00
+date: 2011-11-11 00:00:00 +09:00
 default_executable: clockwork
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: jeweler
-  prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
   type: :development
+  prerelease: false
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: contest
-  prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
   type: :development
+  prerelease: false
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: mocha
-  prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
   type: :development
+  prerelease: false
   version_requirements: *id003
 description: A scheduler process to replace cron, using a more flexible Ruby syntax running as a single long-running process.  Inspired by rufus-scheduler and resque-scheduler.
 email: adam@heroku.com
@@ -91,23 +77,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: clockwork
-rubygems_version: 1.6.2
+rubygems_version: 1.5.0
 signing_key: 
 specification_version: 3
 summary: A scheduler process to replace cron.