dnote 1.1.4 → 1.2.0

data/MANIFEST

@@ -1,33 +0,0 @@
-HISTORY
-LICENSE
-MANIFEST
-README.rdoc
-bin/dnote
-lib/dnote
-lib/dnote.rb
-lib/dnote/command.rb
-lib/dnote/format.rb
-lib/dnote/notes.rb
-lib/dnote/site.rb
-lib/dnote/string.rb
-lib/dnote/templates
-lib/dnote/templates/gnu.erb
-lib/dnote/templates/html.erb
-lib/dnote/templates/markdown.erb
-lib/dnote/templates/rdoc.erb
-lib/dnote/templates/xml.erb
-lib/plugins
-lib/plugins/syckle
-lib/plugins/syckle/dnote.rb
-meta/account
-meta/authors
-meta/contact
-meta/name
-meta/released
-meta/repository
-meta/suite
-meta/summary
-meta/title
-meta/version
-test/cases
-test/cases/notes_case.rb

data/lib/dnote/command.rb

@@ -1,134 +0,0 @@
-#!/usr/bin/env ruby
-
-module DNote
-  require 'optparse'
-  require 'dnote'
-
-  def self.run
-    options = {}
-    format  = 'rdoc'
-
-    opts = OptionParser.new do |opt|
-
-      opt.banner = "Usage: dnote [OPTIONS] path1 [path2 ...]"
-
-      opt.separator(" ")
-      opt.separator("OUTPUT FORMAT: (choose one)")
-
-      opt.on("--gnu", "Plain text format (default)") do
-        options[:format] = 'gnu'
-      end
-
-      opt.on("--rdoc", "RDoc comment format") do
-        options[:format] = 'rdoc'
-      end
-
-      opt.on("--markdown", "Markdown wiki format") do
-        options[:format] = 'markdown'
-      end
-
-      opt.on("--soap", "SOAP XML envelope format") do
-        options[:format] = 'soap'
-      end
-
-      opt.on("--xoxo", "XOXO microformat format") do
-        options[:format] = 'xoxo'
-      end
-
-      opt.on("--xml", "XML markup format") do
-        options[:format] = 'xml'
-      end
-
-      opt.on("--html", "HTML markup format") do
-        options[:format] = 'html'
-      end
-
-      opt.on("--yaml", "YAML serialization format") do
-        options[:format] = 'yaml'
-      end
-
-      opt.on("--json", "JSON serialization format") do
-        options[:format] = 'json'
-      end
-
-      opt.on("--template", "-t FILE", "Use a custom Erb template") do |file|
-        options[:format] = 'custom'
-        options[:template] = file
-      end
-
-      opt.separator(" ")
-      opt.separator("OTHER OPTIONS:")
-
-      opt.on("--label", "labels to collect") do |lbl|
-        options[:labels] ||= []
-        options[:labels] << lbl
-      end
-
-      opt.on("--title", "-t [TITLE]", "title to use in headers") do |title|
-        options[:title] = title
-      end
-
-      opt.on("--output", "-o [PATH]", "name of file or directory") do |path|
-        options[:output] = path
-      end
-
-      opt.separator(" ")
-      opt.separator("STANDARD OPTIONS:")
-
-      #opt.on("--verbose", "-v", "extra verbose output") do
-      #  options[:verbose] = true
-      #end
-
-      opt.on("--debug", "debug mode") do
-        $DEBUG = true
-      end
-
-      #opt.on("--quiet", "-q", "surpress non-essential output") do
-      #  options[:quiet] = true
-      #end
-
-      #opt.on("--noharm", "-n", "only pretend to write to disk") do
-      #  options[:noharm] = true
-      #end
-
-      opt.on("--dryrun", "-n", "do not actually write to disk") do
-        options[:dryrun] = true
-      end
-
-      #opt.on("--trace", "debug and verbose modes combined") do
-      #  $DEBUG = true
-      #  options[:verbose] = true
-      #end
-
-      opt.on_tail('--help', '-h', "show this help information") do
-        puts opt
-        exit
-      end
-
-    end
-
-    begin
-      opts.parse!
-    rescue => err
-      puts err
-      exit 1
-    end
-
-    paths = ARGV.dup
-    paths = ['**/*.rb'] if paths.empty?
-
-    notes  = Notes.new(paths, options[:labels])
-    format = Format.new(notes, options)
-    format.render
-
-    # NOTE: If DNote were a class.
-
-    #if output
-    #  dnote.save(format, output)
-    #else
-    #  dnote.display(format)
-    #end
-  end
-
-end
-

data/lib/dnote/site.rb

@@ -1,140 +0,0 @@
-module DNote
-
-  require 'dnote/notes'
-
-  # Site class is used to build a "pretty" output set.
-  # The template files are saved to the +output+ directory.
-  # Additional +formats+ can be saved to the directory
-  # as well.
-
-  class Site
-
-    # Default output directory is +log/dnote/+.
-    DEFAULT_OUTPUT = Pathname.new('log/dnote')
-
-    # Title to use in any headers.
-    attr_accessor :title
-
-    # Directory to save output.
-    attr_accessor :output
-
-    # Additional Formats to supply besides the html (xml, rdoc, markdown, etc.)
-    attr_accessor :formats
-
-    # Notes object.
-    attr_reader :notes
-
-    def initialize(paths, options)
-      initialize_defaults
-
-      self.title   = options[:title]          if options[:title]
-
-      self.output  = options.delete(:output)  if options[:output]
-      self.formats = options.delete(:formats) if options[:formats]
-
-      @notes = Notes.new(paths, options)
-    end
-
-    #
-    def initialize_defaults
-      @output   = DEFAULT_OUTPUT
-      @title    = "Development Notes"
-      @formats  = ['html']
-    end
-
-    #
-    def output=(path)
-      raise "output cannot be root" if File.expand_path(path) == "/"
-      @output = Pathname.new(path)
-    end
-
-    #
-    def document
-      fu.mkdir_p(output)
-
-      # produce requested additional formats
-      formats.each do |format|
-=begin
-        tdir = tempdir(format)
-
-        # copy non-erb files
-        files = Dir.entries(tdir) - ['.', '..']
-        files = files.reject{ |file| File.extname(file) == '.erb' }
-        files.each do |file|
-          dest = File.dirname(file).sub(tdir, '')
-          fu.cp_r(File.join(tdir, file), output)
-        end
-
-        # write the erb templates
-        templates(format).each do |temp|
-          file = File.join(tdir, temp)
-          erb  = ERB.new(File.read(file))
-          text = erb.result(binding)
-          write(temp.chomp('.erb'), text)
-        end
-=end
-        text = notes.to(format)
-        write("notes.#{format}", text)
-      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 directory.
-    def clean
-      if File.directory?(output)
-        fu.rm_r(output)
-        puts "removed #{output}"
-      end
-    end
-
-    #
-    tempdir(format)
-      "#{__DIR__}/templates/#{format}"
-    end
-
-    # TODO: Don't use chdir.
-    def templates(format)
-      temps = []
-      Dir.chdir(tempdir(format)) do
-        temps = Dir['**/*.erb']
-      end
-      temps
-    end
-
-    # Save file to output.
-    #
-    def write(fname, text)
-      file = output + fname
-      fu.mkdir_p(file.parent)
-      File.open(file, 'w') { |f| f << text } unless $NOOP
-    end
-
-    def __DIR__
-      File.dirname(__FILE__)
-    end
-
-    #
-    def fu
-      @fu ||= (
-        if $NOOP and $DEBUG
-          FileUtils::DryRun
-        elsif $NOOP
-          FileUtils::Noop
-        elsif $DEBUG
-          FileUtils::Verbose
-        else
-          FileUtils
-        end
-      )
-    end
-
-  end
-
- end

data/lib/dnote/templates/gnu.erb

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

data/lib/dnote/templates/markdown.erb

@@ -1,17 +0,0 @@
-<%= title %>
-
-<%= '=' * title.size %>
-
-<% notes.each do |label, per_file| %>
-
-<%= label %> 
-<%= '-' * (label.size) %>
-
-<%   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 %>)
-<% end; end; end %>
-