Class IceCube::Schedule
In: lib/ice_cube/schedule.rb
Parent: Object

Methods

==   add_exception_rule   add_exception_time   add_recurrence_rule   add_recurrence_time   all_occurrences   all_occurrences_enumerator   conflicts_with?   dump   duration   duration=   each_occurrence   encode_with   end_time=   eql?   exception_rules   exception_times   exrule   exrules   extime   extimes   first   from_hash   from_ical   from_yaml   hash   last   load   new   next_occurrence   next_occurrences   occurrences   occurrences_between   occurring_at?   occurring_between?   occurs_at?   occurs_between?   occurs_on?   previous_occurrence   previous_occurrences   recurrence_rules   recurrence_times   remaining_occurrences   remaining_occurrences_enumerator   remove_exception_rule   remove_exception_time   remove_extime   remove_recurrence_rule   remove_recurrence_time   remove_rtime   rrule   rrules   rtime   rtimes   start_time=   terminating?   to_h   to_hash   to_ical   to_s  

Attributes

end_time  [R]  Get the end time
start_time  [R]  Get the start time

Public Class methods

from_ical(ical, options = {})

Load the schedule from ical

Public Instance methods

==(other)

Alias for eql?

add_exception_rule(rule)

Add an exception rule to the schedule

add_exception_time(time)

Add an exception time to the schedule

add_recurrence_rule(rule)

Add a recurrence rule to the schedule

add_recurrence_time(time)

Add a recurrence time to the schedule

all_occurrences_enumerator()

Emit an enumerator based on the start time

conflicts_with?(other_schedule, closing_time = nil)

Determine if this schedule conflicts with another schedule @param [IceCube::Schedule] other_schedule - The schedule to compare to @param [Time] closing_time - the last time to consider @return [Boolean] whether or not the schedules conflict at all

encode_with(coder)

Hook for YAML.dump, enables to_yaml

exception_rules()

Get the exception rules

exception_times()

Get the exception times that are on the schedule

exrule(rule)

Alias for add_exception_rule

exrules()

Alias for exception_rules

extime(time)

Alias for add_exception_time

extimes()

Alias for exception_times

first(n = nil)

Get the first n occurrences, or the first occurrence if n is skipped

last(n = nil)

Get the final n occurrences of a terminating schedule or the final one if no n is given

next_occurrence(from = nil, options = {})

The next occurrence after now (overridable)

occurrences(closing_time)

Get all of the occurrences from the start_time up until a given Time

occurring_at?(time)

Determine if the schedule is occurring at a given time

occurring_between?(opening_time, closing_time)

Return a boolean indicating if an occurrence is occurring between two times, inclusive of its duration. This counts zero-length occurrences that intersect the start of the range and within the range, but not occurrences at the end of the range since none of their duration intersects the range.

occurs_at?(time)

Determine if the schedule occurs at a specific time

occurs_between?(begin_time, closing_time, options = {})

Return a boolean indicating if an occurrence falls between two times

occurs_on?(date)

Return a boolean indicating if an occurrence falls on a certain date

previous_occurrence(from)

The previous occurrence from a given time

previous_occurrences(num, from)

The previous n occurrences before a given time

recurrence_rules()

Get the recurrence rules

recurrence_times()

Get the recurrence times that are on the schedule

remove_exception_rule(rule)

Remove an exception rule

remove_exception_time(time)

Remove an exception time

remove_extime(time)

Alias for remove_exception_time

remove_recurrence_rule(rule)

Remove a recurrence rule

remove_recurrence_time(time)

Remove a recurrence time

remove_rtime(time)

Alias for remove_recurrence_time

rrule(rule)

Alias for add_recurrence_rule

rrules()

Alias for recurrence_rules

rtime(time)

Alias for add_recurrence_time

rtimes()

Alias for recurrence_times

terminating?()

Determine if the schedule will end @return [Boolean] true if ending, false if repeating forever

to_h()

Alias for to_hash

to_hash()

Convert the schedule to a hash

to_ical(force_utc = false)

Serialize this schedule to_ical

to_s()

String serialization

[Validate]