khronotab 1.3.2

data/.document

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

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,24 @@
+Copyright (c) 2010, Kristofer M White
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+    * Neither the name of the <organization> nor the
+      names of its contributors may be used to endorse or promote products
+      derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.rdoc

@@ -0,0 +1,36 @@
+= khronotab
+
+KhronoTab is a pure ruby interface to the crontab. It uses a hash
+interface to allow accessing the data of an existing crontab or the
+creation of a new one far easier.
+
+== Synopsis 
+  This is a sample description of the application.
+  Blah blah blah.
+
+== Installation
+  gem install khronotab
+
+== Examples
+  Reading in an existing crontab
+    require 'khronotab'
+    crontab = Khronotab::CronTab.read_from_file('/etc/cron.d/crontab')
+
+== Author
+  Kristofer M White <me@kmwhite.net>
+
+== Copyright
+  Copyright (c) 2010 Kristofer M White. Licensed under the BSD License:
+  http://www.opensource.org/licenses/bsd-license.html
+
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "khronotab"
+    gem.summary = %Q{A pure ruby cron parser}
+    gem.description = %Q{A pure ruby cron parser with a hash-like interface}
+    gem.email = "me@kmwhite.net"
+    gem.homepage = "http://github.com/kmwhite/khronotab"
+    gem.authors = ["Kristofer M White"]
+    gem.rubyforge_project = %q{khronotab}
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "khronotab #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.3.2

data/demo/sample.ct

@@ -0,0 +1 @@
+* * * * * jsmith ls /home

data/demo/sample.rb

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'khronotab'
+c = Khronotab::CronTab.new
+c.read_from_file('sample.ct')
+puts c.jobs.first.inspect
+puts c.jobs.first.runs_today?

data/khronotab.gemspec

@@ -0,0 +1,51 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{khronotab}
+  s.version = "1.3.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Kristofer M White"]
+  s.date = %q{2010-07-26}
+  s.description = %q{A pure ruby cron parser with a hash-like interface}
+  s.email = %q{me@kmwhite.net}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "demo/sample.ct",
+     "demo/sample.rb",
+     "khronotab.gemspec",
+     "lib/khronotab.rb",
+     "lib/khronotab/cron_job.rb",
+     "lib/khronotab/cron_unit.rb",
+     "lib/khronotab/cron_variable.rb"
+  ]
+  s.homepage = %q{http://github.com/kmwhite/khronotab}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{khronotab}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A pure ruby cron parser}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/lib/khronotab.rb

@@ -0,0 +1,51 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+module Khronotab
+  class CronTab
+
+    require 'khronotab/cron_variable'
+    require 'khronotab/cron_job'
+
+    VERSION = '1.3.2'
+
+    attr_accessor :jobs, :variables
+
+    def initialize opt={}
+      self.read_from_file(opt[:file]) if opt[:file] 
+    end
+
+    def self.read_from_file(*args)
+      self.new.read_from_file(*args)
+    end
+
+    def read_from_file(filename)
+      @variables ||= []
+      @jobs ||= []
+        File.open(filename, 'r').readlines.each do |line|
+          if CronVariable.matches?(line)
+            @variables << CronVariable.add_new(line) 
+          elsif CronJob.matches?(line)
+            @jobs << CronJob.add_new(line)
+          else
+            STDERR.puts("Warning: Line is not a valid variable or job!")
+          end
+        end
+      self
+    end
+
+    def write_to_file(filename)
+      #TODO: Have this validate a file or append to the file if there
+      # is new data. Just overwriting the damn thing isn't very
+      # safe or wise.. -kmwhite 2010.04.19
+      crontab = File.open(filename,'w')
+      @variables.each do |variable|
+        crontab.puts definition.to_line
+      end
+      @jobs.each do |job|
+        crontab.puts job.to_line
+      end
+      crontab.flush
+      crontab.close
+    end
+  end
+end

data/lib/khronotab/cron_job.rb

@@ -0,0 +1,88 @@
+require 'time'
+require 'date'
+require 'khronotab/cron_unit'
+
+
+class CronJob
+
+  attr_accessor :minutes, :hours, :days, :month, :days_of_week, :user, :command, :days_of_month
+
+  JOB_REGEX=/([0-9\*\/\-,]+)\s+([0-9\*\/\-,]+)\s+([0-9\*\/\-,]+)\s+([0-9\*\/\-,]+)\s+([0-9\*\/\-,]+)\s+(\S+)\s+(.+)/
+
+  def self.matches?(ce)
+    return false if ce=~/^[\s]*$/ or ce=~/^\s*#/
+    !!JOB_REGEX.match(ce)
+  end
+    
+  def self.add_new(cron_entry)
+    return nil unless JOB_REGEX.match(cron_entry)
+    minute, hour, dom, month, dow, user, command =
+         cron_entry.scan(JOB_REGEX).shift
+    self.new(
+              :minutes => minute,
+              :hours => hour,
+              :days_of_month => dom,
+              :month => month,
+              :days_of_week => dow,
+              :user => user,
+              :command => command
+            )
+  end
+
+  def [] ac
+    return self.send(ac) if self.respond_to?(ac)
+    raise 'Unknown key!'
+  end
+
+  def []= k,v
+    return self.send("#{k}=",v) if self.respond_to?(k)
+    raise 'Unknown key!'
+  end
+
+  def expand_times(date = Date.today, type = :day)
+    case type
+    when :day 
+      return [] unless runs_on?(date)
+      time_list = []
+      hours.expanded_form.map do |hour|
+        minutes.expanded_form.map do |minute|
+          time_list << "%02i-%02i-%02i %02i:%02i:%02i" % [date.year, date.month, date.day, hour, minute, 0]
+        end
+      end
+      return time_list
+    end 
+  end
+
+  def initialize(data)
+    @minutes = CronUnit.new(data[:minutes], 0, 59)
+    @hours = CronUnit.new(data[:hours], 0, 23)
+    @days_of_month = CronUnit.new(data[:days_of_month], 1, 31)
+    @month = CronUnit.new(data[:month], 1, 12)
+    @days_of_week = CronUnit.new(data[:days_of_week], 0, 7)
+    @user = data[:user]
+    @command = data[:command]
+  end
+
+  def runs_on?(date_to_check)
+    month.contains?(date_to_check.month) &&
+    days_of_month.contains?(date_to_check.day) &&
+    days_of_week.contains?(date_to_check.wday)
+  end
+
+  def runs_today?
+    runs_on?(Time.now)
+  end
+
+  def to_s
+    puts "<Job minutes:%s hours:%s dom:%s month:%s dow:%s user:%s cmd:%s>" %
+            [ minutes, hours, days_of_month, month, days_of_week, user,
+              command ]
+  end
+
+  def to_line
+    puts "%s %s %s %s %s %s %s" %
+            [ minutes, hours, days_of_month, month, days_of_week, user,
+              command ]
+  end
+
+end

data/lib/khronotab/cron_unit.rb

@@ -0,0 +1,47 @@
+class CronUnit
+  attr_accessor :cron_form, :minimum, :maximum 
+
+  def initialize(cron, min, max)
+    @cron_form = cron
+    @minimum = min
+    @maximum = max
+  end
+
+  def contains?(value)
+    expanded_form.include?(value)
+  end
+
+  def expanded_form
+    values = Array.new
+    @cron_form.split(',').each do |segment|
+      case segment
+        when /-/ #range
+          range = segment.split('-').map! { |x| x.to_i }
+          values.concat((range[0] .. range[1]).to_a)
+        when /\// #interval
+          counter = 0
+          interval = segment.split('/').map! { |x|
+            if x == '*'
+              x = @maximum
+            else
+              x.to_i
+            end
+          }
+          while counter < interval[0]
+            values.push(counter)
+            counter += interval[1]
+          end
+        when /[*]/
+          values.concat((@minimum .. @maximum).to_a)
+        else
+          values << segment.to_i
+      end
+    end
+    return values.sort.uniq
+  end
+
+  def to_s
+    @cron_form
+  end
+
+end

data/lib/khronotab/cron_variable.rb

@@ -0,0 +1,42 @@
+class CronVariable < Hash
+
+  attr_accessor :name, :value
+
+  VAR_REGEX=%r{(^\s*[^#]\w+)=(.+)}i
+
+  def [] ac
+    return self.send(ac) if self.respond_to?(ac)
+    raise 'Unknown key!'
+  end
+
+  def []= k,v
+    return self.send("#{k}=",v) if self.respond_to?(k)
+    raise 'Unknown key!'
+  end
+
+  def self.matches?(ce)
+    return false if ce=~/^[\s]*$/ or ce=~/^\s*#/
+    !!VAR_REGEX.match(ce)
+  end
+
+  def self.add_new(cron_entry)
+    return nil unless VAR_REGEX.match(cron_entry)
+    name, value = cron_entry.scan(VAR_REGEX).shift
+    self.new( :name => name, :value => value )
+  end
+
+  def initialize(data)
+    @name = data[:name]
+    @value = data[:value]
+  end
+
+  def to_s
+    puts "< CronVariable name: %s, value: '%s' >" %
+             [ self.name, self.value ]
+  end
+
+  def to_line
+    puts "%s=%s" % [ self.name, self.values ]
+  end
+
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: khronotab
+version: !ruby/object:Gem::Version 
+  version: 1.3.2
+platform: ruby
+authors: 
+- Kristofer M White
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-26 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: A pure ruby cron parser with a hash-like interface
+email: me@kmwhite.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- demo/sample.ct
+- demo/sample.rb
+- khronotab.gemspec
+- lib/khronotab.rb
+- lib/khronotab/cron_job.rb
+- lib/khronotab/cron_unit.rb
+- lib/khronotab/cron_variable.rb
+has_rdoc: true
+homepage: http://github.com/kmwhite/khronotab
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: khronotab
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A pure ruby cron parser
+test_files: []
+