dnote 1.6.1 → 1.7.0

data/APACHE2.txt

@@ -1,202 +0,0 @@
-                             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/lib/dnote/string.rb

@@ -1,68 +0,0 @@
-class Xacto
-
-  # 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
-
-  end
-
-  class ::String #:nodoc:
-    include Xacto::String
-  end
-
-end
-

data/lib/plugins/rake/task.rb

@@ -1,113 +0,0 @@
-# = 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/redline/dnote.rb

@@ -1,158 +0,0 @@
-module Redline::Plugins
-
-  # = Developmer's Notes Plugin
-  #
-  # This plugin goes through you source files and compiles
-  # 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:
-  #
-  # By default this label supports the TODO, FIXME, OPTIMIZE
-  # and DEPRECATE.
-  #
-  # Output is a set of files in HTML, XML and RDoc's simple
-  # markup format. This plugin can run automatically if there
-  # is a +notes/+ directory in the project's log directory.
-  #
-  #--
-  # TODO: Should this service be part of the +site+ track?
-  #++
-  class DNote < Service
-
-    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
-
-    ## 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']
-
-    # 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_reader :output
-
-    # Formats (xml, html, rdoc).
-    attr_accessor :formats
-
-    # 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)
-    end
-
-    #
-    #def dnote
-    #  @dnote ||= ::DNote::Site.new(files, :labels=>labels, :formats=>formats, :output=>output)
-    #end
-
-    # Generate notes documents.
-    #--
-    # TODO: Is #trial? correct?
-    #++
-    def document
-      session = ::DNote::Session.new do |s|
-        s.paths   = files
-        s.exclude = exclude
-        s.ignore  = ignore
-        s.labels  = labels #|| DEFAULT_LABELS   
-        s.title   = title
-        s.context = lines
-        s.output  = output
-        s.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
-
-      #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.
-    def reset
-      if File.directory?(output)
-        File.utime(0,0,output) unless $NOOP
-        puts "Marked #{output}"
-      end
-    end
-
-    # Remove output files.
-    def clean
-      if File.directory?(output)
-        formats.each do |format|
-          ext = ::DNote::Format::EXTENSIONS[format] || format
-          file = (output + "notes.#{ext}").to_s
-          rm(file)
-          report "Removed #{output}"
-        end
-      end
-    end
-
-  private
-
-    #
-    def initialize_requires
-      require 'dnote'
-      require 'dnote/format'
-    end
-
-    #
-    def initialize_defaults
-      @files   = "**/*.rb"
-      @output  = project.log + 'dnote'
-      @formats = ['index']
-      @labels  = nil #DEFAULT_LABELS
-    end
-
-  end
-
-end
-