rcron 0.1.1 → 0.1.2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+0.1.2 / 2012/07/12
+------------------
+* Added support for hyphen+slash syntax
+ * e.g. `2-20/5,45-10/8 * * * *`
+* Uses `Logger` for logging
+
+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/Gemfile

@@ -1,14 +1,4 @@
-source "http://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
+source 'https://rubygems.org'
 
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
-group :development do
-  gem "yard", "~> 0.6.0"
-  gem "bundler", "~> 1.0.0"
-  gem "jeweler", "~> 1.6.4"
-  gem "rcov", ">= 0"
-  gem "simplecov"
-end
+# Specify your gem's dependencies in rcron.gemspec
+gemspec

data/{LICENSE.txt → LICENSE}

@@ -1,4 +1,6 @@
-Copyright (c) 2011 Junegunn Choi
+Copyright (c) 2012 Junegunn Choi
+
+MIT License
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -17,4 +19,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/{README.markdown → README.md}

@@ -3,9 +3,18 @@
 A simple cron-like scheduler for Ruby.
 
 ## Installation
-```ruby
-gem install rcron
-```
+
+Add this line to your application's Gemfile:
+
+    gem 'rcron'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rcron
 
 ## Cron format
 As of now, most of the expressions except for ? and W are supported.
@@ -59,23 +68,21 @@ rcron.enq('Every ten-minutes during summer',
 end
 
 # log to $stderr instead of default $stdout
-rcron.start $stderr
+rcron.start Logger.new($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
-* 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
-* Start a feature/bugfix branch
-* Commit and push until you are happy with your contribution
-* 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.
+- Tested on Ruby 1.8.7, Ruby 1.9.3 and JRuby 1.6.7.2
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
 
 ## Copyright
 

data/Rakefile

@@ -1,29 +1,5 @@
-# encoding: utf-8
-
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'rake'
-
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "rcron"
-  gem.homepage = "http://github.com/junegunn/rcron"
-  gem.license = "MIT"
-  gem.summary = %Q{A simple cron-like scheduler}
-  gem.description = %Q{A simple cron-like scheduler for Ruby}
-  gem.email = "junegunn.c@gmail.com"
-  gem.authors = ["Junegunn Choi"]
-  # dependencies defined in Gemfile
-end
-Jeweler::RubygemsDotOrgTasks.new
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
 
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
@@ -31,16 +7,3 @@ Rake::TestTask.new(:test) do |test|
   test.pattern = 'test/**/test_*.rb'
   test.verbose = true
 end
-
-require 'rcov/rcovtask'
-Rcov::RcovTask.new do |test|
-  test.libs << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-  test.rcov_opts << '--exclude "gems/*"'
-end
-
-task :default => :test
-
-require 'yard'
-YARD::Rake::YardocTask.new

data/lib/rcron.rb

@@ -1,3 +1,4 @@
+require 'rcron/version'
 require 'rcron/task'
 require 'rcron/alarm'
 require 'rcron/parser'

data/lib/rcron/parser.rb

@@ -9,7 +9,7 @@ class RCron
       parser = lambda { |type, min, len, element, subs, extra|
         return nil if element.nil?
 
-        max = min + len
+        max = min + len - 1
 
         (subs || {}).each do |k, v|
           element = element.gsub(/\b#{k}\b/i, v.to_s)
@@ -25,7 +25,22 @@ class RCron
             raise err if ei < min || ei > max
             ei
           when %r|^\*/([1-9][0-9]*)$|
-            (min...max).select { |m| m % $1.to_i == 0 }
+            (min..max).select { |m| m % $1.to_i == 0 }
+          when %r|^([0-9]+)-([0-9]+)/([1-9][0-9]*)$|
+            f, t = $1.to_i, $2.to_i
+            raise err if f < min || f > max
+            raise err if t < min || t > max
+
+            if f < t
+              (f..t).select { |m| (m - f) % $3.to_i == 0 }
+            else
+              (f..max).select { |m| (m - f) % $3.to_i == 0 } + 
+              (min..t).select { |m| 
+                m = m + max + 1 - min
+                (m - f) % $3.to_i == 0
+              }
+            end
+
           when %r|^([0-9]+)-([0-9]+)$|
             f, t = $1.to_i, $2.to_i
 
@@ -35,7 +50,7 @@ class RCron
             if f < t
               (f..t).to_a
             else
-              (f...max).to_a + (min..t).to_a
+              (f..max).to_a + (min..t).to_a
             end
           else
             extra && extra.call(e) || raise(err)

data/lib/rcron/scheduler.rb

@@ -1,12 +1,16 @@
 require 'thread'
+require 'logger'
+require 'forwardable'
 
 class RCron
+  extend Forwardable
+
+  def_delegators :@logger, :info, :warn, :error
+
   def initialize
-    @tasks = []
-    @mutex = Mutex.new
+    @tasks    = []
+    @mutex    = Mutex.new
     @sleeping = false
-    @log_mutex = Mutex.new
-    @log_ostream = $stdout
   end
 
   # Enqueues a task to be run
@@ -29,16 +33,16 @@ class RCron
   alias q enq
 
   # Starts the scheduler
-  # @param log_output_stream Stream to output scheduler log. Should implement puts method.
-  def start log_output_stream = $stdout
-    raise ArgumentError.new(
-        "Log output stream should implement puts method") unless
-            log_output_stream.respond_to? :puts
+  # @param logger Logger instance. Default is a Logger to standard output.
+  def start logger = Logger.new($stdout)
+    unless [:info, :warn, :error].all? { |m| logger.respond_to? m }
+      raise ArgumentError.new("Invalid Logger")
+    end
 
-    @log_ostream = log_output_stream
+    @logger = logger
     @thread = Thread.current
 
-    log "rcron started"
+    info "rcron started"
 
     now = Time.now
     while @tasks.length > 0
@@ -68,15 +72,15 @@ class RCron
       now = Time.now
       @tasks.select { |e| e.queued? && e.scheduled?(now) }.each do |t|
         if t.running? && t.exclusive?
-          log "[#{t.name}] already running exclusively"
+          warn "[#{t.name}] already running exclusively"
           next
         end
 
-        log "[#{t.name}] started"
+        info "[#{t.name}] started"
         t.send :start, now
       end if now >= next_tick
     end#while
-    log "rcron completed"
+    info "rcron completed"
   end#start
 
   # Crontab-like tasklist
@@ -94,10 +98,4 @@ private
       end
     }
   end
-
-  def log msg
-    @log_mutex.synchronize do
-      @log_ostream.puts "[#{Time.now.strftime('%Y-%m-%d %H:%M:%S')}] #{msg}"
-    end
-  end
 end#RCron

data/lib/rcron/task.rb

@@ -141,11 +141,11 @@ class RCron
             task.run
             @ended_at = Time.now
 
-            task.rcron.send :log, "[#{task.name}] completed (#{'%.2f' % elapsed}s)"
+            task.rcron.send :info, "[#{task.name}] completed (#{'%.2f' % elapsed}s)"
           rescue Exception => e
             @ended_at = Time.now
 
-            task.rcron.send :log, "[#{task.name}] terminated: #{[e, e.backtrace].join($/)}"
+            task.rcron.send :error, "[#{task.name}] terminated: #{[e, e.backtrace].join($/)}"
             # Ignore exception?
           end
           task.rcron.send :wake_up

data/lib/rcron/version.rb

@@ -0,0 +1,3 @@
+class RCron
+  VERSION = "0.1.2"
+end

data/rcron.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/rcron/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Junegunn Choi"]
+  gem.email         = ["junegunn.c@gmail.com"]
+  gem.description   = %q{A simple cron-like scheduler}
+  gem.summary       = %q{A simple cron-like scheduler for Ruby}
+  gem.homepage      = "https://github.com/junegunn/rcron"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "rcron"
+  gem.require_paths = ["lib"]
+  gem.version       = RCron::VERSION
+  gem.add_development_dependency "simplecov"
+end

data/test/test_rcron.rb

@@ -1,17 +1,29 @@
-$LOAD_PATH << "."
+$LOAD_PATH.unshift File.dirname(__FILE__)
 require 'helper'
 
 class TestRcron < Test::Unit::TestCase
-  class LogStream
+  class FakeLogger
     def initialize
       @lines = []
     end
 
-    def puts str
-      $stdout.puts str
+    def log header, str
+      $stdout.puts header + ' ' + str
       @lines << str
     end
 
+    def info msg
+      log '[I]', msg
+    end
+
+    def warn msg
+      log '[W]', msg
+    end
+
+    def error msg
+      log '[E]', msg
+    end
+
     def count pat
       @lines.select { |e| e =~ pat }.count
     end
@@ -19,10 +31,10 @@ class TestRcron < Test::Unit::TestCase
 
   def test_empty_q
     rcron = RCron.new
-    log = LogStream.new
-    rcron.start(log)
+    logger = FakeLogger.new
+    rcron.start(logger)
 
-    assert_equal 1, log.count(/completed/)
+    assert_equal 1, logger.count(/completed/)
   end
 
   def test_blockless
@@ -108,7 +120,7 @@ class TestRcron < Test::Unit::TestCase
   def test_non_exclusive
     puts 'non exclusive'
     counter = 0
-    log = LogStream.new
+    log = FakeLogger.new
     rcron = RCron.new
     truth = true
     rcron.q('non-exclusive', '* * * * *') do |task|
@@ -127,7 +139,7 @@ class TestRcron < Test::Unit::TestCase
   def test_exclusive
     puts 'exclusive'
     counter = 0
-    log = LogStream.new
+    log = FakeLogger.new
     rcron = RCron.new
     rcron.q('exclusive', '* * * * *', :exclusive => true) do |task|
       counter += 1
@@ -161,7 +173,7 @@ class TestRcron < Test::Unit::TestCase
   end
 
   def test_exception
-    log = LogStream.new
+    log = FakeLogger.new
     rcron = RCron.new
     rcron.q('Exceptional', '* * * * *') do |task|
       task.dq

data/test/test_rcron_parser.rb

@@ -1,4 +1,4 @@
-$LOAD_PATH << "."
+$LOAD_PATH.unshift File.dirname(__FILE__)
 require 'helper'
 
 class TestRcronParser < Test::Unit::TestCase
@@ -57,6 +57,19 @@ class TestRcronParser < Test::Unit::TestCase
                  RCron::Parser.parse('*/23,*/24 * * * *')[:minutes])
   end
 
+  def test_dividend_with_offset
+    assert_equal({2 => true, 7 => true, 12 => true, 17 => true}, 
+                 RCron::Parser.parse('2-20/5 * * * *')[:minutes])
+    assert_equal({2 => true, 7 => true, 12 => true, 17 => true, 45 => true, 53 => true}, 
+                 RCron::Parser.parse('2-20/5,45-59/8 * * * *')[:minutes])
+    assert_equal({2 => true, 7 => true, 12 => true, 17 => true, 45 => true, 53 => true, 1 => true, 9 => true}, 
+                 RCron::Parser.parse('2-20/5,45-10/8 * * * *')[:minutes])
+    assert_equal({4 => true, 7 => true, 10 => true},
+                 RCron::Parser.parse('* * * apr-oct/3 *')[:months])
+    assert_equal({10 => true, 1 => true, 4 => true},
+                 RCron::Parser.parse('* * * oct-jun/3 *')[:months])
+  end
+
   def test_months
     assert_equal({1 => true, 2 => true, 3 => true, 6 => true, 7 => true, 8 => true}, 
                  RCron::Parser.parse('* * * jan-MAR,Jun-Aug *')[:months])

data/test/test_rcron_task.rb

@@ -1,4 +1,4 @@
-$LOAD_PATH << "."
+$LOAD_PATH.unshift File.dirname(__FILE__)
 require 'helper'
 
 class TestRcronTask < Test::Unit::TestCase

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rcron
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,44 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-06 00:00:00.000000000Z
+date: 2012-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: yard
-  requirement: &2153035480 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.6.0
-  type: :development
-  prerelease: false
-  version_requirements: *2153035480
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: &2153034680 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-  type: :development
-  prerelease: false
-  version_requirements: *2153034680
-- !ruby/object:Gem::Dependency
-  name: jeweler
-  requirement: &2153033680 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.6.4
-  type: :development
-  prerelease: false
-  version_requirements: *2153033680
-- !ruby/object:Gem::Dependency
-  name: rcov
-  requirement: &2153032540 !ruby/object:Gem::Requirement
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,47 +21,40 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153032540
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: &2153029720 !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *2153029720
-description: A simple cron-like scheduler for Ruby
-email: junegunn.c@gmail.com
+description: A simple cron-like scheduler
+email:
+- junegunn.c@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- LICENSE.txt
-- README.markdown
+extra_rdoc_files: []
 files:
 - .document
-- CHANGELOG.rdoc
+- .gitignore
+- CHANGELOG.md
 - Gemfile
-- Gemfile.lock
-- LICENSE.txt
-- README.markdown
+- LICENSE
+- README.md
 - Rakefile
-- VERSION
 - lib/rcron.rb
 - lib/rcron/alarm.rb
 - lib/rcron/parser.rb
 - lib/rcron/scheduler.rb
 - lib/rcron/task.rb
 - lib/rcron/timeout.rb
+- lib/rcron/version.rb
+- rcron.gemspec
 - test/helper.rb
 - test/test_rcron.rb
 - test/test_rcron_parser.rb
 - test/test_rcron_task.rb
-homepage: http://github.com/junegunn/rcron
-licenses:
-- MIT
+homepage: https://github.com/junegunn/rcron
+licenses: []
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -105,9 +65,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -994378731135453233
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -116,8 +73,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.6
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: A simple cron-like scheduler
-test_files: []
+summary: A simple cron-like scheduler for Ruby
+test_files:
+- test/helper.rb
+- test/test_rcron.rb
+- test/test_rcron_parser.rb
+- test/test_rcron_task.rb

data/CHANGELOG.rdoc

@@ -1,6 +0,0 @@
-=== 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/Gemfile.lock

@@ -1,26 +0,0 @@
-GEM
-  remote: http://rubygems.org/
-  specs:
-    git (1.2.5)
-    jeweler (1.6.4)
-      bundler (~> 1.0)
-      git (>= 1.2.5)
-      rake
-    rake (0.9.2)
-    rcov (0.9.10)
-    rcov (0.9.10-java)
-    simplecov (0.4.2)
-      simplecov-html (~> 0.4.4)
-    simplecov-html (0.4.5)
-    yard (0.6.8)
-
-PLATFORMS
-  java
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.0.0)
-  jeweler (~> 1.6.4)
-  rcov
-  simplecov
-  yard (~> 0.6.0)

data/VERSION

@@ -1 +0,0 @@
-0.1.1