rcron 0.1.0 → 0.1.1

data/CHANGELOG.rdoc

@@ -1,3 +1,6 @@
+=== 0.1.1 / 2011/09/06
+* RCron#enq and RCron::Task#deq as aliases of q and dq
+
 === 0.1.0 / 2011/08/31
 * Initial release
 

data/{README.rdoc → README.markdown}

@@ -1,65 +1,74 @@
-= rcron
+# rcron
 
 A simple cron-like scheduler for Ruby.
 
-== Installation
-  gem install rcron
+## Installation
+```ruby
+gem install rcron
+```
 
-== Cron format
+## Cron format
 As of now, most of the expressions except for ? and W are supported.
 
 http://en.wikipedia.org/wiki/Cron#Format
 
-== Examples
-
-=== Basic
-  require 'rcron'
-  rcron = RCron.new
-
-  # Enqueue a task
-  rcron.q('runs every two minutes', '*/2 * * * *') do |task|
-    # Task logic
-    # ...
-  end
-
-  # You can `q' any number of tasks before starting rcron
-
-  rcron.start
-
-=== One-time only task
-  rcron = RCron.new
-  rcron.q('will run once at 8pm next second friday', '0 8 * * fri#2') do |task|
-    # Removes the task from the queue
-    task.dq
-
-    # Task logic
-    # ...
-  end
-  rcron.start
-
-=== Options
-  rcron = RCron.new
-
-  # :exclusive - Only one instance of this task will run simultaneously.
-  # :timeout   - Task will be terminated if it takes longer than the specified seconds.
-  rcron.q('Every ten-minutes during summer', 
-          '*/10 * * jun-aug *', 
-          :exclusive => true, 
-          :timeout => 1200) do |task|
-    # Task logic
-    # ...
-  end
-
-  # log to $stderr instead of default $stdout
-  rcron.start $stderr
-
-== Notes
+## Examples
+
+### Basic
+```ruby
+require 'rcron'
+rcron = RCron.new
+
+# Enqueue a task running every two minutes
+rcron.enq('task #1', '*/2 * * * *') do |task|
+  # Task logic
+  # ...
+end
+
+# You can `enq' any number of tasks before starting rcron
+
+rcron.start
+```
+
+### One-time only task
+```ruby
+rcron = RCron.new
+# will run once at 8pm next second friday
+rcron.enq('task #2', '0 8 * * fri#2') do |task|
+  # Removes the task from the queue
+  task.deq
+
+  # Task logic
+  # ...
+end
+rcron.start
+```
+
+### Options
+```ruby
+rcron = RCron.new
+
+# :exclusive - Only one instance of this task will run simultaneously.
+# :timeout   - Task will be terminated if it takes longer than the specified seconds.
+rcron.enq('Every ten-minutes during summer', 
+        '*/10 * * jun-aug *', 
+        :exclusive => true, 
+        :timeout => 1200) do |task|
+  # Task logic
+  # ...
+end
+
+# log to $stderr instead of default $stdout
+rcron.start $stderr
+```
+
+## Notes
 - Minimum interval for each task is one-minute just like cron. So rcron usually sleeps most of the time and wakes up only once a minute. (Except when short timeouts for the tasks are specified. In that case, rcron wakes up more frequently to check whether the task should be terminated)
 - rcron checks to start tasks at the very first second of every minute. e.g. When you first start it at 12:00:45, it will sleep 15 seconds before doing anything.
 - Tested on Ruby 1.8.7, Ruby 1.9.2 and JRuby 1.6.4
 - 99.67% test coverage. (a false sense of security, though)
 
-== Contributing to rcron
+## Contributing to rcron
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
 * Fork the project
@@ -68,7 +77,7 @@ http://en.wikipedia.org/wiki/Cron#Format
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
-== Copyright
+## Copyright
 
 Copyright (c) 2011 Junegunn Choi. See LICENSE.txt for
 further details.

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/lib/rcron/scheduler.rb

@@ -14,7 +14,7 @@ class RCron
   # @param [String] schedule Cron-format schedule string
   # @param [Hash] options Additional options for the task. :exclusive and :timeout.
   # @return [RCron::Task]
-  def q name, schedule, options = {}, &block
+  def enq name, schedule, options = {}, &block
     raise ArgumentError.new("Block not given") unless block_given?
 
     new_task = nil
@@ -26,6 +26,7 @@ class RCron
     end
     return new_task
   end
+  alias q enq
 
   # Starts the scheduler
   # @param log_output_stream Stream to output scheduler log. Should implement puts method.

data/lib/rcron/task.rb

@@ -53,10 +53,11 @@ class RCron
     end
 
     # Removes the task from the scheduler
-    def dq
+    def deq
       @queued = false
       nil
     end
+    alias dq deq
 
     # Returns if the task is supposed to be triggered at the given moment.
     # @param [Time] at

data/test/test_rcron.rb

@@ -45,10 +45,10 @@ class TestRcron < Test::Unit::TestCase
       task.dq
     end
 
-    @task = rcron.q('basic task 2 - auto dq', "* * * * *") do
+    @task = rcron.enq('basic task 2 - auto dq', "* * * * *") do
       counter += 2
       sleep 3
-      @task.dq
+      @task.deq
     end
 
     st = Time.now

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rcron
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-31 00:00:00.000000000Z
+date: 2011-09-06 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &2156282420 !ruby/object:Gem::Requirement
+  requirement: &2153035480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.6.0
   type: :development
   prerelease: false
-  version_requirements: *2156282420
+  version_requirements: *2153035480
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2156281700 !ruby/object:Gem::Requirement
+  requirement: &2153034680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *2156281700
+  version_requirements: *2153034680
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &2156281080 !ruby/object:Gem::Requirement
+  requirement: &2153033680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *2156281080
+  version_requirements: *2153033680
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &2156280220 !ruby/object:Gem::Requirement
+  requirement: &2153032540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156280220
+  version_requirements: *2153032540
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &2156279280 !ruby/object:Gem::Requirement
+  requirement: &2153029720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,21 +65,21 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156279280
+  version_requirements: *2153029720
 description: A simple cron-like scheduler for Ruby
 email: junegunn.c@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
-- README.rdoc
+- README.markdown
 files:
 - .document
 - CHANGELOG.rdoc
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- README.rdoc
+- README.markdown
 - Rakefile
 - VERSION
 - lib/rcron.rb
@@ -107,7 +107,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1983967147733122663
+      hash: -994378731135453233
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: