clockout 0.1

data/bin/clock

@@ -0,0 +1,136 @@
+#!/usr/bin/env ruby
+
+require 'clockout'
+
+HELP_BANNER = <<-EOS
+Clockout v0.1
+Usage:
+		$ clock [options]
+
+Options:
+	--estimations, -e:   Show estimations made for first commit of each block
+	  --condensed, -c:   Condense output (don't show the timeline for each day)
+ --generate-clock, -g:   Generate .clock file
+	  --see-clock, -s:   See options specified in .clock file
+	       --help, -h:   Show this message
+EOS
+
+TEMPLATE_CLOCKFILE = <<-EOF
+; Ignore initial commit, if it's just template/boilerplate
+;   Type:     BOOL
+;   Default:  0
+
+;ignore_initial = 1
+
+; Minimum time between blocks of commits
+;   Type:     Int (in minutes)
+;   Default:  120
+;
+; Default is 120, so if you think some commits took you more than 2 hours, you should shorten this
+
+;time_cutoff = 90
+
+
+;; Time-estimation options for each first commit of a timeblock
+
+; Diffs of files matched by this regex will be included in commit time estimation
+;   Type:     Regex (Ruby)
+;   Default:  /.*/ (matches everything)
+;
+; With some projects, there are diffs to binaries, images, files modified by an IDE, etc,
+; that you don't want to report as your own work.
+; Below is an example regex that will only calculate changes made to files with those extensions
+
+;my_files = /\.(m|h|rb|txt)$/
+
+; Diffs of files matched by this regex will NOT be included in commit time estimation
+;   Type:     Regex (Ruby)
+;   Default:  <nothing>
+;
+; You also have the option of defining a negative regex match, to ignore certain files.
+; For example, if you added an external library or something, you should ignore those additions
+
+;not_my_files = /(ThisFile\.cpp | SomeOtherClass\.*)/
+
+; Completion time overrides for commit estimations
+;   Type:     Int (in minutes)
+;
+; Override times for specific commits here.
+
+;7deec149 = 25
+;5a6105e6 = 15
+;4325de58 = 120
+EOF
+
+def parse_options(args)
+    opts = {}
+
+	args.each do |arg|
+		if (arg == "-h" || arg == "--help")
+			opts[:help] = true
+        elsif (arg == "-s" || arg == "--see-clock")
+            opts[:see_clock] = true
+		elsif (arg == "-e" || arg == "--estimations")
+			opts[:estimations] = true
+		elsif (arg == "-c" || arg == "--condensed")
+			opts[:condensed] = true
+		elsif (arg == "-g" || arg == "--generate-clock")
+			opts[:generate_clock] = true
+		elsif (arg[0] == "-")
+			puts "Error: invalid option '#{arg}'."
+			puts "Try --help for help."
+			exit
+		end
+	end
+
+	opts
+end
+
+path = Dir.pwd
+
+# Default options
+opts = {time_cutoff:120, my_files:"/.*/"}
+opts.merge!(parse_options(ARGV))
+
+if opts[:generate_clock]
+	clock_path = path+"/.clock"
+	if (File.exists?(clock_path))
+		puts "#{colorize("Error:", RED)} .clock file already exists, ignoring --generate-clock option.\n"
+	else
+		File.open(clock_path, "w") do |file|
+			file.write(TEMPLATE_CLOCKFILE)
+		end
+		puts "Generated .clock file at #{clock_path}.\n"
+	end
+end
+
+clock = Clockout.new(path, opts)
+
+if opts[:see_clock]
+    if !clock.clock_opts
+        puts "No .clock file found. Run `clock -g` to generate one."
+    else
+    	if clock.clock_opts.size == 0
+    		puts "No clock options."
+    	else
+	        puts "Clock options:"
+	        clock.clock_opts.each do |k, v|
+	            key = k[0..19]
+	            puts "    #{key}:#{' '*(20-key.length)}#{v}"
+	        end
+	    end
+    end
+    exit
+end
+
+if opts[:help]
+    puts HELP_BANNER
+    exit
+end
+
+if (opts[:estimations])
+	clock.print_estimations
+else
+	clock.print_chart
+end
+

data/lib/clockout.rb

@@ -0,0 +1,248 @@
+require 'grit'
+
+class Commit
+	attr_accessor :message, :minutes, :date, :diffs, :sha
+end
+
+RED = 31
+YELLOW = 33
+MAGENTA = 35
+LIGHT_BLUE = 94
+def colorize(str, color)
+    "\e[0;#{color};49m#{str}\e[0m"
+end
+
+class Clockout
+	COLS = 80
+	DAY_FORMAT = '%B %e, %Y'
+
+	attr_accessor :blocks, :time_per_day, :clock_opts
+
+	def diffs(commit)
+		plus, minus = 0, 0
+
+		commit.stats.to_diffstat.each do |diff_stat|
+	        my_files = $opts[:my_files]
+	        not_my_files = $opts[:not_my_files]
+			should_include = (diff_stat.filename =~ eval(my_files))
+			should_ignore = not_my_files && (diff_stat.filename =~ eval(not_my_files))
+			if should_include && !should_ignore
+				plus += diff_stat.additions
+				minus += diff_stat.deletions
+			end
+		end
+
+		# Weight deletions half as much, since they are typically
+		# faster to do & also are 1:1 with additions when changing a line
+		plus+minus/2
+	end
+
+	def seperate_into_blocks(repo, commits)
+		blocks = []
+		block = []
+
+		total_diffs, total_mins = 0, 0
+
+		commits.each do |commit|
+
+			c = Commit.new
+			c.date = commit.committed_date
+			c.message = commit.message.gsub("\n",' ')
+			c.diffs = diffs(commit)
+			c.sha = commit.id[0..7]
+
+			if block.size > 0
+				time_since_last = (block.last.date - commit.committed_date).abs/60
+				
+				if (time_since_last > $opts[:time_cutoff])
+					blocks << block
+					block = []
+				else
+					c.minutes = time_since_last
+
+	                @time_per_day[c.date.strftime(DAY_FORMAT)] += c.minutes
+
+					total_diffs += c.diffs
+					total_mins += c.minutes
+				end
+			end
+
+			block << c
+		end
+
+		blocks << block
+
+		# Now go through each block's first commit and estimate the time it took
+		blocks.each do |block|
+			first = block.first
+
+	        # See if they were overriden in the .clock file
+	        if ($opts[first.sha.to_sym])
+	            first.minutes = $opts[first.sha.to_sym].to_i
+			elsif ($opts[:ignore_initial] && block == blocks.first) || total_diffs == 0
+				first.minutes = 0
+			else
+				# Underestimate by a factor of 0.9
+				first.minutes = 0.9*first.diffs*(1.0*total_mins/total_diffs)
+			end
+
+	        @time_per_day[first.date.strftime(DAY_FORMAT)] += first.minutes
+		end
+	end
+
+	def print_chart
+		cols = ($opts[:condensed] ? 30 : COLS)
+		total_sum = 0
+		current_day = nil
+		@blocks.each do |block|
+			date = block.first.date.strftime(DAY_FORMAT)
+			if date != current_day
+				puts if (!$opts[:condensed])
+
+				current_day = date
+
+				sum = @time_per_day[date]
+				total_sum += sum
+
+				sum_str = "#{(sum/60.0).round(2)} hrs"
+				print colorize(date,MAGENTA)
+				print colorize("."*(cols - date.length - sum_str.length),MAGENTA)
+				print colorize(sum_str,RED)
+				puts
+			end
+
+			print_timeline(block) if (!$opts[:condensed])
+		end
+
+		puts " "*(cols-10) + colorize("-"*10,MAGENTA)
+		sum_str = "#{(total_sum/60.0).round(2)} hrs"
+		puts " "*(cols-sum_str.length) + colorize(sum_str,RED)
+	end
+
+	def print_timeline(block)
+		# subtract from the time it took for first commit
+		time = (block.first.date - block.first.minutes*60).strftime('%l:%M %p')+":  "
+		print colorize(time,YELLOW)
+
+		char_count = time.length
+
+		block.each do |commit|
+			if commit.minutes < 60
+				c_mins = "#{commit.minutes.round(0)}m"
+			else
+				c_mins = "#{(commit.minutes/60.0).round(1)}h"
+			end
+
+			seperator = " | "
+		
+			add = c_mins.length+seperator.length
+			if char_count + add > COLS-5
+				puts
+				char_count = time.length # indent by the length of the time label on left
+				print " "*char_count
+			end
+
+			char_count += add
+
+			print c_mins+colorize(seperator,RED)
+		end
+		puts
+	end
+
+	def print_estimations
+		sum = 0
+		@blocks.each do |block|
+			first = block.first
+			date = first.date.strftime('%b %e')+": "
+			sha = first.sha+" "
+			if first.minutes < 60
+				time = "#{first.minutes.round(0)} min"
+			else
+				time = "#{(first.minutes/60.0).round(2)} hrs"
+			end
+
+			print colorize(date,YELLOW)
+			print colorize(sha,RED)
+
+			cutoff = COLS-time.length-date.length-6-sha.length
+			message = first.message[0..cutoff]
+			message += "..." if first.message.length > cutoff
+			print message
+
+			print " "*(COLS-message.length-time.length-date.length-sha.length)
+			puts colorize(time, LIGHT_BLUE)
+
+			sum += first.minutes
+		end
+
+		puts " "*(COLS-10) + colorize("-"*10,LIGHT_BLUE)
+		sum_str = "#{(sum/60.0).round(2)} hrs"
+		puts " "*(COLS-sum_str.length) + colorize(sum_str, LIGHT_BLUE)
+	end
+
+	def get_repo(path)
+	    begin
+	        return Grit::Repo.new(path)
+	    rescue Exception => e
+	        if e.class == Grit::NoSuchPathError
+	            puts "Error: Path '#{path}' could not be found."
+	        else
+	            puts "Error: '#{path}' is not a Git repository."
+	        end
+	    end
+	end
+
+	def parse_clockfile(file)
+	    return nil if !File.exists?(file)
+
+	    opts = {}
+
+	    line_num = 0
+	    File.foreach(file) do |line|
+	        line_num += 1
+	        line.strip!
+
+	        next if line[0] == ";" || line.length == 0
+
+	        sides = line.split("=",2)
+
+	        if sides.length != 2
+	            puts "Error: bad syntax on line #{line_num} of .clock file:"
+	            puts "    #{line}"
+	            puts ""
+	            puts "Line must be of form:"
+	            puts "    KEY = VALUE"
+
+	            exit
+	        end
+
+	        left = sides[0].strip
+	        right = sides[1].strip
+
+	        if left == "ignore_initial"
+	            right = (right != "0")
+	        elsif left == "time_cutoff"
+	            right = right.to_i
+	        end
+
+	        opts[left.to_sym] = right
+	    end
+
+	    opts 
+	end
+
+	def initialize(path, options)
+		$opts = options
+
+	    @clock_opts = parse_clockfile(path+"/.clock")
+	    $opts.merge!(@clock_opts) if @clock_opts
+
+		repo = get_repo(path) || exit
+
+		commits = repo.commits('master', 500)
+		commits.reverse!
+
+		@time_per_day = Hash.new(0)
+		@blocks = seperate_into_blocks(repo, commits)
+	end
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: clockout
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Dan Hassin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: grit
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An sort of extension to Git to support clocking hours worked on a project.
+email:
+- danhassin@mac.com
+executables:
+- clock
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/clockout.rb
+- !binary |-
+  YmluL2Nsb2Nr
+homepage: http://rubygems.org/gems/clockout
+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.24
+signing_key: 
+specification_version: 3
+summary: Clock your hours worked using Git
+test_files: []