todidnt 0.0.0 → 0.1.0

data/Gemfile

@@ -1,6 +1,8 @@
 source 'https://rubygems.org'
 ruby '1.9.3'
 
+gem 'chronic'
+
 group 'test' do
   gem 'minitest'
   gem 'mocha'

data/README.md

@@ -0,0 +1,33 @@
+Todidnt
+====
+
+(:construction: This project is currently under construction! :construction:)
+
+Todidnt is a utility to help you track down TODOs and FIXMEs that you always
+said you'd do but haven't done yet.
+
+Usage
+----
+
+Install the gem:
+
+    gem install todidnt
+
+Then, run `todidnt` in any Git repository directory:
+
+    $ todidnt
+
+TODO[1]
+----
+
+- Optimizing blame step
+- Filtering by author, label
+- Fancy formatted reports
+- TODO stats
+
+Credit
+----
+
+Paul Battley (@threedaymonk) for initial idea/implementation and witty name.
+
+1: Oh, the irony.

data/Rakefile

@@ -0,0 +1,4 @@
+task :test do
+  $LOAD_PATH << './test'
+  Dir.glob('test/test_*.rb').each { |t| require File.basename(t) }
+end

data/bin/todidnt

@@ -1,15 +1,20 @@
 #!/usr/bin/env ruby
 
 require 'optparse'
-
-require_relative '../lib/todidnt'
+require 'todidnt'
 
 options = {:path => '.'}
+command = ARGV.shift
+
 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('-d', '--date STRING', 'Fuzzy string for overdue date comparison, e.g. last week or 7/2/2013 (default: today)') do |date|
+    options[:date] = date
+  end
+
   opts.on_tail('-h', '--help', 'Show this message') do
     puts opts
     exit
@@ -18,4 +23,4 @@ ARGV.options do |opts|
   opts.parse!
 end
 
-Todidnt::Runner.start(options)
+Todidnt::CLI.run(command, options)

data/lib/todidnt/todo_line.rb

@@ -2,7 +2,7 @@ module Todidnt
   class TodoLine
     IGNORE = %r{assets/js|third_?party|node_modules|jquery|Binary}
 
-    attr_reader :filename, :line_number, :content, :author
+    attr_reader :filename, :line_number, :content, :author, :timestamp
 
     def self.all(expressions)
       options = [['-n']]

data/lib/todidnt.rb

@@ -1,10 +1,57 @@
-require_relative 'todidnt/git_repo'
-require_relative 'todidnt/git_command'
-require_relative 'todidnt/todo_line'
+require 'todidnt/git_repo'
+require 'todidnt/git_command'
+require 'todidnt/todo_line'
+
+require 'chronic'
 
 module Todidnt
-  class Runner
-    def self.start(options)
+  class CLI
+    VALID_COMMANDS = %w{all overdue}
+
+    def self.run(command, options)
+      if command && VALID_COMMANDS.include?(command)
+        self.send(command, options)
+      elsif command
+        $stderr.puts("Sorry, `#{command}` is not a valid command.")
+        exit
+      else
+        $stderr.puts("You must specify a command! Try `todidnt all`.")
+      end
+    end
+
+    def self.all(options)
+      all_lines = self.all_lines(options)
+
+      puts "\nResults:"
+      all_lines.sort_by do |line|
+        line.timestamp
+      end.each do |line|
+        puts line.pretty
+      end
+    end
+
+    def self.overdue(options)
+      date = Chronic.parse(options[:date] || 'now', :context => :past)
+      if date.nil?
+        $stderr.puts("Invalid date passed: #{options[:date]}")
+        exit
+      else
+        puts "Finding overdue TODOs (created before #{date.strftime('%F')})..."
+      end
+
+      all_lines = self.all_lines(options)
+
+      puts "\nResults:"
+      all_lines.sort_by do |line|
+        line.timestamp
+      end.select do |line|
+        line.timestamp < date.to_i
+      end.each do |line|
+        puts line.pretty
+      end
+    end
+
+    def self.all_lines(options)
       GitRepo.new(options[:path]).run do |path|
         puts "Running in #{path || 'current directory'}..."
         lines = TodoLine.all(["TODO"])
@@ -15,10 +62,7 @@ module Todidnt
           $stdout.write "\rBlamed: #{i}/#{lines.count}"
         end
 
-        puts "\nResults:"
-        lines.each do |line|
-          puts line.pretty
-        end
+        lines
       end
     end
   end

data/test/lib.rb

@@ -1,8 +1,11 @@
+unless defined? Todidnt
+  $LOAD_PATH << File.expand_path('../../lib', __FILE__)
+  require 'todidnt'
+end
+
 require 'minitest/spec'
 require 'minitest/autorun'
 require 'mocha/setup'
 
-require_relative '../lib/todidnt'
-
 class Test < MiniTest::Spec
 end

data/test/test_todo_line.rb

@@ -0,0 +1,108 @@
+require 'lib'
+
+class TestTodoLine < Test
+  before do
+    Todidnt::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 => [])
+
+        Todidnt::GitCommand.expects(:new).with(:grep, [['-n'], ['-e', 'hello']]).returns(grep)
+        Todidnt::TodoLine.all(['hello'])
+
+        Todidnt::GitCommand.expects(:new).with(:grep, [['-n'], ['-e', 'hello'], ['-e', 'goodbye']]).returns(grep)
+        Todidnt::TodoLine.all(['hello', 'goodbye'])
+      end
+
+      it 'creates a TodoLine object for each result line properly' do
+        Todidnt::GitCommand.any_instance.expects(:output_lines).returns(
+          [
+            'filename.rb:12:     content',
+            'other_filename.rb:643:    TODO'
+          ]
+        )
+
+        Todidnt::TodoLine.expects(:new).with('filename.rb', 12, 'content')
+        Todidnt::TodoLine.expects(:new).with('other_filename.rb', 643, 'TODO')
+
+        Todidnt::TodoLine.all(['anything'])
+      end
+    end
+
+    describe 'functional' do
+      it 'returns a list of TodoLine objects as matches' do
+        Todidnt::GitCommand.any_instance.expects(:output_lines).returns(
+          [
+            'filename.rb:12:     content',
+            'other_filename.rb:643:    TODO'
+          ]
+        )
+
+        todos = Todidnt::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
+        Todidnt::GitCommand.any_instance.expects(:output_lines).returns(
+          [
+            'filename.rb:12:     content',
+            'thirdparty/other_filename.rb:643:    TODO'
+          ]
+        )
+
+        todos = Todidnt::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
+      blame = mock()
+      blame.expects(:output_lines).returns([])
+      Todidnt::GitCommand.expects(:new).with(:blame,
+        [
+          ['--line-porcelain'],
+          ['-L', '50,50'],
+          ['filename.rb']
+        ]
+      ).returns(blame)
+
+      todo_line = Todidnt::TodoLine.new('filename.rb', 50, 'commit message')
+      todo_line.populate_blame
+    end
+
+    it 'sets author, timestamp properties on the TodoLine object' do
+      blame = mock()
+      blame.expects(:output_lines).returns(
+        %w{
+          39efeb14a9 1 1
+          author Amber Feng
+          author-time 1383882788
+          author-mail <amber.feng@gmail.com>,
+          summary Commit message,
+        }
+      )
+      Todidnt::GitCommand.expects(:new).returns(blame)
+
+      todo_line = Todidnt::TodoLine.new('filename.rb', 50, 'commit message')
+      todo_line.populate_blame
+    end
+  end
+end

data/todidnt.gemspec

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: todidnt
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-07 00:00:00.000000000 Z
+date: 2013-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -52,14 +52,15 @@ extra_rdoc_files: []
 files:
 - Gemfile
 - Gemfile.lock
-- README
+- README.md
+- Rakefile
 - 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
+- test/test_todo_line.rb
 - todidnt.gemspec
 homepage: 
 licenses: []
@@ -86,5 +87,4 @@ signing_key:
 specification_version: 3
 summary: Todidnt
 test_files:
-- test/lib.rb
-- test/todo_line.rb
+- test/test_todo_line.rb

data/README

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

data/test/todo_line.rb

@@ -1,86 +0,0 @@
-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