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) ⇒ Integer

Build a year from a 2 digit suffix

Examples:

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

Parameters:

  • year (Integer) —

    The two digit year to build from

  • bias (Integer) —

    The amount of future years to bias

Returns:

  • (Integer) —

    The 4 digit year



78
79
80
81
82
83
84
85
 
# File 'lib/chronic/scalar.rb', line 78

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) ⇒ Array

Scan an Array of Tokens and apply any necessary Scalar tags to each token

Parameters:

  • tokens (Array<Token>) —

    Array of tokens to scan

  • options (Hash) —

    Options specified in Chronic.parse

Returns:

  • (Array) —

    list of tokens



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

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) ⇒ ScalarDay?

Parameters:

Returns:



34
35
36
37
38
39
40
41
 
# File 'lib/chronic/scalar.rb', line 34

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) ⇒ ScalarMonth?

Parameters:

Returns:



46
47
48
49
50
51
52
53
 
# File 'lib/chronic/scalar.rb', line 46

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) ⇒ Scalar?

Parameters:

Returns:



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

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) ⇒ ScalarYear?

Parameters:

Returns:



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

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 



87
88
89
 
# File 'lib/chronic/scalar.rb', line 87

def to_s
  'scalar'
end