class Week

Initialize the week with a date.

Example:

require "date"
date = Date.today
week = Week.new(date)

Return:

* [Week] The new week

# File lib/sixarm_ruby_week/week.rb, line 23
def initialize(date)
  @date = date
end

Return the week that starts today

Example:

week = Week.now

# File lib/sixarm_ruby_week/week.rb, line 55
def self.now
  Week.new(Date.today)
end

Parse date text to a week.

Example:

week = Week.parse("2015-12-31")

Return:

* [Week] A new week.

# File lib/sixarm_ruby_week/week.rb, line 69
def self.parse(date_text)
  Week.new(Date.parse(date_text))
end

Addition: week + other => week

Return a date object pointing at other weeks after self.

The other should be a numeric value.

Example:

week = Week.new(date)
week + 3 #=> three weeks later

Return:

* [Week]

# File lib/sixarm_ruby_week/week.rb, line 233
def +(other)
  if other.is_a? Numeric
    return Week.new(date + (other.to_i * 7))
  else
    raise TypeError
  end
end

Subtraction: week - other => week or integer

If the other is a numeric value, return a week object pointing other weeks before self.

If the other is a week object, then return the difference between the two weeks.

Example:

week = Week.new(date)
week - 3 => three weeks earlier

Example:

a =  Week.new(date)
b =  Week.new(date + 21)
b - a => 3

Return:

* [Week]

# File lib/sixarm_ruby_week/week.rb, line 262
def -(other)
  if other.is_a? Numeric
    return Week.new(date - (other * 7))
  elsif other.is_a? Week
    return ((self.date - other.date) / 7).round
  else
    raise TypeError
  end
end

Return week1.date < week2.date

Example:

a = Week.new(date)
b = Week.new(date - 1)
a < b #=> true

Return:

* [true,false]

# File lib/sixarm_ruby_week/week.rb, line 157
def <(other)
  self.date < other.date
end

Return week1.date <= week2.date

Example:

a = Week.new(date)
b = Week.new(date - 1)
a <= b #=> true

Return:

* [true,false]

# File lib/sixarm_ruby_week/week.rb, line 174
def <=(other)
  self.date <= other.date
end

Return week1.date <=> week2.date

a = Week.now
b = Week.now
a <=> b #=> 0

Return:

* [-1,0,1]

# File lib/sixarm_ruby_week/week.rb, line 140
def <=>(other)
 return self.date <=> other.date
end

Return week1.date == week2.date

Example:

a = Week.now
b = Week.now
a == b #=> true

Return:

* [true,false]

# File lib/sixarm_ruby_week/week.rb, line 112
def ==(other)
  self.date == other.date
end

Return week1.date > week2.date

Example:

a = Week.new(date)
b = Week.new(date + 1)
a > b #=> true

Return:

* [true,false]

# File lib/sixarm_ruby_week/week.rb, line 191
def >(other)
  self.date > other.date
end

Return week1.date >= week2.date

Example:

a = Week.new(date)
b = Week.new(date + 1)
a >= b #=> true

Return:

* [true,false]

# File lib/sixarm_ruby_week/week.rb, line 208
def >=(other)
  self.date >= other.date
end

Return the date range of the week.

This returns start_date..end_date.

Example:

week = Week.now
week.date_range => Range(2012-01-02..2012-01-08)

Return:

* [Range] start_date..stop_date

# File lib/sixarm_ruby_week/week.rb, line 375
def date_range
  start_date..stop_date
end

Return the first date of this week.

Example:

week = Week.new(date)
week.first_date #=> date

Aliases:

   week.begin_date
   week.start_date

Return:

 * [Date] week.date

# File lib/sixarm_ruby_week/week.rb, line 330
def first_date
  @date
end

Return a hash for object comparison.

This is simply the hash of the date, which means that two week objects created with the same date always compare equally.

Example:

date = Date.today
date.hash #=> 1655958911300557206
week = Week.new(date)
week.hash #=> 1655958911300557206

Return:

* [Fixnum] The week's date's object hash number.

# File lib/sixarm_ruby_week/week.rb, line 96
def hash
  date.hash
end

Does the week includes the date?

Example:

date = Date.today
week = Week.new(date)
week.include?(date + 1) => true
week.include?(date + 7) => false

Return:

* [true/false]

# File lib/sixarm_ruby_week/week.rb, line 392
def include?(date)
  (start_date..end_date).include?(date)
end

Return the last date of this week.

Return

Example:

week = Week.new(date)
week.last_date #=> date + 6

Aliases:

week.end_date
week.stop_date

Return:

* [Date] week.date + 6

# File lib/sixarm_ruby_week/week.rb, line 355
def last_date
  @date + 6
end

Return the next week, i.e. seven days later.

Example:

week =  Week.new(date)
week.next #=> seven days later.

Return:

* [Week] The next week

# File lib/sixarm_ruby_week/week.rb, line 304
def next
  return self + 1
end

Return the previous week, i.e. seven days earlier.

Example:

week =  Week.new(date)
week.previous #=> seven days earlier

Return:

* [Week] The previous week

# File lib/sixarm_ruby_week/week.rb, line 289
def previous
  return self - 1
end

Return the week's date, coverted to a string.

Example:

date = Date.parse("2015-12-31")
week = Week.new(date)
week.to_s #=> "2015-12-31"

Return:

* [String] The week's date, coverted to a string.

# File lib/sixarm_ruby_week/week.rb, line 39
def to_s
  @date.to_s
end