Class: ISO8601::Date

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Defined in:
lib/iso8601/date.rb

Overview

A Date representation

Examples:

d = Date.new('2014-05-28')
d.year  # => 2014
d.month # => 5

Week dates

d = Date.new('2014-W15-2')
d.day   # => 27
d.wday  # => 2
d.week # => 15

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(input) ⇒ Date

Returns a new instance of Date.

Parameters:

  • input (String) —

    The date pattern



29
30
31
32
33
 
# File 'lib/iso8601/date.rb', line 29

def initialize(input)
  @original = input
  @atoms = atomize(input)
  @date = compose(@atoms)
end

Instance Attribute Details

#atoms ⇒ Object (readonly)

The original atoms



23
24
25
 
# File 'lib/iso8601/date.rb', line 23

def atoms
  @atoms
end

#separator ⇒ Object (readonly)

The separator used in the original ISO 8601 string.



26
27
28
 
# File 'lib/iso8601/date.rb', line 26

def separator
  @separator
end

Instance Method Details

#+(days) ⇒ ISO8601::Date

Forwards the date the given amount of days.

Parameters:

  • days (Numeric) —

    The days to add

Returns:



47
48
49
 
# File 'lib/iso8601/date.rb', line 47

def +(days)
  ISO8601::Date.new((@date + days).iso8601)
end

#-(days) ⇒ ISO8601::Date

Backwards the date the given amount of days.

Parameters:

  • days (Numeric) —

    The days to remove

Returns:



56
57
58
 
# File 'lib/iso8601/date.rb', line 56

def -(days)
  ISO8601::Date.new((@date - days).iso8601)
end

#to_a ⇒ Object

Converts self to an array of atoms.



61
62
63
 
# File 'lib/iso8601/date.rb', line 61

def to_a
  [year, month, day]
end

#week ⇒ Integer

The calendar week number (1-53)

Returns:

  • (Integer) 


38
39
40
 
# File 'lib/iso8601/date.rb', line 38

def week
  @date.cweek
end