todonotes 0.1.0 → 0.1.1

data/examples/todonotes_how_to.rb

@@ -1,38 +1,58 @@
+=begin rdoc
+Examples of the different syntax version of the fixme/and todo-command.
+=end
 $:.unshift('../lib')
 require 'todonotes'
 
+#a ToDo with default text 'ToDo' and without temporary result
 to do 
-  "mein Ergebnis"
+  "my temporary result"
 end
 
-todo "mein Text"
+#a ToDo without temporary result
+todo "my description of the missing code"
 
-todo { "mein Ergebnis" }
+#a ToDo without description, but a temporary result
+todo { "my temporary result" }
 
-todo ('mein Text' ) { "mein Ergebnis" }
+#a ToDo with description and temporary result
+todo ('my description of the missing code' ) { "my temporary result" }
 
+
+#a ToDo without description, but a temporary result
 todo do
-  "mein Ergebnis"
+  "my temporary result"
 end
 
+#a ToDo with description and temporary result
 todo 'Text' do
-  "mein Ergebnis"
+  "my temporary result"
 end
 
 ####################
-2.times { fixme "mein Text" }
 
-fixme { "mein Ergebnis" }
+#a FixMe without description, but a temporary result
+fixme { "my temporary result" }
 
-fixme ('mein Text' ) { "mein Ergebnis" }
+#a FixMe with description and temporary result
+fixme ('my description if the wrong code' ) { "my temporary result" }
 
+#a FixMe without description, but a temporary result
 fixme do
-  "mein Ergebnis"
+  "my temporary result"
 end
 
-fixme 'Text' do
-  "mein Ergebnis"
+#a FixMe with description and temporary result
+fixme 'my description if the wrong code' do
+  "my temporary result"
 end
+####################
+#a Fixme is called twice
+2.times { fixme "my description of the missing code" }
+#a ToDo is called three times
+3.times { todo  "my description of the missing code" }
+
 ####################
 
+#Get an overview of all ToDos and FixMes
 Todonotes.print_stats

data/examples/todonotes_prim.rb

@@ -1,13 +1,22 @@
+=begin rdoc
+=Example of usage fixme/todo 
+Write a script to count all prime between 1 to 10.
+
+For each number, write a message like
+  x is [a|no] prime number
+
+Until you know, how to determine, if a number is a prime,
+you can take the temporary algorithm: each odd number is a prime.
+=end
 $:.unshift('../lib')
 require 'todonotes'
 
 #
-#
-Todonotes.instance.logger.level = Log4r::WARN #only first time of callinf a fixme/todo
-Todonotes.instance.logger.level = Log4r::INFO   #report all calls of fixme/todo
+Todonotes.logger.level = Log4r::WARN #only first time of callinf a fixme/todo
+#~ Todonotes.logger.level = Log4r::INFO   #report all calls of fixme/todo
 
 primecount = 0
-for i in 1..10
+10.times do|i|
         if fixme "Calculate if prime" do 
               i.odd?  #tempory: odd = prim
             end
@@ -21,5 +30,5 @@ end
 todo "Return total number of primes"
 
 #Details
-Todonotes.print_stats()
+puts Todonotes.print_stats()
 

data/examples/todonotes_prim2.rb

@@ -1,12 +1,23 @@
+=begin rdoc
+=Example of usage fixme/todo 
+Write a script to count all prime between 1 to 10.
+
+For each number, write a message like
+  x is [a|no] prime number
+
+Until you know, how to determine, if a number is a prime,
+you can take the temporary algorithm: each odd number is a prime.
+=end
 $:.unshift('../lib')
 require 'todonotes'
 
 #
-#
-Todonotes.instance.logger.level = Log4r::WARN #only first time of callinf a fixme/todo
-Todonotes.instance.logger.level = Log4r::INFO   #report all calls of fixme/todo
+Todonotes.logger.level = Log4r::WARN #only first time of callinf a fixme/todo
+Todonotes.logger.level = Log4r::INFO   #report all calls of fixme/todo
 
 class Fixnum
+  #Decide if Fixnum is a prime.
+  #This method is only a temporarysolution.
   def prime?
       fixme "Calculate if prime" do 
               self.odd?  #tempory: odd = prim
@@ -15,7 +26,7 @@ class Fixnum
 end
 
 primecount = 0
-for i in 1..10
+10.times do|i|
         if i.prime?
           primecount += 1 
           puts "#{i} is a prime number"
@@ -27,6 +38,6 @@ end
 todo "Return total number of primes"
 
 #Details
-Todonotes.print_stats()
+puts Todonotes.print_stats()
 
 

data/lib/todonotes.rb

@@ -26,186 +26,75 @@ Gem based on a proposal in http://forum.ruby-portal.de/viewtopic.php?f=11&t=1195
 require 'singleton'
 require 'log4r'
 
-=begin rdoc
-Define a formatter.
-=end
-class Log4r::FixmeFormatter < Log4r::BasicFormatter
-=begin rdoc
-If event is an Array, the output is adapted.
-
-This outputter is only for internal use via Todonotes.
-=end
-    def format(event)
-      #@@basicformat      "%*s %s"
-      #~ buff = sprintf("%-*s %-5s", Log4r::MaxLevelLength, Log4r::LNAMES[event.level],
-             #~ event.data.is_a?(Array) ? event.data.first : event.name)
-      buff = "%-5s" % (event.data.is_a?(Array) ? event.data.first : event.name)
-      #~ buff += (event.tracer.nil? ? "" : "(#{event.tracer[2]})") + ": "
-      buff << ": "
-      buff << format_object(event.data.is_a?(Array) ? event.data.last : event.data) 
-      buff << (event.tracer.nil? ? "" : " (#{event.tracer.join('/')})")
-      buff << "\n"
-      buff
-    end
-end
+require_relative 'todonotes/todonotes'
+require_relative 'todonotes/todo'
+require_relative 'todonotes/log4r'
+require_relative 'todonotes/kernel'
 
 =begin rdoc
-Singleton definition for a fixme.
+Module Todonotes.
 
-You can use Fixme#instance to set some global settings:
-* FiXme#log2file Define log file
-* FiXme#logger adapt level, outputter ...
-* FiXme#codeline get Hash with counter per ToDo-locations.
-* FiXme#overview get overview text with ToDo-locations.
+Encapsuate:
+* Todonotes::Todonotes (Singleton)
+* Todonotes::FixmeFormatter
 =end
-class Todonotes
-  VERSION = '0.1.0'
-  include Singleton
+module Todonotes
+  VERSION = '0.1.1'
+  #'singleton'-instance of Todonotes
+  TODONOTES = Todonotes.new()
 =begin rdoc
-Define the singleton-instance.
-=end
-  def initialize()
-    # @codeline is a Hash with Filename and codeline (key). Value is the number of calls.
-    @codeline = Hash.new(0)
-    @logger = Log4r::Logger.new('ToDo')
-    @logger.outputters = Log4r::StdoutOutputter.new('ToDo', 
-                                    :level => Log4r::ALL,
-                                    :formatter => Log4r::FixmeFormatter 
-                                  )
-    #~ @logger.trace = true
-  end
-  #Get logger to define alternative outputters...
-  attr_reader :logger
-=begin rdoc
-Write the todo's in a logging file.
-
-Default filename is $0.todo
+Define module-methods
 =end
-  def log2file(filename = File.basename($0) + '.todo', level = Log4r::ALL)
-    @logger.add( Log4r::FileOutputter.new('ToDo', 
-                                    :filename => filename,
-                                    :level => level,
-                                    :formatter => Log4r::FixmeFormatter 
-                                  ))
+  class << self
     
-  end
-  #Direct access to the codeline list. See also #todo_overview
-  attr_reader :codeline
 =begin rdoc
-Report a FixMe or a ToDo.
-
-The comment is logged, 
-the block is evaluated to get a temporary result.
+See Todonotes::Todonotes#overview
 =end
-  def todo( comment, type = :ToDo, &block)
-    res = nil
-    key = caller[1].split(':in').first
-    if block_given?
-      res = yield self
-      res
+    def print_stats( with_type = false )
+      TODONOTES.overview( with_type )
     end
-    log_todo(key, type, comment, res)
-    #~ @logger.debug("Return #{res.inspect} instead") if @logger.debug?
-    res
-  end
 =begin rdoc
-Report the ToDo/FixMe and count occurence.
-
-The first occurence is reported as a warning, 
-next occurences are informations.
+See Todonotes::Todonotes#overview
 =end
-  def log_todo( key, type, text, res )
-
-    @codeline[key] += 1
-    if @codeline[key] == 1 #First occurence?
-      @logger.warn([type, "#{key} #{text} (temporary: #{res.inspect})"])
-    else  #Erste auftauchen
-      @logger.info([type, "#{key}(#{@codeline[key]}) #{text} (temporary: #{res.inspect})"])
+    def overview(*settings )
+      TODONOTES.overview( *settings )
     end
-    
-  end
-  
 =begin rdoc
-Return a text to be printed
-  puts Todonotes.instance.todo_overview()
-Used from Todonotes.print_stats
-
-Example:
-  List of ToDos/FixMes:
-  fixme.rb:195:    1 call
-  fixme.rb:198:    2 calls
-  fixme.rb:199:    1 call
-  fixme.rb:200:    1 call
+See Todonotes::Todonotes#codelines
 =end
-  def overview( )
-    txt = []
-    txt << "List of ToDos/FixMes:"
-    @codeline.each do |key, messages|
-      txt << "%s: %4i call%s" % [ key, messages, messages > 1 ? 's': ''  ]
+    def codelines()
+      TODONOTES.codelines()
     end
-    txt.join("\n")
-  end
-
-=begin rdoc
-Class methods
-=end
-  class << self
 =begin rdoc
-See Todonotes#overview
+See Todonotes::Todonotes#logger
 =end
-    def print_stats()
-      puts Todonotes.instance.overview()
+    def logger()
+      TODONOTES.logger()
     end
-  end #<< self
-end
-
-=begin rdoc
-Define todo-commands to global usage.
-=end
-module Kernel
 =begin rdoc
-Usage 1 (only message):
-  todo "my todo-message""
-
-Usage 2 (only temporary result):
-  todo { "temporary result" }
-  todo do
-    "temporary result"
-  end
-
-Usage 3(message and temporary result):
-  todo ('message') { "temporary  result" }
-  todo ('message') do
-    "temporary result"
-  end
-
+See Todonotes::Todonotes#log2file
 =end
-  def todo( comment = 'ToDo', &block)
-    Todonotes.instance.todo(comment, &block)
-  end
-=begin rdoc
-Usage:
-  to do 
-    :result
-  end
-=end
-  alias :to :todo
-=begin rdoc
-Add a fixme-command.
+    def log2file(filename = File.basename($0) + '.todo', level = Log4r::ALL)
+      TODONOTES.log2file(filename, level)
+    end
+  end #Todonotes-module mthods
+end #module Todonotes
 
-Can be used to mark available code.
-=end
-  def fixme( comment = 'FixMe', &block)
-    Todonotes.instance.todo(comment, :FixMe, &block)
-  end  
-end
 
+#Some testcode as "quick test"
 if $0 == __FILE__
+  
   todo( 'a' ){  
     "result" 
   }
   2.times{todo { "result" }}
   fixme { "result" }
   to('a') 
-  Todonotes.print_stats( )
-end
+  #~ Todonotes.print_stats( )
+  #~ puts Todonotes.overview( )
+  #~ puts Todonotes.overview( :with_type )
+  #~ puts Todonotes.overview( :with_type, :with_shortdescription )
+  puts Todonotes.overview( :with_type, :with_shortdescription, :with_result )
+
+  puts Todonotes.codelines( )
+end

data/lib/todonotes/kernel.rb

@@ -0,0 +1,40 @@
+=begin rdoc
+Define todo- and fixme commands to global usage.
+=end
+module Kernel
+=begin rdoc
+Usage 1 (only message):
+  todo "my todo-message""
+
+Usage 2 (only temporary result):
+  todo { "temporary result" }
+  todo do
+    "temporary result"
+  end
+
+Usage 3(message and temporary result):
+  todo ('message') { "temporary  result" }
+  todo ('message') do
+    "temporary result"
+  end
+
+=end
+  def todo( comment = 'ToDo', &block)
+    Todonotes::TODONOTES.todo(comment, &block)
+  end
+=begin rdoc
+Usage:
+  to do 
+    :result
+  end
+=end
+  alias :to :todo
+=begin rdoc
+Add a fixme-command.
+
+Can be used to mark available code.
+=end
+  def fixme( comment = 'FixMe', &block)
+    Todonotes::TODONOTES.todo(comment, :FixMe, &block)
+  end    
+end #module Kernel

data/lib/todonotes/log4r.rb

@@ -0,0 +1,24 @@
+module Todonotes
+=begin rdoc
+Define a formatter.
+=end
+class FixmeFormatter < Log4r::BasicFormatter
+=begin rdoc
+If event is an Array, the output is adapted.
+
+This outputter is only for internal use via Todonotes.
+=end
+    def format(event)
+      #@@basicformat      "%*s %s"
+      #~ buff = sprintf("%-*s %-5s", Log4r::MaxLevelLength, Log4r::LNAMES[event.level],
+             #~ event.data.is_a?(Array) ? event.data.first : event.name)
+      buff = "%-5s" % (event.data.is_a?(Array) ? event.data.first : event.name)
+      #~ buff += (event.tracer.nil? ? "" : "(#{event.tracer[2]})") + ": "
+      buff << ": "
+      buff << format_object(event.data.is_a?(Array) ? event.data.last : event.data) 
+      buff << (event.tracer.nil? ? "" : " (#{event.tracer.join('/')})")
+      buff << "\n"
+      buff
+    end
+end
+end #module Todonotes

data/lib/todonotes/todo.rb

@@ -0,0 +1,58 @@
+module Todonotes
+=begin rdoc
+Report the ToDo/FixMe and count occurence.
+
+The first occurence is reported as a warning, 
+next occurences are informations.
+=end
+  class Todo
+=begin rdoc
+
+
+
+=end
+    def initialize(codeline, type, comment, logger, &block)
+      @logger = logger
+      @count = 1
+      @codeline = codeline
+      @type = type
+      @shortdescription = comment      
+      #Build result
+      @result = yield if block_given?
+      
+      @logger.warn([@type, "#{@codeline} #{@shortdescription} (temporary: #{@result.inspect})"])
+
+    end
+    #Temporary result of the Todo. This result should become a 'real' value
+    attr_reader :result
+    attr_reader :short_description
+    attr_reader :count
+=begin rdoc
+Todo/Fixme is called again  
+=end
+    def call()
+      @logger.info([@type, "#{@codeline}(#{@count}) #{@shortdescription} (temporary: #{@result.inspect})"])
+      @count += 1
+    end
+=begin rdoc
+=end    
+    def to_s()
+      "#{@type}: #{@codeline}"  
+    end
+=begin rdoc
+Return a single line with status of the todo.
+
+Depending on with_type you get also the type (ToDo/FixMe)
+=end    
+    def infoline(settings)
+      res = @codeline.dup
+      res << " (%-5s)" % @type if settings.include?(:with_type)
+      res << ": %4i call%s" % [ 
+            @count, @count > 1 ? 's': ''  
+        ]
+      res << " (%s)" % @shortdescription if settings.include?(:with_shortdescription)
+      res << " = '#{@result.inspect}'" if settings.include?(:with_result)
+      res
+    end #info
+  end #class Codeline
+end #module Todonotes

data/lib/todonotes/todonotes.rb

@@ -0,0 +1,97 @@
+module Todonotes
+=begin rdoc
+Collection of todos and fixmes.
+
+The module Todonotes defines a 'singleton'-like 
+Todonotes::TODONOTES to collect all todo/fixme from Kernel.
+
+You can set settings with 
+* Todonotes::Todonotes#log2file Define log file
+* Todonotes::Todonotes#logger adapt level, outputter ...
+* Todonotes::Todonotes#codelines get Hash with counter per ToDo-locations.
+* Todonotes::Todonotes#overview get overview text with ToDo-locations.
+=end
+class Todonotes
+
+=begin rdoc
+Define the singleton-instance.
+=end
+  def initialize()
+    @codelines = Hash.new()
+    
+    @logger = Log4r::Logger.new('ToDo')
+    @logger.outputters = Log4r::StdoutOutputter.new('ToDo', 
+                                    :level => Log4r::ALL,
+                                    :formatter => FixmeFormatter 
+                                  )
+    #~ @logger.trace = true
+  end
+  #Get logger to define alternative outputters...
+  attr_reader :logger
+=begin rdoc
+Write the todo's in a logging file.
+
+Default filename is $0.todo
+=end
+  def log2file(filename = File.basename($0) + '.todo', level = Log4r::ALL)
+    @logger.add( Log4r::FileOutputter.new('ToDo', 
+                                    :filename => filename,
+                                    :level => level,
+                                    :formatter => FixmeFormatter 
+                                  ))
+    
+  end
+  #Direct access to the codelines list. See also #overview
+  #Accessible via Todonotes::Todonotes.instance.codelines()
+  attr_reader :codelines
+=begin rdoc
+Report a FixMe or a ToDo.
+Create a Todonotes::Todo
+
+The block is evaluated to get a temporary result.
+=end
+  def todo( comment, type = :ToDo, &block)
+    codeline = caller[1].split(':in').first
+    codelinekey = "#{codeline} (#{type})"
+
+    if @codelines[codelinekey] #2nd or more calls
+      @codelines[codelinekey].call
+    else #First occurence?
+      @codelines[codelinekey] = Todo.new(codeline, type, comment, @logger, &block)
+    end 
+    @codelines[codelinekey].result
+  end #todo
+  
+=begin rdoc
+Return a text to be printed
+  puts Todonotes.overview()
+Used from Todonotes.print_stats
+
+Example:
+  List of ToDos/FixMes:
+  todonotes.rb:230:    1 call
+  todonotes.rb:233:    2 calls
+  todonotes.rb:234:    1 call
+  todonotes.rb:235:    1 call
+
+You may extend the output by parameters:
+* :with_type
+* :with_shortdescription
+* :with_result
+
+Example :with_type:
+  todonotes.rb:230 (ToDo):    1 call
+  todonotes.rb:233 (ToDo):    2 calls
+  todonotes.rb:234 (FixMe):    1 call
+  todonotes.rb:235 (ToDo):    1 call
+=end
+  def overview( *settings )
+    txt = []
+    txt << "List of ToDos/FixMes:"
+    @codelines.each do |key, todo|
+      txt << todo.infoline(settings)
+    end
+    txt.join("\n")
+  end
+end #class Todonotes
+end #module Todonotes

data/{readme.rd → readme.rdoc}

@@ -1,10 +1,12 @@
-=fixme
-Define todo- and fixme-command.
+=todonotes
+Define todo- and fixme-command to mark open topics during software development.
 
 ==Usage:
-Add todo and fixme to your code and get track of your todos during 
+Add _todo_ and _fixme_ to your code and get track of your todos during 
 runtime of your code.
 
+Productive programms should not use this gem.
+
 When you pass a todo/fixme during execution, you get a logging information.
 
   todo ('message' ) { "temporary result" }
@@ -12,13 +14,13 @@ When you pass a todo/fixme during execution, you get a logging information.
 
 todo and fixme have the same syntax, the sematic meaning is:
 * ToDo: Mark missing code.
-* Todonotes: Mark code to repair.
+* FixMe: Mark code to repair.
 
 Disadvantage:
-* Does not replace a good IDE. 
-  to see the ToDo/Todonotes 
+* Does not replace a good IDE to find the ToDo/Fixmes.
+
 
-Gem based on a proposal in http://forum.ruby-portal.de/viewtopic.php?f=11&t=11957
+This Gem is based on a proposal in http://forum.ruby-portal.de/viewtopic.php?f=11&t=11957
 
 =Example
 
@@ -31,7 +33,7 @@ So you can start your program:
 
   primecount = 0
   for i in 1..10
-          if fixme "Calculate if prime, prim = true, ja, sonst nein" do 
+          if fixme "Calculate if prime, temporary: true for odd numbers" do 
                 i.odd?  #tempory: odd = prim
               end
             primecount += 1 
@@ -67,11 +69,11 @@ Or
 
 Now you get a output like this:
 
-  Todonotes: todonotes_prim2.rb:12 Calculate if prime misssing (temporary: true)
+  FixMe: todonotes_prim2.rb:12 Calculate if prime misssing (temporary: true)
   1 is a prime number
-  Todonotes: todonotes_prim2.rb:12(2) Calculate if prime misssing (temporary: false)
+  FixMe: todonotes_prim2.rb:12(2) Calculate if prime misssing (temporary: false)
   2 is no prime number
-  Todonotes: todonotes_prim2.rb:12(3) Calculate if prime misssing (temporary: true)
+  FixMe: todonotes_prim2.rb:12(3) Calculate if prime misssing (temporary: true)
   ...
   ToDo : todonotes_prim2.rb:27 Return total number of primes (temporary: nil)
 
@@ -85,25 +87,30 @@ You are informed about source code file and line number. In braces you get the n
 The todo/fixme command evaluates the optional block.
 The result is returned as a temporary result (in this example: odd numbers are primes.).
 
+
+Please refer the examples folder for more details.
+
 ==Logging
 
-The Fixme and ToDo are reported via a logger.
+The Fixme's and ToDo's are reported via a logger (log4r).
+
 The first call of a fixme/todo is a warning, the next call is an information.
+With this logic you can decide, if you want to see each call or only the first call.
 
 
 You may change the level with:
-  Todonotes.instance.logger.level = Log4r::WARN #only first time of callinf a fixme/todo
-  Todonotes.instance.logger.level = Log4r::INFO   #report all calls of fixme/todo
+  Todonotes.logger.level = Log4r::WARN #only first time of a call of a fixme/todo
+  Todonotes.logger.level = Log4r::INFO   #report all calls of fixme/todo
 
 You can log the fixme/todos to a file:
-  Todonotes.instance.log2file()
+  Todonotes.log2file()
 
 ==Get Overview
 You may print an overview on all fixme/todos:
   Todonotes.print_stats()
 
 Example:
-  List of ToDos/Todonotess:
+  List of ToDos/Fixmes:
   todonotes_prim.rb:11:   10 calls
   todonotes_prim.rb:21:    1 call
 

data/unittest/unittest_todonotes.rb

@@ -26,10 +26,10 @@ Clear message array and return messages
   end
 end #ArrayOutputter
 
-#~ Todonotes.instance.logger.level = Log4r::OFF  #No logging
-Todonotes.instance.logger.outputters.first.level = Log4r::OFF
-Todonotes.instance.logger.outputters << $testlog = ArrayOutputter.new('testlog')
-$testlog.formatter = Log4r::FixmeFormatter.new
+#~ Todonotes::TODONOTES.logger.level = Log4r::OFF  #No logging
+Todonotes::TODONOTES.logger.outputters.first.level = Log4r::OFF
+Todonotes::TODONOTES.logger.outputters << $testlog = ArrayOutputter.new('testlog')
+$testlog.formatter = Todonotes::FixmeFormatter.new
 
 class Test_syntax < Test::Unit::TestCase
   def test_todo()
@@ -113,35 +113,87 @@ class Test_value_and_log < Test::Unit::TestCase
 end
 
 class Test_overview < Test::Unit::TestCase
+  def setup()
+    Todonotes::TODONOTES.codelines.clear
+  end
   def test_overview()
-    Todonotes.instance.codeline.clear
-    
     #check empty fixme/todo
     text = "List of ToDos/FixMes:"
-    codeline = {}
-    assert_equal(text, Todonotes.instance.overview())
-    assert_equal(codeline, Todonotes.instance.codeline)
-    
+    codeline = []
+    assert_equal(text, Todonotes::TODONOTES.overview())
+    assert_equal(codeline, Todonotes::TODONOTES.codelines.keys)
+    #Check class methods
+    assert_equal(Todonotes.overview(), Todonotes::TODONOTES.overview())
+    assert_equal(Todonotes.codelines, Todonotes::TODONOTES.codelines)
+
     line = __LINE__; fixme('a')
     text << "\n#{__FILE__}:#{line}:    1 call"
-    codeline["#{__FILE__}:#{line}"] = 1
-    assert_equal(text, Todonotes.instance.overview())
-    assert_equal(codeline, Todonotes.instance.codeline)
+    codeline << "#{__FILE__}:#{line} (FixMe)"
+    assert_equal(text, Todonotes::TODONOTES.overview())
+    assert_equal(codeline, Todonotes::TODONOTES.codelines.keys)
+    #Check class methods
+    assert_equal(Todonotes.overview(), Todonotes::TODONOTES.overview())
+    assert_equal(Todonotes.codelines, Todonotes::TODONOTES.codelines)
     
     #Add 2nd todo
     line = __LINE__; fixme('b')
     text << "\n#{__FILE__}:#{line}:    1 call"
-    codeline["#{__FILE__}:#{line}"] = 1
-    assert_equal(text, Todonotes.instance.overview())
-    assert_equal(codeline, Todonotes.instance.codeline)
+    codeline << "#{__FILE__}:#{line} (FixMe)"
+    assert_equal(text, Todonotes::TODONOTES.overview())
+    assert_equal(codeline, Todonotes::TODONOTES.codelines.keys)
+    #Check class methods
+    assert_equal(Todonotes.overview(), Todonotes::TODONOTES.overview())
+    assert_equal(Todonotes.codelines, Todonotes::TODONOTES.codelines)
+  end #test_overview()
     
+  def test_plural()
     #check plural-s in calls
     line = __LINE__; 2.times{ fixme('c') }
-    text << "\n#{__FILE__}:#{line}:    2 calls"
-    codeline["#{__FILE__}:#{line}"] = 2
-    assert_equal(text, Todonotes.instance.overview())
-    assert_equal(codeline, Todonotes.instance.codeline)
+    assert_equal("List of ToDos/FixMes:\n#{__FILE__}:#{line}:    2 calls", Todonotes::TODONOTES.overview())
+    assert_equal(["#{__FILE__}:#{line} (FixMe)"], Todonotes::TODONOTES.codelines.keys)
+    #Check class methods
+    assert_equal(Todonotes.overview(), Todonotes::TODONOTES.overview())
+    assert_equal(Todonotes.codelines, Todonotes::TODONOTES.codelines)
+  end
+
+  def test_overview_with_type()
+    
+    line = __LINE__; fixme('a')
+    
+    assert_equal("List of ToDos/FixMes:\n#{__FILE__}:#{line} (FixMe):    1 call", 
+            Todonotes::TODONOTES.overview(:with_type)
+        )
+    #Check class methods
+    assert_equal(Todonotes.overview(), Todonotes::TODONOTES.overview())
+    assert_equal(Todonotes.codelines, Todonotes::TODONOTES.codelines)
+    
   end
+  def test_overview_with_type_description()
+    
+    line = __LINE__; fixme('a')
+    
+    assert_equal("List of ToDos/FixMes:\n#{__FILE__}:#{line} (FixMe):    1 call (a)", 
+        Todonotes::TODONOTES.overview(:with_type, :with_shortdescription)
+      )
+
+    #Check class methods
+    assert_equal(Todonotes.overview(), Todonotes::TODONOTES.overview())
+    assert_equal(Todonotes.codelines, Todonotes::TODONOTES.codelines)
+    
+  end  
+  def test_overview_with_type_description_result()
+    
+    line = __LINE__; fixme('a'){2}
+    
+    assert_equal("List of ToDos/FixMes:\n#{__FILE__}:#{line} (FixMe):    1 call (a) = '2'", 
+        Todonotes::TODONOTES.overview(:with_type, :with_shortdescription, :with_result)
+      )
+
+    #Check class methods
+    assert_equal(Todonotes.overview(), Todonotes::TODONOTES.overview())
+    assert_equal(Todonotes.codelines, Todonotes::TODONOTES.codelines)
+    
+  end   
 end
 
 class Test_log_with_file < Test::Unit::TestCase
@@ -157,21 +209,20 @@ class Test_log_with_file < Test::Unit::TestCase
   end
   def test_logfile()
     assert_false(File.exist?(@@logfilename))
-    Todonotes.instance.log2file(@@logfilename)
-    assert_equal(@@logfilename, Todonotes.instance.logger.outputters.last.filename)
+    Todonotes::TODONOTES.log2file(@@logfilename)
+    assert_equal(@@logfilename, Todonotes::TODONOTES.logger.outputters.last.filename)
     assert_true(File.exist?(@@logfilename))
-    Todonotes.instance.logger.outputters.last.close #
-    Todonotes.instance.logger.outputters.pop  #
+    Todonotes::TODONOTES.logger.outputters.last.close #
+    Todonotes::TODONOTES.logger.outputters.pop  #
   end
   def test_logfile_default()
     assert_false(File.exist?(@@logfilename_default))
-    Todonotes.instance.log2file() #no filename
-    assert_equal(@@logfilename_default, Todonotes.instance.logger.outputters.last.filename)
+    Todonotes::TODONOTES.log2file() #no filename
+    assert_equal(@@logfilename_default, Todonotes::TODONOTES.logger.outputters.last.filename)
     assert_true(File.exist?(@@logfilename_default))
-    Todonotes.instance.logger.outputters.last.close #
-    Todonotes.instance.logger.outputters.pop  #
+    Todonotes::TODONOTES.logger.outputters.last.close #
+    Todonotes::TODONOTES.logger.outputters.pop  #
   end
 end
 
-
 __END__

metadata

@@ -1,91 +1,81 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: todonotes
-version: !ruby/object:Gem::Version 
-  hash: 27
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 0
-  version: 0.1.0
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Knut Lickert
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-06-24 00:00:00 +02:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-12-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: log4r
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-description: |
-  todonotes.
-  Support programming by fixme/todo commands
-  
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! 'todonotes.
+
+  Support programming by fixme/todo commands.
+
+
   Gem based on a proposal in http://forum.ruby-portal.de/viewtopic.php?f=11&t=11957
 
+'
 email: knut@lickert.net
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- readme.rd
-files: 
-- readme.rd
+extra_rdoc_files:
+- readme.rdoc
+files:
+- readme.rdoc
 - lib/todonotes.rb
+- lib/todonotes/todonotes.rb
+- lib/todonotes/todo.rb
+- lib/todonotes/kernel.rb
+- lib/todonotes/log4r.rb
 - examples/todonotes_how_to.rb
 - examples/todonotes_prim.rb
 - examples/todonotes_prim2.rb
 - unittest/unittest_todonotes.rb
-has_rdoc: true
-homepage: 
+homepage: http://rubypla.net/todonotes
 licenses: []
-
 post_install_message: 
-rdoc_options: 
-- --main
-- readme.rd
-require_paths: 
+rdoc_options:
+- lib/**/*.rb
+- --main readme.rdoc
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Support programming by todonotes/todo commands.
-test_files: 
+test_files:
 - unittest/unittest_todonotes.rb