notes 0.0.1 → 0.0.2

data/CHANGELOG.rdoc

@@ -1,3 +1,8 @@
+== 0.0.2
+
+* Now search for exact word. e.g. TODO_LIST or TODOLIST will be ignored if TODO is asked.
+* A suffix is allowed (i.e. ':' or ' :') and will be ignored in annotation text.
+
 == 0.0.1
 
 Initial version of Notes gem.

data/README.rdoc

@@ -3,9 +3,9 @@
 == grep annotations in source files
 
 This lib provides a Ruby library and command line tool to find annotations in source files such as:
- * TODO
- * FIXME
- * OPTIMIZE
+* TODO
+* FIXME
+* OPTIMIZE
 Custom tags can also be found.
 
 The purpose of this code is to get a generic version of the `rake notes' command (only used for Ruby on Rails applications).
@@ -35,12 +35,12 @@ For details, see the help.
       -a, --all                        Search TODO, FIXME and OPTIMIZE annotations
       -t, --todo                       Search TODO annotations
       -f, --fixme                      Search FIXME annotations
-      -i, --improve                    Search OPTIMIZE annotations
+      -z, --optimize                   Search OPTIMIZE annotations
       -c, --custom=TAG                 Search TAG annotations
       -o, --out=FILE                   Save output in FILE
       -v, --version                    Print notes version
   Example: notes -ac IMPROVE test.c lib
-  will search for TODO, FIXME, OPTIMIZE and IMPROVE annotations in test.c lib directory.
+  will search for TODO, FIXME, OPTIMIZE and IMPROVE annotations in test.c file and lib directory.
 
 Another example:
 
@@ -71,11 +71,11 @@ This code can be used as a Ruby lib. Let's see how it works in irb:
 
   $ irb
   >> require 'notes'
-  >> AnnotationExtractor.tags << "FOO"
-  >> notes = AnnotationExtractor.new "test/data/sample.c"
-  >> notes.list
-  >> notes.get "FIXME"
-  >> notes.write "TODO.rdoc"
+  >> AnnotationExtractor.tags << "FOO"                    # Add custom tag
+  >> notes = AnnotationExtractor.new "test/data/sample.c" # Parse file
+  >> notes.list                                           # Return the array of annotations
+  >> notes.get "FIXME"                                    # Return the array of FIXME annotations only
+  >> notes.write "TODO.rdoc"                              # Write all annotations in a file
 
 == License
 

data/lib/notes.rb

@@ -10,7 +10,7 @@ require 'rubygems'
 require 'rak'
 
 class AnnotationExtractor
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 
   # An annotation class.
   class Annotation
@@ -68,9 +68,10 @@ class AnnotationExtractor
 
   private
 
-  # Extract for annotations.
+  # Extract annotations.
   def extract
     tags = self.class.tags.join("|")
+    suffix = "\s?:?" # Allowed annotation suffix.
     source = @source.join(" ")
 
     # Because of different rak versions,
@@ -84,12 +85,15 @@ class AnnotationExtractor
     # 0.9 is the current rak version from rubygems.
     # 1.1 is the current rak version from the github repo.
     if rak_version == "1.1"
-      regex = /^(.*):(\d*):.*(#{tags})\s*(.*)$/
+      #TODO /^(.+):(\d+):...?
+      regex = /^(.*):(\d*):.*(#{tags})#{suffix}(.*)$/
     else
-      regex = /^([^\s]+)\s+(\d+)\|.*(#{tags})\s*(.*)$/
+      regex = /^([^\s]+)\s+(\d+)\|.*(#{tags})#{suffix}(.*)$/
     end
+    # TODO extract first matching annotation if there're many on a line.
+    # e.g. "TODO: Rename $TODOLIST variable."
 
-    out = `rak '#{tags}' #{source}`.strip
+    out = `rak '(#{tags})#{suffix}\s+' #{source}`.strip
 
     @list = out.split("\n").map do |l|
       if l =~ regex

data/test/data/sample.c

@@ -23,13 +23,13 @@ int main()
     size_t a_size = sizeof(struct sockaddr_in);
     void *buffer = malloc(STEP);
 
-    //FIXME first fixme thing
+    //FIXME: first fixme thing
     int port = 4242;
 
     /* address server sock */
     struct sockaddr_in addr = {AF_INET, htons(port), {htonl(INADDR_ANY)}};
 
-    //TODO second todo thing!
+    //TODO : second todo thing!
     /* client sock */
     struct sockaddr_in client;
 
@@ -39,10 +39,13 @@ int main()
     /* bind socket to local */
     bind(sock, (struct sockaddr*) &addr, sizeof(struct sockaddr_in));
 
-    //OPTIMIZE make it better
+    //OPTIMIZE make it better  
     while(1)
     {
         //FOO a custom tag
+        //FOOBAR this should not be found if 'FOO' is asked. Same thing for:
+        //TODOLIST blah blah
+        //TODO_LIST etc.
         while (recvfrom(sock, buffer, size, MSG_PEEK, NULL, NULL) == size)
             buffer = realloc(buffer, size += STEP); //TODO hello world
 

data/test/notes_test.rb

@@ -23,6 +23,14 @@ class NotesTest < Test::Unit::TestCase
     notes = AnnotationExtractor.new(@sample)
     assert_equal 6, notes.list.size
 
+    # Test exact text
+    assert_equal "first thing to do", notes.list[0].text
+    assert_equal "first fixme thing", notes.list[1].text
+    assert_equal "second todo thing!", notes.list[2].text
+    assert_equal "make it better", notes.list[3].text
+    assert_equal "a custom tag", notes.list[4].text
+    assert_equal "hello world", notes.list[5].text
+
     AnnotationExtractor.tags = "OPTIMIZE"
     notes = AnnotationExtractor.new(@sample)
     assert_equal 1, notes.list.size

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: notes
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Vivien Didelot
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-13 00:00:00 +01:00
+date: 2010-12-02 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency