Module: Todo

Defined in:
lib/todo.rb,
lib/todo/file.rb,
lib/todo/list.rb,
lib/todo/task.rb,
lib/todo/logger.rb,
lib/todo/syntax.rb,
lib/todo/options.rb

Overview

Allows for easy management of task lists and tasks in the todo.txt format.

Defined Under Namespace

Modules: Logger, Syntax Classes: File, List, Options, Task

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.options_instanceObject

Returns the value of attribute options_instance.



13
14
15
# File 'lib/todo.rb', line 13

def options_instance
  @options_instance
end

Class Method Details

.customize {|options_instance| ... } ⇒ Object

Customize global list behaviour.

Example:

Todo.customize do |opts|
  opts.require_completed_on = false
end

Yields:



34
35
36
37
# File 'lib/todo.rb', line 34

def self.customize
  self.options_instance ||= Options.new
  yield(options_instance)
end

.optionsObject

Global access to custom options.

Example:

if Todo.options.require_completed_on
  # Do something
end


23
24
25
# File 'lib/todo.rb', line 23

def self.options
  self.options_instance ||= Options.new
end