Class: Doing::Note

Inherits:

Array

• Object
• Array
• Doing::Note

Defined in:

lib/doing/note.rb

Overview

This class describes an item note.

Instance Method Summary

• #add(note, replace: false) ⇒ Object

  Add note contents, optionally replacing existing note.

• #compress ⇒ Array

  Remove blank lines and comments (#).

• #compress! ⇒ Object
• #equal?(other) ⇒ Boolean

  Test if a note is equal (compare string representations).

• #initialize(note = []) ⇒ Note constructor

  Initializes a new note.

• #strip_lines ⇒ Array

  Remove leading/trailing whitespace for every line of note.

• #strip_lines! ⇒ Object
• #to_line(separator: ' ') ⇒ String

  Returns note as a single line, newlines separated by space.

• #to_s(prefix: "\t\t") ⇒ Object

  Note as multi-line string.

Methods inherited from Array

#cap_first, #good?, #utf8

Methods included from ChronifyArray

#time_string, #to_abbr, #to_natural, #to_years

Constructor Details

#initialize(note = []) ⇒ Note

Initializes a new note

Parameters:

• note (Array) (defaults to: []) —

  Initial note, can be string or array

Instance Method Details

#add(note, replace: false) ⇒ Object

Add note contents, optionally replacing existing note

Parameters:

• note (Array|String|Note) —

  The note to add, can be String, Array, or Note

• replace (Boolean) (defaults to: false) —

  replace existing content

#compress ⇒ Array

Remove blank lines and comments (#)

Returns:

• (Array) —

  compressed array

#compress! ⇒ Object

#equal?(other) ⇒ Boolean

Test if a note is equal (compare string representations)

Parameters:

• other (Note) —

  The other Note

Returns:

• (Boolean) —

  true if equal

#strip_lines ⇒ Array

Remove leading/trailing whitespace for every line of note

Returns:

• (Array) —

  Stripped note

#strip_lines! ⇒ Object

#to_line(separator: ' ') ⇒ String

Returns note as a single line, newlines separated by space

Parameters:

• separator (defaults to: ' ') —

  The separator with which to join multiple lines

Returns:

• (String) —

  Line representation of the Note.

#to_s(prefix: "\t\t") ⇒ Object

Note as multi-line string

Parameters:

• prefix (String) (defaults to: "\t\t") —

  prefix for each line (default two tabs, TaskPaper format)