Class: Chronic::Scalar

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

Direct Known Subclasses

ScalarDay, ScalarMonth, ScalarYear

Constant Summary collapse

DAY_PORTIONS = 
%w( am pm morning afternoon evening night )

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

.make_year(year, bias) ⇒ Object

Build a year from a 2 digit suffix.

year - The two digit Integer year to build from. bias - The Integer amount of future years to bias.

Examples:

make_year(96, 50) #=> 1996
make_year(79, 20) #=> 2079
make_year(00, 50) #=> 2000

Returns The Integer 4 digit year.



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

def self.make_year(year, bias)
  return year if year.to_s.size > 2
  start_year = Chronic.time_class.now.year - bias
  century = (start_year / 100) * 100
  full_year = century + year
  full_year += 100 if full_year < start_year
  full_year
end

.scan(tokens, options) ⇒ Object

Scan an Array of Token objects and apply any necessary Scalar tags to each token.

tokens - An Array of tokens to scan. options - The Hash of options specified in Chronic::parse.

Returns an Array of tokens.



12
13
14
15
16
17
18
19
 
# File 'lib/chronic/scalar.rb', line 12

def self.scan(tokens, options)
  tokens.each_index do |i|
    if t = scan_for_scalars(tokens[i], tokens[i + 1]) then tokens[i].tag(t) end
    if t = scan_for_days(tokens[i], tokens[i + 1]) then tokens[i].tag(t) end
    if t = scan_for_months(tokens[i], tokens[i + 1]) then tokens[i].tag(t) end
    if t = scan_for_years(tokens[i], tokens[i + 1], options) then tokens[i].tag(t) end
  end
end

.scan_for_days(token, post_token) ⇒ Object

token - The Token object we want to scan. post_token - The next Token object.

Returns a new Scalar object.



37
38
39
40
41
42
43
44
 
# File 'lib/chronic/scalar.rb', line 37

def self.scan_for_days(token, post_token)
  if token.word =~ /^\d\d?$/
    toi = token.word.to_i
    unless toi > 31 || toi < 1 || (post_token && DAY_PORTIONS.include?(post_token.word))
      return ScalarDay.new(toi)
    end
  end
end

.scan_for_months(token, post_token) ⇒ Object

token - The Token object we want to scan. post_token - The next Token object.

Returns a new Scalar object.



50
51
52
53
54
55
56
57
 
# File 'lib/chronic/scalar.rb', line 50

def self.scan_for_months(token, post_token)
  if token.word =~ /^\d\d?$/
    toi = token.word.to_i
    unless toi > 12 || toi < 1 || (post_token && DAY_PORTIONS.include?(post_token.word))
      return ScalarMonth.new(toi)
    end
  end
end

.scan_for_scalars(token, post_token) ⇒ Object

token - The Token object we want to scan. post_token - The next Token object.

Returns a new Scalar object.



25
26
27
28
29
30
31
 
# File 'lib/chronic/scalar.rb', line 25

def self.scan_for_scalars(token, post_token)
  if token.word =~ /^\d*$/
    unless post_token && DAY_PORTIONS.include?(post_token.word)
      return Scalar.new(token.word.to_i)
    end
  end
end

.scan_for_years(token, post_token, options) ⇒ Object

token - The Token object we want to scan. post_token - The next Token object. options - The Hash of options specified in Chronic::parse.

Returns a new Scalar object.



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

def self.scan_for_years(token, post_token, options)
  if token.word =~ /^([1-9]\d)?\d\d?$/
    unless post_token && DAY_PORTIONS.include?(post_token.word)
      year = make_year(token.word.to_i, options[:ambiguous_year_future_bias])
      return ScalarYear.new(year.to_i)
    end
  end
end

Instance Method Details

#to_s ⇒ Object 



94
95
96
 
# File 'lib/chronic/scalar.rb', line 94

def to_s
  'scalar'
end