todofind 1.0.0

data/.gitignore

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Mark Szymanski
+
+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,29 @@
+# todofind
+
+A gem for finding TODO/FIXME/etc. comments in files.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'todofind'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install todofind
+
+## Usage
+
+See `todofind -h`
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,18 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+require 'cane/rake_task'
+require 'rake/testtask'
+
+desc "Run cane quality tests"
+Cane::RakeTask.new(:quality)
+
+desc "Run tests"
+task :test do
+  Rake::TestTask.new do |t|
+    t.libs << "test"
+    t.test_files = FileList['test/*_test.rb']
+    t.verbose = false
+  end
+end
+
+task :default => [:quality, :test]

data/bin/todofind

@@ -0,0 +1,78 @@
+#!/usr/bin/env ruby
+
+$: << File.expand_path("../../lib/.", __FILE__)
+
+require 'todofind'
+require 'optparse'
+
+options = {}
+
+parser = OptionParser.new do |opts|
+  opts.banner = "Usage: #{$0} [options] [path]"
+
+  opts.on "-c FILE", "--config FILE", "Use FILE as the configuration file.", "Must be a JSON file." do |config_file|
+    if !config_file.match /(.+)\.json/
+      puts "Error: Configuration file isn't a json file."
+      exit 1
+    end
+    options[:config_file] = config_file
+  end
+
+  opts.on "-f FORMATTER", "--formatter",
+  "Use FORMATTER as the formatter." do |formatter|
+    options[:formatter] = formatter
+  end
+
+  opts.on_tail "-h", "--help", "Display this message." do
+    puts opts
+    exit
+  end
+
+  opts.on_tail "-l", "--list-formatters",
+  "List the available output formatters." do
+    TodoFind::FORMATTERS.keys.each{|f| puts f }
+    exit
+  end
+
+  opts.on_tail "-v", "--version", "Display the version number." do
+    puts VERSION
+    exit
+  end
+end
+
+parser.parse! ARGV
+
+if ARGV.size > 1
+  puts "Too many arguments."
+  exit 1
+end
+
+path = ARGV[0] || "."
+
+formatter_name = (options[:formatter] || "default").to_sym
+
+if options[:config_file]
+  begin
+    config_data = File.read options[:config_file]
+    config_data = JSON.parse config_data
+    if config_data["formatter"]
+     formatter_name = config_data["formatter"].to_sym
+   end
+ rescue Errno::ENOENT
+  puts "Config file doesn't exist."
+  exit 1
+end
+else
+  config_data = {}
+end
+
+finder = TodoFind::Finder.new config_data, path
+out = finder.find
+
+if TodoFind::FORMATTERS.include? formatter_name
+  formatter = TodoFind::FORMATTERS[formatter_name].new
+else
+  formatter = TodoFind::DefaultFormatter.new
+end
+
+puts formatter.render out

data/config.json

@@ -0,0 +1,6 @@
+{
+  "labels": [ "TODO", "FIXME" ],
+  "exclude_files": [ "LICENSE" ],
+  "exclude_dirs": [ ".git", "test/testing_dir" ],
+  "formatter": "default"
+}

data/lib/todofind/config.rb

@@ -0,0 +1,38 @@
+module TodoFind
+  # Internal: A model for the configuration data.
+  class Config
+    attr_reader :exclude_dirs, :exclude_files, :labels
+    # Public: Create a new instance of Config
+    #
+    # data - A hash of the data to be used
+    #        :labels - A list of labels to search for. Defaults are TODO and
+    #                  FIXME
+    #        :exclude_dirs - A list of directories to exclude from the search.
+    #        :exclude_files - A list of files to exclude from the search.
+    #
+    # Examples:
+    #
+    #   config = TodoFind::Config.new({ :labels => ["TODO, "FIXME", "OHAI"]})
+    def initialize(data)
+      new_data = {}
+      data.each do |k, v|
+        new_data[k.to_sym] = v
+      end
+
+      @labels = new_data[:labels] || %w{TODO FIXME}
+      if !@labels.is_a? Array
+        @labels = []
+      end
+
+      @exclude_dirs = new_data[:exclude_dirs] || []
+      if !@exclude_dirs.is_a? Array
+        @exclude_dirs = []
+      end
+
+      @exclude_files = new_data[:exclude_files] || []
+      if !@exclude_files.is_a? Array
+        @exclude_files = []
+      end
+    end
+  end
+end

data/lib/todofind/finder.rb

@@ -0,0 +1,94 @@
+module TodoFind
+  # Public: The comment finder. It finds all files in the current directory
+  #         containing the comments specified in the config data, or the
+  #         defaults: TODO and FIXME.
+  #
+  # Examples:
+  #
+  #   finder = Finder.new(config_data, '.')
+  #   finder.find
+  #   # => [{:filename => "my_file.rb", :comments =>
+  #                                     [{:line => 3,
+  #                                       :label => "TODO",
+  #                                       :comment => "A todo comment"}]}]
+  class Finder
+    # Public: Create a new Finder object with specified config data and a path.
+    #
+    # config - A hash of the configuration data. Allowed options are:
+    #          :labels - An array of labels to find (Defaults are TODO and
+    #                    FIXME)
+    #          :exclude_files - An array of files to exclude from the search.
+    #          :exclude_dirs - An array of directories to exclude from the
+    #                          search.
+    #
+    # path - The path to start the search at. The search will recurse down from
+    #        here but never above this directory.
+    def initialize(config, path)
+      @config = TodoFind::Config.new config
+      @path = path
+    end
+
+    # Public: Start recursing through directories under the Finder object's
+    #         path and look for comments with the specified labels.
+    #
+    # Examples:
+    #
+    #   finder.find
+    #
+    #   # => [{:filename => "my_file.rb",
+    #          :comments => [{:line => 3,
+    #                         :label => "TODO",
+    #                         :comment => "Do something"}]}]
+    #
+    # Returns a Hash of the comment data.
+    def find
+      file_list = get_file_list
+      regex = /(#{@config.labels.join "|"}): (.+)/
+      data = []
+
+      file_list.each do |file|
+        did_output_filename = false
+
+        file_data = { :filename => file, :comments => [] }
+
+        contents = File.read file
+        lines = contents.split "\n"
+        lines.each_with_index do |line, line_num|
+          line.match regex do |match|
+            label = match[1]
+            comment = match[2]
+            file_data[:comments] << { :line => line_num + 1,
+              :label => label,
+              :comment => comment }
+            end
+          end
+          if !file_data[:comments].empty?
+            data << file_data
+          end
+        end
+        return data
+      end
+
+      private
+    # Internal: Get the list of files underneath the current one. Recursively.
+    #
+    # Examples:
+    #
+    #   finder = TodoFind::Finder.new(config_data, ".")
+    #   finder.get_file_list
+    #   # => [ "file", "dir", "dir/file" ]
+    #
+    # Returns an Array containing the entries from the recursive file search.
+    def get_file_list
+      file_list = Dir.glob "#{@path}/**/*"
+      file_list.reject! do |f|
+        File.directory?(f) ||
+        @config.exclude_files.include?(File.path f) ||
+        (!@config.exclude_dirs.empty? && @config.exclude_dirs.map do |dir|
+          File.path(f)[dir]
+        end.any?)
+      end
+      return file_list
+    end
+  end
+end

data/lib/todofind/formatters/default_formatter.rb

@@ -0,0 +1,28 @@
+# TODO: Allow using any sort of formatter from any file as the formatter.
+
+module TodoFind
+  # Public: The default output formatter to use when printing the search data.
+  class DefaultFormatter
+    # Public: Render the given data.
+    #
+    # data - The search data to render. (ex: Data returned from
+    #         TodoFind::Finder#find
+    #
+    # Returns a String of the rendered data.
+    def render(data)
+      output = ""
+      data.each do |file|
+        filename = file[:filename]
+
+        output << "#{filename.green}:\n"
+
+        file[:comments].each do |comment|
+          output <<
+            "#{comment[:line]}: [#{comment[:label].red}] #{comment[:comment]}\n"
+        end
+        output << "\n"
+      end
+      output
+    end
+  end
+end

data/lib/todofind/formatters/json_formatter.rb

@@ -0,0 +1,10 @@
+require 'json'
+
+module TodoFind
+  # Public: A JSON search formatter.
+  class JSONFormatter
+    def render(data)
+      data.to_json
+    end
+  end
+end

data/lib/todofind.rb

@@ -0,0 +1,13 @@
+require 'colored'
+require 'json'
+require 'todofind/config'
+require 'todofind/finder'
+require 'todofind/formatters/default_formatter'
+require 'todofind/formatters/json_formatter'
+require 'todofind/formatter'
+
+module TodoFind
+  # Public: The output formatters
+  FORMATTERS = { :default => TodoFind::DefaultFormatter,
+    :json => TodoFind::JSONFormatter }
+end

data/lib/version.rb

@@ -0,0 +1,4 @@
+module TodoFind
+  # Private: The version number.
+  VERSION = "1.0.0"
+end

data/test/default_testing_dir/testfile

@@ -0,0 +1 @@
+TODO: A TODO comment

data/test/todofind_test.rb

@@ -0,0 +1,20 @@
+# TODO: Write the unit tests.
+
+$: << File.expand_path("../../lib/.", __FILE__)
+require 'riot'
+require 'todofind'
+
+context "Searching without config" do
+  setup { TodoFind::Finder.new({}, "test/default_testing_dir") }
+  asserts(:find).equals([{:filename=>"test/default_testing_dir/testfile", :comments=>[{:line=>1, :label=>"TODO", :comment=>"A TODO comment"}]}])
+end
+
+context "Ignoring files" do
+  setup { TodoFind::Finder.new({ :exclude_files => ["test/default_testing_dir/testfile"] }, "test/default_testing_dir") }
+  asserts(:find).equals([])
+end
+
+context "Ignoring directories" do
+  setup { TodoFind::Finder.new({ :exclude_dirs => ["test/default_testing_dir"] }, "test/default_testing_dir") }
+  asserts(:find).equals []
+end

data/todofind.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/./version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Mark Szymanski"]
+  gem.email         = ["mdszy@me.com"]
+  gem.description   = %q{Find comments in files that contain certain labels}
+  gem.summary       = %q{Find comments with labels}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "todofind"
+  gem.require_paths = ["lib"]
+  gem.version       = TodoFind::VERSION
+
+  gem.add_development_dependency "tomdoc"
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: todofind
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Mark Szymanski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tomdoc
+  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: Find comments in files that contain certain labels
+email:
+- mdszy@me.com
+executables:
+- todofind
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/todofind
+- config.json
+- lib/todofind.rb
+- lib/todofind/config.rb
+- lib/todofind/finder.rb
+- lib/todofind/formatter.rb
+- lib/todofind/formatters/default_formatter.rb
+- lib/todofind/formatters/json_formatter.rb
+- lib/version.rb
+- test/default_testing_dir/testfile
+- test/todofind_test.rb
+- todofind.gemspec
+homepage: ''
+licenses: []
+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: Find comments with labels
+test_files:
+- test/default_testing_dir/testfile
+- test/todofind_test.rb
+has_rdoc: