mvz-dnote 1.8.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b9675201f53edcd5b27e0121bd08844769047c613d3d92b44b7ec9326e2f49d
-  data.tar.gz: 0b386e81dea084ee1618d6fd13fe48b5a8c15ec6be9a420442880f715956c05a
+  metadata.gz: 63a1703569a00e121051d24aa575d670c35a073d2ad3bb297ac21d9962df74c4
+  data.tar.gz: bb4a5b8e4af7345fd785a99437894558fde1db23afec33483fba5cc80a48bf2d
 SHA512:
-  metadata.gz: dfe4a7bb7d9fb549025519ee59030c863e3a4c9242a55f96bdbb5dc17d93d9eae569f09f16ed39a3fb107382b753fc307cf2c8fad543bc7c819cba85f7a1010b
-  data.tar.gz: 190179a14bcddc1ae626107c05237afc6adce940e2c72047b3a7e4f3348c0646bb82c59ed4984357feb716113c068d749819005d7247f48536e15549efff6fae
+  metadata.gz: 42983874e4878d69f6e6611a5498ca3fa8fe69432970430851375a42d7c8380c2a30c3dcdd7a72b867c570b35dcd9c7dcee47236608cff0869fa85ddc20e6fb2
+  data.tar.gz: 4818f542b9c8ff57c1764ab33e54d938777d23c24b78713f45d19cb6b84c55d5705bbe0cdbf907475d81486e9ae917b296b554382ff35fef0dcc72b7aed24719

data/HISTORY.rdoc

@@ -1,5 +1,14 @@
 = RELEASE HISTORY
 
+== Unreleased
+
+== 1.9.0 / 2021-09-17
+
+* Drop support for Ruby 2.3 and 2.4
+* Officially support Ruby 2.7 and 3.0
+* Update development dependencies
+* Improve code quality
+
 == 1.8.0 / 2018-12-29
 
 * Officially support CRuby 2.5 and 2.6

data/README.md

@@ -5,9 +5,6 @@
 * [Source Code](http://github.com/rubyworks/dnote)
 
 [![Gem Version](https://badge.fury.io/rb/mvz-dnote.svg)](https://badge.fury.io/rb/mvz-dnote)
-[![Build Status](https://travis-ci.org/mvz/mvz-dnote.svg?branch=master)](https://travis-ci.org/mvz/mvz-dnote)
-[![Coverage Status](https://coveralls.io/repos/github/mvz/mvz-dnote/badge.svg?branch=master)](https://coveralls.io/github/mvz/mvz-dnote?branch=master)
-[![Dependency Status](https://gemnasium.com/badges/github.com/mvz/mvz-dnote.svg)](https://gemnasium.com/github.com/mvz/mvz-dnote)
 [![Maintainability](https://api.codeclimate.com/v1/badges/608621bbad5de3a98e3b/maintainability)](https://codeclimate.com/github/mvz/dnote/maintainability)
 
 ## DESCRIPTION

data/bin/dnote

@@ -1,13 +1,13 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require 'dnote'
+require "dnote"
 
 begin
   DNote::Session.main(*ARGV)
-rescue StandardError => err
-  raise err if $DEBUG
+rescue StandardError => e
+  raise e if $DEBUG
 
-  puts err
+  puts e
   exit 1
 end

data/lib/dnote/core_ext.rb

@@ -13,9 +13,9 @@ module DNote
 
     def indent(num)
       if num >= 0
-        gsub(/^/, ' ' * num)
+        gsub(/^/, " " * num)
       else
-        gsub(/^ {0,#{-num}}/, '')
+        gsub(/^ {0,#{-num}}/, "")
       end
     end
 

data/lib/dnote/format.rb

@@ -9,35 +9,27 @@ module DNote
   #   TODO: Need XSL?
   #++
   class Format
-    require 'fileutils'
-    require 'erb'
-    require 'rexml/text'
-    require 'dnote/core_ext'
-
-    EXTENSIONS = { 'text' => 'txt', 'soap' => 'xml', 'xoxo' => 'xml' }.freeze
-
-    attr_reader :notes
-
-    attr_accessor :format
-
-    attr_accessor :subtype
-
-    attr_accessor :output
-
-    attr_accessor :template
-
-    attr_accessor :title
-
-    attr_accessor :dryrun
-
-    def initialize(notes, options = {})
-      @notes   = notes
-      @format  = 'text'
-      @subtype = 'label'
-      @title   = "Developer's Notes"
-      @dryrun  = false
-      options.each { |k, v| __send__("#{k}=", v) if v }
-      yield(self) if block_given?
+    require "fileutils"
+    require "erb"
+    require "rexml/text"
+    require "dnote/core_ext"
+
+    EXTENSIONS = { "text" => "txt", "soap" => "xml", "xoxo" => "xml" }.freeze
+
+    attr_reader :notes, :format, :output, :template, :title, :dryrun
+
+    def initialize(notes,
+                   format: "text",
+                   title: "Developer's Notes",
+                   template: nil,
+                   output: nil,
+                   dryrun: false)
+      @notes    = notes
+      @format   = format
+      @title    = title
+      @dryrun   = dryrun
+      @template = template
+      @output   = output
     end
 
     def render
@@ -45,7 +37,7 @@ module DNote
         $stderr << "No #{notes.labels.join(', ')} notes.\n"
       else
         case format
-        when 'custom'
+        when "custom"
           render_custom
         else
           render_template
@@ -53,6 +45,8 @@ module DNote
       end
     end
 
+    private
+
     # C U S T O M
 
     def render_custom
@@ -63,15 +57,13 @@ module DNote
     # T E M P L A T E
 
     def render_template
-      template = File.join(File.dirname(__FILE__), 'templates', "#{format}.erb")
+      template = File.join(File.dirname(__FILE__), "templates", "#{format}.erb")
       raise "No such format - #{format}" unless File.exist?(template)
 
       result = erb(template)
       publish(result)
     end
 
-    private
-
     def erb(file)
       scope = ErbScope.new(notes: notes, title: title)
       scope.render(file)
@@ -83,12 +75,12 @@ module DNote
       else
         puts(result)
       end
-      $stderr << '(' + notes.counts.map { |l, n| "#{n} #{l}s" }.join(', ') + ")\n"
+      $stderr << "(#{notes.counts.map { |l, n| "#{n} #{l}s" }.join(', ')})\n"
     end
 
     def write(result, fname = nil)
-      if output.to_s[-1, 1] == '/' || File.directory?(output)
-        fmt  = format.split('/').first
+      if output.to_s[-1, 1] == "/" || File.directory?(output)
+        fmt  = format.split("/").first
         ext  = EXTENSIONS[fmt] || fmt
         file = File.join(output, fname || "notes.#{ext}")
       else
@@ -100,7 +92,7 @@ module DNote
       else
         dir = File.dirname(file)
         fu.mkdir(dir) unless File.exist?(dir)
-        File.open(file, 'w') { |f| f << result }
+        File.open(file, "w") { |f| f << result }
       end
       file
     end
@@ -114,7 +106,7 @@ module DNote
     end
 
     def fu
-      @fu ||= begin
+      @fu ||=
         if dryrun? && debug?
           FileUtils::DryRun
         elsif dryrun?
@@ -124,7 +116,6 @@ module DNote
         else
           FileUtils
         end
-      end
     end
 
     # Evaluation scope for ERB templates
@@ -134,7 +125,12 @@ module DNote
       end
 
       def render(file)
-        erb = ERB.new(File.read(file), nil, '<>')
+        contents = File.read(file)
+        erb = if RUBY_VERSION >= "2.6"
+                ERB.new(contents, trim_mode: "<>")
+              else
+                ERB.new(contents, nil, "<>")
+              end
         erb.result(binding)
       end
 
@@ -150,7 +146,7 @@ module DNote
       end
 
       def respond_to_missing?(method)
-        @data.key? method.to_sym
+        @data.key?(method.to_sym) || super
       end
     end
   end

data/lib/dnote/note.rb

@@ -31,7 +31,6 @@ module DNote
     # Initialize new Note instance.
     def initialize(notes, file, label, line, text, mark)
       @notes   = notes
-
       @file    = file
       @label   = label
       @line    = line
@@ -52,13 +51,13 @@ module DNote
 
     # Remove newlines from note text.
     def textline
-      text.tr("\n", ' ')
+      text.tr("\n", " ")
     end
 
     # Sort by file name and line number.
     def <=>(other)
       s = file <=> other.file
-      return s unless s.zero?
+      return s unless s == 0
 
       line <=> other.line
     end
@@ -69,12 +68,12 @@ module DNote
     # TODO: Add +code+? Problem is that xml needs code in CDATA.
     #++
     def to_h
-      { 'label' => label, 'text' => textline, 'file' => file, 'line' => line }
+      { "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, 'code' => code }
+      { "label" => label, "text" => text, "file" => file, "line" => line, "code" => code }
     end
 
     # Convert to JSON.
@@ -89,6 +88,8 @@ module DNote
 
     # Return line URL based on URL template. If no template was set, then
     # returns the file.
+    #
+    # FIXME: Move out of Note so we can drop the reference to notes
     def url
       if notes.url
         format(notes.url, file, line)
@@ -112,13 +113,13 @@ module DNote
     def unindent(lines)
       dents = []
       lines.each do |line|
-        if (md = /^([\ ]*)/.match(line))
+        if (md = /^(\ *)/.match(line))
           dents << md[1]
         end
       end
       dent = dents.min_by(&:size)
       lines.map do |line|
-        line.sub(dent, '')
+        line.sub(dent, "")
       end
     end
   end

data/lib/dnote/notes.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
-require 'pathname'
-require 'dnote/note'
+require "pathname"
+require "dnote/note"
+require "dnote/notes_collection"
 
 module DNote
   # = Developer Notes
@@ -18,31 +19,29 @@ module DNote
   #         have a outline format, rather then the single line.
   #++
   class Notes
-    include Enumerable
-
     # Default paths (all ruby scripts).
-    DEFAULT_PATHS  = ['**/*.rb'].freeze
+    DEFAULT_PATHS  = ["**/*.rb"].freeze
 
     # Default note labels to look for in source code. (NOT CURRENTLY USED!)
     DEFAULT_LABELS = %w(TODO FIXME OPTIMIZE THINK DEPRECATE).freeze
 
     # Files to search for notes.
-    attr_accessor :files
+    attr_reader :files
 
     # Labels to document. Defaults are: +TODO+, +FIXME+, +OPTIMIZE+ and +DEPRECATE+.
-    attr_accessor :labels
+    attr_reader :labels
 
     # Require label colon? Default is +true+.
-    attr_accessor :colon
+    attr_reader :colon
 
     # Specific remark marker (+nil+ for auto).
-    attr_accessor :marker
+    attr_reader :marker
 
     # Link template.
-    attr_accessor :url
+    attr_reader :url
 
     # Number of lines of context to show.
-    attr_accessor :context
+    attr_reader :context
 
     # New set of notes for give +files+ and optional special labels.
     def initialize(files, options = {})
@@ -52,34 +51,13 @@ module DNote
       @marker  = options[:marker]
       @url     = options[:url]
       @context = options[:context] || 0
-
       @remark  = {}
 
       parse
     end
 
-    # Array of notes.
-    attr_reader :notes
-
-    # Notes counts by label.
-    def counts
-      @counts ||= begin
-        h = {}
-        by_label.each do |label, notes|
-          h[label] = notes.size
-        end
-        h
-      end
-    end
-
-    # Iterate through notes.
-    def each(&block)
-      notes.each(&block)
-    end
-
-    # No notes?
-    def empty?
-      notes.empty?
+    def notes_collection
+      @notes_collection ||= NotesCollection.new(@notes)
     end
 
     # Gather notes.
@@ -89,42 +67,45 @@ module DNote
     def parse
       records = []
       files.each do |fname|
-        next unless File.file?(fname)
+        records += parse_file(fname)
+      end
 
-        mark = remark(fname)
-        lineno = 0
-        note = nil
-        text = nil
-        capt = nil
-        File.readlines(fname).each do |line|
-          lineno += 1
-          note = match(line, lineno, fname)
-          if note
-            text = note.text
-            capt = note.capture
-            records << note
-          elsif text
-            case line
-            when /^\s*#{mark}+\s*$/, /^\s*#{mark}\-\-/, /^\s*#{mark}\+\+/
-              text.strip!
-              text = nil
-            when /^\s*#{mark}/
-              if text[-1, 1] == "\n"
-                text << line.gsub(/^\s*#{mark}\s*/, '')
-              else
-                text << "\n" << line.gsub(/^\s*#{mark}\s*/, '')
-              end
-            else
-              text.strip!
-              text = nil
-            end
-          elsif line !~ /^\s*#{mark}/
-            capt << line if capt && capt.size < context
+      @notes = records.sort
+    end
+
+    def parse_file(fname)
+      return [] unless File.file?(fname)
+
+      records = []
+      mark = remark(fname)
+      lineno = 0
+      note = nil
+      text = nil
+      capt = nil
+      File.readlines(fname).each do |line|
+        lineno += 1
+        note = match(line, lineno, fname)
+        if note
+          text = note.text
+          capt = note.capture
+          records << note
+        elsif text
+          case line
+          when /^\s*#{mark}+\s*$/, /^\s*#{mark}--/, /^\s*#{mark}\+\+/
+            text.strip!
+            text = nil
+          when /^\s*#{mark}/
+            text << "\n" unless text[-1, 1] == "\n"
+            text << line.gsub(/^\s*#{mark}\s*/, "")
+          else
+            text.strip!
+            text = nil
           end
+        elsif !/^\s*#{mark}/.match?(line)
+          capt << line if capt && capt.size < context
         end
       end
-
-      @notes = records.sort
+      records
     end
 
     # Is this line a note?
@@ -148,15 +129,13 @@ module DNote
       rec
     end
 
-    #--
-    # TODO: ruby-1.9.1-p378 reports: `match': invalid byte sequence in UTF-8
-    #++
     def match_special_regex(label, file)
       mark = remark(file)
+      label = Regexp.escape(label)
       if colon
-        /#{mark}\s*#{Regexp.escape(label)}[:]\s+(.*?)$/
+        /#{mark}\s*#{label}:\s+(.*?)$/
       else
-        /#{mark}\s*#{Regexp.escape(label)}[:]?\s+(.*?)$/
+        /#{mark}\s*#{label}:?\s+(.*?)$/
       end
     end
 
@@ -176,83 +155,18 @@ module DNote
     def match_general_regex(file)
       mark = remark(file)
       if colon
-        /#{mark}\s*([A-Z]+)[:]\s+(.*?)$/
+        /#{mark}\s*([A-Z]+):\s+(.*?)$/
       else
         /#{mark}\s*([A-Z]+)\s+(.*?)$/
       end
     end
 
-    # Organize notes into a hash with labels for keys.
-    def by_label
-      @by_label ||= begin
-        list = {}
-        notes.each do |note|
-          list[note.label] ||= []
-          list[note.label] << note
-          list[note.label].sort
-        end
-        list
-      end
-    end
-
-    # Organize notes into a hash with filename for keys.
-    def by_file
-      @by_file ||= begin
-        list = {}
-        notes.each do |note|
-          list[note.file] ||= []
-          list[note.file] << note
-          list[note.file].sort!
-        end
-        list
-      end
-    end
-
-    # Organize notes into a hash with labels for keys, followed
-    # by a hash with filename for keys.
-    def by_label_file
-      @by_label_file ||= begin
-        list = {}
-        notes.each do |note|
-          list[note.label] ||= {}
-          list[note.label][note.file] ||= []
-          list[note.label][note.file] << note
-          list[note.label][note.file].sort!
-        end
-        list
-      end
-    end
-
-    # Organize notes into a hash with filenames for keys, followed
-    # by a hash with labels for keys.
-    def by_file_label
-      @by_file_label ||= begin
-        list = {}
-        notes.each do |note|
-          list[note.file] ||= {}
-          list[note.file][note.label] ||= []
-          list[note.file][note.label] << note
-          list[note.file][note.label].sort!
-        end
-        list
-      end
-    end
-
-    # Convert to an array of hashes.
-    def to_a
-      notes.map(&:to_h)
-    end
-
-    # Same as #by_label.
-    def to_h
-      by_label
-    end
-
     def remark(file)
-      @remark[File.extname(file)] ||= begin
-        mark = guess_marker(file)
-        Regexp.escape(mark)
-      end
+      @remark[File.extname(file)] ||=
+        begin
+          mark = guess_marker(file)
+          Regexp.escape(mark)
+        end
     end
 
     # Guess marker based on file extension. Fallsback to '#'
@@ -263,16 +177,16 @@ module DNote
       return @marker if @marker # forced marker
 
       case File.extname(file)
-      when '.js', '.c', 'cpp', '.css'
-        '//'
-      when '.bas'
+      when ".js", ".c", "cpp", ".css"
+        "//"
+      when ".bas"
         "'"
-      when '.sql', '.ada'
-        '--'
-      when '.asm'
-        ';'
+      when ".sql", ".ada"
+        "--"
+      when ".asm"
+        ";"
       else
-        '#'
+        "#"
       end
     end
   end

data/lib/dnote/notes_collection.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module DNote
+  # = Notes Collection
+  #
+  # This class contains a collection of Note objects and can group them in
+  # several ways.
+  #
+  class NotesCollection
+    include Enumerable
+
+    def initialize(notes)
+      @notes = notes
+    end
+
+    # Array of notes.
+    attr_reader :notes
+
+    # Notes counts by label.
+    def counts
+      @counts ||=
+        begin
+          h = {}
+          by_label.each do |label, notes|
+            h[label] = notes.size
+          end
+          h
+        end
+    end
+
+    # Iterate through notes.
+    def each(&block)
+      notes.each(&block)
+    end
+
+    # No notes?
+    def empty?
+      notes.empty?
+    end
+
+    # Organize notes into a hash with labels for keys.
+    def by_label
+      @by_label ||= notes.group_by(&:label)
+    end
+
+    # Organize notes into a hash with filename for keys.
+    def by_file
+      @by_file ||= notes.group_by(&:file)
+    end
+
+    # Organize notes into a hash with labels for keys, followed
+    # by a hash with filename for keys.
+    def by_label_file
+      @by_label_file ||= by_label.transform_values { |notes| notes.group_by(&:file) }
+    end
+
+    # Organize notes into a hash with filenames for keys, followed
+    # by a hash with labels for keys.
+    def by_file_label
+      @by_file_label ||= by_file.transform_values { |notes| notes.group_by(&:label) }
+    end
+
+    # Convert to an array of hashes.
+    def to_a
+      notes.map(&:to_h)
+    end
+
+    # Same as #by_label.
+    def to_h
+      by_label
+    end
+  end
+end

data/lib/dnote/options.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+require "dnote/core_ext"
+require "dnote/notes"
+require "dnote/format"
+require "optparse"
+
+module DNote
+  # Option parser
+  class Options
+    def self.parse(*argv)
+      new(argv).parse
+    end
+
+    def initialize(argv)
+      @argv = argv
+    end
+
+    def parse
+      session = Session.new
+
+      opts = OptionParser.new do |opt|
+        opt.banner = "DNote v#{DNote::VERSION}"
+
+        opt.separator(" ")
+        opt.separator("USAGE:\n  dnote [OPTIONS] path1 [path2 ...]")
+
+        add_output_format_options(session, opt)
+        add_other_options(session, opt)
+        add_command_options(session, opt)
+      end
+
+      opts.parse!(@argv)
+      session.paths.replace(@argv)
+      session
+    end
+
+    def add_command_options(session, opt)
+      opt.separator(" ")
+      opt.separator("COMMAND OPTIONS:")
+
+      opt.on_tail("--templates", "-T", "list available format templates") do
+        session.list_templates
+        exit
+      end
+
+      opt.on_tail("--help", "-h", "show this help information") do
+        puts opt
+        exit
+      end
+    end
+
+    def add_output_format_options(session, opt)
+      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
+    end
+
+    def add_other_options(session, opt)
+      opt.separator(" ")
+      opt.separator("OTHER OPTIONS:")
+
+      opt.on("--label", "-l LABEL", "labels to collect") do |lbl|
+        session.labels.concat(lbl.split(":"))
+      end
+
+      opt.on(:colon, "--[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
+    end
+  end
+end

data/lib/dnote/rake/dnotetask.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require 'rspec/core/rake_task'
+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 = %w(TODO FIXME OPTIMIZE DEPRECATE).freeze
@@ -38,30 +38,47 @@ module DNote
     end
 
     def init
-      require 'dnote'
-      require 'dnote/format'
-      @files   = '**/*.rb'
-      @output  = 'log/dnote'
-      @formats = ['index']
+      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|
+      session = new_session
+
+      formats.each do |format|
+        generate_document_for_format(session, format)
+      end
+    end
+
+    # Remove output files.
+    def clean
+      formats.each do |format|
+        clean_format format
+      end
+    end
+
+    private
+
+    def new_session
+      ::DNote::Session.new do |s|
         s.paths   = files
         s.exclude = exclude
         s.ignore  = ignore
@@ -70,31 +87,28 @@ module DNote
         s.output  = output
         s.dryrun  = application.options.dryrun # trial?
       end
+    end
 
-      formats.each do |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?
+    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
 
-    # Remove output files.
-    def clean
-      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}"
+    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,8 +1,9 @@
 # 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.
@@ -17,7 +18,7 @@ module DNote
     DIR = File.dirname(__FILE__)
 
     # Default format.
-    DEFAULT_FORMAT = 'text'
+    DEFAULT_FORMAT = "text"
 
     # Default title.
     DEFAULT_TITLE = "Developer's Notes"
@@ -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,11 +126,11 @@ 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 -= 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
 
@@ -133,115 +139,27 @@ module DNote
     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
 
-    # 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
+    # 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
 
-      opts.parse!(argv)
-      session.paths.replace(argv)
+    # Commandline interface.
+    def self.main(*argv)
+      session = Options.parse(*argv)
       session.run
     end
   end

data/lib/dnote/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DNote
-  VERSION = '1.8.0'
+  VERSION = "1.9.0"
 end

data/lib/dnote.rb

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

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: mvz-dnote
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.9.0
 platform: ruby
 authors:
 - Thomas Sawyer
 - Matijs van Zuijlen
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-12-29 00:00:00.000000000 Z
+date: 2021-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aruba
@@ -17,42 +17,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.1
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.1
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '7.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rake-manifest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -67,23 +95,79 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-packaging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.11.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.1
+        version: 0.21.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.1
-description: |2
-      DNote makes it easy to extract developer's notes from source code,
-      and supports almost any language.
+        version: 0.21.0
+description: |
+  DNote makes it easy to extract developer's notes from source code,
+  and supports almost any language.
 email:
 - matijs@matijs.net
 executables:
@@ -103,6 +187,8 @@ files:
 - lib/dnote/format.rb
 - lib/dnote/note.rb
 - lib/dnote/notes.rb
+- lib/dnote/notes_collection.rb
+- lib/dnote/options.rb
 - lib/dnote/rake/dnotetask.rb
 - lib/dnote/session.rb
 - lib/dnote/templates/html.erb
@@ -143,25 +229,31 @@ files:
 - lib/dnote/templates/yaml/list.erb
 - lib/dnote/version.rb
 homepage: https://github.com/mvz/dnote
-licenses: []
-metadata: {}
-post_install_message: 
-rdoc_options: []
+licenses:
+- BSD-2-Clause
+metadata:
+  homepage_uri: https://github.com/mvz/dnote
+  source_code_uri: https://github.com/mvz/dnote
+  changelog_uri: https://github.com/mvz/dnote/blob/master/HISTORY.rdoc
+post_install_message:
+rdoc_options:
+- "--main"
+- README.md
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Extract developer's notes from source code.
 test_files: []