crontab-parser 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.1.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.1"
+  gem "rcov", ">= 0"
+  gem "reek", "~> 1.2.8"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 uu59
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+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.

data/README.rdoc

@@ -0,0 +1,19 @@
+= crontab-ruby
+
+Description goes here.
+
+== Contributing to crontab-ruby
+ 
+* 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.
+
+== Copyright
+
+Copyright (c) 2011 uu59. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,57 @@
+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 = "crontab-parser"
+  gem.homepage = "http://github.com/tt25/crontab-parser"
+  gem.license = "MIT"
+  gem.summary = %Q{TODO: one-line summary of your gem}
+  gem.description = %Q{TODO: longer description of your gem}
+  gem.email = "a@tt25.org"
+  gem.authors = ["uu59"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+require 'reek/rake/task'
+Reek::Rake::Task.new do |t|
+  t.fail_on_error = true
+  t.verbose = false
+  t.source_files = 'lib/**/*.rb'
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "crontab-parser#{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/benchmark/test.rb

@@ -0,0 +1,57 @@
+# -- coding: utf-8
+
+require File.expand_path(File.dirname(__FILE__) + '/../spec/spec_helper')
+require "benchmark"
+require "ruby-prof"
+
+crontab = <<-CRON
+  # should ignore comment only line and blank line
+
+  #m h d m w cmd
+   * * * * * foo # always run. this comment was ignored
+   3 * * * * bar
+   */1 0-22 * * * baz
+CRON
+crontab *= 64
+range = {
+  0 => 0..59,
+  1 => 0..23,
+  2 => 1..31,
+  3 => 1..12,
+  4 => 0..6,
+}
+
+5000.times{
+  line = ""
+  5.times {|n|
+    ra = range[n].to_a.shuffle
+    line << case rand(10)
+      when 0..7
+        ra.first.to_s
+      when 8
+        x,y = [ra.first, ra.last].sort
+        "#{x}-#{y}"
+      else
+        ra.take(rand(ra.length - 1) + 1).sort.join(",")
+    end
+    if rand(2) == 1
+      line << "/" + (rand(range[n].last) + 1).to_s
+    end
+    line << " "
+  }
+  line << "cmd" + Time.now.to_f.to_s
+  line << "\n"
+  crontab += line
+}
+crontab += "k k k k k"
+File.open('foo.txt', 'w'){|f| f.puts crontab}
+
+now = Time.utc(2010,1,1,0,0,0)
+c = CrontabParser.new("foo.txt")
+
+GC.disable
+RubyProf.start
+puts c.find_all{|row| row.times}.length
+result = RubyProf.stop
+GC.enable
+RubyProf::FlatPrinter.new(result).print

data/lib/crontab-parser.rb

@@ -0,0 +1,29 @@
+# -- coding: utf-8
+
+require "stringio"
+require "crontab-parser/record.rb"
+require "crontab-parser/time_parser.rb"
+
+class CrontabParser
+  include Enumerable
+
+  def initialize(crontab, options={})
+    @crontab = crontab
+    @options = options
+  end
+
+  def each
+    io = if File.exists?(@crontab)
+      open(@crontab, 'r')
+    else
+      StringIO.new(@crontab)
+    end
+    until io.eof?
+      line = io.gets
+      line.strip!
+      if line.length > 0 && line.index('#') != 0
+        yield Record.new(line, @options) 
+      end
+    end
+  end
+end

data/lib/crontab-parser/record.rb

@@ -0,0 +1,65 @@
+# -- coding: utf-8
+
+class CrontabParser
+  class Record
+    attr_reader :line
+
+    def initialize(line, options={})
+      @line = line
+      @options = options
+    end
+
+    def cmd
+      times
+      @cmd
+    end
+
+    def to_s
+      @line
+    end
+
+    def should_run?(time)
+      time.utc
+      times[:min].include?(time.min) &&
+        times[:hour].include?(time.hour) &&
+        times[:day].include?(time.day) &&
+        times[:month].include?(time.month) &&
+        times[:week].include?(time.wday)
+    end
+
+    def times
+      @times ||= begin
+        base = @line.strip.gsub(/#.*/, "").gsub(%r!^@(yearly|annually|monthly|weekly|daily|midnight|hourly)!){|m|
+          case $1
+            when 'yearly','annually'
+              '0 0 1 1 *'
+            when 'monthly'
+              '0 0 1 * *'
+            when 'weekly'
+              '0 0 * * 0'
+            when 'daily','midnight'
+              '0 0 * * *'
+            when 'hourly'
+              '0 * * * *'
+          end
+        }.strip
+        min,hour,day,month,week,@cmd = *base.split(/[\t\s]+/, 6)
+        base = [min,hour,day,month,week].join(" ")
+        if week.nil?
+          if @options[:silent]
+            return nil
+          else
+            raise "invalid line #{@line}" 
+          end
+        end
+        {
+          :month => TimeParser.parse(month, 1, 12),
+          :day => TimeParser.parse(day, 1, 31),
+          :hour =>  TimeParser.parse(hour, 0, 23),
+          :min => TimeParser.parse(min, 0, 59),
+          :week => TimeParser.parse(week, 0, 6),
+        }
+      end
+    end
+  end
+end

data/lib/crontab-parser/time_parser.rb

@@ -0,0 +1,42 @@
+# -- coding: utf-8
+
+class CrontabParser
+  class TimeParser
+    CACHE = {}
+
+    def self.parse(column, first=0, last=59)
+      base = column + "_#{first}-#{last}"
+      if CACHE[base]
+        return CACHE[base]
+      end
+      column = column.gsub(%r!/1$!,"").gsub('*', "#{first}-#{last}")
+      if column.index('/')
+        times,filter = *column.split("/")
+      else
+        times = column
+        filter = nil
+      end
+
+      result = if times.index(',')
+        times.split(',').map{|col| separetor(col)}
+      else
+        separetor(times)
+      end.flatten
+
+      if filter
+        result = result.find_all{|n| n % filter.to_i == 0}
+      end
+
+      CACHE[base] = result
+    end
+
+    def self.separetor(col)
+      if col.index('-')
+        m,n = *col.split("-").map{|n| n.to_i}
+        (m..n).to_a
+      else
+        [col.to_i]
+      end
+    end
+  end
+end

data/spec/crontab-ruby_spec.rb

@@ -0,0 +1,135 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "CrontabRuby" do
+  it 'should parse time column' do
+    CrontabParser::TimeParser.parse('3').should == [3]
+    CrontabParser::TimeParser.parse('3,4,5').should == [3,4,5]
+    CrontabParser::TimeParser.parse('3,4,5/2').should == [4]
+    CrontabParser::TimeParser.parse('0-10/3').should == [0,3,6,9]
+    CrontabParser::TimeParser.parse('0-10,20-23/3').should == [0,3,6,9,21]
+    CrontabParser::TimeParser.parse('0-3,4-6,9').should == [0,1,2,3,4,5,6,9]
+    CrontabParser::TimeParser.parse('*/9').should == [0,9,18,27,36,45,54]
+    CrontabParser::TimeParser.parse('*/9', 0, 23).should == [0,9,18]
+  end
+
+  it 'should parse each row' do
+    # min,hour,day,mon,week,cmd
+    record = CrontabParser::Record.new(<<-CRON)
+      * * * * * foo
+    CRON
+    record.cmd.should == 'foo'
+    record.times.should == {
+      :month => (1..12).to_a,
+      :day => (1..31).to_a,
+      :hour => (0..23).to_a,
+      :min => (0..59).to_a,
+      :week => (0..6).to_a,
+    }
+    record.should_run?(Time.now).should be_true
+
+    record = CrontabParser::Record.new(<<-CRON)
+      1,2,3,5-10,21-27/5 2-5 */3 * * bar
+    CRON
+    record.cmd.should == 'bar'
+    record.times.should == {
+      :month => (1..12).to_a,
+      :day => [3,6,9,12,15,18,21,24,27,30],
+      :hour => [2,3,4,5],
+      :min => [5,10,25],
+      :week => (0..6).to_a,
+    }
+    record.should_run?(Time.utc(2010,1,1,0,0,0)).should be_false
+    record.should_run?(Time.utc(2010,1,3,2,5,0)).should be_true
+
+    record = CrontabParser::Record.new(<<-CRON)
+      @daily baz
+    CRON
+    record.cmd.should == 'baz'
+    record.times.should == {
+      :month => (1..12).to_a,
+      :day => (1..31).to_a,
+      :hour => [0],
+      :min => [0],
+      :week => (0..6).to_a,
+    }
+  end
+
+  it 'should parse annotations' do
+    c = CrontabParser.new(<<-CRON)
+      @yearly 1/1 only
+      @annually 1/1 only
+      @monthly day 1 only
+      @weekly week==0 only
+      @daily 00:00 only
+      @midnight 00:00 only
+      @hourly *:00 only
+    CRON
+    rows = c.to_a
+    rows[0].times.should == {
+      :month => [1],
+      :day => [1],
+      :hour => [0],
+      :min => [0],
+      :week => (0..6).to_a,
+    }
+    rows[1].times.should == rows[0].times
+    rows[2].times.should == {
+      :month => (1..12).to_a,
+      :day => [1],
+      :hour => [0],
+      :min => [0],
+      :week => (0..6).to_a,
+    }
+    rows[3].times.should == {
+      :month => (1..12).to_a,
+      :day => (1..31).to_a,
+      :hour => [0],
+      :min => [0],
+      :week => [0],
+    }
+    rows[4].times.should == {
+      :month => (1..12).to_a,
+      :day => (1..31).to_a,
+      :hour => [0],
+      :min => [0],
+      :week => (0..6).to_a,
+    }
+    rows[5].times.should == rows[4].times
+    rows[6].times.should == {
+      :month => (1..12).to_a,
+      :day => (1..31).to_a,
+      :hour => (0..23).to_a,
+      :min => [0],
+      :week => (0..6).to_a,
+    }
+  end
+
+  it 'should parse crontab' do
+    c = CrontabParser.new(<<-CRON)
+      # should ignore comment only line and blank line
+
+      #m h d m w cmd
+       * * * * * foo # always run. this comment was ignored
+       3 * * * * bar
+       */1 0-22 * * * baz
+    CRON
+    now = Time.utc(2010,1,1,0,0,0)
+    c.find_all{|row|
+      row.should_run?(now)
+    }.map{|row| row.cmd}.should == ["foo","baz"]
+
+    c = CrontabParser.new(<<-CRON)
+    should raise invalid line
+    CRON
+    lambda {
+      c.each{|r| r.cmd}
+    }.should raise_error
+
+    c = CrontabParser.new(<<-CRON, :silent => true)
+    should raise invalid line
+    CRON
+    lambda {
+      c.each{|r| r.cmd}
+    }.should_not raise_error
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'crontab-parser'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification 
+name: crontab-parser
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- uu59
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-08 00:00:00 +09:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 1
+        - 0
+        version: 2.1.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 5
+        - 1
+        version: 1.5.1
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: reek
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 8
+        version: 1.2.8
+  type: :development
+  version_requirements: *id005
+description: crontab parser for ruby
+email: a@tt25.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- benchmark/test.rb
+- lib/crontab-parser.rb
+- lib/crontab-parser/record.rb
+- lib/crontab-parser/time_parser.rb
+- spec/crontab-ruby_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/tt25/crontab-parser
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: crontab parser for ruby
+test_files: 
+- spec/crontab-ruby_spec.rb
+- spec/spec_helper.rb