Class: Chronic::Ordinal

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

Direct Known Subclasses

OrdinalDay

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

Scan an Array of Tokens and apply any necessary Ordinal 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



10
11
12
13
14
15
 
# File 'lib/chronic/ordinal.rb', line 10

def self.scan(tokens, options)
  tokens.each do |token|
    if t = scan_for_ordinals(token) then token.tag(t) end
    if t = scan_for_days(token) then token.tag(t) end
  end
end

.scan_for_days(token) ⇒ OrdinalDay?

Parameters:

Returns:



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

def self.scan_for_days(token)
  if token.word =~ /^(\d*)(st|nd|rd|th)$/
    unless $1.to_i > 31 || $1.to_i < 1
      OrdinalDay.new(token.word.to_i)
    end
  end
end

.scan_for_ordinals(token) ⇒ Ordinal?

Parameters:

Returns:



19
20
21
 
# File 'lib/chronic/ordinal.rb', line 19

def self.scan_for_ordinals(token)
  Ordinal.new($1.to_i) if token.word =~ /^(\d*)(st|nd|rd|th)$/
end

Instance Method Details

#to_s ⇒ Object 



33
34
35
 
# File 'lib/chronic/ordinal.rb', line 33

def to_s
  'ordinal'
end