Module: Chronic::Handlers

Defined in:
lib/chronic/handlers.rb

Class Method Summary collapse

Class Method Details

.day_or_time(day_start, time_tokens, options) ⇒ Object

support methods



420
421
422
423
424
425
426
427
428
429
 
# File 'lib/chronic/handlers.rb', line 420

def day_or_time(day_start, time_tokens, options)
  outer_span = Span.new(day_start, day_start + (24 * 60 * 60))

  if !time_tokens.empty?
    Chronic.now = outer_span.begin
    get_anchor(dealias_and_disambiguate_times(time_tokens, options), options)
  else
    outer_span
  end
end

.dealias_and_disambiguate_times(tokens, options) ⇒ Object 



511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
 
# File 'lib/chronic/handlers.rb', line 511

def dealias_and_disambiguate_times(tokens, options)
  # handle aliases of am/pm
  # 5:00 in the morning -> 5:00 am
  # 7:00 in the evening -> 7:00 pm

  day_portion_index = nil
  tokens.each_with_index do |t, i|
    if t.get_tag(RepeaterDayPortion)
      day_portion_index = i
      break
    end
  end

  time_index = nil
  tokens.each_with_index do |t, i|
    if t.get_tag(RepeaterTime)
      time_index = i
      break
    end
  end

  if day_portion_index && time_index
    t1 = tokens[day_portion_index]
    t1tag = t1.get_tag(RepeaterDayPortion)

    case t1tag.type
    when :morning
      puts '--morning->am' if Chronic.debug
      t1.untag(RepeaterDayPortion)
      t1.tag(RepeaterDayPortion.new(:am))
    when :afternoon, :evening, :night
      puts "--#{t1tag.type}->pm" if Chronic.debug
      t1.untag(RepeaterDayPortion)
      t1.tag(RepeaterDayPortion.new(:pm))
    end
  end

  # handle ambiguous times if :ambiguous_time_range is specified
  if options[:ambiguous_time_range] != :none
    ambiguous_tokens = []

    tokens.each_with_index do |token, i|
      ambiguous_tokens << token
      next_token = tokens[i + 1]

      if token.get_tag(RepeaterTime) && token.get_tag(RepeaterTime).type.ambiguous? && (!next_token || !next_token.get_tag(RepeaterDayPortion))
        distoken = Token.new('disambiguator')

        distoken.tag(RepeaterDayPortion.new(options[:ambiguous_time_range]))
        ambiguous_tokens << distoken
      end
    end

    tokens = ambiguous_tokens
  end

  tokens
end

.find_within(tags, span, pointer) ⇒ Object

Recursively finds repeaters within other repeaters. Returns a Span representing the innermost time span or nil if no repeater union could be found



484
485
486
487
488
489
490
491
492
493
494
495
 
# File 'lib/chronic/handlers.rb', line 484

def find_within(tags, span, pointer)
  puts "--#{span}" if Chronic.debug
  return span if tags.empty?

  head = tags.shift
  head.start = (pointer == :future ? span.begin : span.end)
  h = head.this(:none)

  if span.cover?(h.begin) || span.cover?(h.end)
    find_within(tags, h, pointer)
  end
end

.get_anchor(tokens, options) ⇒ Object 



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
 
# File 'lib/chronic/handlers.rb', line 431

def get_anchor(tokens, options)
  grabber = Grabber.new(:this)
  pointer = :future
  repeaters = get_repeaters(tokens)
  repeaters.size.times { tokens.pop }

  if tokens.first && tokens.first.get_tag(Grabber)
    grabber = tokens.shift.get_tag(Grabber)
  end

  head = repeaters.shift
  head.start = Chronic.now

  case grabber.type
  when :last
    outer_span = head.next(:past)
  when :this
    if options[:context] != :past and repeaters.size > 0
      outer_span = head.this(:none)
    else
      outer_span = head.this(options[:context])
    end
  when :next
    outer_span = head.next(:future)
  else
    raise ChronicPain, "Invalid grabber"
  end

  if Chronic.debug
    puts "Handler-class: #{head.class}"
    puts "--#{outer_span}"
  end

  find_within(repeaters, outer_span, pointer)
end

.get_repeaters(tokens) ⇒ Object 



467
468
469
 
# File 'lib/chronic/handlers.rb', line 467

def get_repeaters(tokens)
  tokens.map { |token| token.get_tag(Repeater) }.compact.sort.reverse
end

.handle_generic(tokens, options) ⇒ Object

Handle generic timestamp (ruby 1.8)



134
135
136
137
 
# File 'lib/chronic/handlers.rb', line 134

def handle_generic(tokens, options)
  t = Chronic.time_class.parse(options[:text])
  Span.new(t, t + 1)
end

.handle_m_d(month, day, time_tokens, options) ⇒ Object

Handle month/day



6
7
8
9
10
11
12
13
 
# File 'lib/chronic/handlers.rb', line 6

def handle_m_d(month, day, time_tokens, options)
  month.start = Chronic.now
  span = month.this(options[:context])
  year, month = span.begin.year, span.begin.month
  day_start = Chronic.time_class.local(year, month, day)

  day_or_time(day_start, time_tokens, options)
end

.handle_o_r_g_r(tokens, options) ⇒ Object

Handle ordinal/repeater/grabber/repeater



413
414
415
416
 
# File 'lib/chronic/handlers.rb', line 413

def handle_o_r_g_r(tokens, options)
  outer_span = get_anchor(tokens[2..3], options)
  handle_orr(tokens[0..1], outer_span, options)
end

.handle_o_r_s_r(tokens, options) ⇒ Object

Handle ordinal/repeater/separator/repeater



407
408
409
410
 
# File 'lib/chronic/handlers.rb', line 407

def handle_o_r_s_r(tokens, options)
  outer_span = get_anchor([tokens[3]], options)
  handle_orr(tokens[0..1], outer_span, options)
end

.handle_od_rm(tokens, options) ⇒ Object

Handle ordinal this month



53
54
55
56
57
 
# File 'lib/chronic/handlers.rb', line 53

def handle_od_rm(tokens, options)
  day = tokens[0].get_tag(OrdinalDay).type
  month = tokens[2].get_tag(RepeaterMonth)
  handle_m_d(month, day, tokens[3..tokens.size], options)
end

.handle_od_rmn(tokens, options) ⇒ Object

Handle ordinal-day/repeater-month-name



60
61
62
63
64
65
66
67
 
# File 'lib/chronic/handlers.rb', line 60

def handle_od_rmn(tokens, options)
  month = tokens[1].get_tag(RepeaterMonthName)
  day = tokens[0].get_tag(OrdinalDay).type

  return if month_overflow?(Chronic.now.year, month.index, day)

  handle_m_d(month, day, tokens[2..tokens.size], options)
end

.handle_od_rmn_sy(tokens, options) ⇒ Object

Handle oridinal-day/repeater-month-name/scalar-year



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/chronic/handlers.rb', line 174

def handle_od_rmn_sy(tokens, options)
  day = tokens[0].get_tag(OrdinalDay).type
  month = tokens[1].get_tag(RepeaterMonthName).index
  year = tokens[2].get_tag(ScalarYear).type
  time_tokens = tokens.last(tokens.size - 3)

  return if month_overflow?(year, month, day)

  begin
    day_start = Chronic.time_class.local(year, month, day)
    day_or_time(day_start, time_tokens, options)
  rescue ArgumentError
    nil
  end
end

.handle_orr(tokens, outer_span, options) ⇒ Object

Handle oridinal repeaters



388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/chronic/handlers.rb', line 388

def handle_orr(tokens, outer_span, options)
  repeater = tokens[1].get_tag(Repeater)
  repeater.start = outer_span.begin - 1
  ordinal = tokens[0].get_tag(Ordinal).type
  span = nil

  ordinal.times do
    span = repeater.next(:future)

    if span.begin >= outer_span.end
      span = nil
      break
    end
  end

  span
end

.handle_p_s_r(tokens, options) ⇒ Object

Handle pointer/scalar/repeater



374
375
376
377
 
# File 'lib/chronic/handlers.rb', line 374

def handle_p_s_r(tokens, options)
  new_tokens = [tokens[1], tokens[2], tokens[0]]
  handle_s_r_p(new_tokens, options)
end

.handle_r(tokens, options) ⇒ Object

Handle repeaters



343
344
345
346
 
# File 'lib/chronic/handlers.rb', line 343

def handle_r(tokens, options)
  dd_tokens = dealias_and_disambiguate_times(tokens, options)
  get_anchor(dd_tokens, options)
end

.handle_r_g_r(tokens, options) ⇒ Object

Handle repeater/grabber/repeater



349
350
351
352
 
# File 'lib/chronic/handlers.rb', line 349

def handle_r_g_r(tokens, options)
  new_tokens = [tokens[1], tokens[0], tokens[2]]
  handle_r(new_tokens, options)
end

.handle_rdn_rmn_od(tokens, options) ⇒ Object

Handle RepeaterDayName RepeaterMonthName OrdinalDay



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/chronic/handlers.rb', line 274

def handle_rdn_rmn_od(tokens, options)
  month = tokens[1].get_tag(RepeaterMonthName)
  day = tokens[2].get_tag(OrdinalDay).type
  year = Chronic.now.year

  return if month_overflow?(year, month.index, day)

  begin
    start_time = Chronic.time_class.local(year, month.index, day)
    end_time = time_with_rollover(year, month.index, day + 1)
    Span.new(start_time, end_time)
  rescue ArgumentError
    nil
  end
end

.handle_rdn_rmn_sd(tokens, options) ⇒ Object

Handle RepeaterDayName RepeaterMonthName ScalarDay



291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/chronic/handlers.rb', line 291

def handle_rdn_rmn_sd(tokens, options)
  month = tokens[1].get_tag(RepeaterMonthName)
  day = tokens[2].get_tag(ScalarDay).type
  year = Chronic.now.year

  return if month_overflow?(year, month.index, day)

  begin
    start_time = Chronic.time_class.local(year, month.index, day)
    end_time = time_with_rollover(year, month.index, day + 1)
    Span.new(start_time, end_time)
  rescue ArgumentError
    nil
  end
end

.handle_rdn_rmn_sd_sy(tokens, options) ⇒ Object

Handle RepeaterDayName RepeaterMonthName ScalarDay ScalarYear



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/chronic/handlers.rb', line 308

def handle_rdn_rmn_sd_sy(tokens, options)
  month = tokens[1].get_tag(RepeaterMonthName)
  day = tokens[2].get_tag(ScalarDay).type
  year = tokens[3].get_tag(ScalarYear).type

  return if month_overflow?(year, month.index, day)

  begin
    start_time = Chronic.time_class.local(year, month.index, day)
    end_time = time_with_rollover(year, month.index, day + 1)
    Span.new(start_time, end_time)
  rescue ArgumentError
    nil
  end
end

.handle_rmn_od(tokens, options) ⇒ Object

Handle repeater-month-name/ordinal-day



43
44
45
46
47
48
49
50
 
# File 'lib/chronic/handlers.rb', line 43

def handle_rmn_od(tokens, options)
  month = tokens[0].get_tag(RepeaterMonthName)
  day = tokens[1].get_tag(OrdinalDay).type

  return if month_overflow?(Chronic.now.year, month.index, day)

  handle_m_d(month, day, tokens[2..tokens.size], options)
end

.handle_rmn_od_on(tokens, options) ⇒ Object

Handle repeater-month-name/ordinal-day with separator-on



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/chronic/handlers.rb', line 96

def handle_rmn_od_on(tokens, options)
  if tokens.size > 3
    month = tokens[2].get_tag(RepeaterMonthName)
    day = tokens[3].get_tag(OrdinalDay).type
    token_range = 0..1
  else
    month = tokens[1].get_tag(RepeaterMonthName)
    day = tokens[2].get_tag(OrdinalDay).type
    token_range = 0..0
  end

  return if month_overflow?(Chronic.now.year, month.index, day)

  handle_m_d(month, day, tokens[token_range], options)
end

.handle_rmn_od_sy(tokens, options) ⇒ Object

Handle repeater-month-name/ordinal-day/scalar-year



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/chronic/handlers.rb', line 157

def handle_rmn_od_sy(tokens, options)
  month = tokens[0].get_tag(RepeaterMonthName).index
  day = tokens[1].get_tag(OrdinalDay).type
  year = tokens[2].get_tag(ScalarYear).type
  time_tokens = tokens.last(tokens.size - 3)

  return if month_overflow?(year, month, day)

  begin
    day_start = Chronic.time_class.local(year, month, day)
    day_or_time(day_start, time_tokens, options)
  rescue ArgumentError
    nil
  end
end

.handle_rmn_sd(tokens, options) ⇒ Object

Handle repeater-month-name/scalar-day



16
17
18
19
20
21
22
23
 
# File 'lib/chronic/handlers.rb', line 16

def handle_rmn_sd(tokens, options)
  month = tokens[0].get_tag(RepeaterMonthName)
  day = tokens[1].get_tag(ScalarDay).type

  return if month_overflow?(Chronic.now.year, month.index, day)

  handle_m_d(month, day, tokens[2..tokens.size], options)
end

.handle_rmn_sd_on(tokens, options) ⇒ Object

Handle repeater-month-name/scalar-day with separator-on



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/chronic/handlers.rb', line 26

def handle_rmn_sd_on(tokens, options)
  if tokens.size > 3
    month = tokens[2].get_tag(RepeaterMonthName)
    day = tokens[3].get_tag(ScalarDay).type
    token_range = 0..1
  else
    month = tokens[1].get_tag(RepeaterMonthName)
    day = tokens[2].get_tag(ScalarDay).type
    token_range = 0..0
  end

  return if month_overflow?(Chronic.now.year, month.index, day)

  handle_m_d(month, day, tokens[token_range], options)
end

.handle_rmn_sd_sy(tokens, options) ⇒ Object

Handle repeater-month-name/scalar-day/scalar-year



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/chronic/handlers.rb', line 140

def handle_rmn_sd_sy(tokens, options)
  month = tokens[0].get_tag(RepeaterMonthName).index
  day = tokens[1].get_tag(ScalarDay).type
  year = tokens[2].get_tag(ScalarYear).type
  time_tokens = tokens.last(tokens.size - 3)

  return if month_overflow?(year, month, day)

  begin
    day_start = Chronic.time_class.local(year, month, day)
    day_or_time(day_start, time_tokens, options)
  rescue ArgumentError
    nil
  end
end

.handle_rmn_sy(tokens, options) ⇒ Object

Handle repeater-month-name/scalar-year



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/chronic/handlers.rb', line 113

def handle_rmn_sy(tokens, options)
  month = tokens[0].get_tag(RepeaterMonthName).index
  year = tokens[1].get_tag(ScalarYear).type

  if month == 12
    next_month_year = year + 1
    next_month_month = 1
  else
    next_month_year = year
    next_month_month = month + 1
  end

  begin
    end_time = Chronic.time_class.local(next_month_year, next_month_month)
    Span.new(Chronic.time_class.local(year, month), end_time)
  rescue ArgumentError
    nil
  end
end

.handle_s_r_p(tokens, options) ⇒ Object

Handle scalar/repeater/pointer



366
367
368
369
370
371
 
# File 'lib/chronic/handlers.rb', line 366

def handle_s_r_p(tokens, options)
  repeater = tokens[1].get_tag(Repeater)
  span = Span.new(Chronic.now, Chronic.now + 1)

  handle_srp(tokens, span, options)
end

.handle_s_r_p_a(tokens, options) ⇒ Object

Handle scalar/repeater/pointer/anchor



380
381
382
383
 
# File 'lib/chronic/handlers.rb', line 380

def handle_s_r_p_a(tokens, options)
  anchor_span = get_anchor(tokens[3..tokens.size - 1], options)
  handle_srp(tokens, anchor_span, options)
end

.handle_sd_rmn(tokens, options) ⇒ Object

Handle scalar-day/repeater-month-name



86
87
88
89
90
91
92
93
 
# File 'lib/chronic/handlers.rb', line 86

def handle_sd_rmn(tokens, options)
  month = tokens[1].get_tag(RepeaterMonthName)
  day = tokens[0].get_tag(ScalarDay).type

  return if month_overflow?(Chronic.now.year, month.index, day)

  handle_m_d(month, day, tokens[2..tokens.size], options)
end

.handle_sd_rmn_sy(tokens, options) ⇒ Object

Handle scalar-day/repeater-month-name/scalar-year



191
192
193
194
195
 
# File 'lib/chronic/handlers.rb', line 191

def handle_sd_rmn_sy(tokens, options)
  new_tokens = [tokens[1], tokens[0], tokens[2]]
  time_tokens = tokens.last(tokens.size - 3)
  handle_rmn_sd_sy(new_tokens + time_tokens, options)
end

.handle_sd_sm(tokens, options) ⇒ Object

Handle scalar-day/scalar-month



246
247
248
249
250
 
# File 'lib/chronic/handlers.rb', line 246

def handle_sd_sm(tokens, options)
  new_tokens = [tokens[1], tokens[0]]
  time_tokens = tokens.last(tokens.size - 2)
  handle_sm_sd(new_tokens + time_tokens, options)
end

.handle_sd_sm_sy(tokens, options) ⇒ Object

Handle scalar-day/scalar-month/scalar-year (endian little)



215
216
217
218
219
 
# File 'lib/chronic/handlers.rb', line 215

def handle_sd_sm_sy(tokens, options)
  new_tokens = [tokens[1], tokens[0], tokens[2]]
  time_tokens = tokens.last(tokens.size - 3)
  handle_sm_sd_sy(new_tokens + time_tokens, options)
end

.handle_sm_rmn_sy(tokens, options) ⇒ Object 



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/chronic/handlers.rb', line 324

def handle_sm_rmn_sy(tokens, options)
  day = tokens[0].get_tag(ScalarDay).type
  month = tokens[1].get_tag(RepeaterMonthName).index
  year = tokens[2].get_tag(ScalarYear).type
  if tokens.size > 3
    time = get_anchor([tokens.last], options).begin
    h, m, s = time.hour, time.min, time.sec
    time = Chronic.time_class.local(year, month, day, h, m, s)
    end_time = Chronic.time_class.local(year, month, day + 1, h, m, s)
  else
    time = Chronic.time_class.local(year, month, day)
    end_time = Chronic.time_class.local(year, month, day + 1)
  end
  Span.new(time, end_time)
end

.handle_sm_sd(tokens, options) ⇒ Object

Handle scalar-month/scalar-day



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/chronic/handlers.rb', line 229

def handle_sm_sd(tokens, options)
  month = tokens[0].get_tag(ScalarMonth).type
  day = tokens[1].get_tag(ScalarDay).type
  year = Chronic.now.year
  time_tokens = tokens.last(tokens.size - 2)

  return if month_overflow?(year, month, day)

  begin
    day_start = Chronic.time_class.local(year, month, day)
    day_or_time(day_start, time_tokens, options)
  rescue ArgumentError
    nil
  end
end

.handle_sm_sd_sy(tokens, options) ⇒ Object

Handle scalar-month/scalar-day/scalar-year (endian middle)



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/chronic/handlers.rb', line 198

def handle_sm_sd_sy(tokens, options)
  month = tokens[0].get_tag(ScalarMonth).type
  day = tokens[1].get_tag(ScalarDay).type
  year = tokens[2].get_tag(ScalarYear).type
  time_tokens = tokens.last(tokens.size - 3)

  return if month_overflow?(year, month, day)

  begin
    day_start = Chronic.time_class.local(year, month, day)
    day_or_time(day_start, time_tokens, options)
  rescue ArgumentError
    nil
  end
end

.handle_sm_sy(tokens, options) ⇒ Object

Handle scalar-month/scalar-year



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/chronic/handlers.rb', line 253

def handle_sm_sy(tokens, options)
  month = tokens[0].get_tag(ScalarMonth).type
  year = tokens[1].get_tag(ScalarYear).type

  if month == 12
    next_month_year = year + 1
    next_month_month = 1
  else
    next_month_year = year
    next_month_month = month + 1
  end

  begin
    end_time = Chronic.time_class.local(next_month_year, next_month_month)
    Span.new(Chronic.time_class.local(year, month), end_time)
  rescue ArgumentError
    nil
  end
end

.handle_srp(tokens, span, options) ⇒ Object

Handle scalar/repeater/pointer helper



357
358
359
360
361
362
363
 
# File 'lib/chronic/handlers.rb', line 357

def handle_srp(tokens, span, options)
  distance = tokens[0].get_tag(Scalar).type
  repeater = tokens[1].get_tag(Repeater)
  pointer = tokens[2].get_tag(Pointer).type

  repeater.offset(span, distance, pointer) if repeater.respond_to?(:offset)
end

.handle_sy_rmn_od(tokens, options) ⇒ Object 



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/chronic/handlers.rb', line 69

def handle_sy_rmn_od(tokens, options)
  year = tokens[0].get_tag(ScalarYear).type
  month = tokens[1].get_tag(RepeaterMonthName).index
  day = tokens[2].get_tag(OrdinalDay).type
  time_tokens = tokens.last(tokens.size - 3)

  return if month_overflow?(year, month, day)

  begin
    day_start = Chronic.time_class.local(year, month, day)
    day_or_time(day_start, time_tokens, options)
  rescue ArgumentError
    nil
  end
end

.handle_sy_sm_sd(tokens, options) ⇒ Object

Handle scalar-year/scalar-month/scalar-day



222
223
224
225
226
 
# File 'lib/chronic/handlers.rb', line 222

def handle_sy_sm_sd(tokens, options)
  new_tokens = [tokens[1], tokens[2], tokens[0]]
  time_tokens = tokens.last(tokens.size - 3)
  handle_sm_sd_sy(new_tokens + time_tokens, options)
end

.month_overflow?(year, month, day) ⇒ Boolean

Returns:

  • (Boolean) 


471
472
473
474
475
476
477
478
479
 
# File 'lib/chronic/handlers.rb', line 471

def month_overflow?(year, month, day)
  if Date.leap?(year)
    day > RepeaterMonth::MONTH_DAYS_LEAP[month - 1]
  else
    day > RepeaterMonth::MONTH_DAYS[month - 1]
  end
rescue ArgumentError
  false
end

.time_with_rollover(year, month, day) ⇒ Object 



497
498
499
500
501
502
503
504
505
506
507
508
509
 
# File 'lib/chronic/handlers.rb', line 497

def time_with_rollover(year, month, day)
  date_parts =
    if month_overflow?(year, month, day)
      if month == 12
        [year + 1, 1, 1]
      else
        [year, month + 1, 1]
      end
    else
      [year, month, day]
    end
  Chronic.time_class.local(*date_parts)
end