khronotab 1.3.2 → 1.3.3

data/README.rdoc

@@ -4,10 +4,6 @@ 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
 
@@ -21,9 +17,9 @@ creation of a new one far easier.
 
 == Copyright
   Copyright (c) 2010 Kristofer M White. Licensed under the BSD License:
+  See LICENSE for details.
   http://www.opensource.org/licenses/bsd-license.html
 
-
 == Note on Patches/Pull Requests
  
 * Fork the project.
@@ -31,6 +27,5 @@ creation of a new one far easier.
 * 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)
+  (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

@@ -5,22 +5,23 @@ 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.summary = %Q{A pure ruby crontab parser with a Hash-like interface}
+    gem.description = %Q{A pure ruby crontab 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.add_development_dependency "thoughtbot-shoulda", ">= 0"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
+  Jeweler::GemcutterTasks.new
 rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
 end
 
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
   test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/*_test.rb'
+  test.pattern = 'test/**/test_*.rb'
   test.verbose = true
 end
 
@@ -28,7 +29,7 @@ begin
   require 'rcov/rcovtask'
   Rcov::RcovTask.new do |test|
     test.libs << 'test'
-    test.pattern = 'test/**/*_test.rb'
+    test.pattern = 'test/**/test_*.rb'
     test.verbose = true
   end
 rescue LoadError
@@ -39,15 +40,36 @@ end
 
 task :test => :check_dependencies
 
+begin
+  require 'reek/adapters/rake_task'
+  Reek::RakeTask.new do |t|
+    t.fail_on_error = true
+    t.verbose = false
+    t.source_files = 'lib/**/*.rb'
+  end
+rescue LoadError
+  task :reek do
+    abort "Reek is not available. In order to run reek, you must: sudo gem install reek"
+  end
+end
+
+begin
+  require 'roodi'
+  require 'roodi_task'
+  RoodiTask.new do |t|
+    t.verbose = false
+  end
+rescue LoadError
+  task :roodi do
+    abort "Roodi is not available. In order to run roodi, you must: sudo gem install roodi"
+  end
+end
+
 task :default => :test
 
 require 'rake/rdoctask'
 Rake::RDocTask.new do |rdoc|
-  if File.exist?('VERSION')
-    version = File.read('VERSION')
-  else
-    version = ""
-  end
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
 
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title = "khronotab #{version}"

data/VERSION

@@ -1 +1 @@
-1.3.2
+1.3.3

data/khronotab.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = %q{khronotab}
-  s.version = "1.3.2"
+  s.version = "1.3.3"
 
   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.date = %q{2010-11-09}
+  s.description = %q{A pure ruby crontab parser with a Hash-like interface}
   s.email = %q{me@kmwhite.net}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -27,25 +27,48 @@ Gem::Specification.new do |s|
      "demo/sample.rb",
      "khronotab.gemspec",
      "lib/khronotab.rb",
+     "lib/khronotab/cron_comment.rb",
      "lib/khronotab/cron_job.rb",
      "lib/khronotab/cron_unit.rb",
-     "lib/khronotab/cron_variable.rb"
+     "lib/khronotab/cron_variable.rb",
+     "test/helper.rb",
+     "test/tc_cron_job_command-length.rb",
+     "test/tc_cron_job_different-time-arguments.rb",
+     "test/tc_cron_job_nil-checks.rb",
+     "test/test_khronotab.rb",
+     "test/ts_cron_job.rb",
+     "test/ts_cron_tab.rb",
+     "test/ts_cron_unit.rb",
+     "test/ts_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}
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A pure ruby crontab parser with a Hash-like interface}
+  s.test_files = [
+    "test/tc_cron_job_nil-checks.rb",
+     "test/ts_cron_variable.rb",
+     "test/ts_cron_job.rb",
+     "test/test_khronotab.rb",
+     "test/tc_cron_job_different-time-arguments.rb",
+     "test/tc_cron_job_command-length.rb",
+     "test/ts_cron_unit.rb",
+     "test/ts_cron_tab.rb",
+     "test/helper.rb"
+  ]
 
   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
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
     else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
     end
   else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
   end
 end
 

data/lib/khronotab/cron_comment.rb

@@ -0,0 +1,17 @@
+class CronComment < String
+
+  COMMENT_REGEX=%r{\s*#.*}i
+
+  def self.matches?(cron_entry)
+    !!COMMENT_REGEX.match(cron_entry)
+  end
+
+  def to_s
+    puts self
+  end
+
+  def to_line
+    puts self
+  end
+
+end

data/lib/khronotab/cron_job.rb

@@ -9,9 +9,8 @@ class CronJob
 
   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)
+  def self.matches?(cron_entry)
+    !!JOB_REGEX.match(cron_entry)
   end
     
   def self.add_new(cron_entry)
@@ -29,31 +28,28 @@ class CronJob
             )
   end
 
-  def [] ac
+  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)
+  def []=(key,value)
+    return self.send("#{key}=", value) if self.respond_to?(key)
     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
+  def expand_times(date = Date.today)
+    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
-      return time_list
-    end 
+    end
+    return time_list
   end
 
-  def initialize(data)
+  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)

data/lib/khronotab/cron_unit.rb

@@ -11,33 +11,43 @@ class CronUnit
     expanded_form.include?(value)
   end
 
+  def expand_range(segment)
+    range = segment.split('-').map! { |x| x.to_i }
+    (range[0] .. range[1]).to_a
+  end
+
+  def expand_interval(segment)
+    counter = 0
+    times = []
+    interval = segment.split('/').map! { |x|
+      if x == '*'
+        x = @maximum
+      else
+        x.to_i
+      end
+    }
+    while counter < interval[0]
+      times.push(counter)
+      counter += interval[1]
+    end
+    times
+  end
+
   def expanded_form
-    values = Array.new
+    values = []
     @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)
+          values.concat(expand_range(segment))
         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
+          values.concat(expand_interval(segment))
         when /[*]/
           values.concat((@minimum .. @maximum).to_a)
         else
           values << segment.to_i
       end
     end
-    return values.sort.uniq
+    values.sort.uniq
   end
 
   def to_s

data/lib/khronotab/cron_variable.rb

@@ -4,19 +4,18 @@ class CronVariable < Hash
 
   VAR_REGEX=%r{(^\s*[^#]\w+)=(.+)}i
 
-  def [] ac
+  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)
+  def []=(key,value)
+    return self.send("#{key}=", value) if self.respond_to?(key)
     raise 'Unknown key!'
   end
 
-  def self.matches?(ce)
-    return false if ce=~/^[\s]*$/ or ce=~/^\s*#/
-    !!VAR_REGEX.match(ce)
+  def self.matches?(cron_entry)
+    !!VAR_REGEX.match(cron_entry)
   end
 
   def self.add_new(cron_entry)

data/lib/khronotab.rb

@@ -4,13 +4,17 @@ module Khronotab
   class CronTab
 
     require 'khronotab/cron_variable'
+    require 'khronotab/cron_comment'
     require 'khronotab/cron_job'
 
     VERSION = '1.3.2'
 
-    attr_accessor :jobs, :variables
+    attr_accessor :jobs, :variables, :comments
 
-    def initialize opt={}
+    def initialize(opt={})
+      @variables ||= []
+      @jobs ||= []
+      @comments ||= []
       self.read_from_file(opt[:file]) if opt[:file] 
     end
 
@@ -19,19 +23,19 @@ module Khronotab
     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
+      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)
+        elsif CronComment.matches?(line)
+          @comments << line
+        else
+          STDERR.puts("Warning: Line is not valid!(#{line.chomp})")
         end
-      self
-    end
+      end
+    self
+    end 
 
     def write_to_file(filename)
       #TODO: Have this validate a file or append to the file if there

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'khronotab'
+
+class Test::Unit::TestCase
+end

data/test/tc_cron_job_command-length.rb

@@ -0,0 +1,29 @@
+class CronJobTest < Test::Unit::TestCase
+
+  context "a CronJob with a single-arg cmd" do
+    setup do
+      @cronjob = CronJob.add_new('0 0 0 0 0 root ls')
+    end
+
+    should "parse user and cmd correctly" do
+      assert_equal('root', @cronjob.user,
+                   'User parsed incorrectly') &&
+      assert_equal('ls', @cronjob.command,
+                   'Command parsed incorrectly')
+    end
+  end
+
+  context "a CronJob with a multi-arg cmd" do
+    setup do
+      @cronjob = CronJob.add_new('0 0 0 0 0 root grep foo /var/log/bar | cut -d\':\' -f 3 | sort | uniq')
+    end
+
+    should "handle complex, multi command lines" do
+      assert_equal('root', @cronjob.user,
+                   'User parsed incorrectly') &&
+      assert_equal('grep foo /var/log/bar | cut -d\':\' -f 3 | sort | uniq', @cronjob.command,
+                   'Command parsed incorrectly')
+    end
+  end
+end
+

data/test/tc_cron_job_different-time-arguments.rb

@@ -0,0 +1,56 @@
+class CronJobTest < Test::Unit::TestCase
+
+  context "a CronJob with range time args" do
+    setup do
+      @cronjob = CronJob.add_new('0-9 0-9 0-9 0-9 0-4 root ls')
+    end
+
+    should "should have correct user and command" do
+      assert_equal('root', @cronjob.user,
+                   'User parsed incorrectly') &&
+      assert_equal('ls', @cronjob.command,
+                   'Command parsed incorrectly')
+    end
+  end
+
+  context "a CronJob with interval time args" do
+    setup do
+      @cronjob = CronJob.add_new('6/2 6/2 6/2 6/2 6/2 root ls')
+    end
+
+    should "should have correct user and command" do
+      assert_equal('root', @cronjob.user,
+                   'User parsed incorrectly') &&
+      assert_equal('ls', @cronjob.command,
+                   'Command parsed incorrectly')
+    end
+  end
+
+  context "a CronJob with asterisk time args" do
+    setup do
+      @cronjob = CronJob.add_new('* * * * * root ls')
+    end
+
+    should "should have correct user and command" do
+      assert_equal('root', @cronjob.user,
+                   'User parsed incorrectly') &&
+      assert_equal('ls', @cronjob.command,
+                   'Command parsed incorrectly')
+    end
+  end
+
+  context "a CronJob with mixed time args" do
+    setup do
+      @cronjob = CronJob.add_new('* 6/2 0-9 0 0 root ls')
+    end
+
+    should "should have correct user and command" do
+      assert_equal('root', @cronjob.user,
+                   'User parsed incorrectly') &&
+      assert_equal('ls', @cronjob.command,
+                   'Command parsed incorrectly')
+    end
+  end
+
+end
+

data/test/tc_cron_job_nil-checks.rb

@@ -0,0 +1,38 @@
+class CronJobTest < Test::Unit::TestCase
+
+  context "a CronJob" do
+    setup do
+      @cronjob = CronJob.new
+    end
+
+    should "have a nil minutes" do
+      assert_nil @cronjob.minutes.cron_form
+    end
+
+    should "have a nil hours" do
+      assert_nil @cronjob.hours.cron_form
+    end
+
+    should "have a nil days_of_month" do
+      assert_nil @cronjob.days_of_month.cron_form
+    end
+
+    should "have a nil month" do
+      assert_nil @cronjob.month.cron_form
+    end
+
+    should "have a nil days_of_week" do
+      assert_nil @cronjob.days_of_week.cron_form
+    end
+
+    should "have a nil user" do
+      assert_nil @cronjob.user
+    end
+
+    should "have a nil command" do
+      assert_nil @cronjob.command
+    end
+
+  end
+end
+

data/test/test_khronotab.rb

@@ -0,0 +1,12 @@
+require 'helper'
+
+require 'ts_cron_tab'
+require 'ts_cron_job'
+require 'ts_cron_unit'
+require 'ts_cron_variable'
+
+class TestKhronotab < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+  #  flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/test/ts_cron_job.rb

@@ -0,0 +1,4 @@
+require 'test/unit'
+require 'tc_cron_job_nil-checks'
+require 'tc_cron_job_different-time-arguments'
+require 'tc_cron_job_command-length'

data/test/ts_cron_tab.rb

@@ -0,0 +1 @@
+require 'test/unit'

data/test/ts_cron_unit.rb

@@ -0,0 +1 @@
+require 'test/unit'

data/test/ts_cron_variable.rb

@@ -0,0 +1 @@
+require 'test/unit'

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: khronotab
 version: !ruby/object:Gem::Version 
-  version: 1.3.2
+  hash: 29
+  prerelease: false
+  segments: 
+  - 1
+  - 3
+  - 3
+  version: 1.3.3
 platform: ruby
 authors: 
 - Kristofer M White
@@ -9,11 +15,24 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-26 00:00:00 -05:00
+date: 2010-11-09 00:00:00 -06:00
 default_executable: 
-dependencies: []
-
-description: A pure ruby cron parser with a hash-like interface
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: A pure ruby crontab parser with a Hash-like interface
 email: me@kmwhite.net
 executables: []
 
@@ -33,9 +52,19 @@ files:
 - demo/sample.rb
 - khronotab.gemspec
 - lib/khronotab.rb
+- lib/khronotab/cron_comment.rb
 - lib/khronotab/cron_job.rb
 - lib/khronotab/cron_unit.rb
 - lib/khronotab/cron_variable.rb
+- test/helper.rb
+- test/tc_cron_job_command-length.rb
+- test/tc_cron_job_different-time-arguments.rb
+- test/tc_cron_job_nil-checks.rb
+- test/test_khronotab.rb
+- test/ts_cron_job.rb
+- test/ts_cron_tab.rb
+- test/ts_cron_unit.rb
+- test/ts_cron_variable.rb
 has_rdoc: true
 homepage: http://github.com/kmwhite/khronotab
 licenses: []
@@ -46,23 +75,37 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
-rubyforge_project: khronotab
-rubygems_version: 1.3.5
+rubyforge_project: 
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: A pure ruby cron parser
-test_files: []
-
+summary: A pure ruby crontab parser with a Hash-like interface
+test_files: 
+- test/tc_cron_job_nil-checks.rb
+- test/ts_cron_variable.rb
+- test/ts_cron_job.rb
+- test/test_khronotab.rb
+- test/tc_cron_job_different-time-arguments.rb
+- test/tc_cron_job_command-length.rb
+- test/ts_cron_unit.rb
+- test/ts_cron_tab.rb
+- test/helper.rb