1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510
|
require 'yaml'
module IceCube
class Schedule
extend Deprecated
# Get the start time
attr_reader :start_time
deprecated_alias :start_date, :start_time
# Get the end time
attr_reader :end_time
deprecated_alias :end_date, :end_time
# Create a new schedule
def initialize(start_time = nil, options = {})
self.start_time = start_time || TimeUtil.now
self.end_time = self.start_time + options[:duration] if options[:duration]
self.end_time = options[:end_time] if options[:end_time]
@all_recurrence_rules = []
@all_exception_rules = []
yield self if block_given?
end
# Set start_time
def start_time=(start_time)
@start_time = TimeUtil.ensure_time start_time
end
deprecated_alias :start_date=, :start_time=
# Set end_time
def end_time=(end_time)
@end_time = TimeUtil.ensure_time end_time
end
deprecated_alias :end_date=, :end_time=
def duration
end_time ? end_time - start_time : 0
end
def duration=(seconds)
@end_time = start_time + seconds
end
# Add a recurrence time to the schedule
def add_recurrence_time(time)
return if time.nil?
rule = SingleOccurrenceRule.new(time)
add_recurrence_rule rule
time
end
alias :rtime :add_recurrence_time
deprecated_alias :rdate, :rtime
deprecated_alias :add_recurrence_date, :add_recurrence_time
# Add an exception time to the schedule
def add_exception_time(time)
return if time.nil?
rule = SingleOccurrenceRule.new(time)
add_exception_rule rule
time
end
alias :extime :add_exception_time
deprecated_alias :exdate, :extime
deprecated_alias :add_exception_date, :add_exception_time
# Add a recurrence rule to the schedule
def add_recurrence_rule(rule)
return if rule.nil?
@all_recurrence_rules << rule unless @all_recurrence_rules.include?(rule)
end
alias :rrule :add_recurrence_rule
# Remove a recurrence rule
def remove_recurrence_rule(rule)
res = @all_recurrence_rules.delete(rule)
res.nil? ? [] : [res]
end
# Add an exception rule to the schedule
def add_exception_rule(rule)
return if rule.nil?
@all_exception_rules << rule unless @all_exception_rules.include?(rule)
end
alias :exrule :add_exception_rule
# Remove an exception rule
def remove_exception_rule(rule)
res = @all_exception_rules.delete(rule)
res.nil? ? [] : [res]
end
# Get the recurrence rules
def recurrence_rules
@all_recurrence_rules.reject { |r| r.is_a?(SingleOccurrenceRule) }
end
alias :rrules :recurrence_rules
# Get the exception rules
def exception_rules
@all_exception_rules.reject { |r| r.is_a?(SingleOccurrenceRule) }
end
alias :exrules :exception_rules
# Get the recurrence times that are on the schedule
def recurrence_times
@all_recurrence_rules.select { |r| r.is_a?(SingleOccurrenceRule) }.map(&:time)
end
alias :rtimes :recurrence_times
deprecated_alias :rdates, :rtimes
deprecated_alias :recurrence_dates, :recurrence_times
# Remove a recurrence time
def remove_recurrence_time(time)
found = false
@all_recurrence_rules.delete_if do |rule|
found = true if rule.is_a?(SingleOccurrenceRule) && rule.time == time
end
time if found
end
alias :remove_rtime :remove_recurrence_time
deprecated_alias :remove_recurrence_date, :remove_recurrence_time
deprecated_alias :remove_rdate, :remove_rtime
# Get the exception times that are on the schedule
def exception_times
@all_exception_rules.select { |r| r.is_a?(SingleOccurrenceRule) }.map(&:time)
end
alias :extimes :exception_times
deprecated_alias :exdates, :extimes
deprecated_alias :exception_dates, :exception_times
# Remove an exception time
def remove_exception_time(time)
found = false
@all_exception_rules.delete_if do |rule|
found = true if rule.is_a?(SingleOccurrenceRule) && rule.time == time
end
time if found
end
alias :remove_extime :remove_exception_time
deprecated_alias :remove_exception_date, :remove_exception_time
deprecated_alias :remove_exdate, :remove_extime
# Get all of the occurrences from the start_time up until a
# given Time
def occurrences(closing_time)
enumerate_occurrences(start_time, closing_time).to_a
end
# All of the occurrences
def all_occurrences
require_terminating_rules
enumerate_occurrences(start_time).to_a
end
# Emit an enumerator based on the start time
def all_occurrences_enumerator
enumerate_occurrences(start_time)
end
# Iterate forever
def each_occurrence(&block)
enumerate_occurrences(start_time, &block).to_a
self
end
# The next n occurrences after now
def next_occurrences(num, from = nil, options = {})
from = TimeUtil.match_zone(from, start_time) || TimeUtil.now(start_time)
enumerate_occurrences(from + 1, nil, options).take(num)
end
# The next occurrence after now (overridable)
def next_occurrence(from = nil, options = {})
from = TimeUtil.match_zone(from, start_time) || TimeUtil.now(start_time)
enumerate_occurrences(from + 1, nil, options).next
rescue StopIteration
nil
end
# The previous occurrence from a given time
def previous_occurrence(from)
from = TimeUtil.match_zone(from, start_time) or raise ArgumentError, "Time required, got #{from.inspect}"
return nil if from <= start_time
enumerate_occurrences(start_time, from - 1).to_a.last
end
# The previous n occurrences before a given time
def previous_occurrences(num, from)
from = TimeUtil.match_zone(from, start_time) or raise ArgumentError, "Time required, got #{from.inspect}"
return [] if from <= start_time
a = enumerate_occurrences(start_time, from - 1).to_a
a.size > num ? a[-1*num,a.size] : a
end
# The remaining occurrences (same requirements as all_occurrences)
def remaining_occurrences(from = nil, options = {})
require_terminating_rules
from ||= TimeUtil.now(@start_time)
enumerate_occurrences(from, nil, options).to_a
end
# Returns an enumerator for all remaining occurrences
def remaining_occurrences_enumerator(from = nil, options = {})
from ||= TimeUtil.now(@start_time)
enumerate_occurrences(from, nil, options)
end
# Occurrences between two times
def occurrences_between(begin_time, closing_time, options = {})
enumerate_occurrences(begin_time, closing_time, options).to_a
end
# Return a boolean indicating if an occurrence falls between two times
def occurs_between?(begin_time, closing_time, options = {})
enumerate_occurrences(begin_time, closing_time, options).next
true
rescue StopIteration
false
end
# 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.
def occurring_between?(opening_time, closing_time)
occurs_between?(opening_time, closing_time, :spans => true)
end
# Return a boolean indicating if an occurrence falls on a certain date
def occurs_on?(date)
date = TimeUtil.ensure_date(date)
begin_time = TimeUtil.beginning_of_date(date, start_time)
closing_time = TimeUtil.end_of_date(date, start_time)
occurs_between?(begin_time, closing_time)
end
# Determine if the schedule is occurring at a given time
def occurring_at?(time)
time = TimeUtil.match_zone(time, start_time) or raise ArgumentError, "Time required, got #{time.inspect}"
if duration > 0
return false if exception_time?(time)
occurs_between?(time - duration + 1, time)
else
occurs_at?(time)
end
end
# 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
def conflicts_with?(other_schedule, closing_time = nil)
closing_time = TimeUtil.ensure_time(closing_time)
unless terminating? || other_schedule.terminating? || closing_time
raise ArgumentError, "One or both schedules must be terminating to use #conflicts_with?"
end
# Pick the terminating schedule, and other schedule
# No need to reverse if terminating? or there is a closing time
terminating_schedule = self
unless terminating? || closing_time
terminating_schedule, other_schedule = other_schedule, terminating_schedule
end
# Go through each occurrence of the terminating schedule and determine
# if the other occurs at that time
#
last_time = nil
terminating_schedule.each_occurrence do |time|
if closing_time && time > closing_time
last_time = closing_time
break
end
last_time = time
return true if other_schedule.occurring_at?(time)
end
# Due to durations, we need to walk up to the end time, and verify in the
# other direction
if last_time
last_time += terminating_schedule.duration
other_schedule.each_occurrence do |time|
break if time > last_time
return true if terminating_schedule.occurring_at?(time)
end
end
# No conflict, return false
false
end
# Determine if the schedule occurs at a specific time
def occurs_at?(time)
occurs_between?(time, time)
end
# Get the first n occurrences, or the first occurrence if n is skipped
def first(n = nil)
occurrences = enumerate_occurrences(start_time).take(n || 1)
n.nil? ? occurrences.first : occurrences
end
# Get the final n occurrences of a terminating schedule
# or the final one if no n is given
def last(n = nil)
require_terminating_rules
occurrences = enumerate_occurrences(start_time).to_a
n.nil? ? occurrences.last : occurrences[-n..-1]
end
# String serialization
def to_s
pieces = []
rd = recurrence_times_with_start_time - extimes
pieces.concat rd.sort.map { |t| IceCube::I18n.l(t, format: IceCube.to_s_time_format) }
pieces.concat rrules.map { |t| t.to_s }
pieces.concat exrules.map { |t| IceCube::I18n.t('ice_cube.not', target: t.to_s) }
pieces.concat extimes.sort.map { |t|
target = IceCube::I18n.l(t, format: IceCube.to_s_time_format)
IceCube::I18n.t('ice_cube.not_on', target: target)
}
pieces.join(IceCube::I18n.t('ice_cube.pieces_connector'))
end
# Serialize this schedule to_ical
def to_ical(force_utc = false)
pieces = []
pieces << "DTSTART#{IcalBuilder.ical_format(start_time, force_utc)}"
pieces.concat recurrence_rules.map { |r| "RRULE:#{r.to_ical}" }
pieces.concat exception_rules.map { |r| "EXRULE:#{r.to_ical}" }
pieces.concat recurrence_times_without_start_time.map { |t| "RDATE#{IcalBuilder.ical_format(t, force_utc)}" }
pieces.concat exception_times.map { |t| "EXDATE#{IcalBuilder.ical_format(t, force_utc)}" }
pieces << "DTEND#{IcalBuilder.ical_format(end_time, force_utc)}" if end_time
pieces.join("\n")
end
# Load the schedule from ical
def self.from_ical(ical, options = {})
IcalParser.schedule_from_ical(ical, options)
end
# Hook for YAML.dump, enables to_yaml
def encode_with(coder)
coder.represent_object nil, to_hash
end
# Load the schedule from yaml
def self.from_yaml(yaml, options = {})
YamlParser.new(yaml).to_schedule do |schedule|
Deprecated.schedule_options(schedule, options)
yield schedule if block_given?
end
end
# Convert the schedule to a hash
def to_hash
data = {}
data[:start_time] = TimeUtil.serialize_time(start_time)
data[:start_date] = data[:start_time] if IceCube.compatibility <= 11
data[:end_time] = TimeUtil.serialize_time(end_time) if end_time
data[:rrules] = recurrence_rules.map(&:to_hash)
if IceCube.compatibility <= 11 && exception_rules.any?
data[:exrules] = exception_rules.map(&:to_hash)
end
data[:rtimes] = recurrence_times.map do |rt|
TimeUtil.serialize_time(rt)
end
data[:extimes] = exception_times.map do |et|
TimeUtil.serialize_time(et)
end
data
end
alias_method :to_h, :to_hash
# Load the schedule from a hash
def self.from_hash(original_hash, options = {})
HashParser.new(original_hash).to_schedule do |schedule|
Deprecated.schedule_options(schedule, options)
yield schedule if block_given?
end
end
# Determine if the schedule will end
# @return [Boolean] true if ending, false if repeating forever
def terminating?
@all_recurrence_rules.all?(&:terminating?)
end
def hash
[
TimeUtil.hash(start_time), duration,
*@all_recurrence_rules.map(&:hash).sort!,
*@all_exception_rules.map(&:hash).sort!
].hash
end
def eql?(other)
self.hash == other.hash
end
alias == eql?
def self.dump(schedule)
return schedule if schedule.nil? || schedule == ""
schedule.to_yaml
end
def self.load(yaml)
return yaml if yaml.nil? || yaml == ""
from_yaml(yaml)
end
private
# Reset all rules for another run
def reset
@all_recurrence_rules.each(&:reset)
@all_exception_rules.each(&:reset)
end
# Find all of the occurrences for the schedule between opening_time
# and closing_time
# Iteration is unrolled in pairs to skip duplicate times in end of DST
def enumerate_occurrences(opening_time, closing_time = nil, options = {})
opening_time = TimeUtil.match_zone(opening_time, start_time)
closing_time = TimeUtil.match_zone(closing_time, start_time)
opening_time += TimeUtil.subsec(start_time) - TimeUtil.subsec(opening_time)
opening_time = start_time if opening_time < start_time
spans = options[:spans] == true && duration != 0
Enumerator.new do |yielder|
reset
t1 = full_required? ? start_time : opening_time
t1 -= duration if spans
t1 = start_time if t1 < start_time
loop do
break unless (t0 = next_time(t1, closing_time))
break if closing_time && t0 > closing_time
if (spans ? (t0.end_time > opening_time) : (t0 >= opening_time))
yielder << (block_given? ? yield(t0) : t0)
end
t1 = t0 + 1
end
end
end
# Get the next time after (or including) a specific time
def next_time(time, closing_time)
loop do
min_time = recurrence_rules_with_implicit_start_occurrence.reduce(nil) do |best_time, rule|
begin
new_time = rule.next_time(time, start_time, best_time || closing_time)
[best_time, new_time].compact.min
rescue StopIteration
best_time
end
end
break unless min_time
next (time = min_time + 1) if exception_time?(min_time)
break Occurrence.new(min_time, min_time + duration)
end
end
# Indicate if any rule needs to be run from the start of time
# If we have rules with counts, we need to walk from the beginning of time
def full_required?
@all_recurrence_rules.any?(&:full_required?) ||
@all_exception_rules.any?(&:full_required?)
end
# Return a boolean indicating whether or not a specific time
# is excluded from the schedule
def exception_time?(time)
@all_exception_rules.any? do |rule|
rule.on?(time, start_time)
end
end
def require_terminating_rules
return true if terminating?
method_name = caller[0].split(' ').last
raise ArgumentError, "All recurrence rules must specify .until or .count to use #{method_name}"
end
def implicit_start_occurrence_rule
SingleOccurrenceRule.new(start_time)
end
def recurrence_times_without_start_time
recurrence_times.reject { |t| t == start_time }
end
def recurrence_times_with_start_time
if recurrence_rules.empty?
[start_time].concat recurrence_times_without_start_time
else
recurrence_times
end
end
def recurrence_rules_with_implicit_start_occurrence
if recurrence_rules.empty?
[implicit_start_occurrence_rule].concat @all_recurrence_rules
else
@all_recurrence_rules
end
end
end
end
|