dnote 1.2.1 → 1.3.0

data/PROFILE

@@ -0,0 +1,23 @@
+--- 
+title  : DNote
+suite  : proutils
+summary: Extract developer's notes from source code
+contact: trans <transfire@gmail.com>
+created: 2009-10-09
+authors: Thomas Sawyer
+
+description:
+  Dnote makes it easy to extract developer's
+  notes from source code, and supports almost
+  any language.
+
+resources:
+  home: http://proutils.github.com/dnote
+  code: http://github.com/proutils/dnote
+  wiki: http://wiki.github.com/proutils/dnote
+  api : http://proutils.github.com/dnote/rdoc
+  mail: http://groups.google.com/group/proutils
+  repo: git://github.com/proutils/dnote.git
+
+copyright: Copyright (c) 2009 Thomas Sawyer
+

data/REQUIRE

@@ -0,0 +1,6 @@
+development:
+  - syckle
+
+development/test:
+  - lemon
+

data/VERSION

@@ -0,0 +1,5 @@
+name : dnote
+major: 1
+minor: 3
+patch: 0
+date : 2010-06-04

data/lib/dnote/notes.rb

@@ -34,11 +34,15 @@ module DNote
     # Require label colon? Default is +true+.
     attr_accessor :colon
 
+    # Alternate remark marker. Default is '#'.
+    attr_accessor :marker
+
     # New set of notes for give +files+ and optional special labels.
     def initialize(files, options={})
       @files  = [files].flatten
-      @labels = [options[:labels]].flatten.compact
+      @labels = [options[:labels] || DEFAULT_LABELS].flatten.compact
       @colon  = options[:colon].nil? ? true : options[:colon]
+      @marker = options[:marker] || '#'
       parse
     end
 
@@ -89,14 +93,15 @@ module DNote
               records << save
             else
               if text
-                if line =~ /^\s*[#]{0,1}\s*$/ or line !~ /^\s*#/ or line =~ /^\s*#[+][+]/
+                case line
+                when /^\s*#{remark}+\s*$/, /(?!^\s*#{remark})/, /^\s*#{remark}[+][+]/
                   text.strip!
                   text = nil
                 else
                   if text[-1,1] == "\n"
-                    text << line.gsub(/^\s*#\s*/,'')
+                    text << line.gsub(/^\s*#{remark}\s*/,'')
                   else
-                    text << "\n" << line.gsub(/^\s*#\s*/,'')
+                    text << "\n" << line.gsub(/^\s*#{remark}\s*/,'')
                   end
                 end
               end
@@ -135,9 +140,9 @@ module DNote
     #++
     def match_special_regex(label)
       if colon
-        /\#\s*#{Regexp.escape(label)}[:]\s*(.*?)$/
+        /#{remark}\s*#{Regexp.escape(label)}[:]\s*(.*?)$/
       else
-        /\#\s*#{Regexp.escape(label)}[:]?\s*(.*?)$/
+        /#{remark}\s*#{Regexp.escape(label)}[:]?\s*(.*?)$/
       end
     end
 
@@ -155,9 +160,9 @@ module DNote
     #
     def match_general_regex
       if colon
-        /\#\s*([A-Z]+)[:]\s+(.*?)$/
+        /#{remark}\s*([A-Z]+)[:]\s+(.*?)$/
       else
-        /\#\s*([A-Z]+)[:]?\s+(.*?)$/
+        /#{remark}\s*([A-Z]+)[:]?\s+(.*?)$/
       end
     end
 
@@ -227,6 +232,11 @@ module DNote
       by_label
     end
 
+    #
+    def remark
+      @remark ||= Regexp.escape(marker)
+    end
+
     # Convert to array of hashes then to YAML.
     #def to_yaml
     #  require 'yaml'

data/lib/dnote/session.rb

@@ -37,6 +37,9 @@ module DNote
     # Selected labels can optionally do without the colon.
     attr_accessor :colon
 
+    # Alternate remark marker. Useful to other languages besides Ruby.
+    attr_accessor :marker
+
     # Output format.
     attr_accessor :format
 
@@ -72,6 +75,7 @@ module DNote
       @format  = DEFAULT_FORMAT
       @title   = DEFAULT_TITLE
       @dryrun  = false
+      @marker  = '#'
     end
 
   public
@@ -88,7 +92,7 @@ module DNote
 
     # Run session.
     def run
-      notes = Notes.new(files, :labels=>labels, :colon=>colon)
+      notes = Notes.new(files, :labels=>labels, :colon=>colon, :marker=>marker)
       formatter = Format.new(notes) do |f|
         f.format   = format
         f.template = template
@@ -151,41 +155,9 @@ module DNote
         opt.separator(" ")
         opt.separator("OUTPUT FORMAT: (choose one)")
 
-        #opt.on("--default", "Plain text format (default)") do
-        #  session.format = 'label'
-        #end
-
-        #opt.on("--yaml", "YAML serialization format") do
-        #  session.format = 'yaml'
-        #end
-
-        #opt.on("--json", "JSON serialization format") do
-        #  session.format = 'json'
-        #end
-
-        #opt.on("--soap", "SOAP XML envelope format") do
-        #  session.format = 'soap'
-        #end
-
-        #opt.on("--xoxo", "XOXO microformat format") do
-        #  session.format = 'xoxo'
-        #end
-
-        #opt.on("--xml", "XML markup format") do
-        #  session.format = 'xml'
-        #end
-
-        #opt.on("--html", "HTML markup format") do
-        #  session.format = 'html'
-        #end
-
-        #opt.on("--rdoc", "rdoc comment format") do
-        #  session.format = 'rdoc'
-        #end
-
-        #opt.on("--markdown", "markdown wiki format") do
-        #  session.format = 'md'
-        #end
+        opt.on("--marker", '-m MARK', "Alternative remark marker") do |mark|
+           session.marker = mark 
+        end
 
         opt.on("--format", "-f NAME", "select a format [text]") do |format|
           session.format = format

data/lib/plugins/rake/task.rb

@@ -0,0 +1,113 @@
+# = Developmer's Notes Rake Task
+#
+class DNoteTask < Rake::TaskLib
+
+  require 'rake/clean'
+
+  # Default note labels to looked for in source code.
+  DEFAULT_LABELS = ['TODO', 'FIXME', 'OPTIMIZE', 'DEPRECATE']
+
+  # File paths to search.
+  attr_accessor :files
+
+  # Labels to document. Defaults are: TODO, FIXME, OPTIMIZE and DEPRECATE.
+  attr_accessor :labels
+
+  # Formats (xml, html, rdoc, rdoc/list and so on).
+  attr_accessor :formats
+
+  # Exclude paths.
+  attr_accessor :exclude
+
+  # Ignore paths based on any part of pathname.
+  attr_accessor :ignore
+
+  # Output directory to save notes file. Defaults to <tt>dnote/</tt> under
+  # the project log directory (eg. <tt>log/dnote/</tt>).
+  attr_accessor :output
+
+  # Title to use if temaplte can use it.
+  attr_accessor :title
+
+  #
+  def output=(path)
+    @output = Pathname.new(path)
+  end
+
+  #
+  def init
+    require 'dnote'
+    require 'dnote/format'
+    @files   = "**/*.rb"
+    @output  = 'log/dnote'
+    @formats = ['index']
+    @labels  = nil #DEFAULT_LABELS
+  end
+
+  #
+  def define
+    desc "Collect Developer's Notes"
+    task 'dnote' do
+      document
+    end
+    task 'dnote:clobber' do
+      clean
+    end
+    task :clobber => ['dnote:clobber']
+  end
+
+  # Generate notes document(s).
+  def document
+    abort "dnote: #{output} is not a directory" unless output.directory?
+
+    session = ::DNote::Session.new do |s|
+      s.paths   = files
+      s.exclude = exclude
+      s.ignore  = ignore
+      s.labels  = labels #|| DEFAULT_LABELS   
+      s.title   = title
+      s.output  = output
+      s.dryrun  = application.options.dryrun #trial?
+    end
+
+    formats.each do |format|
+      if format == 'index'
+        session.format = 'html'
+        session.output = File.join(self.output, 'index.html')
+      else
+        session.format = format
+      end
+      session.run
+      report "Updated #{output.to_s.sub(Dir.pwd+'/','')}" unless trial?
+    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} as out-of-date"
+    #end
+  end
+
+  # Remove output files.
+  def clean
+    #if File.directory?(output)
+      formats.each do |format|
+        if format == 'index'
+          file = (output + "index.html").to_s
+        else
+          ext = ::DNote::Format::EXTENSIONS[format] || format
+          file = (output + "notes.#{ext}").to_s
+        end
+        rm(file)
+        report "Removed #{output}"
+      end
+    #else
+    #  rm(output)
+    #  report "Removed #{output}"
+    #end
+  end
+
+end
+

data/lib/plugins/syckle/dnote.rb

@@ -34,10 +34,10 @@ module Syckle::Plugins
       end
     end
 
-    # autorun if log/notes exists
-    autorun do |project|
-      (project.log + 'dnote').exist?
-    end
+    ## autorun if log/notes exists
+    #autorun do |project|
+    #  (project.log + 'dnote').exist?
+    #end
 
     # Default note labels to looked for in source code.
     DEFAULT_LABELS = ['TODO', 'FIXME', 'OPTIMIZE', 'DEPRECATE']

data/test/{cases/notes_case.rb → notes_case.rb}

@@ -2,7 +2,7 @@ require 'dnote/notes'
 
 Case DNote::Notes do
 
-  Concern "Basic coverage of DNote::Notes class."
+  Concern "Coverage of DNote::Notes class."
 
   Unit :labels => 'returns the list of labels' do
     notes = DNote::Notes.new([], :labels=>['TODO'])

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 1
-  - 2
-  - 1
-  version: 1.2.1
+  - 3
+  - 0
+  version: 1.3.0
 platform: ruby
 authors: 
 - Thomas Sawyer
@@ -14,18 +14,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-20 00:00:00 -05:00
+date: 2010-06-04 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
-description: ""
-email: 
+description: Dnote makes it easy to extract developer's notes from source code, and supports almost any language.
+email: transfire@gmail.com
 executables: 
 - dnote
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- README.rdoc
 files: 
 - bin/dnote
 - lib/dnote/format.rb
@@ -70,21 +70,15 @@ files:
 - lib/dnote/templates/yaml/list.erb
 - lib/dnote/templates/yaml.erb
 - lib/dnote.rb
+- lib/plugins/rake/task.rb
 - lib/plugins/syckle/dnote.rb
-- meta/account
-- meta/authors
-- meta/contact
-- meta/name
-- meta/released
-- meta/repository
-- meta/suite
-- meta/summary
-- meta/title
-- meta/version
-- test/cases/notes_case.rb
+- test/notes_case.rb
+- PROFILE
 - LICENSE
 - README.rdoc
 - HISTORY
+- REQUIRE
+- VERSION
 has_rdoc: true
 homepage: 
 licenses: []
@@ -92,7 +86,9 @@ licenses: []
 post_install_message: 
 rdoc_options: 
 - --title
-- D'Note API
+- DNote API
+- --main
+- README.rdoc
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -112,9 +108,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: dnote
-rubygems_version: 1.3.6.pre.3
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
-summary: Extract developer notes from source code.
+summary: Extract developer's notes from source code
 test_files: []
 

data/meta/account

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

data/meta/authors

@@ -1 +0,0 @@
-Thomas Sawyer

data/meta/contact

@@ -1 +0,0 @@
-http://googlegroups.com/group/proutils

data/meta/name

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

data/meta/released

@@ -1 +0,0 @@
-2010-02-06

data/meta/repository

@@ -1 +0,0 @@
-git://github.com/proutils/dnote.git

data/meta/suite

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

data/meta/summary

@@ -1 +0,0 @@
-Extract developer notes from source code.

data/meta/title

@@ -1 +0,0 @@
-D'Note

data/meta/version

@@ -1 +0,0 @@
-1.2.1