todo_lint 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9468fdec36cf8fd3dd9af14c1969c31181fed8ff
-  data.tar.gz: 665b4a107a8dc3202edfe9125ca7f7787446da10
+  metadata.gz: 8dd171321dda2f34a965d06f4db8a014fbd6972c
+  data.tar.gz: 2790af0c8f0d386ede48b57d7122bbefd141224f
 SHA512:
-  metadata.gz: 62036c3c37d81615f93f88699de46fbf31bad91f831ff7d961f8527c3fea201fef25a45f21c5a39bf52aadd17e9bf7eb8691bb5faeda3ae00908506f676ceb86
-  data.tar.gz: e5683ed19b617972f455b36562feec1297eb9c5f7250f66b1951bf8c6cbaa5ffd9b48ce0162880ac134aea2203b08596ac97e796ddb6531ca99915be13fa3898
+  metadata.gz: 3ecf76a06b3f3da22f3d39b9152e4d99aa6fbbe95e7fb377c2211846fba7a55b35f7c8e015daf21cd60cbfd30429fb614b83168cc81c233a0ef3b2752eaffc87
+  data.tar.gz: f59058158b7f2e2bd76be1253106b779987034c947e58fb02ddb09ed3763c0e23d985e0c7d675e06f6faf280e74cf20c6f5ccba38cba1a1b62260a1e82730ca6

data/.rubocop.yml

@@ -18,3 +18,7 @@ Metrics/MethodLength:
   Exclude:
     - lib/todo_lint/cli.rb
     - lib/todo_lint/options.rb
+
+Metrics/ModuleLength:
+  Exclude:
+    - spec/**/*.rb

data/lib/todo_lint/cli.rb

@@ -64,7 +64,7 @@ module TodoLint
       files = load_files(finder)
       files_count = files.count
       reports = files.map do |file|
-        Todo.within(File.open(file)).map do |todo|
+        Todo.within(File.open(file), :config => @options).map do |todo|
           reporter = Reporter.new(todo,
                                   :judge => Judge.new(todo))
           reporter.report.tap do |report|
@@ -96,11 +96,12 @@ module TodoLint
       finder = FileFinder.new(path, options)
       files = load_files(finder)
       files.each do |file|
-        todos += Todo.within(File.open(file))
+        todos += Todo.within(File.open(file), :config => @options)
       end
       todos.sort.each.with_index do |todo, num|
         due_date = if todo.due_date
-                     Rainbow(" (due #{todo.due_date.to_date})")
+                     tag_context = " via #{todo.tag}" if todo.tag?
+                     Rainbow(" (due #{todo.due_date.to_date}#{tag_context})")
                        .public_send(todo.due_date.overdue? ? :red : :blue)
                    else
                      Rainbow(" (no due date)").red

data/lib/todo_lint/config_file.rb

@@ -5,12 +5,13 @@ module TodoLint
   class ConfigFile
     # Parses the config file and loads the options
     # @api public
-    # @example ConfigFile.new.parse('.todo-lint.yml')
+    # @example ConfigFile.new.read_config_file('.todo-lint.yml')
     # @return [Hash] parsed file-options
     def read_config_file(file)
       @config_hash = YAML.load_file(file)
       @starting_path = File.expand_path(File.split(file).first)
       @config_options = {}
+      load_tags
       load_file_exclusions
       load_extension_inclusions
       config_options
@@ -51,5 +52,21 @@ module TodoLint
       return unless config_hash["Extensions"]
       config_options[:extensions] = config_hash["Extensions"]
     end
+
+    # Load the tags from the configuration file as DueDates
+    #
+    # @return is irrelevant
+    # @api private
+    def load_tags
+      config_options[:tags] = {}
+      return unless config_hash["Tags"]
+      config_hash["Tags"].each do |tag, due_date|
+        unless due_date.is_a? Date
+          raise ArgumentError, "#{due_date} is not a date"
+        end
+
+        config_options[:tags]["##{tag}"] = DueDate.new(due_date)
+      end
+    end
   end
 end

data/lib/todo_lint/due_date.rb

@@ -3,7 +3,18 @@ require "date"
 module TodoLint
   # When is this todo actually due? When ought we be reminded of this one?
   class DueDate
-    ANNOTATION_PATTERN = /\((\d{4})-(\d{2})-(\d{2})/
+    DATE_PATTERN = /(\d{4})-(\d{2})-(\d{2})/
+    ANNOTATION_PATTERN = /\(#{DATE_PATTERN}\)/
+
+    # Parse the date from the todo_lint configuration file
+    # @example
+    #   DueDate.from_config_file("2015-04-14")
+    # @return [DueDate] if the annotation is formatted properly
+    # @raise [ArgumentError] if the annotation is not formatted properly
+    # @api public
+    def self.from_config_file(date)
+      from_pattern(date, DATE_PATTERN)
+    end
 
     # Parse the date from the todo comment's due date annotation
     # @example
@@ -11,14 +22,23 @@ module TodoLint
     # @return [DueDate] if the annotation is formatted properly
     # @raise [ArgumentError] if the annotation is not formatted properly
     # @api public
-    def self.from_annotation(annotation)
-      if (match = ANNOTATION_PATTERN.match(annotation))
+    def self.from_annotation(date)
+      from_pattern(date, ANNOTATION_PATTERN)
+    end
+
+    # Helper method for extracting dates from patterns
+    # @return [DueDate] if pattern matches
+    # @raise [ArgumentError] if pattern does not match
+    # @api private
+    def self.from_pattern(date, pattern)
+      if (match = pattern.match(date))
         DueDate.new(Date.new(match[1].to_i, match[2].to_i, match[3].to_i))
       else
-        msg = "not a properly formatted annotation: #{annotation.inspect}"
+        msg = "not a properly formatted date: #{date.inspect}"
         raise ArgumentError, msg
       end
     end
+    private_class_method :from_pattern
 
     # The actual date object when something is due
     # @example

data/lib/todo_lint/judge.rb

@@ -15,10 +15,30 @@ module TodoLint
     #   Judge.new(todo)
     # @api public
     def initialize(todo)
-      if todo.annotated?
-        @charge = "Overdue due date" if todo.due_date.overdue?
-      else
-        @charge = "Missing due date annotation"
+      @todo = todo
+      @charge = make_charge
+    end
+
+    private
+
+    # Which todo is being judged?
+    #
+    # @return [Todo]
+    # @api private
+    attr_reader :todo
+
+    # What is the problem with this todo?
+    #
+    # @return [String] if there's a problem
+    # @return [NilClass] if no charge needed
+    # @api private
+    def make_charge
+      if !todo.annotated?
+        "Missing due date annotation"
+      elsif todo.due_date.overdue? && todo.tag?
+        "Overdue due date #{todo.due_date.to_date} via tag"
+      elsif todo.due_date.overdue?
+        "Overdue due date"
       end
     end
   end

data/lib/todo_lint/todo.rb

@@ -5,8 +5,9 @@ module TodoLint
     PATTERN = /
     (?<flag> TODO ){0}
     (?<due_date> \(\d{4}-\d{2}-\d{2}\)){0}
+    (?<tag>\#\w+){0}
     (?<task>.+){0}
-    \g<flag>\g<due_date>?: \g<task>
+    \g<flag>(?:\g<due_date>|(?:\(\g<tag>\)))?: \g<task>
     /x
 
     # Search a file for all of the todo/fixme/etc comments within it
@@ -14,11 +15,15 @@ module TodoLint
     #   Todo.within(File.open("app.rb"))
     # @api public
     # @return [Array<Todo>]
-    def self.within(file)
+    def self.within(file, config: RequiredArg.new(:config))
       file.each_line.with_index.map do |line, line_number|
-        if present_in?(line)
-          new(line, :line_number => line_number + 1, :path => file.path)
-        end
+        next unless present_in?(line)
+        new(
+          line,
+          :line_number => line_number + 1,
+          :path => file.path,
+          :config => config
+        )
       end.compact
     end
 
@@ -60,11 +65,13 @@ module TodoLint
     # @api public
     def initialize(line,
                    line_number: RequiredArg.new(:line_number),
-                   path: RequiredArg.new(:path))
+                   path: RequiredArg.new(:path),
+                   config: RequiredArg.new(:config))
       absent_todo!(line) unless self.class.present_in?(line)
       @line = line
       @line_number = line_number
       @path = path
+      @config = config
     end
 
     # Was this todo annotated with a due date?
@@ -77,7 +84,7 @@ module TodoLint
     # @return [Boolean]
     # @api public
     def annotated?
-      !match[:due_date].nil?
+      !match[:due_date].nil? || !match[:tag].nil?
     end
 
     # What is the actual task associated with this todo?
@@ -101,7 +108,13 @@ module TodoLint
     # @return [NilClass] if there is no due date
     # @api public
     def due_date
-      DueDate.from_annotation(match[:due_date]) if annotated?
+      return unless annotated?
+      return @due_date if defined?(@due_date)
+      @due_date = if match[:due_date]
+                    DueDate.from_annotation(match[:due_date])
+                  elsif match[:tag]
+                    lookup_tag_due_date
+                  end
     end
 
     # What did the developer write to get our attention?
@@ -122,6 +135,29 @@ module TodoLint
       (line =~ PATTERN) + 1
     end
 
+    # Was this todo using a tag (as opposed to a direct due date)?
+    #
+    # @example
+    #   todo.tag? #=> true
+    # @return [Boolean]
+    # @api public
+    def tag?
+      !match[:tag].nil?
+    end
+
+    # What tag does this todo use?
+    #
+    # @example
+    #   todo.tag #=> "#shipit"
+    #   todo.tag #=> nil
+    #
+    # @return [String] if the Todo has a tag
+    # @return [NilClass] if the Todo has no tag
+    # @api public
+    def tag
+      match[:tag]
+    end
+
     # Which todo is due sooner?
     #
     # @example
@@ -161,6 +197,12 @@ module TodoLint
 
     private
 
+    # What is the configuration for this code base's todo_lint setup?
+    #
+    # @return [Hash]
+    # @api private
+    attr_reader :config
+
     # Analyze the line to help identify when the todo is due
     # @return [MatchData]
     # @api private
@@ -174,5 +216,16 @@ module TodoLint
     def absent_todo!(line)
       raise ArgumentError, "Not even a todo: #{line.inspect}"
     end
+
+    # A tag was referenced, so let's see when that's due
+    # @return [DueDate]
+    # @raise [KeyError] if the tag does not reference a due date in the config
+    # @api private
+    def lookup_tag_due_date
+      config.fetch(:tags).fetch(match[:tag])
+    rescue KeyError
+      msg = "#{match[:tag]} tag not defined in config file"
+      raise KeyError, msg
+    end
   end
 end

data/lib/todo_lint/version.rb

@@ -2,5 +2,5 @@
 # it's in its own file so it can be required in the gemspec without requiring
 # everything else as well
 module TodoLint
-  VERSION = "0.3.1".freeze
+  VERSION = "0.4.0".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: todo_lint
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Max Jacobson