git_time_extractor 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 67380a618ca6269c81cdbbcfeccbeacb07320737
-  data.tar.gz: 13ac9b92971197d84aa25ddbcb234ae653c78531
+  metadata.gz: 5cd63888dc7235ee55baee19108e6b576dbdf474
+  data.tar.gz: a0ac045a5dd7ad3d81e763c4a76d74880dcaaf42
 SHA512:
-  metadata.gz: 3f6c5fd9ed017ad1b09ae83bda466c1d0d63188e052340b6dbdb15d1260b31f88c11f27f90fe56604848e28dec2e9d154427c36f853bd6b86c45ce7140d3ead6
-  data.tar.gz: d74d5556f3c677a1bfc2001cc4ca38d6558a5e71b1d7a68071deb8e64cede801bca5388480ea5f86fb1e4ab7a82cd960508d420026a1f63cefea36fad3ecd7a5
+  metadata.gz: 0363407a1a542759865af72d0958e2af5c4fa1dc235e78bdd56ac6fb2a4809f47275d25618b45bd8769a4cbb54c27751fcaefbb49fc5c0d942f76d5caa90756a
+  data.tar.gz: 503fe4be1588f616c93911c073a59e1bc8a563e12790cc5532c266f39108967e30a2ebbbb7c4c2415a8ad685b29b85068f91fa0ba707e19b40e828664e1d2ac7

data/History.txt

@@ -1,3 +1,6 @@
+=== 0.3.0 / 2014-11-13
+  Major update. Command line configurable assumptions and multiple author support.
+=== 0.2.3
 === 0.1.0 / 2012-05-05
 
 * 1 major enhancement

data/bin/git_time_extractor

@@ -1,8 +1,8 @@
 #!/usr/bin/env ruby
 # Extract Reasonable Developer Time Records from a GIT Repository's Commit Log
 #
-# This is inspired by a RAKE task publicly posted by Sharad at 
-# http://www.tatvartha.com/2010/01/generating-time-entry-from-git-log/. 
+# This is inspired by a RAKE task publicly posted 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.
 #
 # Portions (C) 2012 Rietta Inc. and licensed under the terms of the BSD license.
@@ -10,36 +10,71 @@
   # Adjust path in case called directly and not through gem
   $:.unshift "#{File.expand_path(File.dirname(__FILE__))}/../lib"
 
+  require 'optparse'
   require 'git_time_extractor'
 
-  #puts "\n# Arguments #{ARGV.length}\n"
+
+  options = { :project => '',
+              :path_to_repo => Dir.pwd,
+              :output_file => '-',
+              :max_commits => 10000,
+              :initial_effort_mins => 30,
+              :merge_effort_mins => 30,
+              :session_duration_hrs => 3
+  }
 
   valid_usage = false
 
-  if ARGV.empty?
-    output_file = "-"
-    path_to_repo = Dir.pwd
-    project_name = ""
-    valid_usage = true
-  elsif "-h" == ARGV[0].downcase || "--help" == ARGV[0].downcase
-    # Show help
-  elsif ARGV.length == 2
-    output_file = ARGV.pop
-    path_to_repo = ARGV.pop
-    valid_usage = true
-  elsif ARGV.length == 1
-    output_file = "-"
-    path_to_repo = ARGV.pop 
-    valid_usage = true
+  option_parser = OptionParser.new do |opts|
+    opts.on('-p PROJECT', '--project PROJECT') do |project|
+       options[:project] = project
+    end
+
+    opts.on('-i REPOPATH', '--repo-path REPOPATH') do |repopath|
+       options[:path_to_repo] = repopath
+    end
+
+    opts.on('-o OUTPUT_CSV', '--out OUTPUT_CSV') do |output_file|
+       options[:output_file] = output_file
+    end
+
+    opts.on('-c MAX_COMMITS', '--max-commits MAX_COMMITS',
+            'Maximum number of commits to read from Git. Default: ' + options[:max_commits].to_s ) do |max_commits|
+      options[:max_commits] = max_commits
+    end
+
+    opts.on('-e INITIAL_EFFORT', '--initial-effort INITIAL_EFFORT',
+            'Initial Effort before each commit, in minutes. Default: ' + options[:initial_effort_mins].to_s ) do |initial_effort|
+      options[:initial_effort_mins] = initial_effort
+    end
+
+    opts.on('-m MERGE_EFFORT', '--merge-effort MERGE_EFFORT',
+            'Effort spent merging, in minutes. Default: ' + options[:merge_effort_mins].to_s) do |initial_effort|
+      options[:initial_effort_mins] = initial_effort
+    end
+
+    opts.on('-s SESSION_DURATION', '--session-duration SESSION_DURATION',
+            'Session duration, in hours. Default: ' + options[:session_duration_hrs].to_s ) do |session_duration|
+      options[:session_duration_hrs] = session_duration
+    end
   end
 
-  unless valid_usage
-    puts "Usage: git_time_extractor PROJECT_NAME [PATH_TO_REPO] [OUTPUT_FILE]"
-    puts "Copyright 2012 Rietta Inc.  http://www.rietta.com"
+  option_parser.parse!
+
+  if options[:project] && options[:path_to_repo] && options[:output_file]
+    extractor = GitTimeExtractor.new(options)
+    rows = extractor.process_git_log_into_time
+    if options[:output_file] == '-'
+      rows.each do |row|
+        puts row.map!{|value| value.to_s.gsub('"', '\"').gsub("\n", '\n') }.to_csv
+      end
+    else
+      puts 'Output to file not implemented yet'
+    end # options
+
+  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'
     exit 0
-  else 
-    #path_to_repo = File.expand_path(File.dirname(path_to_repo)) if nil != path_to_repo && "" != path_to_repo
-    #puts "\n\nGit Repo Path: #{path_to_repo}\nOutput: #{output_file}\n"
-    GitTimeExtractor.process_git_log_into_time(path_to_repo, output_file)
-  end
+  end # options
 

data/lib/author.rb

@@ -0,0 +1,146 @@
+class Author
+
+  attr_accessor :commits, :worklog, :rows, :options
+
+  def initialize(options)
+    @options  = options
+    @commits  = Array.new
+    @worklog  = Hash.new
+    @rows     = Array.new
+  end
+
+  # Each commit is added into the list
+  def add_commit(commit)
+    @commits << commit
+  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|
+       roll_up_to_days commit, index
+    end
+
+    # Go through the work log
+    @worklog.keys.sort.each do |date|
+        @rows << summarize(@worklog[date], date)
+    end # worklog each
+  end # tabulate_days
+
+  def summarize(summary, date)
+    start_time = DateTime.parse(date.to_s)
+    duration_in_seconds = (summary.duration.to_f * 60.0).round(0)
+    duration_in_minutes = summary.duration.to_i
+    duration_in_hours   = (summary.duration / 60.0).round(1)
+
+    return summarize_helper(
+                              start_time,
+                              duration_in_seconds,
+                              duration_in_minutes,
+                              duration_in_hours,
+                              summary
+                           )
+  end # summarize
+
+  def summarize_helper(
+                        start_time,
+                        duration_in_seconds,
+                        duration_in_minutes,
+                        duration_in_hours,
+                        summary
+                      )
+    [
+      start_time.strftime("%m/%d/%Y"),
+      summary.commit_count,
+      summary.pivotal_stories.count,
+      duration_in_minutes,
+      duration_in_hours,
+      summary.author.name,
+      summary.author.email,
+      project_name,
+      summary.message,
+      summary.pivotal_stories.map(&:inspect).join('; '),
+      start_time.strftime("%W").to_i,
+      start_time.strftime("%Y").to_i
+    ]
+  end # summarize_helper
+
+  def roll_up_to_days(commit, index)
+    # Get the appropriate worklog
+    author_date = commit.author_date.to_date
+
+    #puts "DEBUG: Reading #{commit} #{author_date} from #{commit.author.email}"
+    daylog = get_or_create_new_daylog(author_date)
+    @worklog[author_date] = process_day_log(commit, index, daylog)
+  end # roll_up_to_days
+
+  def get_or_create_new_daylog(author_date)
+    if @worklog[author_date]
+      return @worklog[author_date]
+    else
+      return OpenStruct.new(
+                      :date => author_date,
+                      :duration => 0,
+                      :commit_count => 0,
+                      :pivotal_stories => Set.new
+                    )
+    end # if
+  end # daylog
+
+  def pivotal_ids(text)
+    ::PivotalIdsExtractor.new(text).stories
+  end
+
+  def process_day_log(commit, index, daylog)
+    #puts "DEBUG: Processing #{commit} - #{commit.author}"
+    daylog.author = commit.author
+    daylog.message = "#{daylog.message} --- #{commit.message}"
+    daylog.duration = daylog.duration + calc_duration_in_minutes(@commits, index)
+
+    # The git commit count
+    daylog.commit_count += 1
+
+    # Pivotal Stories
+    stories = pivotal_ids(commit.message)
+    if stories
+      # It's a set, so each story only gets added once per day
+      stories.each do |sid|
+        daylog.pivotal_stories << sid
+      end # each
+    end # if stories
+
+    return daylog
+  end # process_day_log
+
+  # Calculate the duration of work in minutes
+  def calc_duration_in_minutes(log_entries, index)
+    if index > 1
+      # Compute the time between this and this previous entry
+      return compute_commit_time_duration(log_entries[index], log_entries[index - 1])
+    else
+      # This is the first commit in the log
+      return @options[:initial_effort_mins].to_f
+    end
+    return duration
+  end # calc_duration_in_minutes
+
+  def compute_commit_time_duration(commit, previous_commit)
+    # Default duration in Ruby is in seconds, so lets make it minutes
+    duration = (commit.author_date - previous_commit.author_date) / 60.0
+
+    #initial_effort_mins: 30, session_duration_hrs: 3, max_commits: 1000
+    if duration > @options[:session_duration_hrs].to_f * 60.0
+      # first commit in this session
+      duration = @options[:initial_effort_mins].to_f
+    elsif duration < 0
+      # probably a merge.
+      duration = @options[:merge_effort_mins].to_f
+    end
+
+    return duration.to_f
+  end # compute_commit_time_duration
+
+  def project_name
+    @options[:project]
+  end
+
+end # class

data/lib/autoload.rb

@@ -0,0 +1,9 @@
+require 'ostruct'
+require 'logger'
+require 'git'
+require 'csv'
+
+autoload :Author, 'author'
+autoload :GitTimeExtractor, 'git_time_extractor'
+autoload :PivotalIdsExtractor, 'pivotal_ids_extractor'
+autoload :TimeEntry, 'time_entry'

data/lib/git_time_extractor.rb

@@ -1,151 +1,126 @@
 #
 # Extract Reasonable Developer Time Records from a GIT Repository's Commit Log
 #
-# This is inspired by a RAKE task publicly posted by Sharad at 
-# http://www.tatvartha.com/2010/01/generating-time-entry-from-git-log/. 
+# This is inspired by a RAKE task publicly posted 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.
 #
-# Portions (C) 2012 Rietta Inc. and licensed under the terms of the BSD license.
+# Portions (C) 2014 Rietta Inc. and licensed under the terms of the BSD license.
 #
 class GitTimeExtractor
-  VERSION = '0.2.2'
-  
-  require 'rubygems'
-  require 'ostruct'
-  require 'logger'
-  require 'git'
-  require 'csv'
+  VERSION = '0.2.3'
+
+  require 'autoload'
   require 'set'
 
-  #
-  # Go through the GIT commit log, to compute the elapsed working time of each committing developer, based
-  # on a few assumptions:
-  #
-  # (1) A series of commits within a 3 hour window are part of the same development session
-  # (2) A single commit (or the first commit of the session) is considered to represent 30 minutes of work time
-  # (3) The more frequent a developer commits to the repository while working, the more accurate the time report will be
-  #
-  #
-  def self.process_git_log_into_time(path_to_git_repo = "./", path_to_output_file = "-", project_name = "")
+  attr_accessor :options, :summary, :authors
+
+  def initialize( opts = {
+                          project: "Untitled",
+                          path_to_repo: "./",
+                          output_file: "-",
+                          initial_effort_mins: 30,
+                          merge_effort_mins: 30,
+                          session_duration_hrs: 3,
+                          max_commits: 1000
+                        } )
+    @options = opts
+    @authors_hash = Hash.new
+    @authors      = Array.new
+  end
+
+  def path_to_git_repo
+    options[:path_to_repo]
+  end
 
-    if "-" != path_to_output_file
-      raise "Output path not yet implemented. Use a Unix pipe to write to your desired file. For example: git_time_extractor ./ > my_result.csv\n" 
-    end 
-    
+  def path_to_output_file
+    options[:output_file]
+  end
+
+  def project_name
+    options[:project]
+  end
+
+  def load_git_log_entries(path_to_git_repo)
     # Open the GIT Repository for Reading
     logger = Logger.new(STDOUT)
     logger.level = Logger::WARN
     g = Git.open(path_to_git_repo, :log => logger)
-    logs = g.log(1000)
-    log_entries = logs.entries.reverse
-    worklog = {}
+    logs = g.log(@options[:max_commits])
+    return logs.entries.reverse
+  end
 
+  # Scan through the commit log entries and split into each author's accounting
+  def distribute_entries_to_authors(log_entries)
     # Go through the GIT commit records and construct the time
     log_entries.each_with_index do |commit, index|
-      author_date = commit.author_date.to_date
-      daylog = worklog[author_date] || OpenStruct.new(:date => author_date, :duration => 0, :commit_count => 0, :pivotal_stories => Set.new )
-      daylog.author = commit.author
-      daylog.message = "#{daylog.message} --- #{commit.message}"
-      daylog.duration = daylog.duration + calc_duration_in_minutes(log_entries, index)
-      
-      # The git commit count
-      daylog.commit_count += 1
-      
-      # Pivotal Stories
-      stories = pivotal_ids(commit.message)
-      if stories
-        # It's a set, so each story only gets added once per day
-        stories.each do |sid|
-          daylog.pivotal_stories << sid
+      key = commit.author.email
+       if @authors_hash[key].nil?
+         @authors_hash[key] = Author.new(@options)
+       end
+       @authors_hash[key].add_commit(commit)
+    end # log_entries.each_with_index
+
+    if @authors_hash
+      @authors_hash.each do |key, value|
+        if value
+          value.tabulate_days
+          @authors << value
+          #puts "DEBUG: Looking at #{key}, #{value}, with #{value.rows.count} commits"
         end
       end
-      
-      
-      worklog[author_date] = daylog
-    end # log_entries.each_with_index
+    end
 
-    # Print the header row for the CSV
-    puts [
-        'Date',
-        'Git Commits Count',
-        'Pivotal Stories Count',
-        'Minutes',
-        'Hours',
-        'Person',
-        'Email',
-        'Project',
-        'Notes',
-        'Pivotal Stories',
-        'Week Number',
-        'Year'
-        ].to_csv
-
-    # Go through the work log  
-    worklog.keys.sort.each do |date|
-        summary = worklog[date]
-        start_time = DateTime.parse(date.to_s)
-        duration_in_seconds = (summary.duration.to_f * 60.0).round(0)
-        duration_in_minutes = summary.duration.to_i
-        duration_in_hours = (summary.duration / 60.0).round(1)
-
-        stop_time = start_time + duration_in_seconds
-        
-        row = [
-              start_time.strftime("%m/%d/%Y"),
-              summary.commit_count,
-              summary.pivotal_stories.count,
-              duration_in_minutes,
-              duration_in_hours,
-              summary.author.name,
-              summary.author.email,
-              project_name,
-              summary.message,
-              summary.pivotal_stories.map(&:inspect).join('; '),
-              start_time.strftime("%W").to_i,
-              start_time.strftime("%Y").to_i]
-        puts row.to_csv
-    end # worklog each
+    #puts "DEBUG: #{@authors.count} authors"
 
-  end # process_git_log_into_time
-  
-  # Calculate the duration of work in minutes
-  def self.calc_duration_in_minutes(log_entries, index)
-    commit = log_entries[index]
-    if index > 1
-      previous_commit = log_entries[index-1]
-      # Default duration in Ruby is in seconds
-      duration = commit.author_date - previous_commit.author_date
-      
-      # ASSUMPTION: if the gap between 2 commits is more than 3 hours, reduce it to 1/2 hour
-      # Also, if the time is negative then this is usually a merge operation.  Assume the developer spent
-      # 30 minutes reviewing it
-      duration = 30 * 60 if duration < 0 || duration > 3 * 3600
-    else
-      # ASSUMPTION: first commit took 1/2 hour
-      duration = 30 * 60
-    end
-    return duration.to_f / 60.0
-  end # calc_duration_in_minutes
+    return @authors
+  end # distribute_entries_to_authors
 
-  def self.say_hi
-    "hi"
-  end
-  
-  #  --- [#62749778] New Email Page --- Merge branch 'development' of bitbucket.org:rietta/roofregistry-web into development --- [#62749778] Roughed out email form. --- Added delete Attachment functionality --- Merge branch 'development' of bitbucket.org:rietta/roofregistry-web into development --- [#62749778] Refactored controller to be plural. --- [#62749778] Added to the Email model. --- [62749778] The email this report view formatting. --- [#62749778] Breadcrumbs in the navigation. --- [#62749778] The Emails controller routes. --- The report list is now sorted with newest first - and it shows how long ago that the change was made. --- [#62749778] The share link is bold. --- [#62749778] Recipient parsing and form fields --- [#62749778] List of emails that have received it. --- [#62749778] The email form will validate that at least one email is provided. --- [#62749778] Send Roof Report AJAX form. --- [#62749778] Default messages and the mailer --- [Finishes #62749778] The emails are sent! --- removed delete from show --- added txt and xpf to permitted file types --- Attachments can only be deleted by the owner of the roof report. --- Merge branch 'development' of bitbucket.org:rietta/roofregistry-web into development --- The test server is using production. --- Returns all recommended options across all sections with roof_report.recommedations --- patial commit --- Finished summary section --- Added caps to permitted --- added to_s to inspection --- E-mail spec is not focused at the moment. --- Merge branch 'development' of bitbucket.org:rietta/roofregistry-web into development --- fixed a few bugs --- Merge branch 'development' of bitbucket.org:rietta/roofregistry-web into development --- Disable ajax save. --- Merge branch 'development' of bitbucket.org:rietta/roofregistry-web into development
-  # s = "[#62749778] [#62749778] [#6274977] [#1] [#231]"
-  # m = s.scan /\[[A-Za-z ]{0,20}#[0-9]{1,20}\]/
-  def self.pivotal_ids(text)
-    stories = Array.new
-    # Extract the unique ids between brackets
-    if text
-      candidates = text.scan /\[[A-Za-z \t]{0,20}#[0-9]{1,35}[ \t]{0,5}\]/
-      if candidates
-        candidates.uniq.each do |story|
-          story_num = story.match(/[0-9]{1,35}/).to_s.to_i
-          stories << story_num if story_num > 0
-        end
+  def prepare_rows_for_csv
+    rows = Array.new
+    rows << header_row_template()
+    @authors.each do |author|
+      author.rows.each do |author_row|
+        rows << author_row
       end
     end
-    stories.sort
+    return rows
   end
+
+  #
+  # Go through the GIT commit log, to compute the elapsed working time of each committing developer, based
+  # on a few assumptions:
+  #
+  # (1) A series of commits within a 3 hour window are part of the same development session
+  # (2) A single commit (or the first commit of the session) is considered to represent 30 minutes of work time
+  # (3) The more frequent a developer commits to the repository while working, the more accurate the time report will be
+  #
+  #
+  def process_git_log_into_time
+    distribute_entries_to_authors( load_git_log_entries( path_to_git_repo ) )
+    return prepare_rows_for_csv
+  end # process_git_log_into_time
+
+
+
+  #####################################
+  private
+
+  def header_row_template
+    [
+      'Date',
+      'Git Commits Count',
+      'Pivotal Stories Count',
+      'Minutes',
+      'Hours',
+      'Person',
+      'Email',
+      'Project',
+      'Notes',
+      'Pivotal Stories',
+      'Week Number',
+      'Year'
+    ]
+  end # header_row_template
+
 end # class GitTimeExtractor

data/lib/pivotal_ids_extractor.rb

@@ -0,0 +1,28 @@
+class PivotalIdsExtractor
+
+  attr_accessor :source_text, :stories
+
+  #  --- [#62749778] New Email Page --- Merge branch 'development' of bitbucket.org:rietta/roofregistry-web into development --- [#62749778] Roughed out email form. --- Added delete Attachment functionality --- Merge branch 'development' of bitbucket.org:rietta/roofregistry-web into development --- [#62749778] Refactored controller to be plural. --- [#62749778] Added to the Email model. --- [62749778] The email this report view formatting. --- [#62749778] Breadcrumbs in the navigation. --- [#62749778] The Emails controller routes. --- The report list is now sorted with newest first - and it shows how long ago that the change was made. --- [#62749778] The share link is bold. --- [#62749778] Recipient parsing and form fields --- [#62749778] List of emails that have received it. --- [#62749778] The email form will validate that at least one email is provided. --- [#62749778] Send Roof Report AJAX form. --- [#62749778] Default messages and the mailer --- [Finishes #62749778] The emails are sent! --- removed delete from show --- added txt and xpf to permitted file types --- Attachments can only be deleted by the owner of the roof report. --- Merge branch 'development' of bitbucket.org:rietta/roofregistry-web into development --- The test server is using production. --- Returns all recommended options across all sections with roof_report.recommedations --- patial commit --- Finished summary section --- Added caps to permitted --- added to_s to inspection --- E-mail spec is not focused at the moment. --- Merge branch 'development' of bitbucket.org:rietta/roofregistry-web into development --- fixed a few bugs --- Merge branch 'development' of bitbucket.org:rietta/roofregistry-web into development --- Disable ajax save. --- Merge branch 'development' of bitbucket.org:rietta/roofregistry-web into development
+  # s = "[#62749778] [#62749778] [#6274977] [#1] [#231]"
+  # m = s.scan /\[[A-Za-z ]{0,20}#[0-9]{1,20}\]/
+
+  def initialize(text)
+    stories = Array.new
+    # Extract the unique ids between brackets
+    if text
+      # Require brackets
+      #candidates = text.scan /\[[A-Za-z \t]{0,20}#[0-9]{1,35}[ \t]{0,5}\]/
+      candidates = text.scan /[A-Za-z \t]{0,20}#[0-9]{1,35}[ \t]{0,5}/
+      if candidates
+        candidates.uniq.each do |story|
+          story_num = story.match(/[0-9]{1,35}/).to_s.to_i
+          stories << story_num if story_num > 0
+        end
+      end
+    end
+    @source_text  = text
+    @stories      = stories.sort
+  end
+
+
+end

data/readme.md

@@ -0,0 +1,50 @@
+[![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
+
+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:
+
+ - A series of commits within a 3 hour window are part of the same development session
+ - A single commit (or the first commit of the session) is considered to represent 30 minutes of work time
+ - The more frequent a developer commits to the repository while working, the more accurate the time report will be
+
+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).
+
+## 1. Running
+
+### Usage
+
+Command line configurable options are supported!
+
+```
+Usage: git_time_extractor [options]
+    -p, --project PROJECT
+    -i, --repo-path REPOPATH
+    -o, --out OUTPUT_CSV
+    -c, --max-commits MAX_COMMITS    Maximum number of commits to read from Git. Default: 10000
+    -e INITIAL_EFFORT,               Initial Effort before each commit, in minutes. Default: 30
+        --initial-effort
+    -m, --merge-effort MERGE_EFFORT  Effort spent merging, in minutes. Default: 30
+    -s SESSION_DURATION,             Session duration, in hours. Default: 3
+        --session-duration
+```
+### Most basic usage
+
+- `cd /path/to/your/repository`
+- `git_time_extractor > time_log.csv`
+
+## 2. Analysis
+
+Once the you have used Git Time Extractor to prepare a CSV file, you can perform a lot of different analysis operations using a spreadsheet.  See the [examples spreadsheets](examples/) for some ideas.
+
+## 3. License Terms (BSD License)
+
+© 2014 Rietta Inc. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: git_time_extractor
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Frank Rietta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-22 00:00:00.000000000 Z
+date: 2014-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
@@ -16,41 +16,44 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.6
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.6
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: logger
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.8
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.8
+        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.
   See https://github.com/rietta/git_time_extractor/wiki.
-email: products@rietta.com
+email: hello@rietta.com
 executables:
 - git_time_extractor
 extensions: []
 extra_rdoc_files: []
 files:
 - History.txt
-- README.txt
 - bin/git_time_extractor
+- lib/author.rb
+- lib/autoload.rb
 - lib/git_time_extractor.rb
+- lib/pivotal_ids_extractor.rb
+- readme.md
 homepage: https://github.com/rietta/git_time_extractor
 licenses:
 - BSD
@@ -71,7 +74,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Reasonable developer time log extractor that uses a GIT repository's commit

data/README.txt

@@ -1,77 +0,0 @@
-= git_time_extractor
-
-RubyGem Page: https://rubygems.org/gems/git_time_extractor
-Project Wiki: https://github.com/rietta/git_time_extractor/wiki
-
-== DESCRIPTION:
-
-EXTRACT REASONABLE TIME RECORDS FROM A GIT REPOSITORY
-
-git_time_extractor is a free tool that goes through a GIT, the popular revision control system, repository's commit log and produces a Comma Separated Values (CSV) file that indicates the time spent by each developer, per day. 
-
-The working time estimates are based on three assumptions:
-
-    1. A series of commits within a three (3) hour window are part of the same development session
-    2. A single commit (or the first commit of the session) is considered to represent 30 minutes of work time
-    3. The more frequently a developer commits to the repository while working, the more accurate the time report will be
-
-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).
-
-git_time_extractor is useful for software development companies that want to discover the approximate time spent by developers on particular projects based on real data in the GIT revision control system. This is useful for managers, accountants, and for those who need to back up records for tax purposes.
-
-For example, in the United States there is a Research & Development (R&D) tax credit available for companies who build or improve software for certain purposes.  To claim this credit requires certain types of records.  Check with your accountant to see if the results from this program is appropriate in your particular situation.  You can learn more information about this particular credit at http://www.irs.gov/businesses/article/0,,id=156366,00.html.
-
-== BENEFITS:
-
-	* Compute time records based on the timestamps of each code commit by each developer
-	* Compare these results with other time-sheets or metrics to measure the effectiveness of your team members
-	* Save money on taxes by producing documents required by your accountant to properly apply for certain tax credits
-	* It's a Free Open Source Tool
-	
-== FEATURES:
-
-	* Easy command-line operation
-	* Reads from a local GIT branch in the current directory
-	* Writes to a CSV-file that is compatible with Microsoft Excel, OpenOffice Calc, or Google Docs
-	
-== SYNOPSIS:
-
-  	cd /path/to/your/repository
-  	git_time_extractor > time_log.csv
-
-== REQUIREMENTS:
-
-	The following GEMS are required as dependencies:
-		* git
-		* logger
-
-== INSTALL:
-
-	gem install git_time_extractor
-
-== UNINSTALL:
-	
-	gem install git_time_extractor
-
-== DEVELOPERS:
-
-After checking out the source, run:
-
-  $ rake newb
-
-This task will install any missing dependencies, run the tests/specs,
-and generate the RDoc.
-
-== LICENSE:
-
-(The BSD License)
-
-Copyright (c) 2012 Rietta Inc. All rights reserved.
-
-Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
-
-Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
-Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.  
-