dnote 1.4.0 → 1.6.0

data/.ruby

@@ -0,0 +1,47 @@
+--- 
+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: 
+  - test
+  name: lemon
+  version: 0+
+- group: 
+  - build
+  name: redline
+  version: 0+
+- group: 
+  - build
+  name: reap
+  version: 0+
+manifest: MANIFEST
+version: 1.6.0
+licenses: []
+
+copyright: Copyright (c) 2009 Thomas Sawyer
+authors: 
+- Thomas Sawyer
+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

data/APACHE2.txt

@@ -0,0 +1,202 @@
+                             Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.
+

data/{HISTORY → HISTORY.rdoc}

@@ -1,16 +1,46 @@
 = RELEASE HISTORY
 
+== 1.6.0 / 2011-05-17
+
+This release adds code conext output. Select the number of
+context lines to display with the `-c` option. Currently
+only the HTML, YAML and JSON formats support context.
+
+This release also fixes the false note match that can arise when
+a class or module name with double-colons starts a comment line.
+We have changed the regex to ALWAYS REQUIRE a space after the
+label colon. Please make a note of it!
+
+Changes:
+
+* Add code context count option and output.
+* Regex changed to REQUIRE space after label colon.
+
+
+== 1.5.0 / 2010-11-27
+
+This release adds a `--url` option for defining a URL template
+string used in certain HTML/XML formats. In addition a parsing
+bug was corrected that limited some notes to one line.
+
+Changes:
+
+* Add support for configurable URLs.
+* Fix multi-line note parsing bug.
+
+
 == 1.4.0 / 2010-06-26
 
 This release adds auto-determination of marker based on file
-extension. This mean DNote can now scan multiple file types
-in  a single pass. The supported type are fairly small at this
-point, but will expand in the future. The fallback marker is '#'.
-You can still force a particular marker using the --marker option.
+extension. This means DNote can now scan multiple file types
+in a single pass. The supported types are fairly small at this
+point, but cover the command cases and will expand in the future.
+The fallback marker is '#'. You can still force a particular
+marker using the --marker option.
 
 Changes:
 
-* Support for automatic markers.
+* Add support for automatic markers.
 
 
 == 1.3.1 / 2010-06-11

data/README.rdoc

@@ -1,8 +1,8 @@
 = D'Note
 
-* home: http://proutils.github.com/dnote
-* forum: http://googlegroups.com/group/proutils
-* source: http://github.com/proutils/dnote
+* {Homepage}[http://rubyworks.github.com/dnote]
+* {Mailing List}[http://googlegroups.com/group/rubyworks-mailinglist]
+* {Source Code}[http://github.com/rubyworks/dnote]
 
 
 == DESCRIPTION
@@ -15,7 +15,7 @@ output formats for them.
 
 === Note Structure
 
-D'Note scans for the common note patterns used by developers of many languages in the form of an
+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,
 it needs to follow this simple set of rules:
 
@@ -25,7 +25,7 @@ it needs to follow this simple set of rules:
 
 2) Any note that requires more than one line must remain flush to the left
 margin (the margin is set by the first line). This is done because RDoc will mistake
-the note for a <tt>&lt;pre&gt;</tt> block if it is indented.
+the note for a <code>pre</code> block if it is indented.
 
   # LABEL: description ...
   # continue ...
@@ -63,6 +63,8 @@ As you can see the commandline interface is pretty straight-forward.
   OTHER OPTIONS:
       -l, --label LABEL                labels to collect
           --[no-]colon                 match labels with/without colon suffix
+      -m, --marker MARK                alternative remark marker
+      -u  --url TEMPLATE               url template for line entries (for HTML)
       -x, --exclude PATH               exclude file or directory
       -i, --ignore NAME                ignore based on any part of the pathname
       -t, --title TITLE                title to use in header
@@ -102,11 +104,19 @@ The usual RubyGem's command will do the trick.
   $ sudo gem install dnote
 
 
-== COPYRIGHTS
+== COPYRIGHT
 
-(MIT License)
+Copyright (c) 2006 Thomas Sawyer
 
-Copyright (c) 2006, 2009 Thomas Sawyer
+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
 
-THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+   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.
 

data/lib/dnote.rb

@@ -1,27 +1,4 @@
-require 'yaml'
-
-module DNote
-  DIRECTORY = File.dirname(__FILE__) + '/dnote'
-
-  profile = YAML.load(File.new(DIRECTORY + '/profile.yml'))
-  verfile = YAML.load(File.new(DIRECTORY + '/version.yml'))
-
-  VERSION = verfile.values_at('major','minor','patch','state','build').compact.join('.')
-
-  #
-  def self.const_missing(name)
-    key = name.to_s.downcase
-    if verfile.key?(key)
-      verfile[key]
-    elsif profile.key?(key)
-      profile[key]
-    else
-      super(name)
-    end
-  end
-end
-
+require 'dnote/version'
 require 'dnote/session'
 
 # TEST: This is a test of arbitraty labels.
-

data/lib/dnote/format.rb

@@ -102,7 +102,7 @@ module DNote
 
     #
     def write(result, fname=nil)
-      if output.end_with?('/') || File.directory?(output)
+      if output.to_s[-1,1] == '/' || File.directory?(output)
         fmt  = format.split('/').first
         ext  = EXTENSIONS[fmt] || fmt
         file = File.join(output, fname || "notes.#{ext}")

data/lib/dnote/note.rb

@@ -1,30 +1,59 @@
 module DNote
 
+  # The Note class encapsulates a single note made in a source file.
   #
+  # Each note instance holds a reference, +notes+, to the set of notes
+  # being generated for a given session. This allows the note to access
+  # general options applicable to all notes.
   class Note
+
+    # Number of lines to provide in source context.
+    #CONTEXT_DEPTH = 5
+
+    # Set of notes to which this note belongs.
+    attr :notes
+
+    # The file in which the note is made.
     attr :file
+
+    # The type of note.
     attr :label
+
+    # The line number of the note.
     attr :line
+
+    # The verbatim text of the note.
     attr :text
 
-    def initialize(file, label, line, text)
-      @file  = file
-      @label = label
-      @line  = line
-      @text  = text.rstrip
+    # Remark marker used in parsing the note.
+    attr :mark
+
+    # Contextual lines of code.
+    attr :capture
+
+    # Initialize new Note instance.
+    def initialize(notes, file, label, line, text, mark)
+      @notes   = notes
+
+      @file    = file
+      @label   = label
+      @line    = line
+      @text    = text.rstrip
+      @mark    = mark
+      @capture = []
     end
 
-    #
+    # Convert to string representation.
     def to_s
       "#{label}: #{text}"
     end
 
-    #
+    # Convert to string representation.
     def to_str
       "#{label}: #{text}"
     end
 
-    #
+    # Remove newlines from note text.
     def textline
       text.gsub("\n", " ")
     end
@@ -36,22 +65,86 @@ module DNote
       line <=> other.line
     end
 
+    # Convert to Hash.
+    #--
+    # TODO: Add +url+?
+    # TODO: Add +code+? Problem is that xml needs code in CDATA.
+    #++
     def to_h
       { 'label'=>label, 'text'=>textline, 'file'=>file, 'line'=>line }
     end
 
+    # Convert to Hash, leaving the note text verbatim.
     def to_h_raw
-      { 'label'=>label, 'text'=>text, 'file'=>file, 'line'=>line }
+      { 'label'=>label, 'text'=>text, 'file'=>file, 'line'=>line, 'code'=>code }
     end
 
+    # Convert to JSON.
     def to_json(*args)
       to_h_raw.to_json(*args)
     end
 
+    # Convert to YAML.
     def to_yaml(*args)
       to_h_raw.to_yaml(*args)
     end
+
+    # Return line URL based on URL template. If no template was set, then
+    # returns the file.
+    def url
+      if notes.url
+        notes.url % [file, line]
+      else
+        file
+      end
+    end
+
+    #
+    def code
+      unindent(capture).join
+    end
+
+    # Is there code to show?
+    def code?
+      !capture.empty?
+    end
+
+=begin
+    # This isn't being used currently b/c the URL solution as deeemd better,
+    # but the code is here for custom templates.
+    def capture
+      @context ||= (
+        lines = file_cache(file) #.lines.to_a
+        count = line()
+        count +=1 while /^\s*#{mark}/ =~ lines[count]
+        lines[count, context_depth]
+      )
+    end
+
+    # Read in +file+, parse into lines and cache.
+    def file_cache(file)
+      @@file_cache ||= {}
+      @@file_cache[file] ||= File.read(file).lines.to_a
+    end
+=end
+
+    private
+
+    # Remove blank space from lines.
+    def unindent(lines)
+      dents = []
+      lines.each do |line|
+        if md = /^([\ ]*)/.match(line)
+          size = md[1].size
+          dents << md[1]
+        end
+      end
+      dent = dents.min{ |a,b| a.size <=> b.size }
+      lines.map do |line|
+        line.sub(dent, '')
+      end
+    end
+
   end
 
 end
-