worth 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c4437152314700fb411684c31e5ddb0070b754f3
-  data.tar.gz: c4e6a8011d00ffcb34a91458eab55b69a2e6c946
+  metadata.gz: e4ede46dcffddc558ddbfa48ddc7d38b1f0420c7
+  data.tar.gz: 09d627034dec8c174d640ee24c34c416f4126d3d
 SHA512:
-  metadata.gz: da39bba57bd0128ae941450152dbce69b47ac837dc666bd722a8acd7d510b60b0c7e9fb2beba1abc8ba3f79009a3254df85d5ee08baf89039edf15f7d2d8d00d
-  data.tar.gz: a2bdde264421b306982ba8afcb424800658a2a58314abcf3e0c796d38f1930a5282fea1d76a5c5ba381d91f17d666e4330c4399fd42bb4ff44879c44734a2f27
+  metadata.gz: 679730082d239758d712df779cce0a48b6e20e3a85dfa2ea998680cb91243331737db6bd72396fb0d246ebb4785b4a97225863af2bdfdb7be0ef3f6920d33491
+  data.tar.gz: ffd1dc72a3b9819920966c29f68a7584e1cb3e58b75a72a98256e07abbacd4c54bc239111c253e7ff0e399804f86107e74485d69d03fc68ab5a7877a1e1e6476

data/README.md

@@ -1,6 +1,47 @@
 # Worth
 
-TODO: Write a gem description
+Suppose your client asks you to track how many man hours were spent by each
+contributor between a given date range. Aside from
+keeping track of this info manually, every day, for every little thing that you do,
+how might one accomplish this feat of mental agility?
+
+How about a command line tool for analyzing your git logs?
+
+Running
+
+    gem install worth
+    cap-hours 2014-10 2014-11
+
+will print a csv report for each author out into the console.
+
+There will be a row for each commit for each author within the range, along with
+that commit's message, and calculated weight
+
+author |message                         |weight
+-------|--------------------------------|------
+rwassey|Added some less complex feature |0.4
+rwassey|Added some super complex feature|3.8
+
+#### How is the weight of each commit calculated?
+
+Here are the values which are considered as part of the calculation
+
+value             | description
+------------------|----------------------------------
+all_changes       | sum of all changes by all authors
+changes for commit| changes within one commit as a percentage of `all_changes`
+hours in range    | we assume that each contributor is spending a total of 20 days working in a month, with 8 hours development each day
+
+weight is then a function of
+
+    hours_in_range * changes_for_commit
+
+<b>NB</b> This tool should ony be used as a guide for effort estimations. Don't
+go asking your client for renumeration based on these reports!
+
+#### TODO
+
+- See the issues page for a list of known issues
 
 ## Installation
 
@@ -18,7 +59,7 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+    cap-hours <start-year-month> <end-month-year>
 
 ## Contributing
 

data/lib/worth/git.rb

@@ -1,7 +1,5 @@
 class Git
 
-  require "pry"
-
   Commands = YAML.load(%Q{
 
     authors: git log --since="#{ARGV[0]}-01" --before="#{ARGV[1]}-01" --pretty=format:"%an"

data/lib/worth/version.rb

@@ -1,3 +1,3 @@
 module Worth
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/worth.gemspec

@@ -8,9 +8,9 @@ Gem::Specification.new do |spec|
   spec.version       = Worth::VERSION
   spec.authors       = ["Richard Massey"]
   spec.email         = ["rwassey@gmail.com"]
-  spec.description   = %q{Cap Hours, automated}
-  spec.summary       = %q{Infer cap hours from git stats}
-  spec.homepage      = ""
+  spec.description   = %q{Automate the estimation time spent on features}
+  spec.summary       = %q{Trying to remember how much time you spent working on a feature is hard. Let this library do it for you}
+  spec.homepage      = "http://github.com/rwassey/worth"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: worth
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Richard Massey
@@ -38,7 +38,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Cap Hours, automated
+description: Automate the estimation time spent on features
 email:
 - rwassey@gmail.com
 executables:
@@ -65,7 +65,7 @@ files:
 - spec/spec_helper.rb
 - spec/worth_spec.rb
 - worth.gemspec
-homepage: ''
+homepage: http://github.com/rwassey/worth
 licenses:
 - MIT
 metadata: {}
@@ -88,7 +88,8 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Infer cap hours from git stats
+summary: Trying to remember how much time you spent working on a feature is hard.
+  Let this library do it for you
 test_files:
 - spec/commit_spec.rb
 - spec/spec_helper.rb