Module: Montrose

Extended by:
Chainable
Defined in:
lib/montrose.rb,
lib/montrose/day.rb,
lib/montrose/hour.rb,
lib/montrose/ical.rb,
lib/montrose/rule.rb,
lib/montrose/week.rb,
lib/montrose/clock.rb,
lib/montrose/month.rb,
lib/montrose/stack.rb,
lib/montrose/utils.rb,
lib/montrose/errors.rb,
lib/montrose/minute.rb,
lib/montrose/options.rb,
lib/montrose/version.rb,
lib/montrose/schedule.rb,
lib/montrose/year_day.rb,
lib/montrose/chainable.rb,
lib/montrose/frequency.rb,
lib/montrose/month_day.rb,
lib/montrose/recurrence.rb,
lib/montrose/rule/after.rb,
lib/montrose/rule/total.rb,
lib/montrose/rule/until.rb,
lib/montrose/rule/during.rb,
lib/montrose/rule/except.rb,
lib/montrose/time_of_day.rb,
lib/montrose/rule/between.rb,
lib/montrose/rule/covering.rb,
lib/montrose/frequency/daily.rb,
lib/montrose/frequency/hourly.rb,
lib/montrose/frequency/weekly.rb,
lib/montrose/frequency/yearly.rb,
lib/montrose/rule/day_of_week.rb,
lib/montrose/rule/day_of_year.rb,
lib/montrose/rule/hour_of_day.rb,
lib/montrose/rule/time_of_day.rb,
lib/montrose/frequency/monthly.rb,
lib/montrose/rule/day_of_month.rb,
lib/montrose/rule/week_of_year.rb,
lib/montrose/frequency/minutely.rb,
lib/montrose/frequency/secondly.rb,
lib/montrose/rule/month_of_year.rb,
lib/montrose/rule/minute_of_hour.rb,
lib/montrose/rule/nth_day_matcher.rb,
lib/montrose/rule/nth_day_of_year.rb,
lib/montrose/rule/nth_day_of_month.rb,
lib/montrose/refinements/array_concat.rb

Defined Under Namespace

Modules: Chainable, Refinements, Rule, Utils Classes: Clock, Day, Frequency, Hour, ICal, Minute, Month, MonthDay, Options, Recurrence, Schedule, Stack, TimeOfDay, Week, YearDay

Constant Summary collapse

Error = 
Class.new(StandardError)
ConfigurationError = 
Class.new(Error)
SerializationError = 
Class.new(Error)
VERSION = 
"0.17.0"

Class Attribute Summary collapse

Class Method Summary collapse

Methods included from Chainable

at, between, branch, covering, daily, day_of_month, day_of_week, day_of_year, default_options, during, every, except, hour_of_day, hourly, merge, minutely, month_of_year, monthly, on, starts, total, until, week_of_year, weekly, yearly

Class Attribute Details

.enable_deprecated_between_masking ⇒ Object

Create a new recurrence from given options An alias to Montrose::Recurrence.new



57
58
59
 
# File 'lib/montrose.rb', line 57

def enable_deprecated_between_masking
  @enable_deprecated_between_masking
end

Class Method Details

.enable_deprecated_between_masking? ⇒ Boolean

Returns:

  • (Boolean) 


64
65
66
67
68
69
70
 
# File 'lib/montrose.rb', line 64

def enable_deprecated_between_masking?
  result = !!enable_deprecated_between_masking
  if result
    warn "[DEPRECATION] Legacy Montrose.between masking behavior is deprecated. Please use Montrose.covering instead to retain this behavior."
  end
  result
end

.recurrence(options = {}) ⇒ Montrose::Recurrence Also known as: r

Create a new recurrence from given options An alias to Montrose::Recurrence.new

Examples:

Montrose.recurrence(every: :day)
Montrose.r(every: :day)

Parameters:

  • options (Hash) (defaults to: {}) —

    recurrence options

Returns:



50
51
52
 
# File 'lib/montrose.rb', line 50

def recurrence(options = {})
  branch(options)
end