todo_lint 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 42201a41cdbac1da876f84a312754c8f5595cf4d
-  data.tar.gz: 38c19ed259f954d3156a0548358cc9f0db5c4cda
+  metadata.gz: 1af0ecc125399a8f4a1b92b139973fb0c394ed1a
+  data.tar.gz: 5895d4d1df63439f25794c72e81dc2799d14f6d8
 SHA512:
-  metadata.gz: 484583f3c91b0b60eddab45932bd1c1e78593453ca7e0bcdd198aade55e0be00bc055dfef4d32a07a60217ba65f0fdf48dc8577f2a0ead7e2002433d14766965
-  data.tar.gz: 36965bb49a8c2d844f86b35d38958b706e2a22db6dfa5ebdd7cab6dc7c9aed69cfdff9deb758cffdbe8750a61644812141d8fe1c94f8fb7da012aca7682d9b87
+  metadata.gz: 1da62b05fe0a35245fdc065bdee21bbec5e200e289ec0318db16af647de574219887f9da8325ef5fd65bf4aab1e2df7c4f8ecc54fbc42acac24cf824abe23abe
+  data.tar.gz: f1a5b2983d648d46ccde43155b417734ee0fdee5641d2a002dcbf4268e29c90b5c10f1329fc7313b425859bd934010da8b9f564d79aadb527840b0dc4ee56ecf

data/README.md

@@ -29,9 +29,7 @@ Or install it yourself as:
 Add this to your continuous integration list of commands in your `.travis.yml`
 or `circle.yml`:
 
-    bundle exec todo_lint .rb .coffee .scss
-
-(Put whichever file extensions you want it to check; note the leading dot.)
+    bundle exec todo_lint
 
 If you have a bunch of TODO comments in your code, your next build will fail.
 
@@ -49,6 +47,31 @@ to:
 
 Now your build will pass. Until November, 2043.
 
+## Configuration
+
+Create a .todo_lint.yml file in your main repo
+
+    Exclude Files:
+      - vendor/**
+
+Options include "Include Files:", "Exclude Files:", and "Extensions:"
+
+If no extensions are specified, todo_lint will check all .rb files by default.
+
+If you include files, todo_lint will only read those files.
+
+The config file will exclude/include files starting from the directory where the config file is located
+
+You may also configure your use of todo_lint from the command line:
+
+    $ todo_lint -i .rb,.coffee,.js
+
+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
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run

data/lib/todo_lint.rb

@@ -7,6 +7,8 @@ require "todo_lint/todo"
 require "todo_lint/reporter"
 require "todo_lint/judge"
 require "todo_lint/cli"
+require "todo_lint/options"
+require "todo_lint/config_file"
 
 # here we establish the module which will namespace all of the code for this gem
 module TodoLint

data/lib/todo_lint/cli.rb

@@ -1,24 +1,31 @@
+require "todo_lint/options"
+
 module TodoLint
   # Here we bring together all the pieces and see if it comes together
-  # TODO: test this class somehow
   class Cli
     # Startup the thing that actually checks the files for todos!
     # @example
-    #   Cli.new([".rb", ".js"])
+    #   Cli.new(["-i", ".rb,.js"])
     # @api public
-    def initialize(extensions = [])
+    def initialize(args) # rubocop:disable Metrics/AbcSize
+      @options = Options.new.parse(args)
+      if @options[:config_file]
+        @options.merge!(ConfigFile.new.read_config_file(@options[:config_file]))
+      elsif File.exist?("./.todo_lint.yml")
+        @options.merge!(ConfigFile.new.read_config_file("./.todo_lint.yml"))
+      end
       @path = File.expand_path(".")
-      @extensions = extensions
+      add_default_extensions unless @options.fetch(:files, []).any?
     end
 
     # @example
-    #   Cli.new([".rb"]).run!
+    #   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
-      finder = FileFinder.new(File.expand_path("."))
-      files = finder.list(*extensions)
+      finder = FileFinder.new(path, options)
+      files = load_files(finder)
       files_count = files.count
       reports = files.map do |file|
         Todo.within(File.open(file)).map do |todo|
@@ -44,18 +51,30 @@ module TodoLint
       end
     end
 
-    private
-
-    # Which file extensions are we checking?
+    # Loads the files to be read
     # @return [Array<String>]
-    # @api private
-    attr_reader :extensions
+    # @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
+
     # Pluralize a word based on the count
     # @return [String]
     # @api private
@@ -63,5 +82,13 @@ module TodoLint
       s = count == 1 ? "" : "s"
       "#{count} #{word + s}"
     end
+
+    # Set default extensions if none given
+    # @api private
+    # @return [Array<String>]
+    def add_default_extensions
+      return if options[:extensions]
+      options[:extensions] = [".rb"]
+    end
   end
 end

data/lib/todo_lint/config_file.rb

@@ -0,0 +1,55 @@
+require "yaml"
+
+module TodoLint
+  # Loads the config file (.todo-lint.yml)
+  class ConfigFile
+    # Parses the config file and loads the options
+    # @api public
+    # @example ConfigFile.new.parse('.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_file_exclusions
+      load_extension_inclusions
+      config_options
+    end
+
+    private
+
+    # Hashed form of the config file .todo-lint.yml
+    # @return [Hash]
+    # @api private
+    attr_reader :config_hash
+
+    # Options hash for all configurations specified by yaml file
+    # @return [Hash]
+    # @api private
+    attr_reader :config_options
+
+    # Starting path for all files specified in config
+    # @return [String]
+    # @api private
+    attr_reader :starting_path
+
+    # Adds the exclude file options to the config_options hash
+    # @api private
+    # @return [Hash]
+    def load_file_exclusions
+      return unless config_hash["Exclude Files"]
+      config_options[:excluded_files] = []
+      config_hash["Exclude Files"].each do |short_file|
+        config_options[:excluded_files] << File.join(starting_path, short_file)
+      end
+    end
+
+    # Adds the desired extensions to the config_options hash
+    # @api private
+    # @return [Hash]
+    def load_extension_inclusions
+      return unless config_hash["Extensions"]
+      config_options[:extensions] = config_hash["Extensions"]
+    end
+  end
+end

data/lib/todo_lint/file_finder.rb

@@ -7,9 +7,11 @@ module TodoLint
     # @example
     #   FileFinder.new("/Users/max/src/layabout")
     # @api public
-    def initialize(path)
+    def initialize(path, options)
       @path = path
+      @options = options
       @all_files = Dir.glob(Pathname.new(path).join("**", "*"))
+      @excluded = options[:excluded_files]
     end
 
     # Absolute paths to all the files with the provided extensions
@@ -21,8 +23,16 @@ module TodoLint
       all_files.keep_if do |filename|
         extensions.include?(Pathname.new(filename).extname)
       end
+      all_files.reject! { |file| excluded_file?(file) }
+      all_files
     end
 
+    # Options hash for all configurations
+    # @return [Hash]
+    # @example FileFinder.new(path, options).options
+    # @api public
+    attr_reader :options
+
     private
 
     # Which folder to look within for files
@@ -34,5 +44,15 @@ module TodoLint
     # @return [Array<String>]
     # @api private
     attr_reader :all_files
+
+    # Check if this file has been excluded
+    # @api private
+    # @return [Boolean]
+    def excluded_file?(file)
+      full_path = File.expand_path(file)
+      options.fetch(:excluded_files, []).any? do |file_to_exclude|
+        File.fnmatch(file_to_exclude, full_path)
+      end
+    end
   end
 end

data/lib/todo_lint/options.rb

@@ -0,0 +1,68 @@
+require "optparse"
+
+module TodoLint
+  # Handles option parsing for the command line application.
+  class Options
+    # Parses command line options into an options hash
+    # @api public
+    # @example Options.new.parse("todo_lint -c app.rb")
+    # @param args [Array<String>] arguments passed via the command line
+    # @return [Hash] parsed options
+    def parse(args)
+      @options = {}
+
+      OptionParser.new do |parser|
+        parser.banner = "Usage: todo_lint [options] [files]"
+        add_config_options parser
+        exclude_file_options parser
+        include_extension_options parser
+      end.parse!(args)
+
+      # Any remaining arguments are assumed to be files
+      options[:files] = args
+
+      options
+    end
+
+    private
+
+    # Adds the file options to the @options hash
+    # @api private
+    # @return [Hash]
+    def add_config_options(parser)
+      parser.on("-c", "--config config-file", String,
+                "Specify the path to the config file you want
+                 to use, from the main repo") do |conf_file|
+        options[:config_file] = conf_file
+      end
+    end
+
+    # Adds the excluded file options to the options hash
+    # @api private
+    # @return [Hash]
+    def exclude_file_options(parser)
+      parser.on("-e", "--exclude file1,...", Array,
+                "List of file names to exclude") do |files_list|
+        options[:excluded_files] = []
+        files_list.each do |short_file|
+          options[:excluded_files] << File.expand_path(short_file)
+        end
+      end
+    end
+
+    # Adds the include extension options to the @options hash
+    # @api private
+    # @return [Hash]
+    def include_extension_options(parser)
+      parser.on("-i", "--include ext1,...", Array,
+                "List of extensions to include") do |ext_list|
+        options[:extensions] = ext_list
+      end
+    end
+
+    # Options hash for all configurations
+    # @return [Hash]
+    # @api private
+    attr_reader :options
+  end
+end

data/lib/todo_lint/todo.rb

@@ -69,7 +69,7 @@ module TodoLint
     # When this todo is due
     # @example
     #   due_todo.line #=> "# TODO(2015-05-24): go to the beach"
-    #   due__todo.due_date.to_date #=> #<Date: 2015-05-24>
+    #   due_todo.due_date.to_date #=> #<Date: 2015-05-24>
     #   not_due_todo.line #=> "# TODO: become a fish"
     #   not_due_todo.due_date #=> nil
     # @return [DueDate] if there is a due date

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.1.1"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: todo_lint
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Max Jacobson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-06-29 00:00:00.000000000 Z
+date: 2015-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: required_arg
@@ -161,9 +161,11 @@ files:
 - exe/todo_lint
 - lib/todo_lint.rb
 - lib/todo_lint/cli.rb
+- lib/todo_lint/config_file.rb
 - lib/todo_lint/due_date.rb
 - lib/todo_lint/file_finder.rb
 - lib/todo_lint/judge.rb
+- lib/todo_lint/options.rb
 - lib/todo_lint/reporter.rb
 - lib/todo_lint/todo.rb
 - lib/todo_lint/version.rb