rcronwtf 1.0.0

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,20 @@
+Copyright (c) 2009 Darrin Holst
+
+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,17 @@
+== DESCRIPTION:
+
+a ruby port of http://github.com/technoweenie/cronwtf that translates
+cron tables and/or entries to human readable text
+
+== SYNOPSIS:
+
+  CronWTF::Table.new(`crontab -l`).to_s
+  CronWTF::Entry.new("*/10 * * * * /usr/bin/some_command").to_s
+
+== INSTALL:
+
+  sudo gem install rcronwtf
+
+== Copyright
+
+Copyright (c) 2009 Darrin Holst. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,81 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rcronwtf"
+    gem.summary = %Q{translate cron entries into human readable form}
+    gem.email = "darrinholst@gmail.com"
+    gem.homepage = "http://github.com/darrinholst/rcronwtf"
+    gem.authors = ["Darrin Holst"]
+    gem.rubyforge_project = 'rcronwtf'
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+begin
+  require 'rake/contrib/sshpublisher'
+  namespace :rubyforge do
+
+    desc "Release gem and RDoc documentation to RubyForge"
+    task :release => ["rubyforge:release:gem", "rubyforge:release:docs"]
+
+    namespace :release do
+      desc "Publish RDoc to RubyForge."
+      task :docs => [:rdoc] do
+        config = YAML.load(
+            File.read(File.expand_path('~/.rubyforge/user-config.yml'))
+        )
+
+        host = "#{config['username']}@rubyforge.org"
+        remote_dir = "/var/www/gforge-projects/the-perfect-gem/"
+        local_dir = 'rdoc'
+
+        Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
+      end
+    end
+  end
+rescue LoadError
+  puts "Rake SshDirPublisher is unavailable or your rubyforge environment is not configured."
+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 :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rcronwtf #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/rcronwtf/entry.rb

@@ -0,0 +1,114 @@
+class CronWTF::Entry
+  attr_reader :minutes, :hours, :days, :months, :week_days, :command, :is_comment
+  
+  def initialize(entry)
+    @is_comment = (entry.nil? or entry.strip.empty? or entry.match /^#/) ? true : false
+    @entry = entry.strip.gsub(/\s+/, " ")
+    parse unless is_comment
+  end
+  
+  def to_s
+    return @entry if is_comment
+    
+    msg = []
+
+    %w(minute hour day month week_day).each do |attribute|
+      key = (attribute + "s")
+      prev = msg[msg.length - 1]
+      values = self.send(key)
+
+      if(values == '*')
+        if(!prev || !prev.match(/^every/))
+          msg << "every #{attribute.gsub('_', ' ')}"
+        end
+      else
+        msg << send("#{key}_message", values)
+      end
+    end
+
+    "Runs `#{@command}` #{msg.join(', ')}."
+  end
+  
+  private
+  
+  MONTHS = ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec']
+  WEEK_DAYS = ['Sun', 'Mon', "Tue", 'Wed', 'Thu', 'Fri', 'Sat', 'Sun']
+
+  def parse 
+    pieces = @entry.split(/\s+/)
+    @minutes   = parse_attribute(pieces[0], 60)
+    @hours     = parse_attribute(pieces[1], 24)
+    @days      = parse_attribute(pieces[2], 31)
+    @months    = parse_attribute(pieces[3], 12)
+    @week_days = parse_attribute(pieces[4], 8)
+    @command   = pieces.slice(5, pieces.length).join(" ")
+  end
+
+  def parse_attribute(value, upper_bound)
+    return value if value.eql? '*'
+
+    if(value.match(/^\*\/\d+$/))
+      step  = value.match(/^\*\/(\d+)$/)[1].to_i
+      range = []
+
+      for i in (0...upper_bound)
+        range << i if i % step == 0
+      end
+
+      return range
+    end
+
+    if(value.match(/^\d+\-\d+$/))
+      matches = value.match(/^(\d+)\-(\d+)$/)
+      lower = matches[1]
+      upper = matches[2]
+      range = []
+
+      for i in (lower..upper)
+        range << i.to_i
+      end
+
+      return range
+    end
+
+    return value.split(",").map{|v| v.to_i}
+  end
+
+  def minutes_message(values)
+    v = []
+
+    values.each do |value|
+      v << ":#{value.to_s.length == 1 ? '0' : ''}#{value}"
+    end
+
+    "at minute#{values.length > 1 ? 's' : ''} #{v.join(', ')}"
+  end
+
+  def hours_message(values)
+    "on hour#{values.length > 1 ? 's' : ''} #{values.join(', ')}"
+  end
+
+  def days_message(values)
+    "on day#{values.length > 1 ? 's' : ''} #{values.join(', ')}"
+  end
+
+  def months_message(values)
+    v = []
+
+    values.each do |value|
+      v << MONTHS[value]
+    end
+
+    "in #{v.join(', ')}"
+  end
+
+  def week_days_message(values)
+    v = []
+
+    values.each do |value|
+      v << WEEK_DAYS[value]
+    end
+
+    "on #{v.join(', ')}"
+  end  
+end

data/lib/rcronwtf/table.rb

@@ -0,0 +1,24 @@
+class CronWTF::Table
+  attr_reader :entries
+  
+  def initialize(table)
+    @entries = parse(table)
+  end
+  
+  def to_s
+    entries.map{|e| e.to_s}.join("\n")
+  end
+  
+  private
+  
+  def parse(table)
+    lines = []
+    
+    table.split("\n").each do |line|
+      entry = CronWTF::Entry.new(line)
+      lines << entry unless entry.is_comment
+    end
+    
+    lines
+  end
+end

data/lib/rcronwtf.rb

@@ -0,0 +1,8 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module CronWTF
+end
+  
+require 'rcronwtf/table'
+require 'rcronwtf/entry'

data/rcronwtf.gemspec

@@ -0,0 +1,51 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rcronwtf}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Darrin Holst"]
+  s.date = %q{2009-05-15}
+  s.email = %q{darrinholst@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/rcronwtf.rb",
+     "lib/rcronwtf/entry.rb",
+     "lib/rcronwtf/table.rb",
+     "rcronwtf.gemspec",
+     "test/entry_test.rb",
+     "test/table_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/darrinholst/rcronwtf}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{rcronwtf}
+  s.rubygems_version = %q{1.3.3}
+  s.summary = %q{translate cron entries into human readable form}
+  s.test_files = [
+    "test/entry_test.rb",
+     "test/table_test.rb",
+     "test/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
+    else
+    end
+  else
+  end
+end

data/test/entry_test.rb

@@ -0,0 +1,111 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestEntry < Test::Unit::TestCase
+  def test_that_it_does_not_parse_comments
+    assert_equal(true, CronWTF::Entry.new('# * * * * *').is_comment)
+  end
+  
+  def test_that_it_parses_command
+    assert_equal('foo bar baz > wat', CronWTF::Entry.new("1 1,2 3-4 */5 * foo bar baz > wat").command)
+  end
+
+  def test_that_it_parses_infinite_minutes
+    assert_equal('*', CronWTF::Entry.new("* * * *  * foo").minutes)
+  end
+  
+  def test_that_it_parses_minute
+    assert_equal([1], CronWTF::Entry.new("1 * * *  * bar").minutes)
+  end
+  
+  def test_that_it_parses_minute_list
+    assert_equal([1,2], CronWTF::Entry.new("1,2 * * *  * bar").minutes)
+  end
+  
+  def test_that_it_parses_minute_range
+    assert_equal([1,2,3,4,5], CronWTF::Entry.new("1-5 * * *  * bar").minutes)
+  end
+  
+  def test_that_it_parses_minute_step
+    assert_equal([0,10,20,30,40,50], CronWTF::Entry.new("*/10 * * *  * bar").minutes)
+  end
+
+  def test_that_it_parses_infinite_hours
+    assert_equal('*', CronWTF::Entry.new("1 * * *  * foo").hours)
+  end
+  
+  def test_that_it_parses_hour
+    assert_equal([1], CronWTF::Entry.new("2 1 * *  * bar").hours)
+  end
+  
+  def test_that_it_parses_hour_list
+    assert_equal([1,2], CronWTF::Entry.new("1 1,2 * *  * bar").hours)
+  end
+  
+  def test_that_it_parses_hour_range
+    assert_equal([1,2,3,4,5], CronWTF::Entry.new("1 1-5 * *  * bar").hours)
+  end
+  
+  def test_that_it_parses_hour_step
+    assert_equal([0,3,6,9,12,15,18,21], CronWTF::Entry.new("1 */3 *  * bar").hours)
+  end
+
+  def test_that_it_parses_infinite_days
+    assert_equal('*', CronWTF::Entry.new("1 2 * *  * foo").days)
+  end
+  
+  def test_that_it_parses_day
+    assert_equal([1], CronWTF::Entry.new("2 2 1 *  * bar").days)
+  end
+  
+  def test_that_it_parses_day_list
+    assert_equal([1,2], CronWTF::Entry.new("1 1 1,2 *  * bar").days)
+  end
+  
+  def test_that_it_parses_day_range
+    assert_equal([1,2,3,4,5], CronWTF::Entry.new("1 1 1-5 *  * bar").days)
+  end
+  
+  def test_that_it_parses_day_step
+    assert_equal([0,3,6,9,12,15,18,21,24,27,30], CronWTF::Entry.new("1 1 */3 *  * bar").days)
+  end
+
+  def test_that_it_parses_infinite_months
+    assert_equal('*', CronWTF::Entry.new("1 2 3 *  * foo").months)
+  end
+  
+  def test_that_it_parses_month
+    assert_equal([1], CronWTF::Entry.new("2 2 2 1  * bar").months)
+  end
+  
+  def test_that_it_parses_month_list
+    assert_equal([1,2], CronWTF::Entry.new("1 1 1 1,2  * bar").months)
+  end
+  
+  def test_that_it_parses_month_range
+    assert_equal([1,2,3,4,5], CronWTF::Entry.new("1 1 1 1-5  * bar").months)
+  end
+  
+  def test_that_it_parses_month_step
+    assert_equal([0,3,6,9], CronWTF::Entry.new("1 1 1 */3  * bar").months)
+  end
+
+  def test_that_it_parses_infinite_week_days
+    assert_equal('*', CronWTF::Entry.new("1 2 3 4 * foo").week_days)
+  end
+  
+  def test_that_it_parses_week_day
+    assert_equal([1], CronWTF::Entry.new("2 2 2 2 1 bar").week_days)
+  end
+  
+  def test_that_it_parses_week_day_list
+    assert_equal([1,2], CronWTF::Entry.new("1 1 1 1 1,2 bar").week_days)
+  end
+  
+  def test_that_it_parses_week_day_range
+    assert_equal([1,2,3,4,5], CronWTF::Entry.new("1 1 1 1 1-5 bar").week_days)
+  end
+  
+  def test_that_it_parses_week_day_step
+    assert_equal([0,3,6], CronWTF::Entry.new("1 1 1 1 */3 bar").week_days)
+  end
+end

data/test/table_test.rb

@@ -0,0 +1,39 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestTable < Test::Unit::TestCase
+  def test_that_it_parses_multiple_lines
+    assert_table(["Runs `foo` every minute.", "Runs `bar` every minute."], "* * * * * foo\n* * * * * bar")
+  end
+  
+  def test_that_it_parses_mixed_whitespace
+    assert_table(["Runs `foo` every minute."], "\n 	*   * 	* * * foo	 \n\n")
+  end
+
+  def test_that_it_ignores_comments
+    assert_table([], "# mm hh jj MMM JJJ\n \n")
+  end
+
+  def test_that_it_parses_10_minute_cron
+    assert_table(["Runs `foo` at minutes :00, :10, :20, :30, :40, :50, every hour."], "*/10 * * * * foo")
+  end
+
+  def test_that_it_parses_6_hour_cron
+    assert_table(["Runs `foo` at minute :00, on hours 0, 6, 12, 18, every day."], "0 */6 * * * foo")
+  end
+  
+  def test_that_it_parses_by_daily_cron
+    assert_table(["Runs `foo` at minute :00, on hour 0, on days 0, 10, 20, 30, every month."], "0 0 */10 * * foo")
+  end
+
+  def test_that_it_parses_seasonal_cron
+    assert_table(["Runs `foo` at minute :00, on hour 0, every day, in Jan, Feb, Mar, Dec, every week day."], "0 0 * 0,1,2,11 * foo")
+  end
+
+  def test_that_it_parses_seasonal_cron_on_certain_week_days
+    assert_table(["Runs `foo` at minute :00, on hour 0, every day, in Jan, Feb, Mar, Dec, on Mon, Wed, Fri."], "0 0 * 0,1,2,11 1,3,5 foo")
+  end
+  
+  def assert_table(expected, input)
+    assert_equal(expected.join("\n"), CronWTF::Table.new(input).to_s)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/rcronwtf'

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: rcronwtf
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Darrin Holst
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-15 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: 
+email: darrinholst@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/rcronwtf.rb
+- lib/rcronwtf/entry.rb
+- lib/rcronwtf/table.rb
+- rcronwtf.gemspec
+- test/entry_test.rb
+- test/table_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/darrinholst/rcronwtf
+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: rcronwtf
+rubygems_version: 1.3.3
+signing_key: 
+specification_version: 3
+summary: translate cron entries into human readable form
+test_files: 
+- test/entry_test.rb
+- test/table_test.rb
+- test/test_helper.rb