todo_lint 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8cfbc707bf83355d703a91f8d939cb5ff22a9909
-  data.tar.gz: 9511008b2ac6197a9d310f9f2948a187ef806501
+  metadata.gz: 3d925d1749e411f4de9fc8c753060ab43ef53937
+  data.tar.gz: b8c5e5db3ca4f210b752ede2a47c43e451e72fab
 SHA512:
-  metadata.gz: 50f3de4d47e85788b3b7d179c2834655c04515df9539b0e809ebacd4073e117b85dd86777ae338ae600ee0f57fcb0190763d984fbf88b6a8b7203e36be4f2b61
-  data.tar.gz: d0bda1517784ce548ee12f3a7c9ef33c61460b40f9be95c78929e3fcd91876422138304d279c476530bd62afdc4d4ffddd834c6070577b33f024cf9c1e656a9e
+  metadata.gz: 99c1e602b9ef8577c0cd984b772a1417b4c1b658a026d6183d2420d1bf4f2a3e63b80c625d525f46221cd9ab61a29a853e9af6598a6c9cd7c6e9b3984af087e6
+  data.tar.gz: 45caf05a85101b675925986157b573ccf8d2ff7230435b448711d0078ef9141d6fbe90e426aad8fe878ee9070d1cca31e5d9f65bec811802fb6116b5c09465eb

data/.rubocop.yml

@@ -1,3 +1,6 @@
+AllCops:
+  DisplayCopNames: true
+
 Style/StringLiterals:
   EnforcedStyle: double_quotes
 
@@ -6,3 +9,12 @@ Style/SignalException:
 
 Style/HashSyntax:
   EnforcedStyle: hash_rockets
+
+Metrics/AbcSize:
+  Exclude:
+    - lib/todo_lint/cli.rb
+
+Metrics/MethodLength:
+  Exclude:
+    - lib/todo_lint/cli.rb
+    - lib/todo_lint/options.rb

data/.travis.yml

@@ -1,7 +1,8 @@
 language: ruby
 rvm:
   - 2.0.0
-  - 2.2.2
+  - 2.2.4
+  - 2.3.0
 before_install: gem install bundler -v 1.10.5
 script:
   - bundle exec rake form

data/Gemfile

@@ -1,4 +1,11 @@
 source "https://rubygems.org"
 
+gem "rake", "~> 10.0"
+gem "rspec"
+gem "timecop"
+gem "rubocop"
+gem "yardstick"
+gem "pry"
+
 # Specify your gem's dependencies in todo_lint.gemspec
 gemspec

data/lib/todo_lint/cli.rb

@@ -7,7 +7,7 @@ module TodoLint
     # @example
     #   Cli.new(["-i", ".rb,.js"])
     # @api public
-    def initialize(args) # rubocop:disable Metrics/AbcSize
+    def initialize(args) # rubocop:disable
       @options = Options.new.parse(args)
       if @options[:config_file]
         @options.merge!(ConfigFile.new.read_config_file(@options[:config_file]))
@@ -18,12 +18,48 @@ module TodoLint
       add_default_extensions unless @options.fetch(:files, []).any?
     end
 
+    # Perform the actions requested based on the options specified
+    #
     # @example
     #   Cli.new(["-i", ".rb"]).run!
     # @return exit code 0 for success, 1 for failure
     # @api public
-    # rubocop:disable Metrics/AbcSize
-    def run! # rubocop:disable Metrics/MethodLength
+    def run!
+      if options[:report]
+        print_report
+      else
+        lint_codebase
+      end
+    end
+
+    # Loads the files to be read
+    # @return [Array<String>]
+    # @example cli.load_files(file_finder)
+    # @api public
+    def load_files(file_finder)
+      if file_finder.options.fetch(:files).empty?
+        file_finder.list(*options[:extensions])
+      else
+        file_finder.options.fetch(:files, [])
+      end
+    end
+
+    private
+
+    # Where are we looking for files?
+    # @return [String]
+    # @api private
+    attr_reader :path
+
+    # Options hash for all configurations
+    # @return [Hash]
+    # @api private
+    attr_reader :options
+
+    # Check requested files for problematic TODO comments
+    # @return exit code 0 for success, 1 for failure
+    # @api private
+    def lint_codebase
       finder = FileFinder.new(path, options)
       files = load_files(finder)
       files_count = files.count
@@ -52,29 +88,28 @@ module TodoLint
       end
     end
 
-    # Loads the files to be read
-    # @return [Array<String>]
-    # @example cli.load_files(file_finder)
-    # @api public
-    def load_files(file_finder)
-      if file_finder.options.fetch(:files).empty?
-        file_finder.list(*options[:extensions])
-      else
-        file_finder.options.fetch(:files, [])
-      end
-    end
-
-    private
-
-    # Where are we looking for files?
-    # @return [String]
+    # Print report of todos in codebase, then exit
+    #
+    # @return by exiting with 0
     # @api private
-    attr_reader :path
+    def print_report
+      todos = []
+      finder = FileFinder.new(path, options)
+      files = load_files(finder)
+      files.each do |file|
+        todos += Todo.within(File.open(file))
+      end
+      todos.sort.each.with_index do |todo, num|
+        due_date = if todo.due_date
+                     Rainbow(" (due #{todo.due_date.to_date})").blue
+                   else
+                     Rainbow(" (missing due date)").red
+                   end
+        puts "#{num + 1}. #{todo.task}#{due_date}"
+      end
 
-    # Options hash for all configurations
-    # @return [Hash]
-    # @api private
-    attr_reader :options
+      exit 0
+    end
 
     # Pluralize a word based on the count
     # @return [String]

data/lib/todo_lint/options.rb

@@ -9,7 +9,7 @@ module TodoLint
     # @param args [Array<String>] arguments passed via the command line
     # @return [Hash] parsed options
     def parse(args)
-      @options = {}
+      @options = { :report => false }
 
       OptionParser.new do |parser|
         parser.banner = "Usage: todo_lint [options] [files]"
@@ -17,6 +17,7 @@ module TodoLint
         exclude_file_options parser
         include_extension_options parser
         report_version parser
+        report_report_options parser
       end.parse!(args)
 
       # Any remaining arguments are assumed to be files
@@ -71,6 +72,15 @@ module TodoLint
       end
     end
 
+    # Checks if the user requested a report on the todos in their codebase
+    # @api private
+    # @return [Hash]
+    def report_report_options(parser)
+      parser.on("-r", "--report") do
+        options[:report] = true
+      end
+    end
+
     # Options hash for all configurations
     # @return [Hash]
     # @api private

data/lib/todo_lint/reporter.rb

@@ -24,7 +24,7 @@ module TodoLint
       return if judge.charge.nil?
 
       "#{todo_location} #{problem}\n" \
-      "#{todo.line.chomp}\n" \
+      "#{todo.line.chomp.lstrip}\n" \
       "#{spaces}#{carets}"
     end
 
@@ -63,14 +63,21 @@ module TodoLint
     # @return [String]
     # @api private
     def spaces
-      " " * (todo.character_number - 1)
+      " " * number_of_spaces
+    end
+
+    # How many spaces before the carets should there be?
+    # @return [Fixnum]
+    # @api private
+    def number_of_spaces
+      todo.character_number - 1 - (todo.line.length - todo.line.lstrip.length)
     end
 
     # Generate the ^^^^ characters to point at the flag
     # @return [String]
     # @api private
     def carets
-      "^" * (todo.flag.length)
+      "^" * todo.flag.length
     end
   end
 end

data/lib/todo_lint/todo.rb

@@ -4,8 +4,9 @@ module TodoLint
     # The regular expression that identifies todo comments
     PATTERN = /
     (?<flag> TODO ){0}
-    (?<due_date> \(\d{4}-\d{2}-\d{2}\) ){0}
-    \g<flag>\g<due_date>?
+    (?<due_date> \(\d{4}-\d{2}-\d{2}\)){0}
+    (?<task>.+){0}
+    \g<flag>\g<due_date>?: \g<task>
     /x
 
     # Search a file for all of the todo/fixme/etc comments within it
@@ -66,6 +67,17 @@ module TodoLint
       !match[:due_date].nil?
     end
 
+    # What is the actual task associated with this todo?
+    #
+    # @example
+    #   todo.task #=> "Wash the car"
+    #
+    # @return [String]
+    # @api public
+    def task
+      match[:task].lstrip
+    end
+
     # When this todo is due
     # @example
     #   due_todo.line #=> "# TODO(2015-05-24): go to the beach"
@@ -97,6 +109,31 @@ module TodoLint
       (line =~ PATTERN) + 1
     end
 
+    # Which todo is due sooner?
+    #
+    # @example
+    #   [todo_one, todo_two].sort # this implicitly calls <=>
+    #
+    # @return [Fixnum]
+    # @api public
+    def <=>(other)
+      due_date_for_sorting <=> other.due_date_for_sorting
+    end
+
+    protected
+
+    # Helper for sorting todos
+    #
+    # @example
+    #   todo.due_date_for_sorting #=> #<Date: 2016-02-06>
+    #
+    # @return [Date]
+    # @api semipublic
+    def due_date_for_sorting
+      # Date.new is like the beginning of time
+      due_date ? due_date.to_date : Date.new
+    end
+
     private
 
     # Analyze the line to help identify when the todo is due

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.2.3"
+  VERSION = "0.3.0".freeze
 end

data/todo_lint.gemspec

@@ -26,13 +26,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_development_dependency "bundler", "~> 1.10"
+
   spec.add_runtime_dependency "required_arg", "~> 1.0"
   spec.add_runtime_dependency "rainbow", "~> 2.0.0"
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "timecop"
-  spec.add_development_dependency "rubocop"
-  spec.add_development_dependency "yardstick"
-  spec.add_development_dependency "pry"
 end

metadata

@@ -1,43 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: todo_lint
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Max Jacobson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-07-11 00:00:00.000000000 Z
+date: 2016-02-07 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: required_arg
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: rainbow
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.0.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -53,89 +25,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.10'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: required_arg
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
+        version: '1.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: timecop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: yardstick
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rainbow
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: 2.0.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.0
 description: todo_lint can be integrated into a continuous integration workflow to
   keep todo comments from becoming stagnant over time. Just annotate the comment with
   a date, and if that date has passed, your build will fail, and you'll be reminded
@@ -190,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Linter to help you remember your todos