todo_lint 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3d925d1749e411f4de9fc8c753060ab43ef53937
-  data.tar.gz: b8c5e5db3ca4f210b752ede2a47c43e451e72fab
+  metadata.gz: 9468fdec36cf8fd3dd9af14c1969c31181fed8ff
+  data.tar.gz: 665b4a107a8dc3202edfe9125ca7f7787446da10
 SHA512:
-  metadata.gz: 99c1e602b9ef8577c0cd984b772a1417b4c1b658a026d6183d2420d1bf4f2a3e63b80c625d525f46221cd9ab61a29a853e9af6598a6c9cd7c6e9b3984af087e6
-  data.tar.gz: 45caf05a85101b675925986157b573ccf8d2ff7230435b448711d0078ef9141d6fbe90e426aad8fe878ee9070d1cca31e5d9f65bec811802fb6116b5c09465eb
+  metadata.gz: 62036c3c37d81615f93f88699de46fbf31bad91f831ff7d961f8527c3fea201fef25a45f21c5a39bf52aadd17e9bf7eb8691bb5faeda3ae00908506f676ceb86
+  data.tar.gz: e5683ed19b617972f455b36562feec1297eb9c5f7250f66b1951bf8c6cbaa5ffd9b48ce0162880ac134aea2203b08596ac97e796ddb6531ca99915be13fa3898

data/README.md

@@ -47,6 +47,14 @@ to:
 
 Now your build will pass. Until November, 2043.
 
+### Alternative usage as todo_list generator
+
+If you'd like a summary of all of the todos, instead run:
+
+```
+bundle exec todo_lint --report
+```
+
 ## Configuration
 
 Create a .todo_lint.yml file in your main repo
@@ -71,6 +79,7 @@ Command flag              | Description
 `-c/--config [FILE]`      | Load the specified config file
 `-e/--exclude [FILES]`    | Exclude the specified files
 `-i/--include [EXTS]`     | Only look at specified extensions
+`-r/--report`             | Print a sorted todo list instead of linting
 
 ## Development
 

data/lib/todo_lint/cli.rb

@@ -66,7 +66,6 @@ module TodoLint
       reports = files.map do |file|
         Todo.within(File.open(file)).map do |todo|
           reporter = Reporter.new(todo,
-                                  :path => file,
                                   :judge => Judge.new(todo))
           reporter.report.tap do |report|
             print Rainbow(".").public_send(report.nil? ? :green : :red)
@@ -101,11 +100,16 @@ module TodoLint
       end
       todos.sort.each.with_index do |todo, num|
         due_date = if todo.due_date
-                     Rainbow(" (due #{todo.due_date.to_date})").blue
+                     Rainbow(" (due #{todo.due_date.to_date})")
+                       .public_send(todo.due_date.overdue? ? :red : :blue)
                    else
-                     Rainbow(" (missing due date)").red
+                     Rainbow(" (no due date)").red
                    end
-        puts "#{num + 1}. #{todo.task}#{due_date}"
+        puts "#{num + 1}. #{todo.task}#{due_date} " +
+             Rainbow(
+               "(#{todo.relative_path}:#{todo.line_number}:" \
+               "#{todo.character_number})"
+             ).yellow
       end
 
       exit 0

data/lib/todo_lint/reporter.rb

@@ -5,12 +5,11 @@ module TodoLint
     # Accept a todo and a path to check for problems
     # @example
     #   Reporter.new(todo,
-    #     path: "/Users/max/src/required_arg/README.md",
     #     judge: Judge.new(todo))
     # @api public
-    def initialize(todo, path: RequiredArg.new, judge: RequiredArg.new)
+    def initialize(todo, judge: RequiredArg.new)
       @todo = todo
-      @path = path
+      @path = todo.path
       @judge = judge
     end
 

data/lib/todo_lint/todo.rb

@@ -16,7 +16,9 @@ module TodoLint
     # @return [Array<Todo>]
     def self.within(file)
       file.each_line.with_index.map do |line, line_number|
-        new(line, :line_number => line_number + 1) if present_in?(line)
+        if present_in?(line)
+          new(line, :line_number => line_number + 1, :path => file.path)
+        end
       end.compact
     end
 
@@ -44,14 +46,25 @@ module TodoLint
     # @return [Fixnum]
     attr_reader :line_number
 
+    # The absolute path to the file where we found this todo
+    # @example
+    #   todo.path #=> "/Users/max/src/layabout/Gemfile"
+    #
+    # @api public
+    # @return [String]
+    attr_reader :path
+
     # A new Todo must know a few things
     # @example
     #   Todo.new("#TODO: get a boat", line_number: 4)
     # @api public
-    def initialize(line, line_number: RequiredArg.new(:line_number))
+    def initialize(line,
+                   line_number: RequiredArg.new(:line_number),
+                   path: RequiredArg.new(:path))
       absent_todo!(line) unless self.class.present_in?(line)
       @line = line
       @line_number = line_number
+      @path = path
     end
 
     # Was this todo annotated with a due date?
@@ -120,6 +133,18 @@ module TodoLint
       due_date_for_sorting <=> other.due_date_for_sorting
     end
 
+    # The relative path to the file where this todo was found
+    #
+    # @example
+    #   todo.relative #=> "spec/spec_helper.rb"
+    #
+    # @return [String]
+    # @api public
+    def relative_path
+      current_dir = Pathname.new(File.expand_path("./"))
+      Pathname.new(path).relative_path_from(current_dir).to_s
+    end
+
     protected
 
     # Helper for sorting todos

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.0".freeze
+  VERSION = "0.3.1".freeze
 end

metadata

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