worth 0.0.1 → 0.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: c4437152314700fb411684c31e5ddb0070b754f3
4
- data.tar.gz: c4e6a8011d00ffcb34a91458eab55b69a2e6c946
3
+ metadata.gz: e4ede46dcffddc558ddbfa48ddc7d38b1f0420c7
4
+ data.tar.gz: 09d627034dec8c174d640ee24c34c416f4126d3d
5
5
  SHA512:
6
- metadata.gz: da39bba57bd0128ae941450152dbce69b47ac837dc666bd722a8acd7d510b60b0c7e9fb2beba1abc8ba3f79009a3254df85d5ee08baf89039edf15f7d2d8d00d
7
- data.tar.gz: a2bdde264421b306982ba8afcb424800658a2a58314abcf3e0c796d38f1930a5282fea1d76a5c5ba381d91f17d666e4330c4399fd42bb4ff44879c44734a2f27
6
+ metadata.gz: 679730082d239758d712df779cce0a48b6e20e3a85dfa2ea998680cb91243331737db6bd72396fb0d246ebb4785b4a97225863af2bdfdb7be0ef3f6920d33491
7
+ data.tar.gz: ffd1dc72a3b9819920966c29f68a7584e1cb3e58b75a72a98256e07abbacd4c54bc239111c253e7ff0e399804f86107e74485d69d03fc68ab5a7877a1e1e6476
data/README.md CHANGED
@@ -1,6 +1,47 @@
1
1
  # Worth
2
2
 
3
- TODO: Write a gem description
3
+ Suppose your client asks you to track how many man hours were spent by each
4
+ contributor between a given date range. Aside from
5
+ keeping track of this info manually, every day, for every little thing that you do,
6
+ how might one accomplish this feat of mental agility?
7
+
8
+ How about a command line tool for analyzing your git logs?
9
+
10
+ Running
11
+
12
+ gem install worth
13
+ cap-hours 2014-10 2014-11
14
+
15
+ will print a csv report for each author out into the console.
16
+
17
+ There will be a row for each commit for each author within the range, along with
18
+ that commit's message, and calculated weight
19
+
20
+ author |message |weight
21
+ -------|--------------------------------|------
22
+ rwassey|Added some less complex feature |0.4
23
+ rwassey|Added some super complex feature|3.8
24
+
25
+ #### How is the weight of each commit calculated?
26
+
27
+ Here are the values which are considered as part of the calculation
28
+
29
+ value | description
30
+ ------------------|----------------------------------
31
+ all_changes | sum of all changes by all authors
32
+ changes for commit| changes within one commit as a percentage of `all_changes`
33
+ 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
34
+
35
+ weight is then a function of
36
+
37
+ hours_in_range * changes_for_commit
38
+
39
+ <b>NB</b> This tool should ony be used as a guide for effort estimations. Don't
40
+ go asking your client for renumeration based on these reports!
41
+
42
+ #### TODO
43
+
44
+ - See the issues page for a list of known issues
4
45
 
5
46
  ## Installation
6
47
 
@@ -18,7 +59,7 @@ Or install it yourself as:
18
59
 
19
60
  ## Usage
20
61
 
21
- TODO: Write usage instructions here
62
+ cap-hours <start-year-month> <end-month-year>
22
63
 
23
64
  ## Contributing
24
65
 
@@ -1,7 +1,5 @@
1
1
  class Git
2
2
 
3
- require "pry"
4
-
5
3
  Commands = YAML.load(%Q{
6
4
 
7
5
  authors: git log --since="#{ARGV[0]}-01" --before="#{ARGV[1]}-01" --pretty=format:"%an"
@@ -1,3 +1,3 @@
1
1
  module Worth
2
- VERSION = "0.0.1"
2
+ VERSION = "0.0.2"
3
3
  end
@@ -8,9 +8,9 @@ Gem::Specification.new do |spec|
8
8
  spec.version = Worth::VERSION
9
9
  spec.authors = ["Richard Massey"]
10
10
  spec.email = ["rwassey@gmail.com"]
11
- spec.description = %q{Cap Hours, automated}
12
- spec.summary = %q{Infer cap hours from git stats}
13
- spec.homepage = ""
11
+ spec.description = %q{Automate the estimation time spent on features}
12
+ spec.summary = %q{Trying to remember how much time you spent working on a feature is hard. Let this library do it for you}
13
+ spec.homepage = "http://github.com/rwassey/worth"
14
14
  spec.license = "MIT"
15
15
 
16
16
  spec.files = `git ls-files`.split($/)
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: worth
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.1
4
+ version: 0.0.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Richard Massey
@@ -38,7 +38,7 @@ dependencies:
38
38
  - - ">="
39
39
  - !ruby/object:Gem::Version
40
40
  version: '0'
41
- description: Cap Hours, automated
41
+ description: Automate the estimation time spent on features
42
42
  email:
43
43
  - rwassey@gmail.com
44
44
  executables:
@@ -65,7 +65,7 @@ files:
65
65
  - spec/spec_helper.rb
66
66
  - spec/worth_spec.rb
67
67
  - worth.gemspec
68
- homepage: ''
68
+ homepage: http://github.com/rwassey/worth
69
69
  licenses:
70
70
  - MIT
71
71
  metadata: {}
@@ -88,7 +88,8 @@ rubyforge_project:
88
88
  rubygems_version: 2.2.2
89
89
  signing_key:
90
90
  specification_version: 4
91
- summary: Infer cap hours from git stats
91
+ summary: Trying to remember how much time you spent working on a feature is hard.
92
+ Let this library do it for you
92
93
  test_files:
93
94
  - spec/commit_spec.rb
94
95
  - spec/spec_helper.rb