todidnt 0.0.0

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+ruby '1.9.3'
+
+group 'test' do
+  gem 'minitest'
+  gem 'mocha'
+end

data/Gemfile.lock

@@ -0,0 +1,16 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    metaclass (0.0.1)
+    minitest (5.0.8)
+    mocha (0.14.0)
+      metaclass (~> 0.0.1)
+    trollop (2.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest
+  mocha
+  trollop

data/README

@@ -0,0 +1,9 @@
+TODO:
+
+- tests
+- actual logging that is not putsing
+- optimize blames
+- html report?
+- filter by person or time
+- handle FIXME/XXX/custom
+- stats

data/bin/todidnt

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+
+require_relative '../lib/todidnt'
+
+options = {:path => '.'}
+ARGV.options do |opts|
+  opts.on('-p', '--path PATH', 'Git directory to run Todidnt in (default: current directory)') do |path|
+    options[:path] = path
+  end
+
+  opts.on_tail('-h', '--help', 'Show this message') do
+    puts opts
+    exit
+  end
+
+  opts.parse!
+end
+
+Todidnt::Runner.start(options)

data/lib/todidnt/git_command.rb

@@ -0,0 +1,26 @@
+module Todidnt
+  class GitCommand
+    def initialize(command, options)
+      @command = command
+      @options = options
+    end
+
+    def output_lines
+      run!.strip.split(/\n/)
+    end
+
+    def run!
+      `git #{command_with_options}`
+    end
+
+    def command_with_options
+      full_command = @command.to_s
+
+      for option in @options
+        full_command << " #{option.join(' ')}"
+      end
+
+      full_command
+    end
+  end
+end

data/lib/todidnt/git_repo.rb

@@ -0,0 +1,24 @@
+module Todidnt
+  class GitRepo
+    def initialize(path)
+      expanded_path = File.expand_path(path)
+
+      if File.exist?(File.join(expanded_path, '.git'))
+        @working_dir = expanded_path
+      else
+        $stderr.puts "Whoops, #{expanded_path} is not a git repository!"
+        exit
+      end
+    end
+
+    def run(&blk)
+      unless Dir.pwd == @working_dir
+        Dir.chdir(@working_dir) do
+          yield @working_dir
+        end
+      else
+        yield
+      end
+    end
+  end
+end

data/lib/todidnt/todo_line.rb

@@ -0,0 +1,52 @@
+module Todidnt
+  class TodoLine
+    IGNORE = %r{assets/js|third_?party|node_modules|jquery|Binary}
+
+    attr_reader :filename, :line_number, :content, :author
+
+    def self.all(expressions)
+      options = [['-n']]
+      expressions.each { |e| options << ['-e', e] }
+
+      grep = GitCommand.new(:grep, options)
+      grep.output_lines.map do |line|
+        filename, line_number, content = line.split(/:/, 3)
+        unless filename =~ IGNORE
+          lines = self.new(filename, line_number.to_i, content.strip[0..100])
+        end
+      end.compact
+    end
+
+    def initialize(filename, line_number, content)
+      @filename = filename
+      @line_number = line_number
+      @content = content
+    end
+
+    # TODO: This logic should probably be moved out somewhere else
+    def populate_blame
+      options = [
+        ['--line-porcelain'],
+        ['-L', "#{@line_number},#{@line_number}"],
+        [@filename]
+      ]
+
+      blame = GitCommand.new(:blame, options)
+      blame.output_lines.each do |line|
+        if (author = /author (.*)/.match(line))
+          @author = author[1]
+        elsif (author_time = /author-time (.*)/.match(line))
+          @timestamp = author_time[1].to_i
+        end
+      end
+    end
+
+    def pretty_time
+      Time.at(@timestamp).strftime('%F')
+    end
+
+    def pretty
+      "#{pretty_time} (#{author}, #{filename}:#{line_number}): #{content}"
+    end
+  end
+end

data/lib/todidnt.rb

@@ -0,0 +1,25 @@
+require_relative 'todidnt/git_repo'
+require_relative 'todidnt/git_command'
+require_relative 'todidnt/todo_line'
+
+module Todidnt
+  class Runner
+    def self.start(options)
+      GitRepo.new(options[:path]).run do |path|
+        puts "Running in #{path || 'current directory'}..."
+        lines = TodoLine.all(["TODO"])
+        puts "Found #{lines.count} TODOs. Blaming..."
+
+        lines.each_with_index do |todo, i|
+          todo.populate_blame
+          $stdout.write "\rBlamed: #{i}/#{lines.count}"
+        end
+
+        puts "\nResults:"
+        lines.each do |line|
+          puts line.pretty
+        end
+      end
+    end
+  end
+end

data/test/lib.rb

@@ -0,0 +1,8 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'mocha/setup'
+
+require_relative '../lib/todidnt'
+
+class Test < MiniTest::Spec
+end

data/test/todo_line.rb

@@ -0,0 +1,86 @@
+require_relative 'lib'
+
+class TestTodoLine < Test
+  before do
+    GitCommand.any_instance.stubs(:run!)
+  end
+
+  describe '.all' do
+    describe 'unit' do
+      it 'constructs the correct `git grep` command' do
+        grep = mock()
+        grep.stubs(:output_lines => [])
+
+        GitCommand.expects(:new).with(:grep, [['-n'], ['-e', 'hello']]).returns(grep)
+        TodoLine.all(['hello'])
+
+        GitCommand.expects(:new).with(:grep, [['-n'], ['-e', 'hello'], ['-e', 'goodbye']]).returns(grep)
+        TodoLine.all(['hello', 'goodbye'])
+      end
+
+      it 'creates a TodoLine object for each result line properly' do
+        GitCommand.any_instance.expects(:output_lines).returns(
+          [
+            'filename.rb:12:     content',
+            'other_filename.rb:643:    TODO'
+          ]
+        )
+
+        TodoLine.expects(:new).with('filename.rb', 12, 'content')
+        TodoLine.expects(:new).with('other_filename.rb', 643, 'TODO')
+
+        TodoLine.all(['anything'])
+      end
+    end
+
+    describe 'functional' do
+      it 'returns a list of TodoLine objects as matches' do
+        GitCommand.any_instance.expects(:output_lines).returns(
+          [
+            'filename.rb:12:     content',
+            'other_filename.rb:643:    TODO'
+          ]
+        )
+
+        todos = TodoLine.all(['anything'])
+        assert_equal 2, todos.count
+
+        assert_equal 'filename.rb', todos.first.filename
+        assert_equal 12, todos.first.line_number
+        assert_equal 'content', todos.first.content
+
+        assert_equal 'other_filename.rb', todos.last.filename
+        assert_equal 643, todos.last.line_number
+        assert_equal 'TODO', todos.last.content
+      end
+
+      it 'ignores lines matching IGNORE list' do
+        GitCommand.any_instance.expects(:output_lines).returns(
+          [
+            'filename.rb:12:     content',
+            'thirdparty/other_filename.rb:643:    TODO'
+          ]
+        )
+
+        todos = TodoLine.all(['anything'])
+        assert_equal 1, todos.count
+
+        assert_equal 'filename.rb', todos.first.filename
+        assert_equal 12, todos.first.line_number
+        assert_equal 'content', todos.first.content
+      end
+    end
+  end
+
+  describe '#populate_blame' do
+    it 'constructs the correct `git blame` command' do
+      # TODO
+      skip
+    end
+
+    it 'sets author, timestamp properties on the TodoLine object' do
+      # TODO
+      skip
+    end
+  end
+end

data/todidnt.gemspec

@@ -0,0 +1,16 @@
+Gem::Specification.new do |s|
+  s.name        = 'todidnt'
+  s.version     = '0.0.0'
+  s.summary     = 'Todidnt'
+  s.description = "Todidnt finds and dates todos in your git repository."
+  s.authors     = ["Amber Feng"]
+  s.email       = 'amber.feng@gmail.com'
+
+  s.add_development_dependency('minitest')
+  s.add_development_dependency('mocha')
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- test/*`.split("\n")
+  s.executables   = ['todidnt']
+  s.require_paths = %w[lib]
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: todidnt
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Amber Feng
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  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: Todidnt finds and dates todos in your git repository.
+email: amber.feng@gmail.com
+executables:
+- todidnt
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- README
+- bin/todidnt
+- lib/todidnt.rb
+- lib/todidnt/git_command.rb
+- lib/todidnt/git_repo.rb
+- lib/todidnt/todo_line.rb
+- test/lib.rb
+- test/todo_line.rb
+- todidnt.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: Todidnt
+test_files:
+- test/lib.rb
+- test/todo_line.rb