git_time_extractor 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5cd63888dc7235ee55baee19108e6b576dbdf474
-  data.tar.gz: a0ac045a5dd7ad3d81e763c4a76d74880dcaaf42
+  metadata.gz: 1e7bf5aea252dc4ba852c777e24e6c1887d0c75e
+  data.tar.gz: 64b45f000e6bc36468b07be0c9713a70a2850fd7
 SHA512:
-  metadata.gz: 0363407a1a542759865af72d0958e2af5c4fa1dc235e78bdd56ac6fb2a4809f47275d25618b45bd8769a4cbb54c27751fcaefbb49fc5c0d942f76d5caa90756a
-  data.tar.gz: 503fe4be1588f616c93911c073a59e1bc8a563e12790cc5532c266f39108967e30a2ebbbb7c4c2415a8ad685b29b85068f91fa0ba707e19b40e828664e1d2ac7
+  metadata.gz: a60472dcdde1f9a9db681af4a37ad1eb8bc0b8a8c9d84815b00997536dbca6194445ac3009aef9c4223ba0033787dcb87824c0d100cac581c787aefc191f0d10
+  data.tar.gz: 5ed84870e1a41aa44db2b72324e2829977f55cbea77ffa7d6d8b2a62e7b69050a7f127f79ac1a56be0c13bfc8a83e3dbb54945a4c0b4e3599d4229ba063bb206

data/bin/git_time_extractor

@@ -20,7 +20,8 @@
               :max_commits => 10000,
               :initial_effort_mins => 30,
               :merge_effort_mins => 30,
-              :session_duration_hrs => 3
+              :session_duration_hrs => 3,
+              :filter_by_year => nil,
   }
 
   valid_usage = false
@@ -43,6 +44,16 @@
       options[:max_commits] = max_commits
     end
 
+    opts.on('-y YEAR', '--year YEAR',
+      "Filter for commits in a given four digit year, such as #{Date.today.year} or #{Date.today.year - 1}. Default: Records for all years."
+     ) do |filter_by_year|
+      if filter_by_year.to_i > 0
+        options[:filter_by_year] = filter_by_year.to_i
+      else
+        STDERR.puts "Ignoring non-numeric or negative year, #{filter_by_year}"
+      end
+    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

data/lib/author.rb

@@ -22,7 +22,9 @@ class Author
 
     # Go through the work log
     @worklog.keys.sort.each do |date|
+      if date_in_filter_range(date)
         @rows << summarize(@worklog[date], date)
+      end
     end # worklog each
   end # tabulate_days
 
@@ -143,4 +145,12 @@ class Author
     @options[:project]
   end
 
+  def date_in_filter_range(date_to_check)
+    if @options[:filter_by_year] and date_to_check
+      date_to_check.strftime("%Y").to_i == @options[:filter_by_year]
+    else
+      true
+    end
+  end
+
 end # class

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.2.3'
+  VERSION = '0.3.1'
 
   require 'autoload'
   require 'set'

data/readme.md

@@ -22,6 +22,7 @@ Usage: git_time_extractor [options]
     -i, --repo-path REPOPATH
     -o, --out OUTPUT_CSV
     -c, --max-commits MAX_COMMITS    Maximum number of commits to read from Git. Default: 10000
+    -y, --year YEAR                  Filter for commits in a given four digit year, such as 2015 or 2014. Default: Records for all years.
     -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
@@ -33,6 +34,12 @@ Usage: git_time_extractor [options]
 - `cd /path/to/your/repository`
 - `git_time_extractor > time_log.csv`
 
+### Filtering for a specific year
+One basic usage of `git_time_extractor` is to tabulated time spent on a project in a particular year. Using a year filter is a way to restrict the output to just records for days in a given calendar year.
+
+`git_time_extractor -y 2014 -i ~/Projects/GreatOpenSourceWork`
+
+Will scan the git repo in `~/Projects/GreatOpenSourceWork`, reporting only on the days between January 1, 2014, and December 31, 2015.
 ## 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.
@@ -48,3 +55,7 @@ Redistribution and use in source and binary forms, with or without modification,
 
 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.
 
+## 4. Further reading / other projects
+
+- [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`.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: git_time_extractor
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Frank Rietta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-13 00:00:00.000000000 Z
+date: 2015-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
@@ -39,8 +39,8 @@ 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.
-  See https://github.com/rietta/git_time_extractor/wiki.
+  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.
 email: hello@rietta.com
 executables:
 - git_time_extractor
@@ -74,7 +74,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Reasonable developer time log extractor that uses a GIT repository's commit