dnote 1.6.1 → 1.7.0

data/.ruby

@@ -1,47 +1,55 @@
---- 
-spec_version: 1.0.0
-replaces: []
-
-loadpath: 
-- lib
-name: dnote
-repositories: 
-  public: git://github.com/rubyworks/dnote.git
-conflicts: []
-
-engine_check: []
-
-title: DNote
-contact: trans <transfire@gmail.com>
-resources: 
-  code: http://github.com/rubyworks/dnote
-  api: http://rubyworks.github.com/dnote/rdoc
-  mail: http://groups.google.com/group/rubyworks-mailinglist
-  wiki: http://wiki.github.com/rubyworks/dnote
-  home: http://rubyworks.github.com/dnote
-maintainers: []
-
-requires: 
-- group: 
+---
+source:
+- meta
+authors:
+- name: Thomas Sawyer
+  email: transfire@gmail.com
+copyrights:
+- holder: Thomas Sawyer, Rubyworks
+  year: '2009'
+replacements: []
+alternatives: []
+requirements:
+- name: lemon
+  groups:
+  - test
+  development: true
+- name: ae
+  groups:
   - test
-  name: lemon
-  version: 0+
-- group: 
+  development: true
+- name: detroit
+  groups:
   - build
-  name: redline
-  version: 0+
-- group: 
+  development: true
+- name: reap
+  groups:
   - build
-  name: reap
-  version: 0+
-manifest: MANIFEST
-version: 1.6.1
-licenses: []
+  development: true
+dependencies: []
+conflicts: []
+repositories:
+- uri: git://github.com/rubyworks/dnote.git
+  scm: git
+  name: upstream
+resources:
+  home: http://rubyworks.github.com/dnote
+  code: http://github.com/rubyworks/dnote
+  wiki: http://wiki.github.com/rubyworks/dnote
+  api: http://rubydoc.info/gems/dnote
+  bugs: http://github.com/rubyworks/dnote/issues
+  mail: http://groups.google.com/groups/rubyworks-mailinglist
+extra: {}
+load_path:
+- lib
+revision: 0
+created: '2009-10-09'
+summary: Extract developer's notes from source code.
+title: DNote
+version: 1.7.0
+name: dnote
+description: ! 'DNote makes it easy to extract developer''s notes from source code,
 
-copyright: Copyright (c) 2009 Thomas Sawyer
-authors: 
-- Thomas Sawyer
+  and supports almost any language.'
 organization: RubyWorks
-description: DNote makes it easy to extract developer's notes from source code, and supports almost any language.
-summary: Extract developer's notes from source code
-created: 2009-10-09
+date: '2011-10-25'

data/.yardopts

@@ -0,0 +1,5 @@
+--protected
+--private
+lib/**/*.rb
+-
+[A-Z]*.*

data/COPYING.rdoc

@@ -0,0 +1,31 @@
+= COPYRIGHT NOTICES
+
+== DNote
+
+Copyright:: (c) 2006 Thomas Sawyer, Rubyworks
+License:: BSD-2-Clause
+Website:: http://rubyworks.github.com/tapout
+
+    Copyright 2006 Thomas Sawyer, Rubyworks. All rights reserved.
+
+    Redistribution and use in source and binary forms, with or without
+    modification, are permitted provided that the following conditions are met:
+
+       1. Redistributions of source code must retain the above copyright notice,
+          this list of conditions and the following disclaimer.
+
+       2. Redistributions in binary form must reproduce the above copyright
+          notice, this list of conditions and the following disclaimer in the
+          documentation and/or other materials provided with the distribution.
+
+    THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
+    INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
+    AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+    COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+    INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+    NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR  SERVICES; LOSS OF USE,
+    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+    OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+    EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

data/HISTORY.rdoc

@@ -1,11 +1,23 @@
 = RELEASE HISTORY
 
 
+== 1.7.0 / 2011-10-25
+
+This release finishes adding code context support to all formats. Use the `-c`
+option to set the number of lines to include. Note also that the rake task has
+been moved to `dnote/rake/dnotetask`.
+
+Changes:
+
+* Support code contexts in all formats.
+* Rake task moved to `dnote/rake/dnotetask`.
+
+
 == 1.6.1 / 2011-05-18
 
 Last release reused the `-c` option for context lines. This clobbered
-the shortcut option for `--custom`. To fix this release capitalizes
-the shortcut to `-C`.
+the shortcut option for `--custom`. To fix, this release capitalizes
+the custom shortcut to `-C`.
 
 Changes:
 

data/README.rdoc

@@ -1,4 +1,4 @@
-= D'Note
+= DNote
 
 * {Homepage}[http://rubyworks.github.com/dnote]
 * {Mailing List}[http://googlegroups.com/group/rubyworks-mailinglist]
@@ -16,7 +16,7 @@ output formats for them.
 === Note Structure
 
 DNote scans for the common note patterns used by developers of many languages in the form of an
-all-caps labels followed by a colon. To be more specific, for D'Note to recognize a note,
+all-caps labels followed by a colon. To be more specific, for DNote to recognize a note,
 it needs to follow this simple set of rules:
 
 1) Notes start with an all-caps label punctuated with a colon, followed by the note's text.
@@ -106,17 +106,8 @@ The usual RubyGem's command will do the trick.
 
 == COPYRIGHT
 
-Copyright (c) 2006 Thomas Sawyer
+Copyright (c) 2006 Thomas Sawyer, Rubyworks
 
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-   http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+DNote is distributable in accordance with the terms of the *FreeBSD* license.
 
+See COPYING.rdoc for details.

data/lib/dnote.rb

@@ -1,4 +1,4 @@
 require 'dnote/version'
 require 'dnote/session'
 
-# TEST: This is a test of arbitraty labels.
+# TEST: This is a test of an arbitrary label.

data/lib/dnote/core_ext.rb

@@ -10,3 +10,83 @@ module Enumerable
 
 end
 
+module DNote
+
+  # Extensions for String class.
+  # These methods are taken directly from Ruby Facets.
+  #
+  module String
+
+    # Provides a margin controlled string.
+    #
+    #   x = %Q{
+    #         | This
+    #         |   is
+    #         |     margin controlled!
+    #         }.margin
+    #
+    #
+    #   NOTE: This may still need a bit of tweaking.
+    #
+    #  CREDIT: Trans
+
+    def margin(n=0)
+      #d = /\A.*\n\s*(.)/.match( self )[1]
+      #d = /\A\s*(.)/.match( self)[1] unless d
+      d = ((/\A.*\n\s*(.)/.match(self)) ||
+          (/\A\s*(.)/.match(self)))[1]
+      return '' unless d
+      if n == 0
+        gsub(/\n\s*\Z/,'').gsub(/^\s*[#{d}]/, '')
+      else
+        gsub(/\n\s*\Z/,'').gsub(/^\s*[#{d}]/, ' ' * n)
+      end
+    end
+
+    # Preserves relative tabbing.
+    # The first non-empty line ends up with n spaces before nonspace.
+    #
+    #  CREDIT: Gavin Sinclair
+
+    def tabto(n)
+      if self =~ /^( *)\S/
+        indent(n - $1.length)
+      else
+        self
+      end
+    end
+
+    # Indent left or right by n spaces.
+    # (This used to be called #tab and aliased as #indent.)
+    #
+    #  CREDIT: Gavin Sinclair
+    #  CREDIT: Trans
+
+    def indent(n)
+      if n >= 0
+        gsub(/^/, ' ' * n)
+      else
+        gsub(/^ {0,#{-n}}/, "")
+      end
+    end
+
+    #
+    #
+    def tabset(n) 
+      i = lines.map do |line|
+        line.strip.empty? ? nil : line.index(/\S/)
+      end
+      x = i.compact.min
+      t = n - x.to_i
+      t = 0 if t < 0
+      indent(t)
+    end
+
+  end
+
+  class ::String #:nodoc:
+    include DNote::String
+  end
+
+end
+

data/lib/dnote/format.rb

@@ -12,7 +12,7 @@ module DNote
     require 'fileutils'
     require 'erb'
     require 'rexml/text'
-    require 'dnote/string'
+    require 'dnote/core_ext'
 
     #DEFAULT_OUTPUT_DIR = "log/dnote"
 
@@ -45,6 +45,7 @@ module DNote
       @format  = 'text'
       @subtype = 'label'
       @title   = "Developer's Notes"
+      @dryrun  = false
       options.each{ |k,v| __send__("#{k}=", v) if v }
       yield(self) if block_given?
     end

data/lib/dnote/rake/dnotetask.rb

@@ -0,0 +1,116 @@
+module DNote
+
+  # = Developmer's Notes Rake Task
+  #
+  class RakeTask < 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
+
+end

data/lib/dnote/session.rb

@@ -95,12 +95,12 @@ module DNote
 
     # Set exclude list ensuring that the value is an array.
     def exclude=(list)
-      @exclude = [list].flatten.compact
+      @exclude = [list].compact.flatten.compact
     end
 
     # Set ignore list ensuring that the value is an array.
     def ignore=(list)
-      @ignore = [list].flatten.compact
+      @ignore = [list].compact.flatten.compact
     end
 
     # Run session.

data/lib/dnote/templates/md.erb

@@ -1,6 +1,6 @@
 <%= title %>
 
-<%= '=' * title.size %>
+<%= '=' * title.to_s.size %>
 
 <% notes.by_label_file.each do |label, per_file| %>
 
@@ -14,5 +14,6 @@
 
 <% line_notes.each do |note| %>
 * <%= note %> (<%= note.line %>)
+<% if note.code? %><%= "\n" + note.code.tabset(4).rstrip + "\n\n" %><% end %>
 <% end; end; end %>