todidnt 0.3.1 → 0.4.1

data/Gemfile

@@ -1,11 +1,4 @@
 source 'https://rubygems.org'
 ruby '1.9.3'
 
-gem 'chronic'
-gem 'launchy'
-gem 'tilt'
-
-group 'test' do
-  gem 'minitest'
-  gem 'mocha'
-end
+gemspec

data/Gemfile.lock

@@ -1,7 +1,17 @@
+PATH
+  remote: .
+  specs:
+    todidnt (0.3.1)
+      chronic
+      launchy
+      slop
+      subprocess
+      tilt
+
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.3.5)
+    addressable (2.3.6)
     chronic (0.10.2)
     launchy (2.4.2)
       addressable (~> 2.3)
@@ -9,14 +19,14 @@ GEM
     minitest (5.0.8)
     mocha (0.14.0)
       metaclass (~> 0.0.1)
-    tilt (2.0.0)
+    slop (3.6.0)
+    subprocess (1.2.0)
+    tilt (2.0.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  chronic
-  launchy
   minitest
   mocha
-  tilt
+  todidnt!

data/README.md

@@ -3,8 +3,13 @@ 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.
+Todidnt is a command line utility to help you track down TODOs and FIXMEs that 
+you always said you'd do but haven't actually done yet. It also generates pages
+(rdoc-style) to show you things like pretty graphs of your repository TODOs over
+time.
+
+![todidnt-rails-screenshot](https://cloud.githubusercontent.com/assets/286015/3520069/33fe0e7e-0727-11e4-9a88-6b70dbff236c.png)
+
 
 Usage
 ----
@@ -17,15 +22,7 @@ Then, run `todidnt` in any Git repository directory:
 
     $ todidnt
 
-TODO[1]
-----
-
-- Filtering by author, label
-- TODO stats
-
 Credit
 ----
 
 Paul Battley (@threedaymonk) for initial idea and witty name.
-
-1: Oh, the irony.

data/bin/todidnt

@@ -2,25 +2,24 @@
 
 require 'optparse'
 require 'todidnt'
+require 'slop'
 
-options = {:path => '.'}
-command = ARGV.shift
+command = nil
+opts = Slop.parse(ARGV, help: true) do
+  on 'p','path=', 'Git directory to run Todidnt in (default: current directory)', default: '.'
+  on 't', 'threshold=', 'Threshold of % of TODOs at which to count someone as an individual contributor rather than "Other" (default: 0.03, which means 3%).', as: Float, default: 0.03
 
-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
+  on 'version', 'Print the version.' do
+    puts Todidnt::VERSION
     exit
   end
 
-  opts.parse!
+  commands = ['clear']
+  commands.each do |c|
+    command c do
+      run do command = c end
+    end
+  end
 end
 
-Todidnt::CLI.run(command, options)
+Todidnt::CLI.run(command, opts)

data/lib/todidnt.rb

@@ -5,6 +5,8 @@ require 'todidnt/todo_line'
 require 'todidnt/git_history'
 require 'todidnt/html_generator'
 
+require 'todidnt/version'
+
 require 'chronic'
 require 'launchy'
 
@@ -23,9 +25,9 @@ module Todidnt
       end
     end
 
-    def self.generate(options)
-      GitRepo.new(options[:path]).run do |path|
-        history = GitHistory.new
+    def self.generate(opts)
+      GitRepo.new(opts[:path]).run do |path|
+        history = GitHistory.new(opts)
         buckets, authors = history.timeline!
 
         lines = TodoLine.all(["TODO"])
@@ -47,7 +49,7 @@ module Todidnt
       end
     end
 
-    def self.clear(options)
+    def self.clear(opts)
       puts "Deleting cache..."
       Cache.clear!
       puts "Done!"

data/lib/todidnt/git_history.rb

@@ -3,10 +3,14 @@ module Todidnt
 
     attr_accessor :blames
 
-    def initialize
+    def initialize(opts)
       @history = []
       @blames = {}
       @unmatched_deletions = []
+
+      # Contributor threshold (e.g. only show as a separate contributor
+      # if they've contributed to > N% of TODOs).
+      @threshold = opts[:threshold]
     end
 
     def timeline!
@@ -65,6 +69,8 @@ module Todidnt
       count = 0
 
       command.execute! do |line|
+        line.encode!('UTF-8', 'binary', invalid: :replace, undef: :replace, replace: '')
+
         if (diff = /diff --git a\/(.*) b\/(.*)/.match(line))
           filename = diff[1]
         elsif (diff = /^\+(.*TODO.*)/.match(line))
@@ -152,16 +158,22 @@ module Todidnt
       # Figure out what the interval should be based on the total timespan.
       if timespan > 86400 * 365 * 10 # 10+ years
         interval = 86400 * 365 # years
+        timespan_label = 'years'
       elsif timespan > 86400 * 365 * 5 # 5-10 years
         interval = 86400 * (365 / 2) # 6 months
+        timespan_label = 'months'
       elsif timespan > 86400 * 365 # 2-5 years
         interval = 86400 * (365 / 4) # 3 months
+        timespan_label = 'months'
       elsif timespan > 86400 * 30 * 6 # 6 months-3 year
         interval = 86400 * 30 # months
-      elsif timespan > 86400 * 1 # 1 month - 6 months
+        timespan_label = 'months'
+      elsif timespan > 86400 * 14 * 1 # 1/2 month - 6 months
         interval = 86400 * 7
-      else # 0 - 2 months
+        timespan_label = 'days'
+      else # 0 - 1/2 months
         interval = 86400 # days
+        timespan_label = 'days'
       end
 
       original_interval_start = Time.new(min_commit_date.year, min_commit_date.month, min_commit_date.day).to_i
@@ -175,7 +187,7 @@ module Todidnt
 
       # Add the first bucket of 0
       buckets << {
-        :timestamp => Time.at(interval_start).strftime('%D'),
+        :timestamp => format_date(Time.at(interval_start), timespan_label),
         :authors => {},
         :total => 0
       }
@@ -200,7 +212,7 @@ module Todidnt
         # in a new bucket, finish the current bucket.
         if i == (@history.length - 1) || @history[i + 1][:timestamp] >= interval_end
           buckets << {
-            :timestamp => ([Time.at(interval_end), max_commit_date].min).strftime('%D'),
+            :timestamp => format_date(([Time.at(interval_end), max_commit_date].min), timespan_label),
             :authors => current_bucket_authors,
             :total => bucket_total
           }
@@ -221,7 +233,7 @@ module Todidnt
         bucket[:authors].each do |author, count|
           # Only include the author if they account for more than > 3% of
           # the TODOs in this bucket.
-          if count > bucket[:total] * 0.03
+          if count > bucket[:total] * @threshold
             significant_authors[author] = count
             authors << author
           else
@@ -244,5 +256,17 @@ module Todidnt
       [buckets, authors]
     end
 
+    private
+
+    def format_date(date, timespan_label)
+      case timespan_label
+      when 'years'
+        date.strftime('%Y')
+      when 'months'
+        date.strftime('%-m/%y')
+      when 'days'
+        date.strftime('%-m/%-d')
+      end
+    end
   end
 end

data/lib/todidnt/version.rb

@@ -0,0 +1,3 @@
+module Todidnt
+  VERSION = '0.4.1'
+end

data/templates/css/style.css

@@ -29,7 +29,7 @@ body a:hover {
 header {
   background: #333;
   color: #fff;
-  padding: 10px 30px;
+  padding: 10px 50px;
 }
 
 header h1 {
@@ -38,7 +38,7 @@ header h1 {
 }
 
 section.content {
-  padding: 30px;
+  padding: 50px;
 }
 
 footer {

data/templates/history.erb

@@ -1,6 +1,32 @@
+<style type='text/css'>
+  #legend {
+    width: 19%;
+    height: 500px;
+    overflow: auto;
+
+    margin-top: 20px;
+  }
+
+  #graph {
+    float: left;
+    overflow: auto;
+    width: 80%;
+  }
+
+  .x.axis line, .x.axis path, .y.axis line, .y.axis path {
+    fill: none;
+    stroke: #444;
+  }
+
+</style>
+
+<div id='graph'></div>
+<div id='legend'></div>
+
 <script src='js/vendor/d3.min.js'></script>
 <script src='js/vendor/d3-tip.js'></script>
 <script type='text/javascript'>
   PRELOADED_DATA = <%= data.to_json %>;
 </script>
 <script src='js/todidnt-history.js'></script>
+

data/templates/js/todidnt-history.js

@@ -4,10 +4,10 @@ var margin = {
   top: 20,
   right: 20,
   bottom: 30,
-  left: Math.round(window.innerWidth * 0.09)
+  left: 50
 };
 
-var width = window.innerWidth * 0.8, height = 500;
+var width = window.innerWidth * 0.70, height = 500;
 
 // Graph scale setup
 
@@ -27,6 +27,17 @@ var getColor = function(name) {
   }
 };
 
+var getGrayscaleColor = function(name) {
+  var color = getColor(name);
+
+  // Grayscale the color.
+  hsl = d3.hsl(color);
+  l = hsl.l;
+  l = Math.min(l + ((1 - l) * 0.85), 0.95);
+
+  return d3.hsl(hsl.h, 0, l);
+}
+
 var xAxis = d3.svg.axis()
   .scale(x)
   .orient("bottom");
@@ -62,7 +73,7 @@ var data = PRELOADED_DATA['history'].map(function(d) {
 
 // Graph creation
 
-var svg = d3.select("section.content").append("svg")
+var svg = d3.select("#graph").append("svg")
   .attr("width", '100%')
   .attr("height", height + margin.top + margin.bottom)
   .append("g")
@@ -73,21 +84,6 @@ svg.call(tip);
 x.domain(data.map(function(d) { return d.date; }));
 y.domain([0, d3.max(data, function(d) { return d.total; })]);
 
-svg.append("g")
-.attr("class", "x axis")
-.attr("transform", "translate(0," + height + ")")
-.call(xAxis);
-
-svg.append("g")
-  .attr("class", "y axis")
-  .call(yAxis)
-  .append("text")
-  .attr("transform", "rotate(-90)")
-  .attr("y", 6)
-  .attr("dy", ".71em")
-  .style("text-anchor", "end")
-  .text("TODOs");
-
 var dates = svg.selectAll(".dates")
   .data(data)
   .enter().append("g")
@@ -104,23 +100,70 @@ dates.selectAll("rect")
   .on("mouseover", tip.show)
   .on("mouseout", tip.hide);
 
+
+// Axes
+
+svg.append("g")
+.attr("class", "x axis")
+.attr("transform", "translate(0," + height + ")")
+.call(xAxis);
+
+svg.append("g")
+  .attr("class", "y axis")
+  .call(yAxis)
+  .append("text")
+  .attr("transform", "rotate(-90)")
+  .attr("y", 6)
+  .attr("dy", ".71em")
+  .style("text-anchor", "end")
+  .text("TODOs");
+
 // Legend
 
-var legend = svg.selectAll(".legend")
-  .data(color.domain().slice().reverse())
-  .enter().append("g")
-  .attr("class", "legend")
-  .attr("transform", function(d, i) { return "translate(0," + i * 20 + ")"; });
+var legend_svg = d3.select("#legend")
+  .append('svg')
+  .style("height", color.domain().length * 20);
 
-legend.append("rect")
-  .attr("x", 30)
+var legend = legend_svg.append('g')
+  .attr("class", "legend");
+
+legend.selectAll('rect')
+  .data(color.domain().slice().reverse())
+  .enter().append("rect")
   .attr("width", 18)
   .attr("height", 18)
-  .style("fill", getColor);
-
-legend.append("text")
-  .attr("x", 55)
+  .attr("transform", function(d, i) { return "translate(0," + i * 20 + ")"; })
+  .style("fill", getColor)
+  .style("cursor", "pointer")
+  .on('click', function(d, i) {
+    j = color.domain().length - i - 1; // reversed for some reason
+    dates.selectAll("rect").style("fill",
+      function(d2, i2) {
+        if (j != i2) {
+          return getGrayscaleColor(d2.name);
+        } else {
+          return getColor(d2.name);
+        }
+      }
+    )
+
+    legend.selectAll("rect").style("fill",
+      function(d2, i2) {
+        if (i != i2) {
+          return getGrayscaleColor(d2);
+        } else {
+          return getColor(d2);
+        }
+      }
+    )
+  })
+
+legend.selectAll('text')
+  .data(color.domain().slice().reverse())
+  .enter().append("text")
+  .attr("x", 25)
   .attr("y", 9)
   .attr("dy", ".35em")
+  .attr("transform", function(d, i) { return "translate(0," + i * 20 + ")"; })
   .style("text-anchor", "beginning")
   .text(function(d) { return d; });

data/todidnt.gemspec

@@ -1,13 +1,22 @@
+$:.unshift(File.join(File.dirname(__FILE__), 'lib'))
+require 'todidnt/version'
+
 Gem::Specification.new do |s|
   s.name        = 'todidnt'
-  s.version     = '0.3.1'
+  s.version     = Todidnt::VERSION
   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.add_dependency('chronic', '0.10.2')
+  s.add_dependency('launchy', '2.4.2')
+  s.add_dependency('tilt', '2.0.1')
+  s.add_dependency('slop', '3.6.0')
+  s.add_dependency('subprocess', '1.0.0')
+
+  s.add_development_dependency('minitest', '5.4.0')
+  s.add_development_dependency('mocha', '1.1.0')
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- test/test_*.rb`.split("\n")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: todidnt
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,40 +9,120 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-05 00:00:00.000000000 Z
+date: 2014-08-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: chronic
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.2
+- !ruby/object:Gem::Dependency
+  name: launchy
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.4.2
+- !ruby/object:Gem::Dependency
+  name: tilt
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+- !ruby/object:Gem::Dependency
+  name: subprocess
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.4.0
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.1.0
 description: Todidnt finds and dates todos in your git repository.
 email: amber.feng@gmail.com
 executables:
@@ -63,6 +143,7 @@ files:
 - lib/todidnt/git_repo.rb
 - lib/todidnt/html_generator.rb
 - lib/todidnt/todo_line.rb
+- lib/todidnt/version.rb
 - templates/all.erb
 - templates/css/style.css
 - templates/css/vendor/chosen.min.css