todo_finder 0.0.1

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in todo_finder.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Brian O'Keefe
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,25 @@
+# TodoFinder
+
+A simple command line tool for finding TODOs in a codebase and outputting them in a clean, readable way.
+
+## Installation
+
+    $ gem install todo_finder
+
+## Usage
+
+Run the `todo` command to find all TODOs in the current directory
+
+    $ todo
+
+Optionally specify a directory to search for TODOs:
+
+    $ todo my_technical_debt/lib
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/todo_finder/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/todo

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+require 'todo_finder'
+
+dir = ARGV.first || '.'
+TodoFinder::Finder.new.find(dir).output

data/lib/todo_finder/version.rb

@@ -0,0 +1,3 @@
+module TodoFinder
+  VERSION = "0.0.1"
+end

data/lib/todo_finder.rb

@@ -0,0 +1,41 @@
+require 'todo_finder/version'
+
+module TodoFinder
+  class Finder
+    attr_accessor :matches
+
+    def initialize
+      @matches = Hash.new { |h,k| h[k]=[] }
+    end
+
+    # Find all TODOs in given dir and stuff them in a hash keyed by file
+    def find(dir='.')
+      full_dir = File.expand_path File.join(Dir.pwd, dir, '**', '*')
+      all_files = Dir[full_dir].reject { |file| File.directory? file }
+
+      all_files.each do |file_name|
+        File.open(file_name, :encoding => 'ISO-8859-1') do |file|
+          file.each_line do |line|
+            @matches[file_name] << line if line =~ /TODO/
+          end
+        end
+      end
+
+      return self
+    end
+
+    # Pretty output
+    def output
+      @matches.each do |file, lines|
+        file_name = file.gsub(Dir.pwd, '')
+        puts file_name
+
+        lines.each do |line|
+          puts '  - ' << line.strip
+        end
+
+        puts ''
+      end
+    end
+  end
+end

data/todo_finder.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'todo_finder/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "todo_finder"
+  spec.version       = TodoFinder::VERSION
+  spec.authors       = ["Brian O'Keefe"]
+  spec.email         = ["brian@bokstuff.com"]
+  spec.summary       = %q{A simple command line tool for finding todos in a codebase and outputting them in a clean, readable way.}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/brianokeefe/todo_finder"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: todo_finder
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Brian O'Keefe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple command line tool for finding todos in a codebase and outputting
+  them in a clean, readable way.
+email:
+- brian@bokstuff.com
+executables:
+- todo
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/todo
+- lib/todo_finder.rb
+- lib/todo_finder/version.rb
+- todo_finder.gemspec
+homepage: https://github.com/brianokeefe/todo_finder
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A simple command line tool for finding todos in a codebase and outputting
+  them in a clean, readable way.
+test_files: []