Module: Doing::ItemDates

Included in:

Item

Defined in:

lib/doing/item/dates.rb

Instance Method Summary

• #calculate_end_date(opt) ⇒ Object
• #duration ⇒ Object

  If the entry doesn't have a @done date, return the elapsed time.

• #end_date ⇒ Time

  Get the value of the item's @done tag.

• #expand_date_tags(additional_tags = nil) ⇒ Object

  Updates the title of the Item by expanding natural language dates within configured date tags (tags whose value is expected to be a date).

• #interval ⇒ Object

  Get the difference between the item's start date and the value of its @done tag (if present).

• #overlapping_time?(item_b) ⇒ Boolean

  Test if the interval between start date and @done value overlaps with another item's.

• #same_time?(item_b) ⇒ Boolean

  Test if two items occur at the same time (same start date and equal duration).

Instance Method Details

#calculate_end_date(opt) ⇒ Object

#duration ⇒ Object

If the entry doesn't have a @done date, return the elapsed time

#end_date ⇒ Time

Get the value of the item's @done tag

Returns:

• (Time) —

  @done value

#expand_date_tags(additional_tags = nil) ⇒ Object

Updates the title of the Item by expanding natural language dates within configured date tags (tags whose value is expected to be a date)

Parameters:

• additional_tags (defaults to: nil) —

  An array of additional tag names to consider dates

#interval ⇒ Object

Get the difference between the item's start date and the value of its @done tag (if present)

Returns:

• Interval in seconds

#overlapping_time?(item_b) ⇒ Boolean

Test if the interval between start date and @done value overlaps with another item's

Parameters:

• item_b (Item) —

  The item to compare

Returns:

• (Boolean) —

  overlaps?

#same_time?(item_b) ⇒ Boolean

Test if two items occur at the same time (same start date and equal duration)

Parameters:

• item_b (Item) —

  The item to compare

Returns:

• (Boolean) —

  is equal?