Class: Chronic::Repeater

Inherits:
Tag
  • Object
show all
Defined in:
lib/chronic/repeater.rb

Overview

:nodoc:

Instance Attribute Summary

Attributes inherited from Tag

#type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Tag

#initialize, #start=

Constructor Details

This class inherits a constructor from Chronic::Tag

Class Method Details

.scan(tokens, options) ⇒ Object 



3
4
5
6
7
8
9
10
11
12
13
 
# File 'lib/chronic/repeater.rb', line 3

def self.scan(tokens, options)
  # for each token
  tokens.each_index do |i|
    if t = scan_for_season_names(tokens[i]) then tokens[i].tag(t); next end
    if t = scan_for_month_names(tokens[i]) then tokens[i].tag(t); next end
    if t = scan_for_day_names(tokens[i]) then tokens[i].tag(t); next end
    if t = scan_for_day_portions(tokens[i]) then tokens[i].tag(t); next end
    if t = scan_for_times(tokens[i]) then tokens[i].tag(t); next end
    if t = scan_for_units(tokens[i]) then tokens[i].tag(t); next end
  end
end

.scan_for_day_names(token) ⇒ Object 



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/chronic/repeater.rb', line 43

def self.scan_for_day_names(token)
  scan_for token, RepeaterDayName,
  {
    /^m[ou]n(day)?$/ => :monday,
    /^t(ue|eu|oo|u|)s(day)?$/ => :tuesday,
    /^tue$/ => :tuesday,
    /^we(dnes|nds|nns)day$/ => :wednesday,
    /^wed$/ => :wednesday,
    /^th(urs|ers)day$/ => :thursday,
    /^thu(rs)?$/ => :thursday,
    /^fr[iy](day)?$/ => :friday,
    /^sat(t?[ue]rday)?$/ => :saturday,
    /^su[nm](day)?$/ => :sunday
  }
end

.scan_for_day_portions(token) ⇒ Object 



59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/chronic/repeater.rb', line 59

def self.scan_for_day_portions(token)
  scan_for token, RepeaterDayPortion,
  {
    /^ams?$/ => :am,
    /^pms?$/ => :pm,
    /^mornings?$/ => :morning,
    /^afternoons?$/ => :afternoon,
    /^evenings?$/ => :evening,
    /^(night|nite)s?$/ => :night
  }
end

.scan_for_month_names(token) ⇒ Object 



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

def self.scan_for_month_names(token)
  scan_for token, RepeaterMonthName,
  {
    /^jan\.?(uary)?$/ => :january,
    /^feb\.?(ruary)?$/ => :february,
    /^mar\.?(ch)?$/ => :march,
    /^apr\.?(il)?$/ => :april,
    /^may$/ => :may,
    /^jun\.?e?$/ => :june,
    /^jul\.?y?$/ => :july,
    /^aug\.?(ust)?$/ => :august,
    /^sep\.?(t\.?|tember)?$/ => :september,
    /^oct\.?(ober)?$/ => :october,
    /^nov\.?(ember)?$/ => :november,
    /^dec\.?(ember)?$/ => :december
  }
end

.scan_for_season_names(token) ⇒ Object 



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

def self.scan_for_season_names(token)
  scan_for token, RepeaterSeasonName,
  {
    /^springs?$/ => :spring,
    /^summers?$/ => :summer,
    /^(autumn)|(fall)s?$/ => :autumn,
    /^winters?$/ => :winter
  }
end

.scan_for_times(token) ⇒ Object 



71
72
73
74
75
76
 
# File 'lib/chronic/repeater.rb', line 71

def self.scan_for_times(token)
  if token.word =~ /^\d{1,2}(:?\d{2})?([\.:]?\d{2})?$/
    return Chronic::RepeaterTime.new(token.word)
  end
  return nil
end

.scan_for_units(token) ⇒ Object 



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/chronic/repeater.rb', line 78

def self.scan_for_units(token)
  {
    /^years?$/ => :year,
    /^seasons?$/ => :season,
    /^months?$/ => :month,
    /^fortnights?$/ => :fortnight,
    /^weeks?$/ => :week,
    /^weekends?$/ => :weekend,
    /^(week|business)days?$/ => :weekday,
    /^days?$/ => :day,
    /^hours?$/ => :hour,
    /^minutes?$/ => :minute,
    /^seconds?$/ => :second
  }.each do |item, symbol|
    if item =~ token.word
      klass_name = 'Repeater' + symbol.to_s.capitalize
      klass = Chronic.const_get(klass_name)
      return klass.new(symbol)
    end
  end
  return nil
end

Instance Method Details

#<=>(other) ⇒ Object 



101
102
103
 
# File 'lib/chronic/repeater.rb', line 101

def <=>(other)
  width <=> other.width
end

#next(pointer) ⇒ Object

returns the next occurance of this repeatable.



111
112
113
114
115
 
# File 'lib/chronic/repeater.rb', line 111

def next(pointer)
  !@now.nil? || raise("Start point must be set before calling #next")
  [:future, :none, :past].include?(pointer) || raise("First argument 'pointer' must be one of :past or :future")
  #raise("Repeatable#next must be overridden in subclasses")
end

#this(pointer) ⇒ Object 



117
118
119
120
 
# File 'lib/chronic/repeater.rb', line 117

def this(pointer)
  !@now.nil? || raise("Start point must be set before calling #this")
  [:future, :past, :none].include?(pointer) || raise("First argument 'pointer' must be one of :past, :future, :none")
end

#to_s ⇒ Object 



122
123
124
 
# File 'lib/chronic/repeater.rb', line 122

def to_s
  'repeater'
end

#width ⇒ Object

returns the width (in seconds or months) of this repeatable.



106
107
108
 
# File 'lib/chronic/repeater.rb', line 106

def width
  raise("Repeatable#width must be overridden in subclasses")
end