dnote 1.4.0 → 1.6.0

data/lib/dnote/notes.rb

@@ -34,16 +34,26 @@ module DNote
     # Require label colon? Default is +true+.
     attr_accessor :colon
 
-    # Alternate remark marker. Default is '#'.
+    # Specific remark marker (+nil+ for auto).
     attr_accessor :marker
 
+    # Link template.
+    attr_accessor :url
+
+    # Number of lines of context to show.
+    attr_accessor :context
+
     # New set of notes for give +files+ and optional special labels.
     def initialize(files, options={})
-      @files  = [files].flatten
-      @labels = [options[:labels] || DEFAULT_LABELS].flatten.compact
-      @colon  = options[:colon].nil? ? true : options[:colon]
-      @marker = options[:marker] #|| '#'
-      @remark = {}
+      @files   = [files].flatten
+      @labels  = [options[:labels] || DEFAULT_LABELS].flatten.compact
+      @colon   = options[:colon].nil? ? true : options[:colon]
+      @marker  = options[:marker] #|| '#'
+      @url     = options[:url]
+      @context = options[:context] || 0
+
+      @remark  = {}
+
       parse
     end
 
@@ -75,7 +85,7 @@ module DNote
 
     # Gather notes.
     #--
-    # TODO: Play gold with Notes#parse.
+    # TODO: Play golf with Notes#parse.
     #++
     def parse
       records = []
@@ -83,39 +93,47 @@ module DNote
         next unless File.file?(fname)
         #next unless fname =~ /\.rb$/      # TODO: should this be done?
         mark = remark(fname)
-        File.open(fname) do |f|
-          lineno, save, text = 0, nil, nil
-          while line = f.gets
+        lineno, note, text, capt = 0, nil, nil, nil
+        File.readlines(fname).each do |line|
+          #while line = f.gets
             lineno += 1
-            save = match(line, lineno, fname)
-            if save
+            note = match(line, lineno, fname)
+            if note
               #file = fname
-              text = save.text
-              #save = {'label'=>label,'file'=>file,'line'=>line_no,'note'=>text}
-              records << save
+              text = note.text
+              capt = note.capture
+              #note = {'label'=>label,'file'=>file,'line'=>line_no,'note'=>text}
+              records << note
             else
               if text
                 case line
-                when /^\s*#{mark}+\s*$/, /(?!^\s*#{mark})/, /^\s*#{mark}[+][+]/
+                when /^\s*#{mark}+\s*$/, /^\s*#{mark}\-\-/, /^\s*#{mark}\+\+/
                   text.strip!
                   text = nil
-                else
+                when /^\s*#{mark}/
                   if text[-1,1] == "\n"
                     text << line.gsub(/^\s*#{mark}\s*/,'')
                   else
                     text << "\n" << line.gsub(/^\s*#{mark}\s*/,'')
                   end
+                else
+                  text.strip!
+                  text = nil
+                end
+              else
+                if line !~ /^\s*#{mark}/
+                  capt << line if capt && capt.size < context
                 end
               end
             end
-          end
+          #end
         end
       end
 
       @notes  = records.sort
     end
 
-    #
+    # Is this line a note?
     def match(line, lineno, file)
       if labels.empty?
         match_general(line, lineno, file)
@@ -131,7 +149,7 @@ module DNote
         if md = match_special_regex(label, file).match(line)
           text = md[1]
           #rec = {'label'=>label,'file'=>file,'line'=>lineno,'note'=>text}
-          rec = Note.new(file, label, lineno, text)
+          rec = Note.new(self, file, label, lineno, text, remark(file))
         end
       end
       rec
@@ -143,9 +161,9 @@ module DNote
     def match_special_regex(label, file)
       mark = remark(file)
       if colon
-        /#{mark}\s*#{Regexp.escape(label)}[:]\s*(.*?)$/
+        /#{mark}\s*#{Regexp.escape(label)}[:]\s+(.*?)$/
       else
-        /#{mark}\s*#{Regexp.escape(label)}[:]?\s*(.*?)$/
+        /#{mark}\s*#{Regexp.escape(label)}[:]?\s+(.*?)$/
       end
     end
 
@@ -155,18 +173,19 @@ module DNote
       if md = match_general_regex(file).match(line)
         label, text = md[1], md[2]
         #rec = {'label'=>label,'file'=>file,'line'=>lineno,'note'=>text}
-        rec = Note.new(file, label, lineno, text)
+        rec = Note.new(self, file, label, lineno, text, remark(file))
       end
       return rec
     end
 
-    #
+    # Keep in mind that general non-colon matches have a higher potential
+    # of false positives.
     def match_general_regex(file)
       mark = remark(file)
       if colon
         /#{mark}\s*([A-Z]+)[:]\s+(.*?)$/
-      else
-        /#{mark}\s*([A-Z]+)[:]?\s+(.*?)$/
+      else 
+        /#{mark}\s*([A-Z]+)\s+(.*?)$/
       end
     end
 

data/lib/dnote/session.rb

@@ -26,10 +26,10 @@ module DNote
     attr_accessor :paths
 
     # Paths to exclude (match by pathname).
-    attr_accessor :exclude
+    attr_reader :exclude
 
     # Paths to ignore (match by basename).
-    attr_accessor :ignore
+    attr_reader :ignore
 
     # Labels to lookup.
     # By default these are TODO, FIXME and OPTIMIZE.
@@ -57,6 +57,16 @@ module DNote
     # If output path given, don't actually write to disk.
     attr_accessor :dryrun
 
+    # String template for line URLs (mainly for HTML format). For example,
+    # DNote uses GitHub so we could use a link template:
+    # 
+    #   "https://github.com/rubyworks/dnote/blob/master/%s#L%s"
+    #
+    attr_accessor :url
+
+    # Number of lines of context to display. The default is zero.
+    attr_accessor :context
+
   private
 
     # New Session.
@@ -77,6 +87,8 @@ module DNote
       @title   = DEFAULT_TITLE
       @dryrun  = false
       @marker  = nil
+      @url     = nil
+      @context = 0
     end
 
   public
@@ -93,7 +105,7 @@ module DNote
 
     # Run session.
     def run
-      notes = Notes.new(files, :labels=>labels, :colon=>colon, :marker=>marker)
+      notes = Notes.new(files, :labels=>labels, :colon=>colon, :marker=>marker, :url=>url, :context=>context)
       formatter = Format.new(notes) do |f|
         f.format   = format
         f.template = template
@@ -147,7 +159,6 @@ module DNote
       session = Session.new
 
       opts = OptionParser.new do |opt|
-
         opt.banner = "DNote v#{DNote::VERSION}"
 
         opt.separator(" ")
@@ -184,10 +195,18 @@ module DNote
           session.colon = val
         end
 
-        opt.on("--marker", '-m MARK', "Alternative remark marker") do |mark|
+        opt.on("--marker", "-m MARK", "alternative remark marker") do |mark|
            session.marker = mark 
         end
 
+        opt.on("--url", "-u TEMPLATE", "url template for line entries (for HTML)") do |url|
+           session.url = url
+        end
+
+        opt.on("--context", "-c INTEGER", "number of lines of context to display") do |int|
+           session.context = int.to_i
+        end
+
         opt.on("--exclude", "-x PATH", "exclude file or directory") do |path|
           session.exclude << path
         end
@@ -222,7 +241,7 @@ module DNote
           tnames = tfiles.map{ |tname| tname.sub(tdir+'/', '').chomp('.erb') }
           groups = tnames.group_by{ |tname| tname.split('/').first }
           groups.sort.each do |(type, names)|
-            puts("%-18s " * names.size) % names.sort
+            puts("%-18s " * names.size % names.sort)
           end
           exit
         end

data/lib/dnote/templates/html.erb

@@ -2,19 +2,20 @@
 <head>
   <title><%= title %></title>
   <style>
-    body { margin: 0; padding: 0; }
+    body { margin: 0; padding: 0; font-size: 0.8em; }
     .main {
       width: 800px;
       margin: 0 auto;
-      border: 1px solid #ccc;
+      border: 0px 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; }
+    h1 { margin: 25px 0; font-size: 3em; }
+    h2,h3,h4 { margin: 5px 0; padding: 0; color: #444; }
+    h2 { letter-spacing: 2px; border-top: 4px solid #ddd; padding: 5px 0; }
     ul { margin: 0; padding: 0; text-align: left; }
     li { margin: 0; padding: 0; text-align: left; }
+     a { color: #4488ff; }
+   sup { font-size: 0.8em; }
   </style>
   <link rel="stylesheet" href="notes.css" type="text/css">
 </head>
@@ -23,13 +24,20 @@
   <h1><%= title %></h1>
   <div class="notes">
 <% notes.by_label_file.each do |label, per_file| %>
-    <h2><%= label %></h2>
+    <h2 class="<%= label %>"><%= 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.line <=> b.line } %>
 <% line_notes.each do |note| %>
-        <li class="note <%= label.downcase %>" ref="<%= note.line %>"><%= h note.text %> <sup><%= note.line %></sup></li>
+        <li class="note <%= label.downcase %>" ref="<%= note.line %>">
+          <%= h note.text %> <sup><a href="<%= note.url %>"><%= note.line %></a></sup>
+<% if note.code? %>
+<pre>
+<%= note.code %>
+</pre>
+<% end %>
+        </li>
 <% end %>
       </ol></li>
 <% end %>

data/lib/dnote/templates/html/file.erb

@@ -2,19 +2,20 @@
 <head>
   <title><%= title %></title>
   <style>
-    body { margin: 0; padding: 0; }
+    body { margin: 0; padding: 0; font-size: 0.8em; }
     .main {
       width: 800px;
       margin: 0 auto;
-      border: 1px solid #ccc;
+      border: 0px 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; }
+    h1 { margin: 25px 0; font-size: 3em; }
+    h2,h3,h4 { margin: 5px 0; padding: 0; color: #444; }
+    h2 { letter-spacing: 2px; border-top: 4px solid #ddd; padding: 5px 0; }
     ul { margin: 0; padding: 0; text-align: left; }
     li { margin: 0; padding: 0; text-align: left; }
+     a { color: #4488ff; }
+   sup { font-size: 0.8em; }
   </style>
   <link rel="stylesheet" href="notes.css" type="text/css">
 </head>
@@ -28,7 +29,14 @@
 <% per_label.each do |label, lnotes| %>
       <li><h3><%= label %></h3><ol class="label">
 <% lnotes.each do |note| %>
-        <li class="note <%= label.downcase %>" ref="<%= note.line %>"><%= h note.textline %> <sup><%= note.line %></sup></li>
+        <li class="note <%= label.downcase %>" ref="<%= note.line %>">
+          <%= h note.textline %> <sup><a href="<%= note.url %>"><%= note.line %></a></sup>
+<% if note.code? %>
+<pre>
+<%= note.code %>
+</pre>
+<% end %>
+        </li>
 <% end %>
       </ol></li>
 <% end %>

data/lib/dnote/templates/html/label.erb

@@ -2,19 +2,20 @@
 <head>
   <title><%= title %></title>
   <style>
-    body { margin: 0; padding: 0; }
+    body { margin: 0; padding: 0; font-size: 0.8em; }
     .main {
       width: 800px;
       margin: 0 auto;
-      border: 1px solid #ccc;
+      border: 0px 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; }
+    h1 { margin: 25px 0; font-size: 3em; }
+    h2,h3,h4 { margin: 5px 0; padding: 0; color: #444; }
+    h2 { letter-spacing: 2px; border-top: 4px solid #ddd; padding: 5px 0; }
     ul { margin: 0; padding: 0; text-align: left; }
     li { margin: 0; padding: 0; text-align: left; }
+     a { color: #4488ff; }
+   sup { font-size: 0.8em; }
   </style>
   <link rel="stylesheet" href="notes.css" type="text/css">
 </head>
@@ -29,7 +30,14 @@
       <li><h3><a href="<%= file %>"><%= file %></a></h3><ol class="file" href="<%= file %>">
 <% line_notes.sort!{ |a,b| a.line <=> b.line } %>
 <% line_notes.each do |note| %>
-        <li class="note <%= label.downcase %>" ref="<%= note.line %>"><%= h note.text %> <sup><%= note.line %></sup></li>
+        <li class="note <%= label.downcase %>" ref="<%= note.line %>">
+          <%= h note.text %> <sup><a href="<%= note.url %>"><%= note.line %></a></sup>
+<% if note.code? %>
+<pre>
+<%= note.code %>
+</pre>
+<% end %>
+        </li>
 <% end %>
       </ol></li>
 <% end %>

data/lib/dnote/templates/html/list.erb

@@ -2,19 +2,20 @@
 <head>
   <title><%= title %></title>
   <style>
-    body { margin: 0; padding: 0; }
+    body { margin: 0; padding: 0; font-size: 0.8em; }
     .main {
       width: 800px;
       margin: 0 auto;
-      border: 1px solid #ccc;
+      border: 0px 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; }
+    h1 { margin: 25px 0; font-size: 3em; }
+    h2,h3,h4 { margin: 5px 0; padding: 0; color: #444; }
+    h2 { letter-spacing: 2px; border-top: 4px solid #ddd; padding: 5px 0; }
     ul { margin: 0; padding: 0; text-align: left; }
     li { margin: 0; padding: 0; text-align: left; }
+     a { color: #4488ff; }
+   sup { font-size: 0.8em; }
   </style>
   <link rel="stylesheet" href="notes.css" type="text/css">
 </head>
@@ -24,7 +25,15 @@
   <div class="notes">
     <ol>
 <% notes.each do |note| %>
-    <li class="note <%= note.label.downcase %>" ref="<%= note.line %>"><%= note.label %>: <%= h note.text %> <sup><%= note.file %>: <%= note.line %></sup></li>
+    <li class="note <%= note.label.downcase %>" ref="<%= note.line %>">
+      <%= note.label %>: <%= h note.text %>
+      <sup><a href="<%= note.url %>"><%= note.file %>: <%= note.line %></a></sup>
+<% if note.code? %>
+<pre>
+<%= note.code %>
+</pre>
+<$ end %>
+    </li>
 <% end %>
     </ol>
   </div>

data/lib/dnote/version.rb

@@ -0,0 +1,3 @@
+module DNote
+  VERSION = '1.5.0'
+end

data/lib/plugins/{syckle → redline}/dnote.rb

@@ -1,9 +1,9 @@
-module Syckle::Plugins
+module Redline::Plugins
 
   # = Developmer's Notes Plugin
   #
   # This plugin goes through you source files and compiles
-  # an lit of any labeled comments. Labels are single word
+  # a list 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:
   #
@@ -15,24 +15,24 @@ module Syckle::Plugins
   # is a +notes/+ directory in the project's log directory.
   #
   #--
-  # TODO: Should this service be part of the +site+ cycle?
+  # TODO: Should this service be part of the +site+ track?
   #++
   class DNote < Service
 
-    cycle :main, :document
-    cycle :main, :reset
-    cycle :main, :clean
+    stop :main, :document
+    stop :main, :reset
+    stop :main, :clean
 
     # not that this is necessary, but ...
-    available do |project|
-      begin
-        require 'dnote'
-        require 'dnote/format'
-        true
-      rescue LoadError
-        false
-      end
-    end
+    #available do |project|
+    #  begin
+    #    require 'dnote'
+    #    require 'dnote/format'
+    #    true
+    #  rescue LoadError
+    #    false
+    #  end
+    #end
 
     ## autorun if log/notes exists
     #autorun do |project|
@@ -56,7 +56,7 @@ module Syckle::Plugins
 
     # Output directory to save notes file. Defaults to <tt>dnote/</tt> under
     # the project log directory (eg. <tt>log/dnote/</tt>).
-    attr_accessor :output
+    attr_reader :output
 
     # Formats (xml, html, rdoc).
     attr_accessor :formats
@@ -64,6 +64,9 @@ module Syckle::Plugins
     # Title to use if temaplte can use it.
     attr_accessor :title
 
+    # Number of context lines to display.
+    attr_accessor :lines
+
     #
     def output=(path)
       @output = Pathname.new(path)
@@ -85,6 +88,7 @@ module Syckle::Plugins
         s.ignore  = ignore
         s.labels  = labels #|| DEFAULT_LABELS   
         s.title   = title
+        s.context = lines
         s.output  = output
         s.dryrun  = trial?
       end
@@ -134,6 +138,12 @@ module Syckle::Plugins
 
   private
 
+    #
+    def initialize_requires
+      require 'dnote'
+      require 'dnote/format'
+    end
+
     #
     def initialize_defaults
       @files   = "**/*.rb"