unicron 0.1.0 → 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7ba43e87dc6d00eec7c0c543b402b5d3f9f02d8b
+  data.tar.gz: cff45adb3cf6e095cbf160ad7dc6b821f40b857f
+SHA512:
+  metadata.gz: d7abe6f4fd7b54f5efd37259d835ce7e2fd3d3e88a8231083297c1f41bc7359a0933776df01204816b1a1535f3dd3843f759b59dcd4245fd54b64207d2d760a3
+  data.tar.gz: e62feaba9e0445b490fa6ac6c908d0a8091e6da4706c5564a2f589b37bfaf01421fa51bc9ffe4ad70de3cf3f340ee831ff6e32aa774d7d6bcadbd778000da86f

data/README.rdoc

@@ -0,0 +1,69 @@
+= Unicron
+
+Unicron provides a simple mechanism for scheduling one-off and repeating tasks
+to execute at specific times in the background of a long-running Ruby process.
+The easiest way to set up a Unicron job is to call Unicron::schedule.
+
+The +delay+ parameter schedules a job to run a certain number of seconds in the
+future:
+
+  Unicron.schedule delay: 180 do
+    puts "Ramen's done."
+  end
+
+The +at+ parameter schedules a job to run at a certain time. If the time has
+passed, the job runs immediately:
+
+  Unicron.schedule at: Time.parse('23:00') do
+    puts 'Go to bed!'
+  end
+
+The +delay+ parameter can be combined with +repeat+ to schedule a repeating job:
+
+  Unicron.schedule delay: 1, repeat: true do
+    puts Time.now.sec.odd? ? 'tick' : 'tock'
+  end
+
+If both +at+ and +delay+ are used with +repeat+, the job will first run at the
+time specified by +at+ and then repeat every +repeat+ seconds afterwards. If
++repeat+ is Numeric, it specifies the number of times to repeat the Job.
+
+  Unicron.schedule at: Time.parse('7:00'), delay: 600, repeat: 3
+    puts 'WAKE UP!'
+  end
+
+When both +at+ and +delay+ are specified, and +at+ is in the past, Unicron will
+run the job at the first future even multiple of +delay+ seconds after +at+.
+Although this sounds complicated, it's an easy way to make sure a job runs at
+the same time every day, or only at the top of the hour.
+
+  Unicron.schedule at: Time.parse('12:00'), delay: 86400 do
+    puts 'Time for lunch!'
+  end
+
+The optional +job+ block parameter can be used to modify the job settings from
+within the task.
+
+  Unicron.schedule delay: rand(30), repeat: true do |job|
+    puts 'Peekaboo!'
+    delay = rand 30
+    if delay == 0
+      job.cancel
+    else
+      job.delay = delay
+    end
+  end
+
+== Unicron is not +cron+
+
+Although Unicron serves many of the same purposes as +cron+, there are important
+distinctions between the two. Unicron runs in a background thread of a
+(presumably) long-running Ruby process like your web application. This makes it
+ideal for tasks that are lightweight, dependent on the main process, or which do
+not need to run unless the main process is also running. Unicron also requires
+no system administration, making it an attractive choice if you're authoring a
+turnkey gem that needs to run periodic tasks in the background.
+
+On the other hand, +cron+ is independent of any other processes and is always
+running in the background. This makes +cron+ better suited for spawning
+heavyweight tasks which have limited interaction with the main process.

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: unicron
 version: !ruby/object:Gem::Version
-  version: 0.1.0
-  prerelease: 
+  version: 0.1.2
 platform: ruby
 authors:
 - David P Kleinschmidt
@@ -10,52 +9,56 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-18 00:00:00.000000000Z
+date: 2014-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &83620100 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.7.0
+        version: '2.7'
   type: :development
   prerelease: false
-  version_requirements: *83620100
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
 description: Schedules one-off and repeating background tasks within long-running
   ruby processes.
 email: david@kleinschmidt.name
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.rdoc
 files:
+- README.rdoc
 - lib/unicron.rb
-- lib/unicron/schedule.rb
-- lib/unicron/job_queue.rb
 - lib/unicron/job.rb
-homepage: http://github.com/zobar/unicron
+- lib/unicron/job_queue.rb
+- lib/unicron/schedule.rb
+homepage: http://bitbucket.org/zobar/unicron
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 2.2.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Schedule background tasks.
 test_files: []