git_time_extractor 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1e7bf5aea252dc4ba852c777e24e6c1887d0c75e
-  data.tar.gz: 64b45f000e6bc36468b07be0c9713a70a2850fd7
+  metadata.gz: 4388a37659ca28a30fa8cb863afa2cc43e095019
+  data.tar.gz: d970e6f969cd744b9ff5289c951a342f621bdd06
 SHA512:
-  metadata.gz: a60472dcdde1f9a9db681af4a37ad1eb8bc0b8a8c9d84815b00997536dbca6194445ac3009aef9c4223ba0033787dcb87824c0d100cac581c787aefc191f0d10
-  data.tar.gz: 5ed84870e1a41aa44db2b72324e2829977f55cbea77ffa7d6d8b2a62e7b69050a7f127f79ac1a56be0c13bfc8a83e3dbb54945a4c0b4e3599d4229ba063bb206
+  metadata.gz: 9ad103bd9633bbdac6b7e87aedca20878530317baaa12ec78d94eba986f4b01447770bcc04fb6cb807e4bc53f662d5078b3162c95d2f004645ec6b51813cf08d
+  data.tar.gz: d50da7e0cecc51f5f5e992161da23ff7889ae9b822f788aac4cf24cb953f072fe1554f19cfa721f313236c834765504185132f5fc34c1ce4dc5586a35a1fb6bc

data/History.txt

@@ -1,3 +1,6 @@
+=== 0.3.2 / 2015-05-20
+  Multiple small changes, compact and total-project summary options added.
+
 === 0.3.0 / 2014-11-13
   Major update. Command line configurable assumptions and multiple author support.
 === 0.2.3

data/bin/git_time_extractor

@@ -13,7 +13,6 @@
   require 'optparse'
   require 'git_time_extractor'
 
-
   options = { :project => '',
               :path_to_repo => Dir.pwd,
               :output_file => '-',
@@ -22,6 +21,8 @@
               :merge_effort_mins => 30,
               :session_duration_hrs => 3,
               :filter_by_year => nil,
+              :compact => nil,
+              :project_total => nil,
   }
 
   valid_usage = false
@@ -68,13 +69,21 @@
             'Session duration, in hours. Default: ' + options[:session_duration_hrs].to_s ) do |session_duration|
       options[:session_duration_hrs] = session_duration
     end
+
+    opts.on('--project-total', 'Project commits and time rolled into a single summary line. The field set is total git commit count, total hours, and a list of collaborators.' ) do |project_total|
+      options[:project_total] = project_total
+    end
+
+    opts.on('--compact', 'Compact mode that lists only total git commit count, total hours, person, and email.' ) do |compact|
+      options[:compact] = compact
+    end
+
   end
 
   option_parser.parse!
 
   if options[:project] && options[:path_to_repo] && options[:output_file]
-    extractor = GitTimeExtractor.new(options)
-    rows = extractor.process_git_log_into_time
+    rows = GitTimeExtractor.new(options).process
     if options[:output_file] == '-'
       rows.each do |row|
         puts row.map!{|value| value.to_s.gsub('"', '\"').gsub("\n", '\n') }.to_csv
@@ -85,7 +94,7 @@
 
   else
     puts 'Usage: git_time_extractor -p PROJECT_NAME -i [PATH_TO_REPO] -o [OUTPUT_FILE] -c [MAX_COMMITS] -e [INITIAL_EFFORT_MINS] -m [MERGE_EFFORT_MINS] -s [SESSION_DURATION_HRS]'
-    puts 'Copyright 2014 Rietta Inc. https://rietta.com'
+    puts 'Copyright 2015 Rietta, Inc., and contributors. https://rietta.com'
     exit 0
   end # options
 

data/lib/author.rb

@@ -14,6 +14,25 @@ class Author
     @commits << commit
   end
 
+  def total_commits
+    return @commits.length
+  end
+
+  def total_working_minutes
+    # Go through the work log
+    total = 0
+    @worklog.keys.sort.each do |date|
+      if date_in_filter_range(date)
+        total += @worklog[date].duration.to_i
+      end
+    end # worklog each
+    return total
+  end
+  
+  def total_working_hours
+    return (total_working_minutes() / 60.0).round(1)
+  end
+
   # Then the tabulation is called after the commits are added into this author's list
   def tabulate_days
     @commits.each_with_index do |commit, index|

data/lib/git_time_extractor.rb

@@ -8,7 +8,7 @@
 # Portions (C) 2014 Rietta Inc. and licensed under the terms of the BSD license.
 #
 class GitTimeExtractor
-  VERSION = '0.3.1'
+  VERSION = '0.3.2'
 
   require 'autoload'
   require 'set'
@@ -102,6 +102,68 @@ class GitTimeExtractor
   end # process_git_log_into_time
 
 
+  def prepare_rows_for_summary_csv
+    rows = Array.new
+    rows << summary_header_row_template()
+    commits = 0
+    hours = 0
+    authors = Array.new
+    @authors.each do |author|
+      commits += author.total_commits()
+      hours += author.total_working_hours()
+      authors << author.commits[0].author.name + " (" + author.commits[0].author.email + ")"
+    end
+    rows << [
+      hours,
+      commits,
+      authors.join(";")
+    ]
+    return rows
+  end
+
+  #
+  # create a summary of the computed times
+  #
+  def process_git_log_into_summary
+    distribute_entries_to_authors( load_git_log_entries( path_to_git_repo ) )
+    return prepare_rows_for_summary_csv
+  end # process_git_log_into_time
+
+
+  def prepare_rows_for_author_summary_csv
+    rows = Array.new
+    rows << author_summary_header_row_template()
+    commits = 0
+    hours = 0
+    authors = Array.new
+    @authors.each do |author|
+      rows << [
+        author.total_commits(),
+        author.total_working_hours(),
+        author.commits[0].author.name,
+        author.commits[0].author.email,
+      ]
+    end
+    return rows
+  end
+
+  #
+  # create a summary per author
+  #
+  def process_git_log_into_author_summary
+    distribute_entries_to_authors( load_git_log_entries( path_to_git_repo ) )
+    return prepare_rows_for_author_summary_csv
+  end # process_git_log_into_time
+
+  def process
+    if options[:project_total]
+      process_git_log_into_summary
+    elsif options[:compact]
+      process_git_log_into_author_summary
+    else
+      process_git_log_into_time
+    end
+  end
 
   #####################################
   private
@@ -123,4 +185,25 @@ class GitTimeExtractor
     ]
   end # header_row_template
 
+  def author_summary_header_row_template
+    [
+      'Total Git Commits Count',
+      'Total Hours',
+      'Person',
+      'Email',
+      # 'From Date',
+      # 'To Date',
+    ]
+  end # summary_header_row_template
+
+  def summary_header_row_template
+    [
+      # 'From Date',
+      # 'To Date',
+      'Total Git Commits Count',
+      'Total Hours',
+      'Collaborators',
+    ]
+  end # summary_header_row_template
+
 end # class GitTimeExtractor

data/readme.md

@@ -1,6 +1,7 @@
 [![Gem Version](https://badge.fury.io/rb/git_time_extractor.png)](http://badge.fury.io/rb/git_time_extractor)
 [![Code Climate](https://codeclimate.com/github/rietta/git_time_extractor/badges/gpa.svg)](https://codeclimate.com/github/rietta/git_time_extractor)
-# EXTRACT REASONABLE TIME RECORDS FROM A GIT REPOSITORY
+
+# Extract Reasonable Time Records from a Git Repository
 
 This tool goes through a GIT repository's commit log and prints a CSV dump of per developer, per day working time based on a few assumptions:
 
@@ -10,6 +11,13 @@ This tool goes through a GIT repository's commit log and prints a CSV dump of pe
 
 This script is based on previous code published publicly by *Sharad* at http://www.tatvartha.com/2010/01/generating-time-entry-from-git-log/. However, it has been adapted to run without Rails from the command line. The portions of the code written by Rietta are licensed under the terms of the BSD license (see section 3 below).
 
+## 0. Installing from Ruby Gems
+
+To quickly get started, just run:
+`gem install git_time_extractor`
+
+You can see it at https://rubygems.org/gems/git_time_extractor.
+
 ## 1. Running
 
 ### Usage
@@ -28,6 +36,8 @@ Usage: git_time_extractor [options]
     -m, --merge-effort MERGE_EFFORT  Effort spent merging, in minutes. Default: 30
     -s SESSION_DURATION,             Session duration, in hours. Default: 3
         --session-duration
+        --project-total              Project commits and time rolled into a single summary line. The field set is total git commit count, total hours, and a list of collaborators.
+        --compact                    Compact mode that lists only total git commit count, total hours, person, email.
 ```
 ### Most basic usage
 
@@ -46,7 +56,7 @@ Once the you have used Git Time Extractor to prepare a CSV file, you can perform
 
 ## 3. License Terms (BSD License)
 
-© 2014 Rietta Inc. All rights reserved.
+© 2012-2015 Rietta, Inc, and contributors. All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
 
@@ -59,3 +69,9 @@ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 
 - [Kimmo Brunfeldt](https://github.com/kimmobrunfeldt) has written [git-hours](
 https://github.com/kimmobrunfeldt/git-hours), a NodeJS-based clone that was inspired by this `git_time_extractor`.
+- [Ad van der Veer](https://github.com/advanderveer) is working on [Timeglass](https://github.com/timeglass/glass) in the Go programming language. Unlike `git_time_extractor` and `git-hours`, both of which are built around analyzing past activity, his approach runs a timer in real time during the developer's work and annotates git commits with the time data.
+
+## 5. What users say
+
+[Jason Fieldman: Theseus 3D (2014)](http://www.fieldman.org/theseus-3d/)
+> git_time_extractor says that there is approximately 120 hours of development time on my repo, from September 19 through October 22. Pretty much all grouped on weekends (and our school’s extended 5-day break). The tool overestimates a bit because it does not compensate for meals or mid-session breaks, but it’s relatively close. So let’s say it’s closer to 90-100 hours – not bad to complete the game, including research and dealing with SceneKit foibles along the way.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: git_time_extractor
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Frank Rietta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-16 00:00:00.000000000 Z
+date: 2015-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
@@ -38,9 +38,11 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
-description: Compute the estimated time spent by developers working on code within
-  a GIT repository. Useful for verifying developer time sheets and for tax purposes
-  and it supports filtering for a specific tax year.. See https://github.com/rietta/git_time_extractor/wiki.
+description: Analyzes Git repository commit log to compute developer working hours,
+  weekly activity, and to detect death marches in software development. It computes
+  the timing statistics based on the timestamps of each commit and the intervals between
+  them. Useful for verifying developer time sheets and for tax purposes and it supports
+  filtering for a specific tax year. See https://github.com/rietta/git_time_extractor/wiki.
 email: hello@rietta.com
 executables:
 - git_time_extractor
@@ -77,6 +79,6 @@ rubyforge_project:
 rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: Reasonable developer time log extractor that uses a GIT repository's commit
-  log history.
+summary: Analyzes Git repository commit logs to compute developer working hours, weekly
+  activity, and to detect death marches in software development.
 test_files: []