mvz-dnote 1.7.2 → 1.10.0

data/lib/dnote/rake/dnotetask.rb

@@ -1,13 +1,15 @@
-module DNote
+# frozen_string_literal: true
+
+require "rspec/core/rake_task"
 
+module DNote
   # = Developmer's Notes Rake Task
   #
   class RakeTask < Rake::TaskLib
-
-    require 'rake/clean'
+    require "rake/clean"
 
     # Default note labels to looked for in source code.
-    DEFAULT_LABELS = ['TODO', 'FIXME', 'OPTIMIZE', 'DEPRECATE']
+    DEFAULT_LABELS = %w[TODO FIXME OPTIMIZE DEPRECATE].freeze
 
     # File paths to search.
     attr_accessor :files
@@ -26,91 +28,87 @@ module DNote
 
     # Output directory to save notes file. Defaults to <tt>dnote/</tt> under
     # the project log directory (eg. <tt>log/dnote/</tt>).
-    attr_accessor :output
+    attr_reader :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
+      require "dnote"
+      require "dnote/format"
+      @files = "**/*.rb"
+      @output = "log/dnote"
+      @formats = ["index"]
+      @labels = nil
     end
 
-    #
     def define
       desc "Collect Developer's Notes"
-      task 'dnote' do
+      task "dnote" do
         document
       end
-      task 'dnote:clobber' do
+      task "dnote:clobber" do
         clean
       end
-      task :clobber => ['dnote:clobber']
+      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?
+      session = new_session
+
+      formats.each do |format|
+        generate_document_for_format(session, format)
       end
+    end
 
+    # Remove output files.
+    def clean
       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?
+        clean_format format
       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
+    private
+
+    def new_session
+      ::DNote::Session.new do |s|
+        s.paths = files
+        s.exclude = exclude
+        s.ignore = ignore
+        s.labels = labels
+        s.title = title
+        s.output = output
+        s.dryrun = application.options.dryrun # trial?
+      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
+    def generate_document_for_format(session, format)
+      if format == "index"
+        session.format = "html"
+        session.output = File.join(output, "index.html")
+      else
+        session.format = format
+      end
+      session.run
+      report "Updated #{output.to_s.sub("#{Dir.pwd}/", "")}" unless trial?
     end
 
+    def clean_format(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
   end
-
 end

data/lib/dnote/session.rb

@@ -1,9 +1,11 @@
-module DNote
+# frozen_string_literal: true
 
-  require 'dnote/core_ext'
-  require 'dnote/notes'
-  require 'dnote/format'
+require "dnote/core_ext"
+require "dnote/notes"
+require "dnote/format"
+require "dnote/options"
 
+module DNote
   # User session which is used by commandline interface.
   #
   # By making this a class it makes it easy for external
@@ -11,13 +13,12 @@ module DNote
   # calling the commandline, but without the need to shellout.
   #
   class Session
-
     # Directory relative to this script. This is used
     # to lookup the available format templates.
     DIR = File.dirname(__FILE__)
 
     # Default format.
-    DEFAULT_FORMAT  = "text"
+    DEFAULT_FORMAT = "text"
 
     # Default title.
     DEFAULT_TITLE = "Developer's Notes"
@@ -59,7 +60,7 @@ module DNote
 
     # String template for line URLs (mainly for HTML format). For example,
     # DNote uses GitHub so we could use a link template:
-    # 
+    #
     #   "https://github.com/rubyworks/dnote/blob/master/%s#L%s"
     #
     attr_accessor :url
@@ -67,31 +68,31 @@ module DNote
     # Number of lines of context to display. The default is zero.
     attr_accessor :context
 
-  private
+    private
 
     # New Session.
-    def initialize(options={})
+    def initialize(options = {})
       options ||= {}
       initialize_defaults
-      options.each{ |k,v| __send__("#{k}=", v) }
+      options.each { |k, v| __send__("#{k}=", v) }
       yield(self) if block_given?
     end
 
     # Set default values for attributes.
     def initialize_defaults
-      @paths   = []
-      @labels  = []
+      @paths = []
+      @labels = []
       @exclude = []
-      @ignore  = []
-      @format  = DEFAULT_FORMAT
-      @title   = DEFAULT_TITLE
-      @dryrun  = false
-      @marker  = nil
-      @url     = nil
+      @ignore = []
+      @format = DEFAULT_FORMAT
+      @title = DEFAULT_TITLE
+      @dryrun = false
+      @marker = nil
+      @url = nil
       @context = 0
     end
 
-  public
+    public
 
     # Set exclude list ensuring that the value is an array.
     def exclude=(list)
@@ -105,13 +106,18 @@ module DNote
 
     # Run session.
     def run
-      notes = Notes.new(files, :labels=>labels, :colon=>colon, :marker=>marker, :url=>url, :context=>context)
-      formatter = Format.new(notes) do |f|
-        f.format   = format
-        f.template = template
-        f.title    = title
-        f.output   = output
-      end
+      notes = Notes.new(files,
+                        labels: labels,
+                        colon: colon,
+                        marker: marker,
+                        url: url,
+                        context: context)
+      collection = notes.notes_collection
+      formatter = Format.new(collection,
+                             format: format,
+                             template: template,
+                             title: title,
+                             output: output)
       formatter.render
     end
 
@@ -120,150 +126,41 @@ module DNote
     # compile the list of files.
     def files
       list = [paths].flatten.compact
-      list = ['**/*.rb'] if list.empty?
+      list = ["**/*.rb"] if list.empty?
       list = glob(list)
-      list = list - glob(exclude)
+      list -= glob(exclude)
       list.reject do |path|
-        path.split('/').any?{ |part| ignore.any?{ |ig| File.fnmatch?(ig, part) } }
+        path.split("/").any? { |part| ignore.any? { |ig| File.fnmatch?(ig, part) } }
       end
     end
 
-    # Collect the file glob of each path given. If 
+    # Collect the file glob of each path given. If
     # a path is a directory, inclue all content.
     def glob(paths)
       paths.map do |path|
         if File.directory?(path)
-          Dir.glob(File.join(path, '**/*'))
+          Dir.glob(File.join(path, "**/*"))
         else
           Dir.glob(path)
         end
       end.flatten.uniq
     end
 
-    # Set special labels.
-    #def labels=(labels)
-    #  @labels = (
-    #    case labels
-    #    when String
-    #      labels.split(/[:;,]/)
-    #    else
-    #      labels = [labels].flatten.compact.uniq.map{ |s| s.to_s }
-    #    end
-    #  )
-    #end
+    # List availble format templates
+    def list_templates
+      tdir = File.join(DIR, "templates")
+      tfiles = Dir[File.join(tdir, "**/*.erb")]
+      tnames = tfiles.map { |tname| tname.sub("#{tdir}/", "").chomp(".erb") }
+      groups = tnames.group_by { |tname| tname.split("/").first }
+      groups.sort.each do |(_type, names)|
+        puts("%-18s " * names.size % names.sort)
+      end
+    end
 
     # Commandline interface.
     def self.main(*argv)
-      require 'optparse'
-
-      session = Session.new
-
-      opts = OptionParser.new do |opt|
-        opt.banner = "DNote v#{DNote::VERSION}"
-
-        opt.separator(" ")
-        opt.separator("USAGE:\n  dnote [OPTIONS] path1 [path2 ...]")
-
-        opt.separator(" ")
-        opt.separator("OUTPUT FORMAT: (choose one)")
-
-        opt.on("--format", "-f NAME", "select a format [text]") do |format|
-          session.format = format
-        end
-
-        opt.on("--custom", "-C FILE", "use a custom ERB template") do |file|
-          session.format = 'custom'
-          session.template = file
-        end
-
-        opt.on("--file", "shortcut for text/file format") do
-          session.format = 'text/file'
-        end
-
-        opt.on("--list", "shortcut for text/list format") do
-          session.format = 'text/list'
-        end
-
-        opt.separator(" ")
-        opt.separator("OTHER OPTIONS:")
-
-        opt.on("--label", "-l LABEL", "labels to collect") do |lbl|
-          session.labels.concat(lbl.split(':'))
-        end
-
-        opt.on("--[no-]colon", "match labels with/without colon suffix") do |val|
-          session.colon = val
-        end
-
-        opt.on("--marker", "-m MARK", "alternative remark marker") do |mark|
-           session.marker = mark 
-        end
-
-        opt.on("--url", "-u TEMPLATE", "url template for line entries (for HTML)") do |url|
-           session.url = url
-        end
-
-        opt.on("--context", "-c INTEGER", "number of lines of context to display") do |int|
-           session.context = int.to_i
-        end
-
-        opt.on("--exclude", "-x PATH", "exclude file or directory") do |path|
-          session.exclude << path
-        end
-
-        opt.on("--ignore", "-i NAME", "ignore file based on any part of pathname") do |name|
-          session.ignore << name
-        end
-
-        opt.on("--title", "-t TITLE", "title to use in header") do |title|
-          session.title = title
-        end
-
-        opt.on("--output", "-o PATH", "save to file or directory") do |path|
-          session.output = path
-        end
-
-        opt.on("--dryrun", "-n", "do not actually write to disk") do
-          session.dryrun = true
-        end
-
-        opt.on("--debug", "debug mode") do
-          $DEBUG = true
-          $VERBOSE = true
-        end
-
-        opt.separator(" ")
-        opt.separator("COMMAND OPTIONS:")
-
-        opt.on_tail('--templates', "-T", "list available format templates") do
-          tdir   = File.join(DIR, 'templates')
-          tfiles = Dir[File.join(tdir, '**/*.erb')]
-          tnames = tfiles.map{ |tname| tname.sub(tdir+'/', '').chomp('.erb') }
-          groups = tnames.group_by{ |tname| tname.split('/').first }
-          groups.sort.each do |(type, names)|
-            puts("%-18s " * names.size % names.sort)
-          end
-          exit
-        end
-
-        opt.on_tail('--help', '-h', "show this help information") do
-          puts opt
-          exit
-        end
-      end
-
-      begin
-        opts.parse!(argv)
-        session.paths.replace(argv)
-        session.run
-      rescue => err
-        raise err if $DEBUG
-        puts err
-        exit 1
-      end
+      session = Options.parse(*argv)
+      session.run
     end
-
   end
-
 end
-

data/lib/dnote/version.rb

@@ -1,17 +1,5 @@
-module DNote
-  VERSION = '1.7.2'
-
-  #
-  def self.metadata
-    @metadata ||= (
-      require 'yaml'
-      YAML.load_file(File.dirname(__FILE__) + '/../dnote.yml')
-    )
-  end
-
-  #
-  def self.const_missing(name)
-    metadata[name.to_s.downcase] || super(name)
-  end
+# frozen_string_literal: true
 
+module DNote
+  VERSION = "1.10.0"
 end

data/lib/dnote.rb

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