Module: TimeBoss::Calendar::Waypoints::Relative

Included in:
TimeBoss::Calendar::Waypoints
Defined in:
lib/timeboss/calendar/waypoints/relative.rb

Instance Method Summary collapse

Instance Method Details

#days_ago ⇒ Calendar::Day

Get the day that occurred the specified number of days ago.

Parameters:

  • quantity (Integer) —

    the number of days before today

Returns:




# File 'lib/timeboss/calendar/waypoints/relative.rb', line 56

#days_ahead ⇒ Calendar::Day

Get the day that occurred the specified number of days ahead.

Parameters:

  • quantity (Integer) —

    the number of days after today

Returns:




# File 'lib/timeboss/calendar/waypoints/relative.rb', line 66

#days_back ⇒ Array<Calendar::Day>

Get a quantity of days back from today.

Parameters:

  • quantity (Integer) —

    the number of days requested

Returns:




# File 'lib/timeboss/calendar/waypoints/relative.rb', line 51

#days_for ⇒ Array<Calendar::Day>

Get a list of days within the specified period unit.

Parameters:

Returns:




# File 'lib/timeboss/calendar/waypoints/relative.rb', line 46

#days_forward ⇒ Array<Calendar::Day>

Get a quantity of days forward from today.

Parameters:

  • quantity (Integer) —

    the number of days requested

Returns:




# File 'lib/timeboss/calendar/waypoints/relative.rb', line 61

#halves_ago ⇒ Calendar::Half

Get the half that occurred the specified number of halves ago.

Parameters:

  • quantity (Integer) —

    the number of halves before this half

Returns:




# File 'lib/timeboss/calendar/waypoints/relative.rb', line 212

#halves_ahead ⇒ Calendar::Half

Get the half that occurred the specified number of halves ahead.

Parameters:

  • quantity (Integer) —

    the number of halves after this half

Returns:




# File 'lib/timeboss/calendar/waypoints/relative.rb', line 222

#halves_back ⇒ Array<Calendar::Half>

Get a quantity of halves back from this half.

Parameters:

  • quantity (Integer) —

    the number of halves requested

Returns:




# File 'lib/timeboss/calendar/waypoints/relative.rb', line 207

#halves_for ⇒ Array<Calendar::Half>

Get a list of halves within the specified period unit.

Parameters:

Returns:




# File 'lib/timeboss/calendar/waypoints/relative.rb', line 202

#halves_forward ⇒ Array<Calendar::Half>

Get a quantity of halves forward from this half.

Parameters:

  • quantity (Integer) —

    the number of halves requested

Returns:




# File 'lib/timeboss/calendar/waypoints/relative.rb', line 217

#last_day ⇒ Calendar::Day Also known as: yesterday

Get the previous day within the active calendar.

Returns:




# File 'lib/timeboss/calendar/waypoints/relative.rb', line 38

#last_half ⇒ Calendar::Half

Get the previous half within the active calendar.

Returns:




# File 'lib/timeboss/calendar/waypoints/relative.rb', line 194

#last_month ⇒ Calendar::Month

Get the previous month within the active calendar.

Returns:




# File 'lib/timeboss/calendar/waypoints/relative.rb', line 116

#last_quarter ⇒ Calendar::Quarter

Get the previous quarter within the active calendar.

Returns:




# File 'lib/timeboss/calendar/waypoints/relative.rb', line 155

#last_week ⇒ Calendar::Week

Get the previous week within the active calendar.

Returns:




# File 'lib/timeboss/calendar/waypoints/relative.rb', line 77

#last_year ⇒ Calendar::Year

Get the previous year within the active calendar.

Returns:




# File 'lib/timeboss/calendar/waypoints/relative.rb', line 233

#months_ago ⇒ Calendar::Month

Get the month that occurred the specified number of months ago.

Parameters:

  • quantity (Integer) —

    the number of months before this month

Returns:




# File 'lib/timeboss/calendar/waypoints/relative.rb', line 134

#months_ahead ⇒ Calendar::Month

Get the month that occurred the specified number of months ahead.

Parameters:

  • quantity (Integer) —

    the number of months after this month

Returns:




# File 'lib/timeboss/calendar/waypoints/relative.rb', line 144

#months_back ⇒ Array<Calendar::Month>

Get a quantity of months back from this month.

Parameters:

  • quantity (Integer) —

    the number of months requested

Returns:




# File 'lib/timeboss/calendar/waypoints/relative.rb', line 129

#months_for ⇒ Array<Calendar::Month>

Get a list of months within the specified period unit.

Parameters:

Returns:




# File 'lib/timeboss/calendar/waypoints/relative.rb', line 124

#months_forward ⇒ Array<Calendar::Month>

Get a quantity of months forward from this month.

Parameters:

  • quantity (Integer) —

    the number of months requested

Returns:




# File 'lib/timeboss/calendar/waypoints/relative.rb', line 139

#next_day ⇒ Calendar::Day Also known as: tomorrow

Get the next day within the active calendar.

Returns:




# File 'lib/timeboss/calendar/waypoints/relative.rb', line 42

#next_half ⇒ Calendar::Half

Get the next half within the active calendar.

Returns:




# File 'lib/timeboss/calendar/waypoints/relative.rb', line 198

#next_month ⇒ Calendar::Month

Get the next month within the active calendar.

Returns:




# File 'lib/timeboss/calendar/waypoints/relative.rb', line 120

#next_quarter ⇒ Calendar::Quarter

Get the next quarter within the active calendar.

Returns:




# File 'lib/timeboss/calendar/waypoints/relative.rb', line 159

#next_week ⇒ Calendar::Week

Get the next week within the active calendar.

Returns:




# File 'lib/timeboss/calendar/waypoints/relative.rb', line 81

#next_year ⇒ Calendar::Year

Get the next year within the active calendar.

Returns:




# File 'lib/timeboss/calendar/waypoints/relative.rb', line 237

#quarters_ago ⇒ Calendar::Quarter

Get the quarter that occurred the specified number of quarters ago.

Parameters:

  • quantity (Integer) —

    the number of quarters before this quarter

Returns:




# File 'lib/timeboss/calendar/waypoints/relative.rb', line 173

#quarters_ahead ⇒ Calendar::Quarter

Get the quarter that occurred the specified number of days ahead.

Parameters:

  • quantity (Integer) —

    the number of quarters after this quarter

Returns:




# File 'lib/timeboss/calendar/waypoints/relative.rb', line 183

#quarters_back ⇒ Array<Calendar::Quarter>

Get a quantity of quarters back from this quarter.

Parameters:

  • quantity (Integer) —

    the number of quarters requested

Returns:




# File 'lib/timeboss/calendar/waypoints/relative.rb', line 168

#quarters_for ⇒ Array<Calendar::Quarter>

Get a list of quarters within the specified period unit.

Parameters:

Returns:




# File 'lib/timeboss/calendar/waypoints/relative.rb', line 163

#quarters_forward ⇒ Array<Calendar::Quarter>

Get a quantity of quarters forward from this quarter.

Parameters:

  • quantity (Integer) —

    the number of quarters requested

Returns:




# File 'lib/timeboss/calendar/waypoints/relative.rb', line 178

#this_day ⇒ Calendar::Day Also known as: today

Get the current day within the active calendar.

Returns:




# File 'lib/timeboss/calendar/waypoints/relative.rb', line 34

#this_half ⇒ Calendar::Half

Get the current half within the active calendar.

Returns:




# File 'lib/timeboss/calendar/waypoints/relative.rb', line 190

#this_month ⇒ Calendar::Month

Get the current month within the active calendar.

Returns:




# File 'lib/timeboss/calendar/waypoints/relative.rb', line 112

#this_quarter ⇒ Calendar::Quarter

Get the current quarter within the active calendar.

Returns:




# File 'lib/timeboss/calendar/waypoints/relative.rb', line 151

#this_week ⇒ Calendar::Week

Get the current week within the active calendar.

Returns:




# File 'lib/timeboss/calendar/waypoints/relative.rb', line 73

#this_year ⇒ Calendar::Year

Get the current year within the active calendar.

Returns:




# File 'lib/timeboss/calendar/waypoints/relative.rb', line 229

#weeks_ago ⇒ Calendar::Week

Get the week that occurred the specified number of weeks ago.

Parameters:

  • quantity (Integer) —

    the number of weeks before this week

Returns:




# File 'lib/timeboss/calendar/waypoints/relative.rb', line 95

#weeks_ahead ⇒ Calendar::Week

Get the week that occurred the specified number of weeks ahead.

Parameters:

  • quantity (Integer) —

    the number of weeks after this week

Returns:




# File 'lib/timeboss/calendar/waypoints/relative.rb', line 105

#weeks_back ⇒ Array<Calendar::Week>

Get a quantity of weeks back from this week.

Parameters:

  • quantity (Integer) —

    the number of weeks requested

Returns:




# File 'lib/timeboss/calendar/waypoints/relative.rb', line 90

#weeks_for ⇒ Array<Calendar::Week>

Get a list of weeks within the specified period unit.

Parameters:

Returns:




# File 'lib/timeboss/calendar/waypoints/relative.rb', line 85

#weeks_forward ⇒ Array<Calendar::Week>

Get a quantity of weeks forward from this week.

Parameters:

  • quantity (Integer) —

    the number of weeks requested

Returns:




# File 'lib/timeboss/calendar/waypoints/relative.rb', line 100

#years_ago ⇒ Calendar::Year

Get the year that occurred the specified number of years ago.

Parameters:

  • quantity (Integer) —

    the number of years before this year

Returns:




# File 'lib/timeboss/calendar/waypoints/relative.rb', line 251

#years_ahead ⇒ Calendar::Year

Get the year that occurred the specified number of years ahead.

Parameters:

  • quantity (Integer) —

    the number of years after this year

Returns:




# File 'lib/timeboss/calendar/waypoints/relative.rb', line 261

#years_back ⇒ Array<Calendar::Year>

Get a quantity of years back from this year.

Parameters:

  • quantity (Integer) —

    the number of years requested

Returns:




# File 'lib/timeboss/calendar/waypoints/relative.rb', line 246

#years_for ⇒ Array<Calendar::Year>

Get a list of years within the specified period unit.

Parameters:

Returns:




# File 'lib/timeboss/calendar/waypoints/relative.rb', line 241

#years_forward ⇒ Array<Calendar::Year>

Get a quantity of years forward from this year.

Parameters:

  • quantity (Integer) —

    the number of years requested

Returns:




# File 'lib/timeboss/calendar/waypoints/relative.rb', line 256