Executable TODO Items

Many developers use #TODO comments, many IDEs specially highlights them, there is a Rake task to extract TODOs from source.

This rather simple program collects encountered TODOs during software execution and reminds of them after program termination.
TODOs are embedded into source in any place where 'puts' can be used (e.g. inside a method, before a method or class definition) as call to todo(string) function.

After program execution, number of encountered TODOs is printed, as well as first and last TODOs. This can be convenient after developing the skeleton of a program.

File name and line number are automatically added to TODO-message, so that IDE like NetBeans can jump to the line from the output window.

Installation

1. Copy todoexe.rb to your project folder (or any folder accessible for 'require')
2. require 'todoexe' in your source file(s)
3. Write "todo 'to do something'" where necessary
4. Run your program, you will see 'TODO' report when it terminates

Example usage

File: welcome_todoexe.rb

require 'todoexe'

todo 'benchmark Set vs Array for small number of items'
class SomeClass
  @data = Array.new


  todo 'implement edit()'
  def edit
  end

  
  def insert
  #
  # some implementation here
  #
  end

  
  todo 'add bulk insert functionality'
  
end