mvz-dnote 1.7.2 → 1.8.0

data/lib/dnote/note.rb

@@ -1,35 +1,32 @@
-module DNote
+# frozen_string_literal: true
 
+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
+    attr_reader :notes
 
     # The file in which the note is made.
-    attr :file
+    attr_reader :file
 
     # The type of note.
-    attr :label
+    attr_reader :label
 
     # The line number of the note.
-    attr :line
+    attr_reader :line
 
     # The verbatim text of the note.
-    attr :text
+    attr_reader :text
 
     # Remark marker used in parsing the note.
-    attr :mark
+    attr_reader :mark
 
     # Contextual lines of code.
-    attr :capture
+    attr_reader :capture
 
     # Initialize new Note instance.
     def initialize(notes, file, label, line, text, mark)
@@ -55,13 +52,14 @@ module DNote
 
     # Remove newlines from note text.
     def textline
-      text.gsub("\n", " ")
+      text.tr("\n", ' ')
     end
 
     # Sort by file name and line number.
     def <=>(other)
       s = file <=> other.file
-      return s unless s == 0
+      return s unless s.zero?
+
       line <=> other.line
     end
 
@@ -71,12 +69,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.
@@ -93,13 +91,12 @@ module DNote
     # returns the file.
     def url
       if notes.url
-        notes.url % [file, line]
+        format(notes.url, file, line)
       else
         file
       end
     end
 
-    #
     def code
       unindent(capture).join
     end
@@ -109,42 +106,20 @@ module DNote
       !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
+        if (md = /^([\ ]*)/.match(line))
           dents << md[1]
         end
       end
-      dent = dents.min{ |a,b| a.size <=> b.size }
+      dent = dents.min_by(&:size)
       lines.map do |line|
         line.sub(dent, '')
       end
     end
-
   end
-
 end

data/lib/dnote/notes.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 require 'pathname'
 require 'dnote/note'
 
 module DNote
-
   # = Developer Notes
   #
   # This class goes through you source files and compiles a list
@@ -20,10 +21,10 @@ module DNote
     include Enumerable
 
     # Default paths (all ruby scripts).
-    DEFAULT_PATHS  = ["**/*.rb"]
+    DEFAULT_PATHS  = ['**/*.rb'].freeze
 
     # Default note labels to look for in source code. (NOT CURRENTLY USED!)
-    DEFAULT_LABELS = ['TODO', 'FIXME', 'OPTIMIZE', 'THINK', 'DEPRECATE']
+    DEFAULT_LABELS = %w(TODO FIXME OPTIMIZE THINK DEPRECATE).freeze
 
     # Files to search for notes.
     attr_accessor :files
@@ -44,11 +45,11 @@ module DNote
     attr_accessor :context
 
     # New set of notes for give +files+ and optional special labels.
-    def initialize(files, options={})
+    def initialize(files, options = {})
       @files   = [files].flatten
       @labels  = [options[:labels] || DEFAULT_LABELS].flatten.compact
       @colon   = options[:colon].nil? ? true : options[:colon]
-      @marker  = options[:marker] #|| '#'
+      @marker  = options[:marker]
       @url     = options[:url]
       @context = options[:context] || 0
 
@@ -58,19 +59,17 @@ module DNote
     end
 
     # Array of notes.
-    def notes
-      @notes
-    end
+    attr_reader :notes
 
     # Notes counts by label.
     def counts
-      @counts ||= (
+      @counts ||= begin
         h = {}
         by_label.each do |label, notes|
           h[label] = notes.size
         end
         h
-      )
+      end
     end
 
     # Iterate through notes.
@@ -91,46 +90,41 @@ module DNote
       records = []
       files.each do |fname|
         next unless File.file?(fname)
-        #next unless fname =~ /\.rb$/      # TODO: should this be done?
+
         mark = remark(fname)
-        lineno, note, text, capt = 0, nil, nil, nil
+        lineno = 0
+        note = nil
+        text = nil
+        capt = nil
         File.readlines(fname).each do |line|
-          #while line = f.gets
-            lineno += 1
-            note = match(line, lineno, fname)
-            if note
-              #file = fname
-              text = note.text
-              capt = note.capture
-              #note = {'label'=>label,'file'=>file,'line'=>line_no,'note'=>text}
-              records << note
-            else
-              if 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
+          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
-                if line !~ /^\s*#{mark}/
-                  capt << line if capt && capt.size < context
-                end
+                text << "\n" << line.gsub(/^\s*#{mark}\s*/, '')
               end
+            else
+              text.strip!
+              text = nil
             end
-          #end
+          elsif line !~ /^\s*#{mark}/
+            capt << line if capt && capt.size < context
+          end
         end
       end
 
-      @notes  = records.sort
+      @notes = records.sort
     end
 
     # Is this line a note?
@@ -146,9 +140,8 @@ module DNote
     def match_special(line, lineno, file)
       rec = nil
       labels.each do |label|
-        if md = match_special_regex(label, file).match(line)
+        if (md = match_special_regex(label, file).match(line))
           text = md[1]
-          #rec = {'label'=>label,'file'=>file,'line'=>lineno,'note'=>text}
           rec = Note.new(self, file, label, lineno, text, remark(file))
         end
       end
@@ -156,7 +149,7 @@ module DNote
     end
 
     #--
-    # TODO: ruby-1.9.1-p378 reports: `match': invalid byte sequence in UTF-8 
+    # TODO: ruby-1.9.1-p378 reports: `match': invalid byte sequence in UTF-8
     #++
     def match_special_regex(label, file)
       mark = remark(file)
@@ -170,12 +163,12 @@ module DNote
     # Match notes that are labeled with a colon.
     def match_general(line, lineno, file)
       rec = nil
-      if md = match_general_regex(file).match(line)
-        label, text = md[1], md[2]
-        #rec = {'label'=>label,'file'=>file,'line'=>lineno,'note'=>text}
+      if (md = match_general_regex(file).match(line))
+        label = md[1]
+        text = md[2]
         rec = Note.new(self, file, label, lineno, text, remark(file))
       end
-      return rec
+      rec
     end
 
     # Keep in mind that general non-colon matches have a higher potential
@@ -184,70 +177,70 @@ module DNote
       mark = remark(file)
       if colon
         /#{mark}\s*([A-Z]+)[:]\s+(.*?)$/
-      else 
+      else
         /#{mark}\s*([A-Z]+)\s+(.*?)$/
       end
     end
 
     # Organize notes into a hash with labels for keys.
     def by_label
-      @by_label ||= (
+      @by_label ||= begin
         list = {}
         notes.each do |note|
           list[note.label] ||= []
           list[note.label] << note
-          list[note.label].sort #!{ |a,b| a.line <=> b.line }
+          list[note.label].sort
         end
         list
-      )
+      end
     end
 
     # Organize notes into a hash with filename for keys.
     def by_file
-      @by_file ||= (
+      @by_file ||= begin
         list = {}
         notes.each do |note|
           list[note.file] ||= []
           list[note.file] << note
-          list[note.file].sort! #!{ |a,b| a.line <=> b.line }
+          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 ||= (
+      @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! #{ |a,b| a.line <=> b.line }
+          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 ||= (
+      @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! #{ |a,b| a.line <=> b.line }
+          list[note.file][note.label].sort!
         end
         list
-      )
+      end
     end
 
     # Convert to an array of hashes.
     def to_a
-      notes.map{ |n| n.to_h }
+      notes.map(&:to_h)
     end
 
     # Same as #by_label.
@@ -255,12 +248,11 @@ module DNote
       by_label
     end
 
-    #
     def remark(file)
-      @remark[File.extname(file)] ||= (
+      @remark[File.extname(file)] ||= begin
         mark = guess_marker(file)
         Regexp.escape(mark)
-      )
+      end
     end
 
     # Guess marker based on file extension. Fallsback to '#'
@@ -269,6 +261,7 @@ module DNote
     # TODO: Continue to add comment types.
     def guess_marker(file)
       return @marker if @marker # forced marker
+
       case File.extname(file)
       when '.js', '.c', 'cpp', '.css'
         '//'
@@ -279,42 +272,8 @@ module DNote
       when '.asm'
         ';'
       else
-        '#'        
+        '#'
       end
     end
-
-    # Convert to array of hashes then to YAML.
-    #def to_yaml
-    #  require 'yaml'
-    #  to_a.to_yaml
-    #end
-
-    # Convert to array of hashes then to JSON.
-    #def to_json
-    #  begin
-    #    require 'json'
-    #  rescue LoadError
-    #    require 'json_pure'
-    #  end
-    #  to_a.to_json
-    #end
-
-    # Convert to array of hashes then to a SOAP XML envelope.
-    #def to_soap
-    #  require 'soap/marshal'
-    #  SOAP::Marshal.marshal(to_a)
-    #end
-
-    # XOXO microformat.
-    #--
-    # TODO: Would to_xoxo be better organized by label and or file?
-    #++
-    #def to_xoxo
-    #  require 'xoxo'
-    #  to_a.to_xoxo
-    #end
-
   end
-
 end
-