schedule_job 1.0.0 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0aa14b51b198289543636f7048935e3599a08d5eb2920a2bb7e67b80d259f19d
-  data.tar.gz: 8841e4a6ec99c02c3485927d4ba6e4335a0347b52bba332fc131fff727225e4f
+  metadata.gz: 887f7a67ad740ea939e3c585534e820ad03d85695d07a74b26390c4300a8cb04
+  data.tar.gz: d61192e8ac1ba8b74f62de780b4b000d4b235aeb13f202d24e374f381f7c65ba
 SHA512:
-  metadata.gz: 0f7832e1cc148800389da6b5f6ff3c053878cc930496f578e37af46c665f5dcb708db558b8220568c35c6ba5363e3a16351ee3453d65503cc494b1ed3b19c61d
-  data.tar.gz: c7d18b320759e7dccac481d1b4b9af06e91c09b0954d80e53650d7112ff53e202b4ed4c02ebb23039d4a634b53de9800aad9f0d1517fd60786d833d353af38e6
+  metadata.gz: 86af048f9a4e1c2e50f9c7a63ffbe483fd5c8ffbda9ec521b5c7d2c39a8a6228367e239f0ab347d3c681a2fbbf03918691e3cbf95d67cbf5c256b8439e2dbfe3
+  data.tar.gz: 7866e34e5591ed82159cc81a268166562f07e50033998cee9ff0000baeafd92772df00a7ed3953a6e50f8d627f64fb636898bd432fe460f7099a958f7c078ae5

data/Gemfile

@@ -4,9 +4,6 @@ source "https://rubygems.org"
 gemspec
 
 gem "citrus"
-# gem "whenever"
 gem "cronex"
 gem "parse-cron"
-gem "activesupport"
-# gem "treetop"
-# gem "polyglot"
+gem "activesupport"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    schedule_job (1.0.0)
+    schedule_job (1.0.4)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,15 +1,89 @@
-# Schedule
+# ScheduleJob
 
 schedule is a frontend around crontab to add/remove cron jobs from user cron tables.
 
 ## Installation
 
 ```
-gem install schedule_job
+~ ❯ gem install schedule_job
+Fetching schedule_job-1.0.1.gem
+Successfully installed schedule_job-1.0.1
+Parsing documentation for schedule_job-1.0.1
+Installing ri documentation for schedule_job-1.0.1
+Done installing documentation for schedule_job after 0 seconds
 ```
 
 ## Usage
 
+Example usage:
+```
+~ ❯ schedule --help
+Usage: schedule [options] command
+    -d, --dryrun                     Report what would happen but do not install the scheduled job.
+    -l, --list                       List installed cron jobs.
+    -r, --rm JOB_ID                  Remove the specified job id as indicated by --list
+    -u, --user USER                  User that the crontab belongs to.
+    -e, --every DURATION             Run command every DURATION units of time (valid suffixes are m, h, d, M). DURATION may also be one of the special keywords: reboot, year, month, week, day, hour
+        For example:
+        --every 10m                       # every 10 minutes
+        --every 5h                        # every 5 hours
+        --every 2d                        # every 2 days
+        --every 3M                        # every 3 months
+
+        Special durations:
+        --every reboot                    # after every reboot
+        --every year                      # every year
+        --every month                     # every month
+        --every week                      # every week
+        --every day                       # every day
+        --every hour                      # every hour
+
+    -c, --cron CRON                  Run command on the given cron schedule.
+        For example:
+        --cron "*/5 15 * * 1-5"          # Every 5 minutes, at 3:00 PM, Monday through Friday
+        --cron "0 0/30 8-9 5,20 * ?"     # Every 30 minutes, between 8:00 AM and 9:59 AM, on day 5 and 20 of the month
+
+~ ❯ schedule -l
+~ ❯ schedule -d -e 10m backup.sh
+Scheduling: backup.sh Every 10 minutes
+Next three runs:
+1. 2021-11-01 21:50:00 -0500
+2. 2021-11-01 22:00:00 -0500
+3. 2021-11-01 22:10:00 -0500
+~ ❯ schedule -l
+Jobs
+1. backup.sh Every 10 minutes
+~ ❯ crontab -l
+*/10 * * * * backup.sh
+~ ❯ schedule -e 3M quarterly_backup.sh
+Scheduling: quarterly_backup.sh At 9:50 PM, on day 1 of the month, every 3 months
+Next three runs:
+1. 2022-01-01 21:50:00 -0600
+2. 2022-04-01 21:50:00 -0500
+3. 2022-07-01 21:50:00 -0500
+~ ❯ schedule -l
+Jobs
+1. backup.sh Every 10 minutes
+2. quarterly_backup.sh At 9:50 PM, on day 1 of the month, every 3 months
+~ ❯ crontab -l
+*/10 * * * * backup.sh
+50 21 1 */3 * quarterly_backup.sh
+~ ❯ schedule --dryrun --rm 1
+Would remove: backup.sh Every 10 minutes
+~ ❯ schedule --dryrun --rm 2
+Would remove: quarterly_backup.sh At 9:50 PM, on day 1 of the month, every 3 months
+~ ❯ schedule --rm 1
+Removing: backup.sh Every 10 minutes
+~ ❯ schedule -l
+Jobs
+1. quarterly_backup.sh At 9:50 PM, on day 1 of the month, every 3 months
+~ ❯ schedule --rm 1
+Removing: quarterly_backup.sh At 9:50 PM, on day 1 of the month, every 3 months
+~ ❯ schedule -l
+~ ❯ crontab -l
+~ ❯
+```
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/bin/schedule

@@ -1,9 +1,9 @@
 #!/usr/bin/env ruby
 
-require "schedule"
+require "schedule_job"
 
 def main
-  Schedule::Cli.run(ARGV)
+  ScheduleJob::Cli.run(ARGV)
 end
 
 main

data/lib/{schedule → schedule_job}/cli.rb

@@ -1,8 +1,6 @@
 require "optparse"
 
-# schedule --every 10m "my_command --foo --bar"
-
-module Schedule
+module ScheduleJob
   class Cli
     def self.run(argv = ARGV)
       cli = Cli.new
@@ -32,20 +30,28 @@ module Schedule
           options[:crontab_user] = user
         end
 
-        opts.on("-e", "--every DURATION", "Run command every DURATION units of time.
+        opts.on("-e", "--every DURATION", "Run command every DURATION units of time (valid suffixes are m, h, d, M). DURATION may also be one of the special keywords: reboot, year, month, week, day, hour
         For example:
-        --every 10m                       # meaning, every 10 minutes
-        --every 5h                        # meaning, every 5 hours
-        --every 2d                        # meaning, every 2 days
-        --every 3M                        # meaning, every 3 months
+        --every 10m                       # every 10 minutes
+        --every 5h                        # every 5 hours
+        --every 2d                        # every 2 days
+        --every 3M                        # every 3 months
+
+        Special durations:
+        --every reboot                    # after every reboot
+        --every year                      # every year
+        --every month                     # every month
+        --every week                      # every week
+        --every day                       # every day
+        --every hour                      # every hour
         ") do |every|
           options[:every] = every
         end
 
         opts.on("-c", "--cron CRON", "Run command on the given cron schedule.
         For example:
-        --cron \"*/5 15 * * 1-5\"          # meaning, Every 5 minutes, at 3:00 PM, Monday through Friday
-        --cron \"0 0/30 8-9 5,20 * ?\"     # meaning, Every 30 minutes, between 8:00 AM and 9:59 AM, on day 5 and 20 of the month
+        --cron \"*/5 15 * * 1-5\"          # Every 5 minutes, at 3:00 PM, Monday through Friday
+        --cron \"0 0/30 8-9 5,20 * ?\"     # Every 30 minutes, between 8:00 AM and 9:59 AM, on day 5 and 20 of the month
         ") do |cron_schedule|
           options[:cron] = cron_schedule
         end
@@ -63,6 +69,8 @@ module Schedule
         remove_job(args)
       when args[:cron] || args[:every]    # write jobs
         install_job(args)
+      else
+        puts "No parameters specified. Please specify one of: --every, --cron, --list, or --rm"
       end
     end
 
@@ -90,13 +98,14 @@ module Schedule
         Cron::Job.new(cron_schedule, command)
       when args[:every]
         duration = args[:every]
-        match = duration.match(/(\d+)(m|h|d|M)/)
-        if match
+        if match = duration.match(/(\d+)(m|h|d|M)/)
           qty = match[1].to_i
           unit_of_time = match[2].to_s
           Cron::Job.every(qty, unit_of_time, command)
+        elsif duration.match(/reboot|year|month|week|day|hour/)
+          Cron::Job.every_simple_duration(duration, command)
         else
-          puts "'#{duration}' is an invalid duration. The duration must be specified as: integer followed immediately by m (minutes), h (hours), d (days), M (months) (e.g. 10m)"
+          puts "'#{duration}' is an invalid duration. The duration must be specified as either (1) integer followed immediately by m (minutes), h (hours), d (days), M (months) (e.g. 10m) or (2) reboot, year, month, week, day, hour"
           exit(1)
         end
       end

data/lib/{schedule → schedule_job}/cron.rb

@@ -8,7 +8,7 @@ require "stringio"
 
 require_relative "./cron_parser"
 
-module Schedule
+module ScheduleJob
   module Cron
 
     class EnvironmentVar
@@ -50,12 +50,6 @@ module Schedule
 
         raise("Unable to read crontab: #{error_output}") if !exit_status.success? && !no_crontab
 
-        # puts "read_crontab()"
-        # puts "stdout:"
-        # puts stdout
-        # puts "stderr:"
-        # puts stderr
-        
         crontab_output
       end
 
@@ -63,16 +57,8 @@ module Schedule
       def parse_crontab(user_crontab)
         parser = TableParser.new(user_crontab)
 
-        # user_crontab.each_line do |line|
-        #   puts line
-        #   puts "valid? #{LineParser.valid?(line)}"
-        #   puts LineParser.parse(line)
-        # end
-
         return [], [] unless parser.valid?
 
-        # puts "valid!"
-
         environment_vars = parser.environment_vars&.map do |env_directive|
           name = env_directive[:var].to_s
           expr = env_directive[:expr].to_s
@@ -108,9 +94,9 @@ module Schedule
 
       def install_cron_job(job)
         job_spec = job.specification
-        # puts "Installing new cron job: #{job_spec}"
 
         new_crontab = [read_crontab(@user).strip, job_spec.strip].reject(&:empty?).join("\n")
+        new_crontab << "\n"   # add a trailing newline
         write_crontab(new_crontab)
       end
 
@@ -135,21 +121,12 @@ module Schedule
       end
 
       def write_crontab(new_crontab, user = @user)
+        # overwrite crontab interactively, per https://stackoverflow.com/questions/610839/how-can-i-programmatically-create-a-new-cron-job
         command = ["crontab"]
         command << "-u #{user}" if user
         command << "-"
         command = command.join(" ")
 
-        # command = "(crontab -l ; echo \"#{job_spec}\") | crontab -"   # add new job to bottom of crontab, per https://stackoverflow.com/questions/610839/how-can-i-programmatically-create-a-new-cron-job
-        # puts "writing new crontab:"
-        # puts new_crontab
-        # puts "*" * 80
-
-        # puts "write_crontab:"
-        # puts "command: #{command}"
-        # puts "new crontab:"
-        # puts new_crontab
-
         stdout, stderr, exit_status = Open3.capture3(command, stdin_data: new_crontab)
         crontab_output = stdout
         error_output = stderr
@@ -196,6 +173,25 @@ module Schedule
         self.new(schedule_spec, command)
       end
 
+      # duration is one of: reboot, year, month, week, day, hour
+      def self.every_simple_duration(duration, command)
+        schedule_spec = case duration
+        when "reboot"
+          "@reboot"
+        when "year"
+          "@yearly"
+        when "month"
+          "@monthly"
+        when "week"
+          "@weekly"
+        when "day"
+          "@daily"
+        when "hour"
+          "@hourly"
+        end
+        self.new(schedule_spec, command)
+      end
+
       attr_reader :schedule_spec
       attr_reader :line_number
 

data/lib/{schedule → schedule_job}/cron_parser.rb

@@ -15,13 +15,9 @@ module Citrus
   end
 end
 
-Citrus.require("schedule/cron")
+Citrus.require("schedule_job/cron")
 
-# require "polyglot"
-# require "treetop"
-# require "schedule/cron.treetop"
-
-module Schedule
+module ScheduleJob
   module Cron
     Grammar = ScheduleCronParser
 
@@ -34,7 +30,6 @@ module Schedule
 
       def self.parse(user_crontab_string)
         Grammar.parse(user_crontab_string, root: :user_crontab)
-        # ::CrontabParser.new.parse(user_crontab_string, root: :user_crontab)
       end
 
       def initialize(user_crontab_string)
@@ -55,17 +50,10 @@ module Schedule
       
       def environment_vars
         @user_crontab&.capture(:environment)&.captures(:directive)
-        # puts @user_crontab.methods.sort.inspect
-        # puts @user_crontab.inspect
-        # puts "*" * 80
-        # puts @user_crontab.environment_spec.inspect
-        # exit()
-        # @user_crontab&.environment&.directive
       end
 
       def job_specs
         @user_crontab&.capture(:jobspecs)&.captures(:jobspec)
-        # @user_crontab&.jobspecs&.jobspec
       end
     end
 
@@ -78,7 +66,6 @@ module Schedule
 
       def self.parse(cron_line)
         Grammar.parse(cron_line, root: :jobspec, consume: false)
-        # ::CrontabParser.new.parse(cron_line, root: :jobspec, consume_all_input: false)
       end
     end
   end

data/lib/schedule_job/version.rb

@@ -0,0 +1,3 @@
+module ScheduleJob
+  VERSION = "1.0.5"
+end

data/lib/schedule_job.rb

@@ -1,9 +1,5 @@
 require 'rubygems'
 require 'bundler/setup'
 
-require "schedule/cli"
-require "schedule/cron"
-
-module ScheduleJob
-  VERSION = "1.0.0"
-end
+require "schedule_job/cli"
+require "schedule_job/cron"

data/schedule_job.gemspec

@@ -1,6 +1,8 @@
+require_relative "lib/schedule_job/version"
+
 Gem::Specification.new do |spec|
   spec.name          = "schedule_job"
-  spec.version       = "1.0.0"
+  spec.version       = ScheduleJob::VERSION
   spec.authors       = ["David Ellis"]
   spec.email         = ["david@conquerthelawn.com"]
 
@@ -8,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.description   = "job scheduler"
   spec.homepage      = "https://github.com/davidkellis/scheduler"
   spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
 
   spec.files = Dir["**/**"].
                 grep_v(/.gem$/).

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: schedule_job
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.5
 platform: ruby
 authors:
 - David Ellis
@@ -64,14 +64,13 @@ files:
 - Gemfile.lock
 - LICENSE.txt
 - README.md
-- Rakefile
 - bin/schedule
-- lib/schedule/cli.rb
-- lib/schedule/cron.citrus
-- lib/schedule/cron.rb
-- lib/schedule/cron.treetop
-- lib/schedule/cron_parser.rb
 - lib/schedule_job.rb
+- lib/schedule_job/cli.rb
+- lib/schedule_job/cron.citrus
+- lib/schedule_job/cron.rb
+- lib/schedule_job/cron_parser.rb
+- lib/schedule_job/version.rb
 - schedule_job.gemspec
 homepage: https://github.com/davidkellis/scheduler
 licenses:
@@ -85,7 +84,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/Rakefile

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task default: :spec

data/lib/schedule/cron.treetop

@@ -1,167 +0,0 @@
-grammar Crontab
-  rule user_crontab
-    sep?
-    environment_spec:(environment sep)?
-    jobspecs?
-    sep?
-  end
-
-  rule environment
-    head:directive tail:(sep directive)*
-  end
-
-  rule directive
-    var space "=" space expr
-  end
-
-  rule var
-    alpha alphanumeric?
-  end
-
-  rule expr
-    command
-  end
-
-  rule jobspecs
-    head:jobspec tail:(sep jobspec)*
-  end
-
-  rule jobspec
-    schedule_spec space command ws*
-  end
-
-  rule schedule_spec
-    standard / special
-  end
-
-  rule standard
-    minute space hour space dayofmonth space month space dayofweek
-  end
-
-  rule special
-    "@" ("yearly" / "annually" / "monthly" / "weekly" / "daily" / "hourly" / "reboot")
-  end
-
-  rule minute
-    step
-  end
-
-  rule hour
-    step
-  end
-
-  rule dayofmonthtypes
-    step
-  end
-
-  rule monthtypes
-    step / altmonths
-  end
-
-  rule dayofweektypes
-    step / altdays
-  end
-
-  rule dayofmonth
-    dayofmonthtypes ("," dayofmonthtypes)*
-  end
-
-  rule month
-    monthtypes ("," monthtypes)*
-  end
-
-  rule dayofweek
-    dayofweektypes ("," dayofweektypes)*
-  end
-
-  rule command
-    quoted_string
-    / (!("\n" / comment) .)+
-  end
-
-  rule step
-    common ("/" int)?
-  end
-
-  rule common
-    range / int / any
-  end
-
-  rule range
-    int "-" int
-  end
-
-  rule altdays
-    days ("," days)*
-  end
-
-  rule altmonths
-    months ("," months)*
-  end
-
-  rule days
-    "MON" / "TUE" / "WED" / "THU" / "FRI" / "SAT" / "SUN"
-  end
-
-  rule months
-    "JAN" / "FEB" / "MAR" / "APR" / "MAY" / "JUN" / "JUL" / "AUG" / "SEP" / "OCT" / "NOV" / "DEC"
-  end
-
-  rule any
-    "*"
-  end
-
-  rule int
-    [0-9]+
-  end
-
-  rule alpha
-    [a-zA-Z]+
-  end
-  
-  rule alphanumeric
-    [a-zA-Z0-9]+
-  end
-
-  rule sep
-    (ws* nl)+
-  end
-
-  rule ws
-    space / comment
-  end
-
-  rule space
-    [ \t]+
-  end
-
-  rule nl
-    [\n]+
-  end
-
-  rule comment
-    "#" (!"\n" .)*
-  end
-
-  rule quoted_string
-    "\"" ( (!("\"" / "\\") .) / escape)*  "\""
-    / "'" ( (!("'" / "\\") .) / escape)*  "'"
-  end
-
-  rule escape
-    "\\" escape_sequence
-  end
-
-  rule escape_sequence
-    "'"
-    / "\""
-    / "\\"
-    / "b"
-    / "f"
-    / "n"
-    / "r"
-    / "t"
-    / "v"
-  end
-
-end