gtdlint 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3fbc233bec15bdb84f7e239addc236f4b2d0c650
+  data.tar.gz: 655b4888df40991b13c6dc8d9c167a60ea81cfa7
+SHA512:
+  metadata.gz: 9ca071200dbd35abeba32ce17e6782ab261120d1e4054829e32d9b7e0afc81212c544c067e3d0146bfc32c7652b30bd84d843ebb3924add872e3b676ec50a3ec
+  data.tar.gz: 1b4868f8db94818b0dbc73c4dde2a7a028b093d03d2d6dbd03e74d8e5efa9d697db62680402b49b489bb88b37b06fdcea4cc9a62eed28695376517fedbc2946a

data/CONFIGURE.md

@@ -0,0 +1,52 @@
+# Configuration
+
+Gtdlint offers multiple ways to resolve preferences:
+
+1. Command-line flags (`gtdlint -i`, `gtdlint -p`)
+2. Dotfiles (`.gtdlintignore`, `.gtdlintrc.yml`)
+3. Built-in defaults (`DEFAULT_IGNORES`, `DEFAULT_GTD_PATTERN`)
+
+Any command-line flags that are present override the same settings in dotfiles and built-in defaults.
+
+# Command-line flags
+
+Run `gtdlint -h` or `gtdlint --help` for a full list, or refer to the source code for `bin/gtdlint`.
+
+```
+$ bin/gtdlint -h
+Usage: gtdlint [options] [<files>|-]
+    -i, --ignore pattern             Ignore file names matching Ruby regex pattern
+    -p, --gtd-pattern pattern        Custom GTD pattern
+    -h, --help                       Print usage info
+    -v, --version                    Print version info
+```
+
+# Dotfiles
+
+Gtdlint automatically applies any `.gtdlintignore` and/or `.gtdlintrc.yml` configuration files in the same directory as a file being scanned, or a parent directory (`../.gtdlintignore`, `../.gtdlintrc.yml`), up to `$HOME/.gtdlintignore`, `$HOME/.gtdlintrc.yml`, if any such files exist.
+
+## `.gtdlintignore`
+
+Samples:
+
+* [examples/.gtdlintignore](https://github.com/mcandre/gtdlint/blob/master/examples/.gtdlintignore)
+
+A `.gtdlintignore` may contain Ruby regex patterns of files and/or folders to exclude from scanning, one pattern per line.
+
+## `.gtdlintrc.yml`
+
+Samples:
+
+* [spanish/.gtdlintrc.yml](https://github.com/mcandre/gtdlint/blob/master/examples/spanish/.gtdlintrc.yml)
+
+`.gtdlintrc.yml` may contain a number of keys:
+
+* `gtd_pattern` is a shell-quoted string for a `grep` pattern.
+* `before_lines` is an optional integer for showing n lines before each matching line.
+* `after_lines` is an optional integer for showing n lines after each matching line.
+
+# Built-in defaults
+
+* `gtd_pattern`: `"\'todo\\|to do\\|to-do\\|hack\'"`.
+* `before_lines`: `0`
+* `after_lines`: `0`

data/README.md

@@ -0,0 +1,111 @@
+# 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`
+* `to do`
+* `to-do`
+* `TODO`
+* `TO DO`
+* `TO-DO`
+* `ToDo`
+* `To Do`
+* `To-Do`
+* `hack`
+* `Hack`
+* `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
+
+# EXAMPLES
+
+```
+$ gtdlint examples/
+examples/hello.c:1:// TODO: Add copyright
+examples/hello.c:6:  // TODO: Add proper line ending
+examples/hello.c:9:  putc(10, stdout); // hack
+examples/spanish/phrases.txt:1:PTE: Agregar más frases.
+
+$ cat examples/hello.c | bin/gtdlint
+stdin:1:// TODO: Add copyright
+stdin:6:  // TODO: Add proper line ending
+stdin:9:  putc(10, stdout); // hack
+
+$ gtdlint -i .c examples/
+examples/spanish/phrases.txt:1:PTE: Agregar más frases.
+
+$ gtdlint -p pte examples/spanish/
+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
+    -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
+    -h, --help                       Print usage info
+    -v, --version                    Print version info
+```
+
+# REQUIREMENTS
+
+* [Ruby](https://www.ruby-lang.org/) 2+
+* [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`.
+
+# INSTALL
+
+Install via [RubyGems](http://rubygems.org/):
+
+```
+$ gem install gtdlint
+```
+
+# CONFIGURE
+
+See [CONFIGURE.md](https://github.com/mcandre/gtdlint/blob/master/CONFIGURE.md) for details.
+
+# LICENSE
+
+FreeBSD
+
+# DEVELOPMENT
+
+## Testing
+
+Keep the interface working:
+
+```
+$ cucumber
+```
+
+## Linting
+
+Keep the code tidy:
+
+```
+$ rake lint
+```
+
+## Git Hooks
+
+See `hooks/`.

data/bin/gtdlint

@@ -0,0 +1,161 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'find'
+require 'optparse'
+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|
+      ignores << pattern
+    end
+
+    option.on('-p', '--gtd-pattern pattern', 'Custom GTD pattern') do |pattern|
+      configuration_flags["gtd_pattern"] = pattern
+    end
+
+    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|
+      configuration_flags["lines_after"] = n.to_i
+    end
+
+    option.on('-h', '--help', 'Print usage info') do
+      puts option
+      exit
+    end
+
+    option.on('-v', '--version', 'Print version info') do
+      puts "gtdlint #{GTDLint::VERSION}"
+      exit
+    end
+  end
+
+  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)
+    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 = []
+
+    filenames.each do |f|
+      if File.directory? f
+        recursive_filenames = recursive_filenames.concat(recursive_list(f, ignores))
+      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)
+      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
+    end
+  end
+end
+
+begin
+  main
+# User may quit before completion.
+rescue Interrupt
+  nil
+# Bad regex
+rescue RegexpError => e
+  puts e
+# This program may be piped to another program (e.g. `less`),
+# which is quit before this program completes.
+rescue Errno::EPIPE, Errno::EMFILE
+  nil
+end

data/lib/gtdlint.rb

@@ -0,0 +1,118 @@
+require 'rubygems'
+require 'ptools'
+require 'tempfile'
+
+$stdout.sync = true
+
+require 'version'
+
+DEFAULT_IGNORES = %w(
+  .hg/
+  .svn/
+  .git/
+  .git
+  .gtdlintignore
+  .gtdlintrc.yml
+  node_modules/
+  .vagrant/
+  Gemfile.lock
+  .exe
+  .bin
+  .png
+  .jpg
+  .jpeg
+  .svg
+  .min.js
+  -min.js
+)
+
+# Grep format, case insensitive
+DEFAULT_GTD_PATTERN = "\'todo\\|to do\\|to-do\\|hack\'"
+
+DEFAULT_LINES_BEFORE = 0
+DEFAULT_LINES_AFTER = 0
+
+DEFAULT_CONFIGURATION = {
+  "gtd_pattern" => DEFAULT_GTD_PATTERN,
+  "lines_before" => DEFAULT_LINES_BEFORE,
+  "lines_after" => DEFAULT_LINES_AFTER
+}
+
+#
+# Parse, model, and print a line too wide for its own good
+#
+class GTDThing
+  attr_accessor :filename, :line_number, :line
+
+  def self.parse(filename, grep_line)
+    if grep_line.match(/^--$/) then
+      grep_line
+    else
+      match = grep_line.match(/^([0-9]+)(\:|-)(.*)$/)
+
+      line_number = match[1]
+      line = match[3]
+
+      GTDThing.new(filename, line_number, line)
+    end
+  end
+
+  def initialize(filename, line_number, line)
+    @filename = filename
+    @line_number = line_number
+    @line = line
+  end
+
+  def to_s
+    "#{filename}:#{line_number}:#{line}"
+  end
+end
+
+def self.recursive_list(directory, ignores = DEFAULT_IGNORES)
+  Find.find(directory).reject do |f|
+    File.directory?(f) ||
+    ignores.any? { |ignore| f =~ %r(#{ignore}) } ||
+
+    begin
+      File.binary?(f)
+    rescue Errno::ENOENT
+      true
+    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.write(contents)
+  t.close
+
+  filename = t.path
+
+  output = `grep -B #{lines_before} -A #{lines_after} -n -i #{gtd_pattern} \"#{filename}\"`
+
+  lines = output.split("\n")
+
+  gtd_things = lines.map { |line| GTDThing.parse('stdin', line) }
+
+  gtd_things.each { |m| puts m }
+end
+
+def self.check(filename, configuration = DEFAULT_CONFIGURATION)
+  gtd_pattern = configuration["gtd_pattern"]
+  lines_before = configuration["lines_before"]
+  lines_after = configuration["lines_after"]
+
+  output = `grep -B #{lines_before} -A #{lines_after} -n -i #{gtd_pattern} \"#{filename}\"`
+
+  lines = output.split("\n")
+
+  gtd_things = lines.map { |line| GTDThing.parse(filename, line) }
+
+  gtd_things.each { |m| puts m }
+end

data/lib/version.rb

@@ -0,0 +1,6 @@
+#
+# GTDLint
+#
+module GTDLint
+  VERSION = '0.1'
+end

metadata

@@ -0,0 +1,259 @@
+--- !ruby/object:Gem::Specification
+name: gtdlint
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Andrew Pennebaker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ptools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: flay
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: flog
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.3'
+- !ruby/object:Gem::Dependency
+  name: roodi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: churn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: cane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: excellent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.24'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.24'
+- !ruby/object:Gem::Dependency
+  name: tailor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: guard-shell
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: See README.md for example usage
+email: andrew.pennebaker@gmail.com
+executables:
+- gtdlint
+extensions: []
+extra_rdoc_files: []
+files:
+- CONFIGURE.md
+- README.md
+- bin/gtdlint
+- lib/gtdlint.rb
+- lib/version.rb
+homepage: https://github.com/mcandre/gtdlint
+licenses:
+- FreeBSD
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: search for TO-DO items to complete in large projects
+test_files: []