dnote 1.0 → 1.1

data/HISTORY

@@ -1,5 +1,23 @@
 = RELEASE HISTORY
 
+== 1.1 / 2010-02-06
+
+This relase primarily adjusts the way output it rendered
+underthehood. Serialization formats are rendered as
+before but markup formats now use Erb. In the process
+two new serialization formats have been added: soap and xoxo.
+
+Also, this release renames the lib/plugin directory to
+lib/plugins (plural) per the new convention of the latest
+Plugin gem. This only matters to Syckle users.
+
+Changes:
+
+* Add Soap and XOXO formats.
+* Add actual --output option.
+* Move lib/plugin to lib/plugins.
+
+
 == 1.0 / 2009-10-25
 
 This relase adds support for arbitrary note labels.

data/MANIFEST

@@ -6,22 +6,26 @@ bin/dnote
 lib/dnote
 lib/dnote.rb
 lib/dnote/command.rb
+lib/dnote/format.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/templates
+lib/dnote/templates/gnu.erb
+lib/dnote/templates/html.erb
+lib/dnote/templates/markdown.erb
+lib/dnote/templates/rdoc.erb
+lib/dnote/templates/xml.erb
+lib/plugins
+lib/plugins/syckle
+lib/plugins/syckle/dnote.rb
 meta/account
 meta/contact
-meta/loadpath
-meta/project
+meta/name
 meta/released
 meta/repository
+meta/suite
 meta/summary
 meta/title
 meta/version
-plug/syckle
-plug/syckle/services
-plug/syckle/services/dnote.rb
+test/cases
+test/cases/notes_case.rb

data/README.rdoc

@@ -1,8 +1,8 @@
 = D'Note
 
 * home: http://proutils.github.com/dnote
-* source: http://github.com/proutils/dnote
 * forum: http://googlegroups.com/group/proutils
+* source: http://github.com/proutils/dnote
 
 
 == DESCRIPTION

data/lib/dnote.rb

@@ -1,12 +1,32 @@
-require 'dnote/notes'
-
 module DNote
-  VERSION = "1.0"  #:till: VERSION = "<%= version %>"
+  VERSION = "1.1"  #:till: VERSION = "<%= version %>"
+
+  require 'dnote/notes'
+
+  # NOTE: Toying with the idea of making DNote a class.
+
+  #attr :notes
+  #
+  #def initialize(paths, options={})
+  #  labels = options[:labels] || options['labels']
+  #  @notes = Notes.new(paths, labels)
+  #end
+  #
+  #
+  #def save(format, output, options)
+  #  options = options.merge({ :format=>format, :output=>output })
+  #  format = Format.new(notes, options)
+  #  format.render
+  #end
+  #
+  #
+  #def display(format, options)
+  #  options = options.merge({ :format=>format, :output=>nil })
+  #  format  = Format.new(@notes, options)
+  #  format.render
+  #end
 
-  def self.new(*args)
-    Notes.new(*args)
-  end
 end
 
-# TEST: This is a test of arbitraty note labels.
+# TEST: This is a test of arbitraty labels.
 

data/lib/dnote/command.rb

@@ -3,6 +3,7 @@
 module DNote
   require 'optparse'
   require 'dnote'
+  require 'dnote/format'
 
   def self.run
     options = {}
@@ -15,28 +16,45 @@ module DNote
       opt.separator(" ")
       opt.separator("OUTPUT FORMAT: (choose one)")
 
-      opt.on("--rdoc", "RDoc comment format") do |format|
-        format = 'rdoc'
+      opt.on("--gnu", "Plain text format (default)") do
+        options[:format] = 'gnu'
       end
 
-      opt.on("--markdown", "Markdown wiki format") do |format|
-        format = 'markdown'
+      opt.on("--rdoc", "RDoc comment format") do
+        options[:format] = 'rdoc'
       end
 
-      opt.on("--xml", "XML markup format") do |format|
-        format = 'xml'
+      opt.on("--markdown", "Markdown wiki format") do
+        options[:format] = 'markdown'
       end
 
-      opt.on("--html", "HTML markup format") do |format|
-        format = 'html'
+      opt.on("--soap", "SOAP XML envelope format") do
+        options[:format] = 'soap'
       end
 
-      opt.on("--yaml", "YAML serialization format") do |format|
-        format = 'yaml'
+      opt.on("--xoxo", "XOXO microformat format") do
+        options[:format] = 'xoxo'
       end
 
-      opt.on("--json", "JSON serialization format") do |format|
-        format = 'json'
+      opt.on("--xml", "XML markup format") do
+        options[:format] = 'xml'
+      end
+
+      opt.on("--html", "HTML markup format") do
+        options[:format] = 'html'
+      end
+
+      opt.on("--yaml", "YAML serialization format") do
+        options[:format] = 'yaml'
+      end
+
+      opt.on("--json", "JSON serialization format") do
+        options[:format] = 'json'
+      end
+
+      opt.on("--template", "-t FILE", "Use a custom Erb template") do |file|
+        options[:format] = 'custom'
+        options[:template] = file
       end
 
       opt.separator(" ")
@@ -51,9 +69,9 @@ module DNote
         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.on("--output", "-o [PATH]", "name of file or directory") do |path|
+        options[:output] = path
+      end
 
       opt.separator(" ")
       opt.separator("STANDARD OPTIONS:")
@@ -74,10 +92,9 @@ module DNote
       #  options[:noharm] = true
       #end
 
-      #opt.on("--dryrun", "noharm and verbose modes combined") do
-      #  options[:verbose] = true
-      #  options[:noharm] = true
-      #end
+      opt.on("--dryrun", "-n", "do not actually write to disk") do
+        options[:dryrun] = true
+      end
 
       #opt.on("--trace", "debug and verbose modes combined") do
       #  $DEBUG = true
@@ -91,11 +108,27 @@ module DNote
 
     end
 
-    opts.parse!
+    begin
+      opts.parse!
+    rescue => err
+      puts err
+      exit 1
+    end
 
     paths = ARGV.dup
-    dnote = DNote.new(paths, options)
-    dnote.display(format)
+    paths = ['**/*.rb'] if paths.empty?
+
+    notes  = Notes.new(paths, options[:labels])
+    format = Format.new(notes, options)
+    format.render
+
+    # NOTE: If DNote were a class.
+
+    #if output
+    #  dnote.save(format, output)
+    #else
+    #  dnote.display(format)
+    #end
   end
 
 end

data/lib/dnote/format.rb

@@ -0,0 +1,213 @@
+module DNote
+
+  # = Notes Formatter
+  #
+  #--
+  #   TODO: Need good CSS file.
+  #
+  #   TODO: Need XSL?
+  #++
+  class Format
+
+    require 'fileutils'
+    require 'erb'
+    require 'rexml/text'
+
+    #DEFAULT_OUTPUT_DIR = "log/dnote"
+
+    EXTENSIONS = { 'soap'=>'xml', 'xoxo'=>'xml' }
+
+    #
+    attr :notes
+
+    #
+    attr_accessor :format
+
+    #
+    attr_accessor :output
+
+    #
+    attr_accessor :template
+
+    #
+    attr_accessor :title
+
+    #
+    attr_accessor :dryrun
+
+    #
+    def initialize(notes, options={})
+      @notes  = notes
+      @format = :gnu
+      @title  = "Developer's Notes"
+      options.each do |k,v|
+        __send__("#{k}=", v) if v
+      end
+    end
+
+    #
+    def render
+      if notes.empty?
+        $stderr << "No #{notes.labels.join(', ')} notes.\n"
+      else
+        raise ArgumentError unless respond_to?("render_#{format}")
+        __send__("render_#{format}")
+      end
+    end
+
+    # S E R I A L I Z A T I O N
+
+    def render_yaml
+      result = notes.to_yaml
+      publish(result)
+    end
+
+    def render_json
+      result = notes.to_json
+      publish(result)
+    end
+
+    # M L  M A R K U P
+
+    def render_soap
+      result = notes.to_soap
+      publish(result)
+    end
+
+    def render_xoxo
+      result = notes.to_xoxo
+      publish(result)
+    end
+
+    def render_xml
+      template = File.join(File.dirname(__FILE__), 'templates/xml.erb')
+      result = erb(template)
+      publish(result)
+    end
+
+    def render_html
+      template = File.join(File.dirname(__FILE__), 'templates/html.erb')
+      result = erb(template)
+      publish(result)
+    end
+
+    def render_index
+      template = File.join(File.dirname(__FILE__), 'templates/html.erb')
+      result = erb(template)
+      publish(result, 'index.html')
+    end
+
+    # W I K I  M A R K U P
+
+    def render_gnu
+      template = File.join(File.dirname(__FILE__), 'templates/gnu.erb')
+      result = erb(template)
+      publish(result)
+    end
+
+    def render_rdoc
+      template = File.join(File.dirname(__FILE__), 'templates/rdoc.erb')
+      result = erb(template)
+      publish(result)
+    end
+
+    def render_markdown
+      template = File.join(File.dirname(__FILE__), 'templates/markdown.erb')
+      result = erb(template)
+      publish(result)
+    end
+
+    # C U S T O M  T E M P L A T E
+
+    def render_custom
+      result = erb(template)
+      publish(result)    
+    end
+
+  private
+
+    #
+    def erb(file)
+      scope = ErbScope.new(:notes=>notes, :title=>title)
+      scope.render(file)
+    end
+
+    #
+    def publish(result, fname=nil)
+      if output
+        write(result, fname)
+      else
+        puts(result)
+      end
+      $stderr << "\n(" + notes.counts.map{|l,n| "#{n} #{l}s"}.join(', ') + ")\n"
+    end
+
+    #
+    def write(result, fname=nil)
+      if output.end_with?('/') || File.directory?(output)
+        ext  = EXTENSIONS[format] || format
+        file = File.join(output, fname || "notes.#{ext}")
+      else
+        file = output
+      end
+      if dryrun?
+        puts "mkdir: #{File.dirname(file)}"
+        puts "write: #{file}"
+      else
+        dir = File.dirname(file)
+        fu.mkdir(dir) unless File.exist?(dir)
+        File.open(file, 'w'){ |f| f << result }
+      end
+      return file
+    end
+
+    #
+    def dryrun?
+      @dryrun
+    end
+
+    #
+    def debug?
+      $DEBUG
+    end
+
+    #
+    def fu
+      @fu ||= (
+        if dryrun? and debug?
+          FileUtils::DryRun
+        elsif dryrun?
+          FileUtils::Noop
+        elsif debug?
+          FileUtils::Verbose
+        else
+          FileUtils
+        end
+      )
+    end
+
+    #
+    class ErbScope 
+      #
+      def initialize(data={})
+        @data = data
+      end
+      #
+      def render(file)
+        erb = ERB.new(File.read(file), nil, '<>')
+        erb.result(binding)
+      end
+      #
+      def h(string)
+        REXML::Text.normalize(string)
+      end
+      #
+      def method_missing(s, *a)
+        @data[s.to_sym]
+      end
+    end
+
+  end
+
+end
+

data/lib/dnote/notes.rb

@@ -1,35 +1,29 @@
-require 'rexml/text'
 require 'pathname'
-require 'erb'
 
 module DNote
 
   # = Developer Notes
   #
-  # This class goes through you source files and compiles
-  # an list of any labeled comments. Labels are single word
-  # prefixes to a comment ending in a colon.
+  # This class goes through you source files and compiles a list
+  # of any labeled comments. Labels are single word prefixes to
+  # a comment ending in a colon.
   #
-  # By default the labels supported are TODO, FIXME, OPTIMIZE and DEPRECATE.
+  # By default the labels supported are TODO, FIXME, OPTIMIZE
+  # and DEPRECATE.
   #
-  # Output is a set of files in XML and RDoc's simple
-  # markup format.
-  #
-  #   TODO: Add ability to read header notes. They oftern
+  #--
+  #   TODO: Add ability to read header notes. They often
   #         have a outline format, rather then the single line.
-  #
-  #   TODO: Need good CSS file.
-  #
-  #   TODO: Need XSL?
-  #
+  #++
   class Notes
+    include Enumerable
+
+    # Default paths (all ruby scripts).
+    DEFAULT_PATHS  = ["**/*.rb"]
 
     # Default note labels to look for in source code.
     DEFAULT_LABELS = ['TODO', 'FIXME', 'OPTIMIZE', 'DEPRECATE']
 
-    #
-    attr_accessor :title
-
     # Paths to search.
     attr_accessor :paths
 
@@ -37,23 +31,12 @@ module DNote
     attr_accessor :labels
 
     #
-    def initialize(paths, options={})
-      initialize_defaults
-      options.each do |k, v|
-        __send__("#{k}=", v)
-      end
-      #@paths = ['**/*.rb'] if @paths.empty?
+    def initialize(paths, labels=nil)
+      @paths  = [paths  || DEFAULT_PATHS ].flatten
+      @labels = [labels || DEFAULT_LABELS].flatten
       parse
     end
 
-    #
-    def initialize_defaults
-      @labels   = DEFAULT_LABELS
-      @paths    = ["**/*.rb"]
-      @title    = "Developer's Notes"
-      @format   = "rdoc"
-    end
-
     #
     def notes
       @notes
@@ -64,51 +47,14 @@ module DNote
       @counts
     end
 
-    # Scans source code for developer notes and writes them to
-    # well organized files.
     #
-    def display(format)
-      #paths    = self.paths
-      #output   = self.output
-
-      #parse
-
-      #paths  = paths.to_list
-
-      #labels = labels.split(',') if String === labels
-      #labels = [labels].flatten.compact
-
-      #records, counts = extract(labels, loadpath)
-      #records = organize(records)
-
-      #case format.to_s
-      #when 'rdoc', 'txt', 'text'
-      #  text = format_rd(records)
-      #else
-      #  text = format_xml(records)
-      #end
-
-      if notes.empty?
-        $stderr << "No #{labels.join(', ')} notes.\n"
-      else
-        #temp = templates.find{ |f| /#{format}$/ =~ f }
-        #erb  = ERB.new(File.read(temp))
-        #text = erb.result(binding)
-
-        text = __send__("to_#{format}")
+    def each(&block)
+      notes.each(&block)
+    end
 
-        #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
+    #
+    def empty?
+      notes.empty?
     end
 
     #
@@ -118,7 +64,7 @@ module DNote
         when String
           labels.split(/[:;,]/)
         else
-          labels = [labels].flatten.compact.uniq
+          labels = [labels].flatten.compact.uniq.map{ |s| s.to_s }
         end
       )
     end
@@ -164,7 +110,7 @@ module DNote
     #
     def files
       @files ||= (
-        self.paths.map do |path|
+        [self.paths].flatten.map do |path|
           if File.directory?(path)
             Dir.glob(File.join(path, '**/*'))
           else
@@ -219,107 +165,6 @@ module DNote
       __send__("to_#{format}")
     end
 
-    # Format notes in RDoc format.
-    #
-    def to_rdoc
-      out = []
-      out << "= Development Notes"
-      notes.each do |label, per_file|
-        out << %[\n== #{label}]
-        per_file.each do |file, line_notes|
-          out << %[\n=== file://#{file}\n]
-          line_notes.sort!{ |a,b| a[0] <=> b[0] }
-          line_notes.each do |line, note|
-            out << %[* #{note} (#{line})]
-          end
-        end
-      end
-      return out.join("\n")
-    end
-
-    # Format notes in RDoc format.
-    #
-    def to_markdown
-      out = []
-      out << "# Development Notes"
-      notes.each do |label, per_file|
-        out << %[\n## #{label}]
-        per_file.each do |file, line_notes|
-          out << %[\n### file://#{file}\n]
-          line_notes.sort!{ |a,b| a[0] <=> b[0] }
-          line_notes.each do |line, note|
-            out << %[* #{note} (#{line})]
-          end
-        end
-      end
-      return out.join("\n")
-    end
-
-    # Format notes in XML format.
-    #
-    def to_xml
-      xml = []
-      xml << "<notes>"
-      notes.each do |label, per_file|
-        xml << %[<set label="#{label}">]
-        per_file.each do |file, line_notes|
-          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 << %[<note line="#{line}" type="#{label}">#{note}</note>]
-          end
-          xml << %[</file>]
-        end
-        xml << %[</set>]
-      end
-      xml << "</notes>"
-      return xml.join("\n")
-    end
-
-    # HTML format.
-    #
-    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 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'
@@ -328,68 +173,27 @@ module DNote
 
     #
     def to_json
-      require 'json'  # TODO: fallback to json_pure
+      begin
+        require 'json'
+      rescue LoadError
+        require 'json_pure'
+      end
       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
+    # Soap envelope XML.
+    def to_soap
+      require 'soap/marshal'
+      SOAP::Marshal.marshal(notes)
+    end
+
+    # XOXO microformat.
+    def to_xoxo
+      require 'xoxo'
+      notes.to_xoxo
+    end
 
   end
 
 end
 
-  #     out = ''
-  #
-  #     case format
-  #     when 'yaml'
-  #       out << records.to_yaml
-  #     when 'list'
-  #       records.each do |record|
-  #         out << "* #{record['note']}\n"
-  #       end
-  #     else #when 'rdoc'
-  #       labels.each do |label|
-  #         recs = records.select{ |r| r['label'] == label }
-  #         next if recs.empty?
-  #         out << "\n= #{label}\n"
-  #         last_file = nil
-  #         recs.sort!{ |a,b| a['file'] <=> b['file'] }
-  #         recs.each do |record|
-  #           if last_file != record['file']
-  #             out << "\n"
-  #             last_file = record['file']
-  #             out << "file://#{record['file']}\n"
-  #           end
-  #           out << "* #{record['note'].rstrip} (#{record['line']})\n"
-  #         end
-  #       end
-  #       out << "\n---\n"
-  #       out << counts.collect{|l,n| "#{n} #{l}s"}.join(' ')
-  #       out << "\n"
-  #     end
-
-  #     # List TODO notes. Same as notes --label=TODO.
-  #
-  #     def todo( options={} )
-  #       options = options.to_openhash
-  #       options.label = 'TODO'
-  #       notes(options)
-  #     end
-  #
-  #     # List FIXME notes.  Same as notes --label=FIXME.
-  #
-  #     def fixme( options={} )
-  #       options = options.to_openhash
-  #       options.label = 'FIXME'
-  #       notes(options)
-  #     end
-

data/lib/dnote/site.rb

@@ -4,13 +4,13 @@ module DNote
 
   # 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
+  # Additional +formats+ can be saved to the directory
   # as well.
 
   class Site
 
-    # Default output directory is +dnote/+.
-    DEFAULT_OUTPUT = Pathname.new('dnote')
+    # Default output directory is +log/dnote/+.
+    DEFAULT_OUTPUT = Pathname.new('log/dnote')
 
     # Title to use in any headers.
     attr_accessor :title
@@ -18,17 +18,19 @@ module DNote
     # Directory to save output.
     attr_accessor :output
 
-    # Additional Formats to supply besided the html (xml, rdoc, markdown, etc.)
+    # Additional Formats to supply besides the html (xml, rdoc, markdown, etc.)
     attr_accessor :formats
 
     # Notes object.
     attr_reader :notes
 
     def initialize(paths, options)
-      self.title   = options[:title]
+      initialize_defaults
 
-      self.output  = options.delete(:output)
-      self.formats = options.delete(:formats)
+      self.title   = options[:title]          if options[:title]
+
+      self.output  = options.delete(:output)  if options[:output]
+      self.formats = options.delete(:formats) if options[:formats]
 
       @notes = Notes.new(paths, options)
     end
@@ -37,7 +39,7 @@ module DNote
     def initialize_defaults
       @output   = DEFAULT_OUTPUT
       @title    = "Development Notes"
-      @formats  = []
+      @formats  = ['html']
     end
 
     #
@@ -50,19 +52,27 @@ module DNote
     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|
+=begin
+        tdir = tempdir(format)
+
+        # copy non-erb files
+        files = Dir.entries(tdir) - ['.', '..']
+        files = files.reject{ |file| File.extname(file) == '.erb' }
+        files.each do |file|
+          dest = File.dirname(file).sub(tdir, '')
+          fu.cp_r(File.join(tdir, file), output)
+        end
+
+        # write the erb templates
+        templates(format).each do |temp|
+          file = File.join(tdir, temp)
+          erb  = ERB.new(File.read(file))
+          text = erb.result(binding)
+          write(temp.chomp('.erb'), text)
+        end
+=end
         text = notes.to(format)
         write("notes.#{format}", text)
       end
@@ -85,10 +95,17 @@ module DNote
     end
 
     #
-    def templates
-      @templates ||= (
-        Dir[File.join(File.dirname(__FILE__), 'template/*')].select{ |f| File.file?(f) }
-      )
+    tempdir(format)
+      "#{__DIR__}/templates/#{format}"
+    end
+
+    # TODO: Don't use chdir.
+    def templates(format)
+      temps = []
+      Dir.chdir(tempdir(format)) do
+        temps = Dir['**/*.erb']
+      end
+      temps
     end
 
     # Save file to output.

data/lib/dnote/templates/gnu.erb

@@ -0,0 +1,8 @@
+<%= title %>
+
+<% notes.each do |label, per_file| %>
+    <%= label %>:
+<%   per_file.each do |file, line_notes| %>
+<% line_notes.sort!{ |a,b| a[0] <=> b[0] } %><% line_notes.each do |line, note| %>
+        * <%= note %> (<%= file %>:<%= line %>)
+<% end; end; end %>

data/lib/dnote/templates/html.erb

@@ -0,0 +1,41 @@
+<html>
+<head>
+  <title><%= title %></title>
+  <style>
+    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; }
+  </style>
+  <link rel="stylesheet" href="notes.css" type="text/css">
+</head>
+<body>
+<div class="main">
+  <h1><%= title %></h1>
+  <div class="notes">
+<% notes.each do |label, per_file| %>
+    <h2><%= label %></h2>
+    <ol class="set <%= label.downcase %>">
+<% per_file.each do |file, line_notes| %>
+      <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| %>
+        <li class="note <%= label.downcase %>" ref="<%= line %>"><%= h note %> <sup><%= line %></sup></li>
+<% end %>
+      </ol></li>
+<% end %>
+    </ol>
+<% end %>
+  </div>
+</div>
+</body>
+</html>

data/lib/dnote/templates/markdown.erb

@@ -0,0 +1,11 @@
+# <%= title %><% notes.each do |label, per_file| %>
+
+## <%= label %>
+<%   per_file.each do |file, line_notes| %>
+
+### file://<%= file %>
+
+<% line_notes.sort!{ |a,b| a[0] <=> b[0] } %><% line_notes.each do |line, note| %>
+* <%= note %> (<%= line %>)
+<% end; end; end %>
+

data/lib/dnote/templates/rdoc.erb

@@ -0,0 +1,11 @@
+= <%= title %><% notes.each do |label, per_file| %>
+
+== <%= label %>
+<%   per_file.each do |file, line_notes| %>
+
+=== file://<%= file %>
+
+<% line_notes.sort!{ |a,b| a[0] <=> b[0] } %><% line_notes.each do |line, note| %>
+* <%= note %> (<%= line %>)
+<% end; end; end %>
+

data/lib/dnote/templates/xml.erb

@@ -0,0 +1,15 @@
+<?xml version="1.0" ?>
+<notes>
+<% notes.each do |label, per_file| %>
+    <set label="<%= label %>">
+<% per_file.each do |file, line_notes| %>
+        <file src="<%= file %>">
+<% line_notes.sort!{ |a,b| a[0] <=> b[0] } %>
+<% line_notes.each do |line, note| %>
+            <note line="<%= line %>" type="<%= label %>"><%= h note %></note>
+<% end %>
+        </file>
+<% end %>
+    </set>
+<% end %>
+</notes>

data/{plug/syckle/services → lib/plugins/syckle}/dnote.rb

@@ -26,7 +26,8 @@ module Syckle::Plugins
     # not that this is necessary, but ...
     available do |project|
       begin
-        require 'dnote/site'
+        require 'dnote'
+        require 'dnote/format'
         true
       rescue LoadError
         false
@@ -35,11 +36,11 @@ module Syckle::Plugins
 
     # autorun if log/notes exists
     autorun do |project|
-      (project.log + 'notes').exist?
+      (project.log + 'dnote').exist?
     end
 
     # Default note labels to looked for in source code.
-    DEFAULT_LABELS = ['TODO', 'FIXME', 'OPTIMIZE', 'DEPRECATE']
+    #DEFAULT_LABELS = ['TODO', 'FIXME', 'OPTIMIZE', 'DEPRECATE']
 
     # Paths to search.
     attr_accessor :files
@@ -47,51 +48,71 @@ module Syckle::Plugins
     # 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.
+    # Output directory to save notes file. Defaults to <tt>dnote/</tt> under
+    # the project log directory (eg. <tt>log/dnote/</tt>).
     attr_accessor :output
 
     # Formats (xml, html, rdoc).
     attr_accessor :formats
 
+    # Title to use if temaplte can use it.
+    attr_accessor :title
+
     #
     def output=(path)
       @output = Pathname.new(path)
     end
 
     #
-    def dnote
-      @dnote ||= ::DNote::Site.new(files, :labels=>labels, :formats=>formats, :output=>output)
-    end
+    #def dnote
+    #  @dnote ||= ::DNote::Site.new(files, :labels=>labels, :formats=>formats, :output=>output)
+    #end
 
     # Generate notes documents.
+    #--
+    # TODO: Is #trial? correct?
+    #++
     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+'/','')}"
+      notes = ::DNote::Notes.new(files, labels)
+      [formats].flatten.each do |format|
+        if format == 'index'
+          format = 'html'
+          output = File.join(self.output, 'index.html')
+        end
+        format = ::DNote::Format.new(notes, :format=>format, :output=>output.to_s, :title=>title, :dryrun=>trial?)
+        format.render
+        report "Updated #{output.to_s.sub(Dir.pwd+'/','')}" unless trial?
+      end
     end
 
-    # Mark notes documents as out-of-date.
+    # Reset output directory, marking it as out-of-date.
     def reset
-      #dnote.reset
+      if File.directory?(output)
+        File.utime(0,0,output) unless $NOOP
+        puts "Marked #{output}"
+      end
     end
 
-    # Remove notes directory.
+    # Remove output files.
     def clean
-      #dnote.clean
+      if File.directory?(output)
+        formats.each do |format|
+          ext = ::DNote::Format::EXTENSIONS[format] || format
+          file = (output + "notes.#{ext}").to_s
+          rm(file)
+          report "Removed #{output}"
+        end
+      end
     end
 
   private
 
-    # TODO: maybe files default of **/*.rb is better?
+    #
     def initialize_defaults
-      @files   = metadata.loadpath || 'lib'
+      @files   = "**/*.rb"
       @output  = project.log + 'dnote'
-      @formats = []
-      @labels  = DEFAULT_LABELS
+      @formats = ['index']
+      @labels  = nil #DEFAULT_LABELS
     end
 
   end

data/meta/released

@@ -1 +1 @@
-2009-10-06
+2010-02-06

data/meta/suite

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

data/meta/version

@@ -1 +1 @@
-1.0
+1.1

data/test/cases/notes_case.rb

@@ -0,0 +1,55 @@
+require 'dnote/notes'
+
+Case DNote::Notes do
+
+  Concern "Full coverage of DNote::Notes class."
+
+  Unit :paths
+
+  Unit :labels => 'returns the list of labels' do
+    notes = DNote::Notes.new([])
+    notes.labels.assert == DNote::Notes::DEFAULT_LABELS
+  end
+
+  Unit :labels= => 'changes the list of labels' do
+    notes = DNote::Notes.new([])
+    notes.labels = [:CHOICE]
+    notes.labels.assert == ['CHOICE']
+  end
+
+  Unit :paths => 'returns the paths attribute' do
+    notes = DNote::Notes.new(["example1.rb"])
+    notes.assert.paths == ["example1.rb"]
+    notes = DNote::Notes.new([], :paths => ["example2.rb"])
+    notes.assert.paths == ["example2.rb"]
+  end
+
+  Unit :paths= => 'changes the paths attribute' do
+    notes = DNote::Notes.new([])
+    notes.paths = ["example1.rb"]
+    notes.assert.paths == ["example1.rb"]
+  end
+
+  Unit :files
+
+  Unit :match_arbitrary => '' do
+    notes = DNote::Notes.new([])
+    line, lineno, file = "# TODO: Do something or another!", 1, "foo.rb"
+    rec = notes.match_arbitrary(line, lineno, file)
+    rec.assert == {'label'=>"TODO",'file'=>file,'line'=>lineno,'note'=>"Do something or another!"}
+  end
+
+  Unit :match_common
+  Unit :to_xml
+  Unit :notes
+  Unit :to
+  Unit :initialize_defaults
+  Unit :parse
+  Unit :to_yaml
+  Unit :to_json
+  Unit :counts
+  Unit :organize
+  Unit :display
+
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dnote
 version: !ruby/object:Gem::Version 
-  version: "1.0"
+  version: "1.1"
 platform: ruby
 authors: []
 
@@ -9,21 +9,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-25 00:00:00 -04:00
+date: 2010-02-06 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
 description: ""
-email: http://googlegroups.com/group/proutils
+email: 
 executables: 
 - dnote
 extensions: []
 
-extra_rdoc_files: 
-- MANIFEST
-- LICENSE
-- README.rdoc
-- HISTORY
+extra_rdoc_files: []
+
 files: 
 - HISTORY
 - LICENSE
@@ -32,19 +29,25 @@ files:
 - bin/dnote
 - lib/dnote.rb
 - lib/dnote/command.rb
+- lib/dnote/format.rb
 - lib/dnote/notes.rb
 - lib/dnote/site.rb
-- lib/dnote/template/index.html
+- lib/dnote/templates/gnu.erb
+- lib/dnote/templates/html.erb
+- lib/dnote/templates/markdown.erb
+- lib/dnote/templates/rdoc.erb
+- lib/dnote/templates/xml.erb
+- lib/plugins/syckle/dnote.rb
 - meta/account
 - meta/contact
-- meta/loadpath
-- meta/project
+- meta/name
 - meta/released
 - meta/repository
+- meta/suite
 - meta/summary
 - meta/title
 - meta/version
-- plug/syckle/services/dnote.rb
+- test/cases/notes_case.rb
 has_rdoc: true
 homepage: 
 licenses: []
@@ -55,7 +58,6 @@ rdoc_options:
 - D'Note API
 require_paths: 
 - lib
-- plug
 required_ruby_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="

data/lib/dnote/template/index.html

@@ -1,32 +0,0 @@
-<html>
-<head>
-  <title><%= title %></title>
-  <style>
-    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; }
-  </style>
-</head>
-<body>
-
-<div class="main">
-
-<h1><%= title %></h1>
-
-<%= notes.to_html_list %>
-
-</div>
-
-</boby>
-</html>
-

data/meta/loadpath

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