notes 0.0.1

data/CHANGELOG.rdoc

@@ -0,0 +1,3 @@
+== 0.0.1
+
+Initial version of Notes gem.

data/LICENSE

@@ -0,0 +1,7 @@
+-------------------------------------------------------------------------------
+ "THE BEER-WARE LICENSE" (Revision 42):
+ <vivien.didelot@gmail.com> wrote this gem. As long as you retain this notice
+ you can do whatever you want with this stuff. If we meet some day, and you
+ think this stuff is worth it, you can buy me a beer in return. Vivien Didelot
+-------------------------------------------------------------------------------
+

data/README.rdoc

@@ -0,0 +1,88 @@
+= Notes
+
+== 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
+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).
+It will look for tags recursively in every given files (or in current directory by default).
+
+== Installation
+
+Notes is available on Rubygems.org[http://rubygems.org/gems/notes] and can be installed with:
+
+  $ gem install notes
+
+This command needs Rubygems (rubygems package on Ubuntu).
+
+== Usage
+
+=== Command line tool
+
+  notes [options] [file...]
+
+For details, see the help.
+
+  $ ruby notes --help
+  Usage: notes [options] [file...]
+  Search recursively for annotations in source code.
+  By default, notes will search for all annotations in current directory.
+  Available options:
+      -a, --all                        Search TODO, FIXME and OPTIMIZE annotations
+      -t, --todo                       Search TODO annotations
+      -f, --fixme                      Search FIXME annotations
+      -i, --improve                    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.
+
+Another example:
+
+  $ notes test/data/sample.c
+  ../test/data/sample.c:16: TODO: first thing to do
+  ../test/data/sample.c:26: FIXME: first fixme thing
+  ../test/data/sample.c:32: TODO: second todo thing!
+  ../test/data/sample.c:42: OPTIMIZE: make it better
+  ../test/data/sample.c:47: TODO: hello world
+
+If the terminal allows it, colors will be displayed for files and tags.
+
+Another again:
+
+  $ notes -o TODO.txt test/data/sample.c
+
+will write all notes to a TODO.txt file. It will look like that:
+
+   * [TODO    ] ../test/data/sample.c (16): first thing to do
+   * [FIXME   ] ../test/data/sample.c (26): first fixme thing
+   * [TODO    ] ../test/data/sample.c (32): second todo thing!
+   * [OPTIMIZE] ../test/data/sample.c (42): make it better
+   * [TODO    ] ../test/data/sample.c (47): hello world
+
+=== Lib
+
+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"
+
+== License
+
+  ------------------------------------------------------------------------------
+   "THE BEER-WARE LICENSE" (Revision 42):
+   <vivien.didelot@gmail.com> wrote this gem. As long as you retain this notice
+   you can do whatever you want with this stuff. If we meet some day, and you
+   think this stuff is worth it, you can buy me a beer in return. Vivien Didelot
+  ------------------------------------------------------------------------------
+

data/bin/notes

@@ -0,0 +1,65 @@
+#!/usr/bin/env ruby
+
+# ------------------------------------------------------------------------------
+# "THE BEER-WARE LICENSE" (Revision 42):
+# <vivien.didelot@gmail.com> wrote this file. As long as you retain this notice
+# you can do whatever you want with this stuff. If we meet some day, and you
+# think this stuff is worth it, you can buy me a beer in return. Vivien Didelot
+# ------------------------------------------------------------------------------
+
+# Command line tool to grep annotations from source files.
+# Author:: Vivien 'v0n' Didelot <vivien.didelot@gmail.com>
+
+require 'notes'
+
+require 'rainbow'
+require 'optparse'
+
+def display(list)
+  list.each do |a|
+    color = case a.tag
+            when "TODO" then :yellow
+            when "FIXME" then :red
+            when "OPTIMIZE" then :green
+            else :blue
+            end
+
+    printf("%s:%s: %s: %s\n",
+           a.file.color(:magenta), a.line, a.tag.color(color), a.text)
+  end
+end
+
+tags = []
+source = []
+file = nil
+
+ARGV.options do |o|
+  o.banner = "Usage: #{File.basename $0} [options] [file...]\n"
+  o.banner << "Search recursively for annotations in source code.\n"
+  o.banner << "By default, #{File.basename $0} will search for all annotations in current directory.\n"
+
+  o.on_head("Available options:")
+  o.on("-a", "--all",                "Search TODO, FIXME and OPTIMIZE annotations") { tags << AnnotationExtractor::TAGS }
+  o.on("-t", "--todo",               "Search TODO annotations")                     { tags << "TODO" }
+  o.on("-f", "--fixme",              "Search FIXME annotations")                    { tags << "FIXME" }
+  o.on("-z", "--optimize",           "Search OPTIMIZE annotations")                 { tags << "OPTIMIZE" }
+  o.on("-c", "--custom=TAG", String, "Search TAG annotations")                      { |v| tags << v }
+  o.on("-o", "--out=FILE",   String, "Save output in FILE")                         { |v| file = v }
+  o.on("-v", "--version",            "Print notes version")                         { puts "notes: version #{AnnotationExtractor::VERSION}" ; exit }
+
+  o.on_tail("Example: #{File.basename $0} -ac IMPROVE test.c lib\nwill search for TODO, FIXME, OPTIMIZE and IMPROVE annotations in test.c lib directory.")
+end
+
+begin
+  ARGV.options.parse!
+  AnnotationExtractor.tags = tags.flatten unless tags.empty?
+  source = ARGV
+
+  notes = AnnotationExtractor.new(source)
+
+  file.nil? ? display(notes.list) : notes.write(file)
+rescue => e
+  STDERR.puts "error: #{e}"
+end
+
+exit

data/lib/notes.rb

@@ -0,0 +1,108 @@
+# ------------------------------------------------------------------------------
+# "THE BEER-WARE LICENSE" (Revision 42):
+# <vivien.didelot@gmail.com> wrote this file. As long as you retain this notice
+# you can do whatever you want with this stuff. If we meet some day, and you
+# think this stuff is worth it, you can buy me a beer in return. Vivien Didelot
+# ------------------------------------------------------------------------------
+
+# Useless, but informs that rak should be installed.
+require 'rubygems'
+require 'rak'
+
+class AnnotationExtractor
+  VERSION = "0.0.1"
+
+  # An annotation class.
+  class Annotation
+    attr_accessor :file, :line, :tag, :text
+
+    # Instanciate a new Annotation from a hash.
+    def initialize(args)
+      @file = args[:file]
+      @line = args[:line]
+      @tag = args[:tag]
+      @text = args[:text]
+    end
+  end
+
+  # Default tags list
+  TAGS = ["TODO", "FIXME", "OPTIMIZE"]
+
+  # Trick not to use @@tags class variable, but works the same way.
+  # Custom tags can be added with AnnotationExtractor.tags << "FOO".
+  @tags = TAGS.clone
+  class << self
+    attr_reader :tags
+    def tags=(tags)
+      @tags = tags.is_a?(Array) ? tags : [tags]
+    end
+  end
+
+  # The list of all notes.
+  attr_reader :list
+
+  # Instanciate a new extractor for the given target files.
+  def initialize(source = Dir.pwd)
+    @source = [].push(source).flatten
+    @list = Array.new
+
+    extract
+  end
+
+  # Get annotation with tag 'tag' from the list.
+  def get(tag)
+    @list.find_all { |a| a.tag == tag }
+  end
+
+  # Write all annotations to the file 'file'.
+  def write(file)
+    longest_tag = @list.max { |a, b| a.tag.size <=> b.tag.size }.tag.size
+
+    File.open(file, 'w') do |f|
+      @list.each do |a|
+        f.write(sprintf(" * [%-#{longest_tag}s] %s (%s): %s\n",
+                        a.tag, a.file, a.line, a.text))
+      end
+    end
+  end
+
+  private
+
+  # Extract for annotations.
+  def extract
+    tags = self.class.tags.join("|")
+    source = @source.join(" ")
+
+    # Because of different rak versions,
+    # rak system call outputs are not similar.
+    if `rak --version` =~ /rak (\d\.\d)/
+      rak_version = $1
+    else
+      raise "Can't get rak version"
+    end
+
+    # 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*(.*)$/
+    else
+      regex = /^([^\s]+)\s+(\d+)\|.*(#{tags})\s*(.*)$/
+    end
+
+    out = `rak '#{tags}' #{source}`.strip
+
+    @list = out.split("\n").map do |l|
+      if l =~ regex
+        Annotation.new({
+          :file => $1,
+          :line => $2.to_i,
+          :tag => $3,
+          :text => $4.strip
+        })
+      else
+        # Just for a debug purpose
+        raise "notes: does not match regexp => \"#{l}\""
+      end
+    end
+  end
+end

data/test/data/sample.c

@@ -0,0 +1,55 @@
+/*
+ * -----------------------------------------------------------------------------
+ * "THE BEER-WARE LICENSE" (Revision 42):
+ * <vivien.didelot@gmail.com> wrote this file. As long as you retain this notice
+ * you can do whatever you want with this stuff. If we meet some day, and you
+ * think this stuff is worth it, you can buy me a beer in return. Vivien Didelot
+ * -----------------------------------------------------------------------------
+ */
+
+/* UDP Server */
+
+#include <netinet/in.h>
+#include <stdio.h>
+#include <stdlib.h>
+
+//TODO first thing to do
+#define STEP sizeof(char)
+
+int main()
+{
+    int sock;
+    size_t size = STEP;
+    size_t a_size = sizeof(struct sockaddr_in);
+    void *buffer = malloc(STEP);
+
+    //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!
+    /* client sock */
+    struct sockaddr_in client;
+
+    /* socket declaration */
+    sock = socket(AF_INET, SOCK_DGRAM, 0);
+
+    /* bind socket to local */
+    bind(sock, (struct sockaddr*) &addr, sizeof(struct sockaddr_in));
+
+    //OPTIMIZE make it better
+    while(1)
+    {
+        //FOO a custom tag
+        while (recvfrom(sock, buffer, size, MSG_PEEK, NULL, NULL) == size)
+            buffer = realloc(buffer, size += STEP); //TODO hello world
+
+        recvfrom(sock, buffer, size, 0, (struct sockaddr*) &client, &a_size);
+
+        printf("Server receive: \"%s\"\n", (char*) buffer);
+    }
+
+    return 0;
+}

data/test/notes_test.rb

@@ -0,0 +1,55 @@
+# ------------------------------------------------------------------------------
+# "THE BEER-WARE LICENSE" (Revision 42):
+# <vivien.didelot@gmail.com> wrote this file. As long as you retain this notice
+# you can do whatever you want with this stuff. If we meet some day, and you
+# think this stuff is worth it, you can buy me a beer in return. Vivien Didelot
+# ------------------------------------------------------------------------------
+
+require "test/unit"
+require "notes"
+require "tempfile"
+
+class NotesTest < Test::Unit::TestCase
+  def setup
+    @sample = "#{File.join "..", "test", "data", "sample.c"}"
+  end
+
+  def test_new
+    notes = AnnotationExtractor.new(@sample)
+    assert_equal 5, notes.list.size
+    notes.list.each { |a| assert_kind_of AnnotationExtractor::Annotation, a }
+
+    AnnotationExtractor.tags << "FOO"
+    notes = AnnotationExtractor.new(@sample)
+    assert_equal 6, notes.list.size
+
+    AnnotationExtractor.tags = "OPTIMIZE"
+    notes = AnnotationExtractor.new(@sample)
+    assert_equal 1, notes.list.size
+    assert_equal "make it better", notes.list.first.text
+
+    AnnotationExtractor.tags = "FOO"
+    notes = AnnotationExtractor.new(@sample)
+    assert_equal 1, notes.list.size
+    assert_equal "a custom tag", notes.list.first.text
+  end
+
+  def test_get
+    notes = AnnotationExtractor.new(@sample)
+    assert_equal 3, notes.get("TODO").size
+    assert_equal 1, notes.get("FIXME").size
+    assert_equal 1, notes.get("OPTIMIZE").size
+  end
+
+  def test_write
+    tempfile = Tempfile.new("notes").path
+
+    AnnotationExtractor.tags = AnnotationExtractor::TAGS
+    notes = AnnotationExtractor.new(@sample)
+    notes.write tempfile
+
+    assert_equal 5, File.readlines(tempfile).size
+
+    File.delete tempfile
+  end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification 
+name: notes
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Vivien Didelot
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-13 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rak
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rainbow
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 1
+        version: "1.1"
+  type: :runtime
+  version_requirements: *id002
+description: 
+email: vivien.didelot@gmail.com
+executables: 
+- notes
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/notes.rb
+- test/notes_test.rb
+- test/data/sample.c
+- README.rdoc
+- CHANGELOG.rdoc
+- LICENSE
+- bin/notes
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+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 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A Ruby gem to grep annotations in source files.
+test_files: []
+