gtdlint 0.4 → 0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cada247b35c61d890089ff9557e0df8073612ea4
-  data.tar.gz: 83c4334f89ac04731677ea98e791960bb007a2db
+  metadata.gz: 315a65dffec87f52addba4616dd267d1ed0eec9a
+  data.tar.gz: 58ba330a56b9ef105ff5d4c59d7cd37d0de308a5
 SHA512:
-  metadata.gz: 27dea8891fbb54eb265e2c41a366d1837e5bf087f78cc9490585a4bb5504e7db9009b7243a474d499b98aa6401c2319e2557ec1f2e7c9c4131b39859af3b1881
-  data.tar.gz: b34885f1e759d559a9ace2b5bb8dddda5cecb8400004e01bed5896b155cdd89f652f18a3e2f2ac808765f7b63fbb45b17affa0d1c64f5935c5a2953e15fd4fe6
+  metadata.gz: de669820eb48d62cdd820cc3ba25407f880552c821f43fb1b8b2888ca7fcd9949d07d06a64e2428797cb880883b773f6555a3fb38f10bb87f9d3789523ad81ef
+  data.tar.gz: 2eb9621f4f823809d21d173c96b274df3a55eabecf13e4d0efa526e60646e70c821eb4434c34e2a06d36b64248c4c5551982b04c3a1dae5590dc7db56b8675b2

data/CONFIGURE.md

@@ -15,7 +15,7 @@ Run `gtdlint -h` or `gtdlint --help` for a full list, or refer to the source cod
 ```
 $ bin/gtdlint -h
 Usage: gtdlint [options] [<files>|-]
-    -i, --ignore pattern             Ignore file names matching Ruby regex pattern
+    -i, --ignore pattern             Ignore file pattern (fnmatch)
     -p, --gtd-pattern pattern        Custom GTD pattern
     -h, --help                       Print usage info
     -v, --version                    Print version info
@@ -47,6 +47,6 @@ Samples:
 
 # Built-in defaults
 
-* `gtd_pattern`: `"\'todo\\|to do\\|to-do\\|pending\\|hack\'"`.
+* `gtd_pattern`: `"\'todo\\|to do\\|to-do\\|pending\\|hack\\|fixme\'"`.
 * `before_lines`: `0`
 * `after_lines`: `0`

data/README.md

@@ -1,29 +1,6 @@
 # gtdlint - search for TO-DO items to complete in large projects
 
-# HOMEPAGE
-
-https://github.com/mcandre/gtdlint
-
-# RUBYGEMS
-
-https://rubygems.org/gems/gtdlint
-
-# ABOUT
-
-Gtdlint is a command line program for finding TODO tasks in a project, such as `// TODO` code comments. By default, gtdlint is case-insensitve, and looks for:
-
-* `todo`
-* `pending`
-* `hack`
-
-gtdlint can be customized with a `-p` command line flag and/or a `.gtdlintrc.yml` configuration file. For example, gtdlint can be configured to look for `pte`/`hack` in Spanish projects.
-
-gtdlint is a shell wrapper around the traditional GNU [grep](http://www.gnu.org/software/grep/) backend, presenting a frontend similar to modern linters like [Reek](https://github.com/troessner/reek/wiki) and [JSHint](http://jshint.com/).
-
-* Recursive file search by default
-* Optional ignore patterns
-* Configuration via per-project and per-user [dotfiles](https://github.com/mcandre/gtdlint/blob/master/CONFIGURE.md#dotfiles)
-* Install via a standard programming language package manager
+`gtdlint` searches your projects for code comments indicating TODOs, FIXMEs, and other changes that need to be made.
 
 # EXAMPLES
 
@@ -41,7 +18,7 @@ stdin:1:// TODO: Add copyright
 stdin:6:  // TODO: Add proper line ending
 stdin:9:  putc(10, stdout); // hack
 
-$ gtdlint -i '\.gitignore' '\.c' examples/
+$ gtdlint -i .gitignore '*.c' examples/
 examples/spanish/phrases.txt:1:PTE: Agregar más frases.
 examples/spec/int_spec.rb:3:    pending('mathematical revolution')
 
@@ -50,7 +27,7 @@ examples/spanish/phrases.txt:1:PTE: Agregar más frases.
 
 $ gtdlint -h
 Usage: gtdlint [options] [<files>|-]
-    -i, --ignore pattern             Ignore file names matching Ruby regex pattern
+    -i, --ignore pattern             Ignore file pattern (fnmatch)
     -p, --gtd-pattern pattern        Custom GTD pattern
     -B, --lines-before n             Also show n lines before matching line
     -A, --lines-after n              Also show n lines after matching line
@@ -64,9 +41,34 @@ gtdlint can be combined with other programs. For example, check your most recent
 $ git diff HEAD~1 | gtdlint
 ```
 
+# HOMEPAGE
+
+https://github.com/mcandre/gtdlint
+
+# RUBYGEMS
+
+https://rubygems.org/gems/gtdlint
+
+# ABOUT
+
+Gtdlint is a command line program for finding TODO tasks in a project, such as `// TODO` code comments. By default, gtdlint is case-insensitve, and looks for:
+
+* `todo`
+* `pending`
+* `hack`
+
+gtdlint can be customized with a `-p` command line flag and/or a `.gtdlintrc.yml` configuration file. For example, gtdlint can be configured to look for `pte`/`hack` in Spanish projects.
+
+gtdlint is a shell wrapper around the traditional GNU [grep](http://www.gnu.org/software/grep/) backend, presenting a frontend similar to modern linters like [Reek](https://github.com/troessner/reek/wiki) and [JSHint](http://jshint.com/).
+
+* Recursive file scanning, like `jshint .`
+* Optional ignore patterns, like `.gitignore`
+* Configuration via per-project and per-user [dotfiles](https://github.com/mcandre/gtdlint/blob/master/CONFIGURE.md#dotfiles)
+* Install via a standard programming language package manager
+
 # REQUIREMENTS
 
-* [Ruby](https://www.ruby-lang.org/) 2+
+* [Ruby](https://www.ruby-lang.org/) 2.0+
 * [grep](http://www.gnu.org/software/grep/) (often built-in, or provided by [git](http://git-scm.com/))
 
 E.g., Windows users can `chocolatey install git`.

data/bin/gtdlint

@@ -3,23 +3,19 @@
 require 'rubygems'
 require 'find'
 require 'optparse'
+require 'dotsmack'
 require 'yaml'
 require 'gtdlint'
 
-IGNORE_FILENAME = '.gtdlintignore'
-CONFIGURATION_FILENAME = '.gtdlintrc.yml'
-
 def main
   ignores = DEFAULT_IGNORES
 
-  filenames = ['-']
-
   configuration_flags = {}
 
   option = OptionParser.new do |option|
     option.banner = "Usage: gtdlint [options] [<files>|-]"
 
-    option.on('-i', '--ignore pattern', 'Ignore file names matching Ruby regex pattern') do |pattern|
+    option.on('-i', '--ignore pattern', 'Ignore file pattern (fnmatch)') do |pattern|
       ignores << pattern
     end
 
@@ -27,11 +23,11 @@ def main
       configuration_flags["gtd_pattern"] = pattern
     end
 
-    option.on('-B', '--lines-before n', 'Also show n lines before matching line') do |n|
+    option.on('-B', '--lines-before=n', 'Also show n lines before matching line') do |n|
       configuration_flags["lines_before"] = n.to_i
     end
 
-    option.on('-A', '--lines-after n', 'Also show n lines after matching line') do |n|
+    option.on('-A', '--lines-after=n', 'Also show n lines after matching line') do |n|
       configuration_flags["lines_after"] = n.to_i
     end
 
@@ -48,100 +44,31 @@ def main
 
   option.parse!
 
-  filenames = ARGV unless ARGV.empty?
-
-  if filenames.empty? || filenames == ['-'] then
-    configuration_dotfile = DEFAULT_CONFIGURATION
-
-    pwd = Dir.pwd
-
-    dir = pwd
-
-    parent_of_home = File.expand_path("..", ENV["HOME"])
-
-    while dir != parent_of_home
-      ignore_file = dir + File::SEPARATOR + IGNORE_FILENAME
-
-      if File.exist?(ignore_file) then
-        ignores.concat(open(ignore_file).read.split("\n"))
-      end
-
-      dir = File.expand_path("..", dir)
+  filenames =
+    if ARGV == []
+      ['-']
+    else
+      ARGV
     end
 
-    if ignores.none? { |ignore| pwd =~ %r(#{ignore}) } then
-      dir = Dir.pwd
-
-      parent_of_home = File.expand_path("..", ENV["HOME"])
-
-      while dir != parent_of_home
-        config_file = dir + File::SEPARATOR + CONFIGURATION_FILENAME
-
-        if File.exist?(config_file) then
-          configuration_dotfile = DEFAULT_CONFIGURATION.merge(YAML.load_file(config_file))
-          break
-        else
-          dir = File.expand_path("..", dir)
-        end
-      end
-
-      # Command line flags override dotfile settings
-      configuration = configuration_dotfile.merge(configuration_flags)
-
-      check_stdin(configuration)
-    end
-  else
-    recursive_filenames = []
+  dotsmack = Dotsmack::Smacker.new(
+    dotignore = '.gtdlintignore',
+    additional_ignores = ignores,
+    dotconfig = '.gtdlintrc.yml'
+  )
 
-    filenames.each do |f|
-      if File.directory? f
-        recursive_filenames = recursive_filenames.concat(recursive_list(f, ignores))
+  dotsmack.enumerate(filenames).each do |filename, config|
+    config =
+      if config.nil?
+        DEFAULT_CONFIGURATION.merge(configuration_flags)
       else
-        recursive_filenames << f
-      end
-    end
-
-    configuration_dotfile = DEFAULT_CONFIGURATION
-
-    recursive_filenames.each do |f|
-      dir = File.expand_path("..", f)
-
-      parent_of_home = File.expand_path("..", ENV["HOME"])
-
-      while dir != parent_of_home
-        ignore_file = dir + File::SEPARATOR + IGNORE_FILENAME
-
-        if File.exist?(ignore_file) then
-          ignores.concat(open(ignore_file).read.split("\n"))
-        end
-
-        dir = File.expand_path("..", dir)
+        YAML.load(config).merge(DEFAULT_CONFIGURATION).merge(configuration_flags)
       end
 
-      if ignores.none? { |ignore| f =~ %r(#{ignore}) } then
-        dir = File.expand_path("..", f)
-
-        parent_of_home = File.expand_path("..", ENV["HOME"])
-
-        while dir != parent_of_home
-          config_file = dir + File::SEPARATOR + CONFIGURATION_FILENAME
-
-          if File.exist?(config_file) then
-            configuration_dotfile = DEFAULT_CONFIGURATION.merge(YAML.load_file(config_file))
-            break
-          else
-            dir = File.expand_path("..", dir)
-          end
-        end
-
-        # Hack to Reset configuration when changing directories
-        configuration_dotfile = DEFAULT_CONFIGURATION unless File.exist?(dir + File::SEPARATOR + CONFIGURATION_FILENAME)
-
-        # Command line flags override dotfile settings
-        configuration = configuration_dotfile.merge(configuration_flags)
-
-        check(f, configuration)
-      end
+    if filename == '-'
+      check_stdin(config)
+    else
+      check(filename, config)
     end
   end
 end

data/lib/gtdlint.rb

@@ -1,34 +1,57 @@
-require 'rubygems'
 require 'ptools'
 require 'tempfile'
 
-$stdout.sync = true
-
-require 'version'
+require_relative 'version'
 
 DEFAULT_IGNORES = %w(
-  \.hg/
-  \.svn/
-  \.git/
-  \.gtdlintignore
-  \.gtdlintrc\.yml
-  node_modules/
-  \.vagrant/
+  tmp
+  .hg
+  .svn
+  .git
+  .gtdlintignore
+  .gtdlintrc.yml
+  node_modules
+  bower_components
+  target
+  dist
+  .vagrant
   Gemfile.lock
-  \.exe
-  \.bin
-  \.png
-  \.gif
-  \.jpg
-  \.jpeg
-  \.tiff
-  \.svg
-  \.min.js
-  -min\.js
+  *.exe
+  *.bin
+  *.apk
+  *.ap_
+  res
+  *.class
+  *.zip
+  *.jar
+  *.war
+  *.xpi
+  *.dmg
+  *.pkg
+  *.app
+  *.xcodeproj
+  *.lproj
+  *.xcassets
+  *.pmdoc
+  *.dSYM
+  *.jad
+  *.cmo
+  *.cmi
+  *.png
+  *.gif
+  *.jpg
+  *.jpeg
+  *.tiff
+  *.ico
+  *.svg
+  *.dot
+  *.wav
+  *.mp3
+  *[.-]min.*
 )
 
 # Grep format, case insensitive
-DEFAULT_GTD_PATTERN = "\'todo\\|to do\\|to-do\\|pending\\|hack\'"
+DEFAULT_GTD_PATTERN = "\'todo\\|to do\\|to-do\\|pending\\|hack\\|fixme\'"
 
 DEFAULT_LINES_BEFORE = 0
 DEFAULT_LINES_AFTER = 0
@@ -69,27 +92,21 @@ class GTDThing
   end
 end
 
-def self.recursive_list(directory, ignores = DEFAULT_IGNORES)
-  Find.find(directory).reject do |f|
-    File.directory?(f) ||
-    ignores.any? { |ignore| f =~ /#{ignore}/ } ||
-
-    begin
-      File.binary?(f)
-    rescue Errno::ENOENT
-      true
+def self.check_stdin(configuration = nil)
+  configuration =
+    if configuration.nil?
+      DEFAULT_CONFIGURATION
+    else
+      configuration
     end
-  end
-end
 
-def self.check_stdin(configuration = DEFAULT_CONFIGURATION)
   gtd_pattern = configuration['gtd_pattern']
   lines_before = configuration['lines_before']
   lines_after = configuration['lines_after']
 
   contents = $stdin.read
 
-  t = Tempfile.new('aspelllint')
+  t = Tempfile.new('gtdlint')
   t.write(contents)
   t.close
 
@@ -111,7 +128,14 @@ def self.check_stdin(configuration = DEFAULT_CONFIGURATION)
   gtd_things.each { |m| puts m }
 end
 
-def self.check(filename, configuration = DEFAULT_CONFIGURATION)
+def self.check(filename, configuration = nil)
+  configuration =
+    if configuration.nil?
+      DEFAULT_CONFIGURATION
+    else
+      configuration
+    end
+
   gtd_pattern = configuration['gtd_pattern']
   lines_before = configuration['lines_before']
   lines_after = configuration['lines_after']

data/lib/version.rb

@@ -2,5 +2,5 @@
 # GTDLint
 #
 module GTDLint
-  VERSION = '0.4'
+  VERSION = '0.5'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gtdlint
 version: !ruby/object:Gem::Version
-  version: '0.4'
+  version: '0.5'
 platform: ruby
 authors:
 - Andrew Pennebaker
@@ -24,6 +24,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: dotsmack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -244,7 +258,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
@@ -252,7 +266,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: search for TO-DO items to complete in large projects