dnote 0.8 → 0.9

data/HISTORY

@@ -0,0 +1,23 @@
+= RELEASE HISTORY
+
+== 0.9 / 2009-10-10
+
+This release adds a syckle plugin and improves output.
+
+Changes:
+
+* Add syckle plugin, based on old Notes plugin.
+* Improved HTML output (</div> tag should have been </ol>).
+* If output not specified, sends rdoc to stdout.
+* If no paths specified, will scan '**/*.rb'
+
+== 0.8 / 2009-10-09
+
+This is the initial release of DNote. DNote is a spin-off
+of a Syckle (formerlly Reap) plugin which scans source
+code and compiles a list of developer notes.
+
+Changes:
+
+* Happy Birthday!
+

data/LICENSE

@@ -0,0 +1,23 @@
+The MIT License
+
+Copyright (c) 2009 Thomas Sawyer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+

data/MANIFEST

@@ -1,17 +1,27 @@
+HISTORY
+LICENSE
+MANIFEST
 README.rdoc
 bin/dnote
 lib/dnote
 lib/dnote.rb
+lib/dnote/command.rb
 lib/dnote/notes.rb
+lib/dnote/site.rb
 lib/dnote/template
+lib/dnote/template/assets
+lib/dnote/template/assets/css
+lib/dnote/template/assets/img
 lib/dnote/template/index.html
-lib/dnote/template/notes.rdoc
-lib/dnote/template/notes.xml
+meta/account
 meta/contact
-meta/package
+meta/loadpath
 meta/project
 meta/released
 meta/repository
 meta/summary
 meta/title
-meta/version
+meta/version
+plug/syckle
+plug/syckle/services
+plug/syckle/services/dnote.rb

data/README.rdoc

@@ -1,50 +1,65 @@
 = D'Note
 
-* http://proutils.github.com/dnote
-* http://github.com/proutils/dnote
+* home: http://proutils.github.com/dnote
+* source: http://github.com/proutils/dnote
+* forum: http://googlegroups.com/group/proutils
 
 
 == DESCRIPTION
 
-Extract developement notes from source code and make some pretty RDoc and/or HTML
-formatted files out of them.
+Extract developement notes from source code and generate some nice
+output formats for them.
 
 
 == SYNOPSIS
 
-Developer notes it the source code must be formate as follows: 
+Developer notes it the source code must be formatted as follows: 
 
-  # TYPE: description ...
-  #       ... cont ...
+  # LABEL: description ...
 
-All notes must be separated by a blank line. Eg.
-
-  # TYPE: description ...
-  # 
-  # TYPE: description ...
-
-Without the blank line the second note will be taken to be part of the first.
 Any description that takes up more than one line must remain flush to the left
 margin (if the first line is flush to the left margin too) b/c RDoc will mistake
 of formatting the remaining lines as a +pre+ block it if is not. So...
 
-  # TYPE: ... description ...
+  # LABEL: ... description ...
   # continue ...
 
-Alternately the whole note can be a +pre+ block by indenting them. Then the
-layout if freed-up.
+All consecutive notes must be separated by a blank lines.
+
+  # LABEL: description ...
+  # 
+  # LABEL: description ...
+
+Without the blank line the second note will be taken to be part of the first.
+
+Alternately the whole note can be made a +pre+ block by indention. Then the
+layout if freed-form.
 
   # This is a description of something...
   #
-  #   TYPE: description ...
-  #         continued ...
+  #   LABEL: description ...
+  #          continued ...
+
+With properly formatted notes, we then use the +dnote+ command line tool.
+
+  $ dnote
+
+And lo! Pretty output. See <tt>dnote --help</tt> for more options.
+
+
+== INSTALLATION
+
+The usual RubyGem's command:
+
+  $ sudo gem install dnote
 
 
 == COPYRIGHTS
 
-(GPL Licensed)
+(MIT License)
 
 Copyright (c) 2006, 2009 Thomas Sawyer
 
-[INSERT NOTICE HERE]
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
 

data/bin/dnote

@@ -1,59 +1,4 @@
 #!/usr/bin/env ruby
-
-require 'optparse'
-require 'dnote'
-
-options = {}
-
-opts = OptionParser.new do |opt|
-
-  opt.banner = "Usage: dnote [OPTIONS] path1 [path2 ...]"
-
-  opt.on("--label", "debug and verbose modes combined") do |lbl|
-    options[:labels] ||= []
-    options[:labels] << lbl
-  end
-
-  opt.on("--output", "-o [DIR]", "folder to store output") do |out|
-    options[:output] = out
-  end
-
-  opt.on("--debug", "debug mode") do
-    $DEBUG = true
-  end
-
-  opt.on("--verbose", "-v", "verbose mode") do
-    options[:verbose] = true
-  end
-
-  opt.on("--quiet", "-q", "surpress output") do
-    options[:quiet] = true
-  end
-
-  opt.on("--noop", "-n", "pretend mode") do
-    options[:quiet] = true
-  end
-
-  opt.on("--dryrun", "noop and verbose modes combined") do
-    options[:verbose] = true
-    options[:noop] = true
-  end
-
-  opt.on("--trace", "debug and verbose modes combined") do
-    $DEBUG = true
-    options[:verbose] = true
-  end
-
-  opt.on_tail('--help', '-h', "show this help information") do
-    puts self
-    exit
-  end
-
-end
-
-opts.parse!
-
-paths = ARGV.dup
-dnote = DNote.new(paths, options)
-dnote.document
+load "dnote/command"
+DNote.run
 

data/lib/dnote.rb

@@ -1,7 +1,7 @@
 require 'dnote/notes'
 
 module DNote
-  VERSION = "0.8"  #:till: VERSION = "<%= version %>"
+  VERSION = "0.9"  #:till: VERSION = "<%= version %>"
 
   def self.new(*args)
     Notes.new(*args)

data/lib/dnote/command.rb

@@ -0,0 +1,102 @@
+#!/usr/bin/env ruby
+
+module DNote
+  require 'optparse'
+  require 'dnote'
+
+  def self.run
+    options = {}
+    format  = 'rdoc'
+
+    opts = OptionParser.new do |opt|
+
+      opt.banner = "Usage: dnote [OPTIONS] path1 [path2 ...]"
+
+      opt.separator(" ")
+      opt.separator("OUTPUT FORMAT: (choose one)")
+
+      opt.on("--rdoc", "RDoc comment format") do |format|
+        format = 'rdoc'
+      end
+
+      opt.on("--markdown", "Markdown wiki format") do |format|
+        format = 'markdown'
+      end
+
+      opt.on("--xml", "XML markup format") do |format|
+        format = 'xml'
+      end
+
+      opt.on("--html", "HTML markup format") do |format|
+        format = 'html'
+      end
+
+      opt.on("--yaml", "YAML serialization format") do |format|
+        format = 'yaml'
+      end
+
+      opt.on("--json", "JSON serialization format") do |format|
+        format = 'json'
+      end
+
+      opt.separator(" ")
+      opt.separator("OTHER OPTIONS:")
+
+      opt.on("--label", "labels to collect") do |lbl|
+        options[:labels] ||= []
+        options[:labels] << lbl
+      end
+
+      opt.on("--title", "-t [TITLE]", "title to use in headers") do |title|
+        options[:title] = title
+      end
+
+      #opt.on("--output", "-o [FILE]", "name of file to store output (w/o extension)") do |out|
+      #  options[:output] = out
+      #end
+
+      opt.separator(" ")
+      opt.separator("STANDARD OPTIONS:")
+
+      #opt.on("--verbose", "-v", "extra verbose output") do
+      #  options[:verbose] = true
+      #end
+
+      opt.on("--debug", "debug mode") do
+        $DEBUG = true
+      end
+
+      #opt.on("--quiet", "-q", "surpress non-essential output") do
+      #  options[:quiet] = true
+      #end
+
+      #opt.on("--noharm", "-n", "only pretend to write to disk") do
+      #  options[:noharm] = true
+      #end
+
+      #opt.on("--dryrun", "noharm and verbose modes combined") do
+      #  options[:verbose] = true
+      #  options[:noharm] = true
+      #end
+
+      #opt.on("--trace", "debug and verbose modes combined") do
+      #  $DEBUG = true
+      #  options[:verbose] = true
+      #end
+
+      opt.on_tail('--help', '-h', "show this help information") do
+        puts opt
+        exit
+      end
+
+    end
+
+    opts.parse!
+
+    paths = ARGV.dup
+    dnote = DNote.new(paths, options)
+    dnote.display(format)
+  end
+
+end
+

data/lib/dnote/notes.rb

@@ -1,7 +1,6 @@
 require 'rexml/text'
 require 'pathname'
 require 'erb'
-#require 'reap/project/scm'
 
 module DNote
 
@@ -28,70 +27,31 @@ module DNote
     # Default note labels to look for in source code.
     DEFAULT_LABELS = ['TODO', 'FIXME', 'OPTIMIZE', 'DEPRECATE']
 
-    #
-    DEFAULT_OUTPUT = Pathname.new('log/notes')
-
     #
     attr_accessor :title
 
-    # Non-Operative
-    attr_accessor :noop
-
-    # Verbose
-    attr_accessor :verbose
-
     # Paths to search.
     attr_accessor :paths
 
     # Labels to document. Defaults are: TODO, FIXME, OPTIMIZE and DEPRECATE.
     attr_accessor :labels
 
-    # Directory to save output. Defaults to standard log directory.
-    attr_accessor :output
-
-    # Format (xml, html, text).
-    # TODO: HTML format is not usable yet.
-    #attr_accessor :format
-
     #
     def initialize(paths, options={})
       initialize_defaults
-
-      if paths.empty?
-        if file = File.exist?('meta/loadpath')
-          paths = YAML.load(File.new(file)).to_list
-          paths = Array === paths ? paths : paths.split(/\s+/)
-        elsif file = File.exist?('lib')
-          paths = ['lib']
-        else
-          paths = ['**/*.rb']
-        end
-      end
-
-      @paths = paths
-
       options.each do |k, v|
         __send__("#{k}=", v)
       end
+      #@paths = ['**/*.rb'] if @paths.empty?
+      parse
     end
 
     #
     def initialize_defaults
-      @paths    = ['lib']
-      @output   = DEFAULT_OUTPUT
       @labels   = DEFAULT_LABELS
+      @paths    = ["**/*.rb"]
       @title    = "Developer's Notes"
-      #@format   = 'xml'
-    end
-
-    #
-    def noop?
-      @noop
-    end
-
-    #
-    def verbose?
-      @verbose
+      @format   = "rdoc"
     end
 
     #
@@ -104,19 +64,14 @@ module DNote
       @counts
     end
 
-    #
-    def templates
-      Dir[File.join(File.dirname(__FILE__), 'template/*')]
-    end
-
-    # Scans source code for developer notes and writes them to 
+    # Scans source code for developer notes and writes them to
     # well organized files.
     #
-    def document
-      paths    = self.paths
-      output   = self.output
+    def display(format)
+      #paths    = self.paths
+      #output   = self.output
 
-      parse
+      #parse
 
       #paths  = paths.to_list
 
@@ -134,33 +89,25 @@ module DNote
       #end
 
       if notes.empty?
-        puts "No #{labels.join(', ')} notes."
+        $stderr << "No #{labels.join(', ')} notes.\n"
       else
-        templates.each do |template|
-          erb  = ERB.new(File.read(template))
-          text = erb.result(binding)
-          #text = format_notes(notes, format)
-          file = write(File.basename(template), text)
-          #file = file #Pathname.new(file).relative_path_from(Pathname.pwd) #project.root
-          puts "Updated #{file}"
-        end
-        puts(counts.map{|l,n| "#{n} #{l}s"}.join(', '))
-      end
-    end
-
-    # Reset output directory, marking it as out-of-date.
-    def reset
-      if File.directory?(output)
-        File.utime(0,0,output)
-        puts "marked #{output}"
-      end
-    end
-
-    # Remove output directory.
-    def clean
-      if File.directory?(output)
-        fu.rm_r(output)
-        puts "removed #{output}"
+        #temp = templates.find{ |f| /#{format}$/ =~ f }
+        #erb  = ERB.new(File.read(temp))
+        #text = erb.result(binding)
+
+        text = __send__("to_#{format}")
+
+        #if output
+        #  #templates.each do |template|
+        #    #text = format_notes(notes, format)
+        #    file = write(txt, format)
+        #    #file = file #Pathname.new(file).relative_path_from(Pathname.pwd) #project.root
+        #    puts "Updated #{file}"
+        #  #end
+        #else
+          puts text
+        #end
+        $stderr << "\n(" + counts.map{|l,n| "#{n} #{l}s"}.join(', ') + ")\n"
       end
     end
 
@@ -176,19 +123,9 @@ module DNote
       )
     end
 
-    #
-    def output=(output)
-      raise "output cannot be root" if File.expand_path(output) == "/"
-      @output = Pathname.new(output)
-    end
-
-  private
-
     # Gather and count notes. This returns two elements,
     # a hash in the form of label=>notes and a counts hash.
-    #
     def parse
-      #
       files = self.paths.map do |path|
         if File.directory?(path)
           Dir.glob(File.join(path, '**/*'))
@@ -252,41 +189,37 @@ module DNote
     end
 
     #
-    #def format_notes(notes, type=:rdoc)
-    #  send("format_#{type}", notes)
-    #end
+    def to(format)
+      __send__("to_#{format}")
+    end
 
-    # Format notes in XML format.
+    # Format notes in RDoc format.
     #
-    def notes_xml
-      xml = []
-      xml << "<notes>"
+    def to_rdoc
+      out = []
+      out << "= Development Notes"
       notes.each do |label, per_file|
-        xml << %[<set label="#{label}">]
+        out << %[\n== #{label}]
         per_file.each do |file, line_notes|
-          xml << %[<file src="#{file}">]
+          out << %[\n=== file://#{file}\n]
           line_notes.sort!{ |a,b| a[0] <=> b[0] }
           line_notes.each do |line, note|
-            note = REXML::Text.normalize(note)
-            xml << %[<note line="#{line}" type="#{label}">#{note}</note>]
+            out << %[* #{note} (#{line})]
           end
-          xml << %[</file>]
         end
-        xml << %[</set>]
       end
-      xml << "</notes>"
-      return xml.join("\n")
+      return out.join("\n")
     end
 
     # Format notes in RDoc format.
     #
-    def notes_rdoc
+    def to_markdown
       out = []
-      out << "= Development Notes"
+      out << "# Development Notes"
       notes.each do |label, per_file|
-        out << %[\n== #{label}]
+        out << %[\n## #{label}]
         per_file.each do |file, line_notes|
-          out << %[\n=== file://#{file}]
+          out << %[\n### file://#{file}\n]
           line_notes.sort!{ |a,b| a[0] <=> b[0] }
           line_notes.each do |line, note|
             out << %[* #{note} (#{line})]
@@ -296,52 +229,94 @@ module DNote
       return out.join("\n")
     end
 
-    # HTML format.
+    # Format notes in XML format.
     #
-    def notes_html
+    def to_xml
       xml = []
-      xml << %[<div class="notes">]
+      xml << "<notes>"
       notes.each do |label, per_file|
-        xml << %[<h2>#{label}</h2>\n<ol class="set #{label.downcase}">]
+        xml << %[<set label="#{label}">]
         per_file.each do |file, line_notes|
-          xml << %[<li><h3><a href="#{file}">#{file}</a></h3><ol class="file" href="#{file}">]
+          xml << %[<file src="#{file}">]
           line_notes.sort!{ |a,b| a[0] <=> b[0] }
           line_notes.each do |line, note|
             note = REXML::Text.normalize(note)
-            xml << %[<li class="note #{label.downcase}" ref="#{line}">#{note} <sup>#{line}</sup></li>]
+            xml << %[<note line="#{line}" type="#{label}">#{note}</note>]
           end
-          xml << %[</ol></li>]
+          xml << %[</file>]
         end
-        xml << %[</div>]
+        xml << %[</set>]
       end
-      xml << "</div>"
+      xml << "</notes>"
       return xml.join("\n")
     end
 
-    # Save notes.
+    # HTML format.
     #
-    def write(file, text)
-      file = output + file
-      fu.mkdir_p(output)
-      File.open(file, 'w') { |f| f << text } unless noop?
-      file
+    def to_html
+      html = []
+      html << %[<html>]
+      html << %[<head>]
+      html << %[<title><%= title %></title>]
+      html << %[<style>]
+      html << HTML_CSS
+      html << %[</style>]
+      html << %[</head>]
+      html << %[<body>]
+      html << %[<div class="main">]
+      html << %[<h1><%= title %></h1>]
+      html << to_html_list
+      html << %[</div>]
+      html << %[</boby>]
+      html << %[</html>]
+      html.join("\n")
     end
 
     #
-    def fu
-      @fu ||= (
-        if noop? and verbose?
-          FileUtils::DryRun
-        elsif noop
-          FileUtils::Noop
-        elsif verbose
-          FileUtils::Verbose
-        else
-          FileUtils
+    def to_html_list
+      html = []
+      html << %[<div class="notes">]
+      notes.each do |label, per_file|
+        html << %[<h2>#{label}</h2>]
+        html << %[<ol class="set #{label.downcase}">]
+        per_file.each do |file, line_notes|
+          html << %[<li><h3><a href="#{file}">#{file}</a></h3><ol class="file" href="#{file}">]
+          line_notes.sort!{ |a,b| a[0] <=> b[0] }
+          line_notes.each do |line, note|
+            note = REXML::Text.normalize(note)
+            html << %[<li class="note #{label.downcase}" ref="#{line}">#{note} <sup>#{line}</sup></li>]
+          end
+          html << %[</ol></li>]
         end
-      )
+        html << %[</ol>]
+      end
+      html << %[</div>]
+      html.join("\n")
+    end
+
+    #
+    def to_yaml
+      require 'yaml'
+      notes.to_yaml
     end
 
+    #
+    def to_json
+      require 'json'
+      notes.to_json
+    end
+
+    HTML_CSS = <<-HERE
+      body { margin: 0; padding: 0; }
+      .main { width: 800px; margin: 0 auto; border: 1px solid #ccc; padding: 0 20px 20px 20px; }
+      h1 { margin: 25px 0; }
+      h2,h3,h4 { margin: 5px 0; padding: 0; color: 880044; }
+      h3 { color: 004488; }
+      h4 { color: 888844; }
+      ul { margin: 0; padding: 0; text-align: left; }
+      li { margin: 0; padding: 0; text-align: left; }
+    HERE
+
   end
 
 end

data/lib/dnote/site.rb

@@ -0,0 +1,123 @@
+module DNote
+
+  require 'dnote/notes'
+
+  # Site class is used to build a "pretty" output set.
+  # The template files are saved to the +output+ directory.
+  # Additional +formats+ can be saved the the directory
+  # as well.
+
+  class Site
+
+    # Default output directory is +dnote/+.
+    DEFAULT_OUTPUT = Pathname.new('dnote')
+
+    # Title to use in any headers.
+    attr_accessor :title
+
+    # Directory to save output.
+    attr_accessor :output
+
+    # Additional Formats to supply besided the html (xml, rdoc, markdown, etc.)
+    attr_accessor :formats
+
+    # Notes object.
+    attr_reader :notes
+
+    def initialize(paths, options)
+      self.title   = options[:title]
+
+      self.output  = options.delete(:output)
+      self.formats = options.delete(:formats)
+
+      @notes = Notes.new(paths, options)
+    end
+
+    #
+    def initialize_defaults
+      @output   = DEFAULT_OUTPUT
+      @title    = "Development Notes"
+      @formats  = []
+    end
+
+    #
+    def output=(path)
+      raise "output cannot be root" if File.expand_path(path) == "/"
+      @output = Pathname.new(path)
+    end
+
+    #
+    def document
+      fu.mkdir_p(output)
+
+      # copy the whole template directory over
+      fu.cp_r("#{__DIR__}/template/", "#{output}/")
+
+      # (re)write the erb templates
+      templates.each do |temp|
+        erb  = ERB.new(File.read(temp))
+        text = erb.result(binding)
+        file = File.basename(temp)
+        write(file, text)
+      end
+
+      # produce requested additional formats
+      formats.each do |format|
+        text = notes.to(format)
+        write("notes.#{format}", text)
+      end
+    end
+
+    # Reset output directory, marking it as out-of-date.
+    def reset
+      if File.directory?(output)
+        File.utime(0,0,output) unless $NOOP
+        puts "marked #{output}"
+      end
+    end
+
+    # Remove output directory.
+    def clean
+      if File.directory?(output)
+        fu.rm_r(output)
+        puts "removed #{output}"
+      end
+    end
+
+    #
+    def templates
+      @templates ||= (
+        Dir[File.join(File.dirname(__FILE__), 'template/*')].select{ |f| File.file?(f) }
+      )
+    end
+
+    # Save file to output.
+    #
+    def write(fname, text)
+      file = output + fname
+      fu.mkdir_p(file.parent)
+      File.open(file, 'w') { |f| f << text } unless $NOOP
+    end
+
+    def __DIR__
+      File.dirname(__FILE__)
+    end
+
+    #
+    def fu
+      @fu ||= (
+        if $NOOP and $DEBUG
+          FileUtils::DryRun
+        elsif $NOOP
+          FileUtils::Noop
+        elsif $DEBUG
+          FileUtils::Verbose
+        else
+          FileUtils
+        end
+      )
+    end
+
+  end
+
+ end

data/lib/dnote/template/index.html

@@ -18,13 +18,15 @@
   </style>
 </head>
 <body>
+
 <div class="main">
 
 <h1><%= title %></h1>
 
-<%= notes_html %>
+<%= notes.to_html_list %>
 
 </div>
+
 </boby>
 </html>
 

data/meta/account

@@ -0,0 +1 @@
+proutils

data/meta/loadpath

@@ -0,0 +1,2 @@
+lib
+plug

data/meta/project

@@ -1 +1 @@
-proutils
+dnote

data/meta/version

@@ -1 +1 @@
-0.8
+0.9

data/plug/syckle/services/dnote.rb

@@ -0,0 +1,100 @@
+module Syckle::Plugins
+
+  # = Developmer's Notes Plugin
+  #
+  # This plugin goes through you source files and compiles
+  # an lit of any labeled comments. Labels are single word
+  # prefixes to a comment ending in a colon. For example,
+  # you might note somewhere in your code:
+  #
+  # By default this label supports the TODO, FIXME, OPTIMIZE
+  # and DEPRECATE.
+  #
+  # Output is a set of files in HTML, XML and RDoc's simple
+  # markup format. This plugin can run automatically if there
+  # is a +notes/+ directory in the project's log directory.
+  #
+  #--
+  # TODO: Should this service be part of the +site+ cycle?
+  #++
+  class DNote < Service
+
+    cycle :main, :document
+    cycle :main, :reset
+    cycle :main, :clean
+
+    # not that this is necessary, but ...
+    available do |project|
+      begin
+        require 'dnote/site'
+        true
+      rescue LoadError
+        false
+      end
+    end
+
+    # autorun if log/notes exists
+    autorun do |project|
+      (project.log + 'notes').exist?
+    end
+
+    # Default note labels to looked for in source code.
+    DEFAULT_LABELS = ['TODO', 'FIXME', 'OPTIMIZE', 'DEPRECATE']
+
+    # Paths to search.
+    attr_accessor :files
+
+    # Labels to document. Defaults are: TODO, FIXME, OPTIMIZE and DEPRECATE.
+    attr_accessor :labels
+
+    # Directory to save output. Defaults to <tt>dnote/</tt> under project
+    # log directory.
+    attr_accessor :output
+
+    # Formats (xml, html, rdoc).
+    attr_accessor :formats
+
+    #
+    def output=(path)
+      @output = Pathname.new(path)
+    end
+
+    #
+    def dnote
+      @dnote ||= ::DNote::Site.new(files, :labels=>labels, :formats=>formats, :output=>output)
+    end
+
+    # Generate notes documents.
+    def document
+      $NOOP = noop?  # TODO:
+      dnote.document
+      #mkdir_p(output)
+      #file = output + "index.html"
+      #File.open(file, 'w'){ |f| f << dnote.to_html }
+      report "Updated #{output.to_s.sub(Dir.pwd+'/','')}"
+    end
+
+    # Mark notes documents as out-of-date.
+    def reset
+      #dnote.reset
+    end
+
+    # Remove notes directory.
+    def clean
+      #dnote.clean
+    end
+
+  private
+
+    # TODO: maybe files default of **/*.rb is better?
+    def initialize_defaults
+      @files   = metadata.loadpath || 'lib'
+      @output  = project.log + 'dnote'
+      @formats = []
+      @labels  = DEFAULT_LABELS
+    end
+
+  end
+
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dnote
 version: !ruby/object:Gem::Version 
-  version: "0.8"
+  version: "0.9"
 platform: ruby
 authors: []
 
@@ -9,13 +9,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-09 00:00:00 -04:00
+date: 2009-10-24 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
-description: |-
-  Extract developement notes from source code and make some pretty RDoc and/or HTML
-  formatted files out of them.
+description: ""
 email: http://googlegroups.com/group/proutils
 executables: 
 - dnote
@@ -23,35 +21,41 @@ extensions: []
 
 extra_rdoc_files: 
 - MANIFEST
+- LICENSE
 - README.rdoc
+- HISTORY
 files: 
+- HISTORY
+- LICENSE
+- MANIFEST
 - README.rdoc
 - bin/dnote
 - lib/dnote.rb
+- lib/dnote/command.rb
 - lib/dnote/notes.rb
+- lib/dnote/site.rb
 - lib/dnote/template/index.html
-- lib/dnote/template/notes.rdoc
-- lib/dnote/template/notes.xml
+- meta/account
 - meta/contact
-- meta/package
+- meta/loadpath
 - meta/project
 - meta/released
 - meta/repository
 - meta/summary
 - meta/title
 - meta/version
-- MANIFEST
+- plug/syckle/services/dnote.rb
 has_rdoc: true
 homepage: 
 licenses: []
 
 post_install_message: 
 rdoc_options: 
-- --inline-source
 - --title
-- dnote api
+- D'Note API
 require_paths: 
 - lib
+- plug
 required_ruby_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="

data/lib/dnote/template/notes.rdoc

@@ -1 +0,0 @@
-<%= notes_rdoc %>

data/lib/dnote/template/notes.xml

@@ -1 +0,0 @@
-<%= notes_xml %>

data/meta/package

@@ -1 +0,0 @@
-dnote