Module: TimeBoss::Calendar::Support::Shiftable

Included in:

Unit

Defined in:

lib/timeboss/calendar/support/shiftable.rb

Instance Method Summary

• #days_ago ⇒ Calendar::Day^?

  Get the index-relative day some number of days ago.

• #days_ahead ⇒ Calendar::Day^?

  Get the index-relative day some number of days ahead.

• #halves_ago ⇒ Calendar::Half^?

  Get the index-relative half some number of halves ago.

• #halves_ahead ⇒ Calendar::Half^?

  Get the index-relative half some number of halves ahead.

• #in_day ⇒ Integer^?

  Get the index within the day that this unit falls in.

• #in_half ⇒ Integer^?

  Get the index within the half that this unit falls in.

• #in_month ⇒ Integer^?

  Get the index within the month that this unit falls in.

• #in_quarter ⇒ Integer^?

  Get the index within the quarter that this unit falls in.

• #in_week ⇒ Integer^?

  Get the index within the week that this unit falls in.

• #in_year ⇒ Integer^?

  Get the index within the year that this unit falls in.

• #last_day ⇒ Calendar::Day^? (also: #yesterday)

  Get the index-relative day 1 day ago.

• #last_half ⇒ Calendar::Half^?

  Get the index-relative half 1 half ago.

• #last_month ⇒ Calendar::Month^?

  Get the index-relative month 1 month ago.

• #last_quarter ⇒ Calendar::Quarter^?

  Get the index-relative quarter 1 quarter ago.

• #last_week ⇒ Calendar::Week^?

  Get the index-relative week 1 week ago.

• #last_year ⇒ Calendar::Year^?

  Get the index-relative year 1 year ago.

• #months_ago ⇒ Calendar::Month^?

  Get the index-relative month some number of months ago.

• #months_ahead ⇒ Calendar::Month^?

  Get the index-relative month some number of months ahead.

• #next_day ⇒ Calendar::Day^? (also: #tomorrow)

  Get the index-relative day 1 day forward.

• #next_half ⇒ Calendar::Half^?

  Get the index-relative half 1 half forward.

• #next_month ⇒ Calendar::Month^?

  Get the index-relative month 1 month forward.

• #next_quarter ⇒ Calendar::Quarter^?

  Get the index-relative quarter 1 quarter forward.

• #next_week ⇒ Calendar::Week^?

  Get the index-relative week 1 week forward.

• #next_year ⇒ Calendar::Year^?

  Get the index-relative year 1 year forward.

• #quarters_ago ⇒ Calendar::Quarter^?

  Get the index-relative quarter some number of quarters ago.

• #quarters_ahead ⇒ Calendar::Quarter^?

  Get the index-relative quarter some number of quarters ahead.

• #this_day ⇒ Calendar::Day^? (also: #today)

  Get the index-relative day for this day.

• #this_half ⇒ Calendar::Half^?

  Get the index-relative half for this half.

• #this_month ⇒ Calendar::Month^?

  Get the index-relative month for this month.

• #this_quarter ⇒ Calendar::Quarter^?

  Get the index-relative quarter for this quarter.

• #this_week ⇒ Calendar::Week^?

  Get the index-relative week for this week.

• #this_year ⇒ Calendar::Year^?

  Get the index-relative year for this year.

• #weeks_ago ⇒ Calendar::Week^?

  Get the index-relative week some number of weeks ago.

• #weeks_ahead ⇒ Calendar::Week^?

  Get the index-relative week some number of weeks ahead.

• #years_ago ⇒ Calendar::Year^?

  Get the index-relative year some number of years ago.

• #years_ahead ⇒ Calendar::Year^?

  Get the index-relative year some number of years ahead.

Instance Method Details

#days_ago ⇒ Calendar::Day^?

Get the index-relative day some number of days ago. Returns nil if no single day can be identified.

Parameters:

• offset (Integer) —

  the number of days back to shift this period

Returns:

• (Calendar::Day, nil)

# File 'lib/timeboss/calendar/support/shiftable.rb', line 43

#days_ahead ⇒ Calendar::Day^?

Get the index-relative day some number of days ahead. Returns nil if no single day can be identified.

Parameters:

• offset (Integer) —

  the number of days forward to shift this period

Returns:

• (Calendar::Day, nil)

# File 'lib/timeboss/calendar/support/shiftable.rb', line 49

#halves_ago ⇒ Calendar::Half^?

Get the index-relative half some number of halves ago. Returns nil if no single half can be identified.

Parameters:

• offset (Integer) —

  the number of halves back to shift this period

Returns:

• (Calendar::Half, nil)

# File 'lib/timeboss/calendar/support/shiftable.rb', line 179

#halves_ahead ⇒ Calendar::Half^?

Get the index-relative half some number of halves ahead. Returns nil if no single half can be identified.

Parameters:

• offset (Integer) —

  the number of halves forward to shift this period

Returns:

• (Calendar::Half, nil)

# File 'lib/timeboss/calendar/support/shiftable.rb', line 185

#in_day ⇒ Integer^?

Get the index within the day that this unit falls in. Returns nil if no single day can be identified.

Returns:

• (Integer, nil)

# File 'lib/timeboss/calendar/support/shiftable.rb', line 38

#in_half ⇒ Integer^?

Get the index within the half that this unit falls in. Returns nil if no single half can be identified.

Returns:

• (Integer, nil)

# File 'lib/timeboss/calendar/support/shiftable.rb', line 174

#in_month ⇒ Integer^?

Get the index within the month that this unit falls in. Returns nil if no single month can be identified.

Returns:

• (Integer, nil)

# File 'lib/timeboss/calendar/support/shiftable.rb', line 106

#in_quarter ⇒ Integer^?

Get the index within the quarter that this unit falls in. Returns nil if no single quarter can be identified.

Returns:

• (Integer, nil)

# File 'lib/timeboss/calendar/support/shiftable.rb', line 140

#in_week ⇒ Integer^?

Get the index within the week that this unit falls in. Returns nil if no single week can be identified.

Returns:

• (Integer, nil)

# File 'lib/timeboss/calendar/support/shiftable.rb', line 72

#in_year ⇒ Integer^?

Get the index within the year that this unit falls in. Returns nil if no single year can be identified.

Returns:

• (Integer, nil)

# File 'lib/timeboss/calendar/support/shiftable.rb', line 208

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

Get the index-relative day 1 day ago. Returns nil if no single day can be identified.

Returns:

• (Calendar::Day, nil)

# File 'lib/timeboss/calendar/support/shiftable.rb', line 55

#last_half ⇒ Calendar::Half^?

Get the index-relative half 1 half ago. Returns nil if no single half can be identified.

Returns:

• (Calendar::Half, nil)

# File 'lib/timeboss/calendar/support/shiftable.rb', line 191

#last_month ⇒ Calendar::Month^?

Get the index-relative month 1 month ago. Returns nil if no single month can be identified.

Returns:

• (Calendar::Month, nil)

# File 'lib/timeboss/calendar/support/shiftable.rb', line 123

#last_quarter ⇒ Calendar::Quarter^?

Get the index-relative quarter 1 quarter ago. Returns nil if no single quarter can be identified.

Returns:

• (Calendar::Quarter, nil)

# File 'lib/timeboss/calendar/support/shiftable.rb', line 157

#last_week ⇒ Calendar::Week^?

Get the index-relative week 1 week ago. Returns nil if no single week can be identified.

Returns:

• (Calendar::Week, nil)

# File 'lib/timeboss/calendar/support/shiftable.rb', line 89

#last_year ⇒ Calendar::Year^?

Get the index-relative year 1 year ago. Returns nil if no single year can be identified.

Returns:

• (Calendar::Year, nil)

# File 'lib/timeboss/calendar/support/shiftable.rb', line 225

#months_ago ⇒ Calendar::Month^?

Get the index-relative month some number of months ago. Returns nil if no single month can be identified.

Parameters:

• offset (Integer) —

  the number of months back to shift this period

Returns:

• (Calendar::Month, nil)

# File 'lib/timeboss/calendar/support/shiftable.rb', line 111

#months_ahead ⇒ Calendar::Month^?

Get the index-relative month some number of months ahead. Returns nil if no single month can be identified.

Parameters:

• offset (Integer) —

  the number of months forward to shift this period

Returns:

• (Calendar::Month, nil)

# File 'lib/timeboss/calendar/support/shiftable.rb', line 117

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

Get the index-relative day 1 day forward. Returns nil if no single day can be identified.

Returns:

• (Calendar::Day, nil)

# File 'lib/timeboss/calendar/support/shiftable.rb', line 65

#next_half ⇒ Calendar::Half^?

Get the index-relative half 1 half forward. Returns nil if no single half can be identified.

Returns:

• (Calendar::Half, nil)

# File 'lib/timeboss/calendar/support/shiftable.rb', line 201

#next_month ⇒ Calendar::Month^?

Get the index-relative month 1 month forward. Returns nil if no single month can be identified.

Returns:

• (Calendar::Month, nil)

# File 'lib/timeboss/calendar/support/shiftable.rb', line 133

#next_quarter ⇒ Calendar::Quarter^?

Get the index-relative quarter 1 quarter forward. Returns nil if no single quarter can be identified.

Returns:

• (Calendar::Quarter, nil)

# File 'lib/timeboss/calendar/support/shiftable.rb', line 167

#next_week ⇒ Calendar::Week^?

Get the index-relative week 1 week forward. Returns nil if no single week can be identified.

Returns:

• (Calendar::Week, nil)

# File 'lib/timeboss/calendar/support/shiftable.rb', line 99

#next_year ⇒ Calendar::Year^?

Get the index-relative year 1 year forward. Returns nil if no single year can be identified.

Returns:

• (Calendar::Year, nil)

# File 'lib/timeboss/calendar/support/shiftable.rb', line 235

#quarters_ago ⇒ Calendar::Quarter^?

Get the index-relative quarter some number of quarters ago. Returns nil if no single quarter can be identified.

Parameters:

• offset (Integer) —

  the number of quarters back to shift this period

Returns:

• (Calendar::Quarter, nil)

# File 'lib/timeboss/calendar/support/shiftable.rb', line 145

#quarters_ahead ⇒ Calendar::Quarter^?

Get the index-relative quarter some number of quarters ahead. Returns nil if no single quarter can be identified.

Parameters:

• offset (Integer) —

  the number of quarters forward to shift this period

Returns:

• (Calendar::Quarter, nil)

# File 'lib/timeboss/calendar/support/shiftable.rb', line 151

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

Get the index-relative day for this day. Returns nil if no single day can be identified.

Returns:

• (Calendar::Day, nil)

# File 'lib/timeboss/calendar/support/shiftable.rb', line 60

#this_half ⇒ Calendar::Half^?

Get the index-relative half for this half. Returns nil if no single half can be identified.

Returns:

• (Calendar::Half, nil)

# File 'lib/timeboss/calendar/support/shiftable.rb', line 196

#this_month ⇒ Calendar::Month^?

Get the index-relative month for this month. Returns nil if no single month can be identified.

Returns:

• (Calendar::Month, nil)

# File 'lib/timeboss/calendar/support/shiftable.rb', line 128

#this_quarter ⇒ Calendar::Quarter^?

Get the index-relative quarter for this quarter. Returns nil if no single quarter can be identified.

Returns:

• (Calendar::Quarter, nil)

# File 'lib/timeboss/calendar/support/shiftable.rb', line 162

#this_week ⇒ Calendar::Week^?

Get the index-relative week for this week. Returns nil if no single week can be identified.

Returns:

• (Calendar::Week, nil)

# File 'lib/timeboss/calendar/support/shiftable.rb', line 94

#this_year ⇒ Calendar::Year^?

Get the index-relative year for this year. Returns nil if no single year can be identified.

Returns:

• (Calendar::Year, nil)

# File 'lib/timeboss/calendar/support/shiftable.rb', line 230

#weeks_ago ⇒ Calendar::Week^?

Get the index-relative week some number of weeks ago. Returns nil if no single week can be identified.

Parameters:

• offset (Integer) —

  the number of weeks back to shift this period

Returns:

• (Calendar::Week, nil)

# File 'lib/timeboss/calendar/support/shiftable.rb', line 77

#weeks_ahead ⇒ Calendar::Week^?

Get the index-relative week some number of weeks ahead. Returns nil if no single week can be identified.

Parameters:

• offset (Integer) —

  the number of weeks forward to shift this period

Returns:

• (Calendar::Week, nil)

# File 'lib/timeboss/calendar/support/shiftable.rb', line 83

#years_ago ⇒ Calendar::Year^?

Get the index-relative year some number of years ago. Returns nil if no single year can be identified.

Parameters:

• offset (Integer) —

  the number of years back to shift this period

Returns:

• (Calendar::Year, nil)

# File 'lib/timeboss/calendar/support/shiftable.rb', line 213

#years_ahead ⇒ Calendar::Year^?

Get the index-relative year some number of years ahead. Returns nil if no single year can be identified.

Parameters:

• offset (Integer) —

  the number of years forward to shift this period

Returns:

• (Calendar::Year, nil)

# File 'lib/timeboss/calendar/support/shiftable.rb', line 219