dnote 1.1.4 → 1.2.0

data/lib/dnote/templates/md.erb

@@ -0,0 +1,18 @@
+<%= title %>
+
+<%= '=' * title.size %>
+
+<% notes.by_label_file.each do |label, per_file| %>
+
+<%= label %>
+
+<%= '-' * (label.size) %>
+
+<%   per_file.each do |file, line_notes| %>
+
+### file://<%= file %>
+
+<% line_notes.each do |note| %>
+* <%= note %> (<%= note.line %>)
+<% end; end; end %>
+

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

@@ -0,0 +1,13 @@
+<%= title %>
+
+<%= '=' * title.size %>
+
+<% notes.by_file.each do |file, list| %>
+
+file://<%= file %>
+<%= '-' * (file.size + 7) %>
+
+<% list.each do |note| %>
+* <%= note %> (<%= note.line %>)
+<% end; end %>
+

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

@@ -0,0 +1,18 @@
+<%= title %>
+
+<%= '=' * title.size %>
+
+<% notes.by_label_file.each do |label, per_file| %>
+
+<%= label %>
+
+<%= '-' * (label.size) %>
+
+<%   per_file.each do |file, line_notes| %>
+
+### file://<%= file %>
+
+<% line_notes.each do |note| %>
+* <%= note %> (<%= note.line %>)
+<% end; end; end %>
+

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

@@ -0,0 +1,9 @@
+<%= title %>
+
+<%= '=' * title.size %>
+
+
+<% notes.each_with_index do |note, index| %>
+<%= "%s" % [index+1] %>. <%= note.label %>: <%= h note.textline %> (<%= note.file %>: <%= note.line %>)
+<% end %>
+

data/lib/dnote/templates/rdoc.erb

@@ -1,11 +1,11 @@
-= <%= title %><% notes.each do |label, per_file| %>
+= <%= title %><% notes.by_label_file.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 %>)
+<% line_notes.each do |note| %>
+* <%= note %> (<%= note.line %>)
 <% end; end; end %>
 

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

@@ -0,0 +1,9 @@
+= <%= title %>
+<% notes.by_file.each do |file, list| %>
+
+== file://<%= file %>
+
+<% list.each do |note| %>
+* <%= note %> (<%= note.line %>)
+<% end; end %>
+

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

@@ -0,0 +1,11 @@
+= <%= title %><% notes.by_label_file.each do |label, per_file| %>
+
+== <%= label %>
+<%   per_file.each do |file, line_notes| %>
+
+=== file://<%= file %>
+
+<% line_notes.each do |note| %>
+* <%= note %> (<%= note.line %>)
+<% end; end; end %>
+

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

@@ -0,0 +1,6 @@
+= <%= title %>
+
+<% notes.each_with_index do |note, index| %>
+* <%= note.label %>: <%= h note.textline %> (<%= note.file %>: <%= note.line %>)
+<% end %>
+

data/lib/dnote/templates/soap.erb

@@ -0,0 +1,4 @@
+<%= 
+  require 'soap/marshal'
+  ::SOAP::Marshal.marshal(notes.to_a)
+%>

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

@@ -0,0 +1,4 @@
+<%= 
+  require 'soap/marshal'
+  ::SOAP::Marshal.marshal(notes.by_file)
+%>

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

@@ -0,0 +1,4 @@
+<%= 
+  require 'soap/marshal'
+  ::SOAP::Marshal.marshal(notes.by_label)
+%>

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

@@ -0,0 +1,4 @@
+<%= 
+  require 'soap/marshal'
+  ::SOAP::Marshal.marshal(notes.to_a)
+%>

data/lib/dnote/templates/text.erb

@@ -0,0 +1,11 @@
+<%= title %>
+
+<% notes.by_label.each do |label, line_notes| %>
+
+<%= label %>
+
+
+<% line_notes.each_with_index do |note, i| %>
+<%= note.text.indent(6).sub(' ' * 6,(" %3s. " % [i+1])) %> (<%= note.file %>:<%= note.line %>)
+<% end; end %>
+

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

@@ -0,0 +1,10 @@
+<%= title %>
+
+<% notes.by_file.each do |file, line_notes| %>
+
+<%= file %>:
+
+<% line_notes.sort!{ |a,b| a.line <=> b.line } %><% line_notes.each do |note| %>
+<%= note.to_s.indent(10).sub(' ' * 10,'        * ') %> (<%= note.line %>)
+<% end; end %>
+

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

@@ -0,0 +1,11 @@
+<%= title %>
+
+<% notes.by_label.each do |label, line_notes| %>
+
+<%= label %>
+
+
+<% line_notes.each_with_index do |note, i| %>
+<%= note.text.indent(6).sub(' ' * 6,(" %3s. " % [i+1])) %> (<%= note.file %>:<%= note.line %>)
+<% end; end %>
+

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

@@ -0,0 +1,7 @@
+<%= title %>
+
+
+<% notes.each_with_index do |note, index| %>
+<%= "%4s %s %s" % [index+1, note.label, note.text.gsub("\n", ' ')] %> (<%= note.file %>:<%= note.line %>)
+<% end %>
+

data/lib/dnote/templates/xml.erb

@@ -1,15 +1,15 @@
 <?xml version="1.0" ?>
 <notes>
-<% notes.each do |label, per_file| %>
-    <set label="<%= label %>">
+<% notes.by_label_file.each do |label, per_file| %>
+    <label name="<%= 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>
+<% line_notes.sort!{ |a,b| a.line <=> b.line } %>
+<% line_notes.each do |note| %>
+            <note line="<%= note.line %>" type="<%= label %>"><%= h note.textline %></note>
 <% end %>
         </file>
 <% end %>
-    </set>
+    </label>
 <% end %>
 </notes>

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

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

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

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

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

@@ -0,0 +1,6 @@
+<?xml version="1.0" ?>
+<notes>
+<% notes.each do |note| %>
+  <note file="<%= note.file %>" line="<%= note.line %>" type="<%= label %>"><%= h note.textline %></note>
+<% end %>
+</notes>

data/lib/dnote/templates/xoxo.erb

@@ -0,0 +1,4 @@
+<%=
+  require 'xoxo'
+  notes.by_label.to_xoxo
+%>

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

@@ -0,0 +1,4 @@
+<%=
+  require 'xoxo'
+  notes.by_file.to_xoxo
+%>

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

@@ -0,0 +1,4 @@
+<%=
+  require 'xoxo'
+  notes.by_label.to_xoxo
+%>

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

@@ -0,0 +1,6 @@
+<%=
+  require 'xoxo'
+  notes.map{ |n|
+    { 'label'=>n.label, 'text'=>n.textline, 'file'=>n.file, 'line'=>n.line }
+  }.to_xoxo
+%>

data/lib/dnote/templates/yaml.erb

@@ -0,0 +1 @@
+<%= require 'yaml'; notes.map{ |n| n.to_h_raw }.to_yaml %>

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

@@ -0,0 +1 @@
+<%= require 'yaml'; notes.by_file.to_yaml %>

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

@@ -0,0 +1 @@
+<%= require 'yaml'; notes.by_label.to_yaml %>

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

@@ -0,0 +1 @@
+<%= require 'yaml'; notes.map{ |n| n.to_h_raw }.to_yaml %>

data/lib/plugins/syckle/dnote.rb

@@ -40,14 +40,20 @@ module Syckle::Plugins
     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.
+    # File paths to search.
     attr_accessor :files
 
     # Labels to document. Defaults are: TODO, FIXME, OPTIMIZE and DEPRECATE.
     attr_accessor :labels
 
+    # 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
@@ -73,16 +79,37 @@ module Syckle::Plugins
     # TODO: Is #trial? correct?
     #++
     def document
-      notes = ::DNote::Notes.new(files, labels)
-      [formats].flatten.each do |format|
+      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  = trial?
+      end
+      formats.each do |format|
         if format == 'index'
-          format = 'html'
-          output = File.join(self.output, 'index.html')
+          session.format = 'html'
+          session.output = File.join(self.output, 'index.html')
+        else
+          session.format = format
         end
-        format = ::DNote::Format.new(notes, :format=>format, :output=>output.to_s, :title=>title, :dryrun=>trial?)
-        format.render
+        session.run
         report "Updated #{output.to_s.sub(Dir.pwd+'/','')}" unless trial?
       end
+
+      #files = files.map{ |f| Dir[f] }.flatten
+      #notes = ::DNote::Notes.new(files, :labels=>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
 
     # Reset output directory, marking it as out-of-date.

data/meta/version

@@ -1 +1 @@
-1.1.4
+1.2.0

data/test/cases/notes_case.rb

@@ -2,54 +2,43 @@ require 'dnote/notes'
 
 Case DNote::Notes do
 
-  Concern "Full coverage of DNote::Notes class."
-
-  Unit :paths
+  Concern "Basic coverage of DNote::Notes class."
 
   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']
+    notes = DNote::Notes.new([], :labels=>['TODO'])
+    notes.labels.assert == ['TODO'] #DNote::Notes::DEFAULT_LABELS
   end
 
-  Unit :paths => 'returns the paths attribute' do
+  Unit :files => 'returns the files attribute' do
     notes = DNote::Notes.new(["example1.rb"])
-    notes.assert.paths == ["example1.rb"]
+    notes.assert.files == ["example1.rb"]
     notes = DNote::Notes.new([], :paths => ["example2.rb"])
-    notes.assert.paths == ["example2.rb"]
+    notes.assert.files == ["example2.rb"]
   end
 
-  Unit :paths= => 'changes the paths attribute' do
+  Unit :files= => 'changes the paths attribute' do
     notes = DNote::Notes.new([])
-    notes.paths = ["example1.rb"]
-    notes.assert.paths == ["example1.rb"]
+    notes.files = ["example1.rb"]
+    notes.assert.files == ["example1.rb"]
   end
 
-  Unit :files
-
-  Unit :match_arbitrary => '' do
+  Unit :match_general => '' 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!"}
+    rec = notes.match_general(line, lineno, file)
+    rec.to_h.assert == {'label'=>"TODO",'file'=>file,'line'=>lineno,'text'=>"Do something or another!"}
   end
 
-  Unit :match_common
-  Unit :to_xml
+  Unit :match_specail => '' do
+    notes = DNote::Notes.new([], :labels=>['TODO'])
+    line, lineno, file = "# TODO: Do something or another!", 1, "foo.rb"
+    rec = notes.match_special(line, lineno, file)
+    rec.to_h.assert == {'label'=>"TODO",'file'=>file,'line'=>lineno,'text'=>"Do something or another!"}
+  end
+
+  Unit :counts
   Unit :notes
-  Unit :to
-  Unit :initialize_defaults
   Unit :parse
-  Unit :to_yaml
-  Unit :to_json
-  Unit :counts
-  Unit :organize
-  Unit :display
 
 end
 

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 1
-  - 1
-  - 4
-  version: 1.1.4
+  - 2
+  - 0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Thomas Sawyer
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-12 00:00:00 -05:00
+date: 2010-02-18 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -27,22 +27,49 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- HISTORY
-- LICENSE
-- MANIFEST
-- README.rdoc
 - bin/dnote
-- lib/dnote.rb
-- lib/dnote/command.rb
 - lib/dnote/format.rb
+- lib/dnote/note.rb
 - lib/dnote/notes.rb
-- lib/dnote/site.rb
+- lib/dnote/session.rb
 - lib/dnote/string.rb
-- lib/dnote/templates/gnu.erb
+- lib/dnote/templates/html/file.erb
+- lib/dnote/templates/html/label.erb
+- lib/dnote/templates/html/list.erb
 - lib/dnote/templates/html.erb
-- lib/dnote/templates/markdown.erb
+- lib/dnote/templates/json/file.erb
+- lib/dnote/templates/json/label.erb
+- lib/dnote/templates/json/list.erb
+- lib/dnote/templates/json.erb
+- lib/dnote/templates/md/file.erb
+- lib/dnote/templates/md/label.erb
+- lib/dnote/templates/md/list.erb
+- lib/dnote/templates/md.erb
+- lib/dnote/templates/rdoc/file.erb
+- lib/dnote/templates/rdoc/label.erb
+- lib/dnote/templates/rdoc/list.erb
 - lib/dnote/templates/rdoc.erb
+- lib/dnote/templates/soap/file.erb
+- lib/dnote/templates/soap/label.erb
+- lib/dnote/templates/soap/list.erb
+- lib/dnote/templates/soap.erb
+- lib/dnote/templates/text/file.erb
+- lib/dnote/templates/text/label.erb
+- lib/dnote/templates/text/list.erb
+- lib/dnote/templates/text.erb
+- lib/dnote/templates/xml/file.erb
+- lib/dnote/templates/xml/label.erb
+- lib/dnote/templates/xml/list.erb
 - lib/dnote/templates/xml.erb
+- lib/dnote/templates/xoxo/file.erb
+- lib/dnote/templates/xoxo/label.erb
+- lib/dnote/templates/xoxo/list.erb
+- lib/dnote/templates/xoxo.erb
+- lib/dnote/templates/yaml/file.erb
+- lib/dnote/templates/yaml/label.erb
+- lib/dnote/templates/yaml/list.erb
+- lib/dnote/templates/yaml.erb
+- lib/dnote.rb
 - lib/plugins/syckle/dnote.rb
 - meta/account
 - meta/authors
@@ -55,6 +82,9 @@ files:
 - meta/title
 - meta/version
 - test/cases/notes_case.rb
+- LICENSE
+- README.rdoc
+- HISTORY
 has_rdoc: true
 homepage: 
 licenses: []
@@ -82,7 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: dnote
-rubygems_version: 1.3.6.pre.2
+rubygems_version: 1.3.6.pre.3
 signing_key: 
 specification_version: 3
 summary: Extract developer notes from source code.