Module: Philiprehberger::CronKit

Defined in:

lib/philiprehberger/cron_kit.rb,
lib/philiprehberger/cron_kit/parser.rb,
lib/philiprehberger/cron_kit/aliases.rb,
lib/philiprehberger/cron_kit/version.rb,
lib/philiprehberger/cron_kit/timezone.rb,
lib/philiprehberger/cron_kit/scheduler.rb,
lib/philiprehberger/cron_kit/expression.rb,
lib/philiprehberger/cron_kit/timeout_handler.rb

Defined Under Namespace

Modules: Aliases, Parser, TimeoutHandler, Timezone Classes: Expression, ParseError, Scheduler

Constant Summary

VERSION =

'0.5.1'

Class Method Summary

• .new ⇒ Object

  Create a new Scheduler instance.

• .parse(expression, timezone: nil) ⇒ Object

  Parse a 5-field cron expression and return an Expression instance.

• .valid?(expression, timezone: nil) ⇒ Boolean

  Return true if the given string is a valid cron expression.

Class Method Details

.new ⇒ Object

Create a new Scheduler instance.

# File 'lib/philiprehberger/cron_kit.rb', line 20

def self.new
  Scheduler.new
end

.parse(expression, timezone: nil) ⇒ Object

Parse a 5-field cron expression and return an Expression instance. Supports non-standard aliases (@hourly, @daily, etc.) and optional timezone.

# File 'lib/philiprehberger/cron_kit.rb', line 15

def self.parse(expression, timezone: nil)
  Expression.new(expression, timezone: timezone)
end

.valid?(expression, timezone: nil) ⇒ Boolean

Return true if the given string is a valid cron expression. Accepts the same syntax as ‘parse` (5-field expressions and aliases).

Returns:

• (Boolean)

# File 'lib/philiprehberger/cron_kit.rb', line 26

def self.valid?(expression, timezone: nil)
  Expression.valid?(expression, timezone: timezone)
end