pair_see 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 395e98d640b7d14ff1c16a02ed3c21ff21823317
-  data.tar.gz: 33ca0a5a3b708ab237cf3c7bf90f16a86457e89d
+  metadata.gz: e643f465727a23bdecbf0b3bc4f562db6093bff1
+  data.tar.gz: 8d629337fa045ed9283d01345ded022168d65fde
 SHA512:
-  metadata.gz: 5d047500df1fac79f523fca933d433879dfa174d2de09fbf137ddcc5ce8073310a51e874f42c88026a29ac5f81d3898327d63071e72ceb8166e86cf764ed1759
-  data.tar.gz: 1b818b5f0a1aff57f1c9de4f2cfb7be3eada651693c400b5fc66319ebb7ab37358ddb5e8f3fd974674c823e930cc0f1c5d7c2329a721c325a3ca090cb4cac9b4
+  metadata.gz: 0f595c02ef0cd4fd4b0ba8b22fa1d5f6f785e291738df4e372fb8c6036e9735a4d95f680b7d04169d1a29ad9acc845c1a4a1e52c587c471c92fc54dc35bc60f3
+  data.tar.gz: 8f220e25fd5aaba1e88a8cd2e5b01dc5d12d720a4cf91cc05663a52a78bcca0a7b2788283b7c5b8752c11aa96217ebc5a750f97605aa1f16130f80a287c31873

data/.rubocop.yml

@@ -0,0 +1 @@
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,98 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2017-10-25 01:55:47 -0200 using RuboCop version 0.49.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 2
+Lint/AmbiguousOperator:
+  Exclude:
+    - 'lib/pair_see/log_lines.rb'
+    - 'lib/pair_see/too_much_stuff.rb'
+
+# Offense count: 1
+Lint/ScriptPermission:
+  Exclude:
+    - 'bin/console'
+
+# Offense count: 1
+Lint/Void:
+  Exclude:
+    - 'lib/pair_see/card.rb'
+
+# Offense count: 1
+Metrics/AbcSize:
+  Max: 34
+
+# Offense count: 10
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/BlockLength:
+  Max: 127
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 127
+
+# Offense count: 1
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+# Offense count: 63
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 172
+
+# Offense count: 3
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 34
+
+# Offense count: 1
+Metrics/PerceivedComplexity:
+  Max: 12
+
+# Offense count: 1
+Style/ClassVars:
+  Exclude:
+    - 'lib/pair_see/log_line_parse.rb'
+
+# Offense count: 16
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 35
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: when_needed, always, never
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+# Offense count: 2
+Style/MultilineBlockChain:
+  Exclude:
+    - 'lib/pair_see/too_much_stuff.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: AutoCorrect, EnforcedStyle, SupportedStyles.
+# SupportedStyles: predicate, comparison
+Style/NumericPredicate:
+  Exclude:
+    - 'spec/**/*'
+    - 'lib/pair_see/pair_commit_count.rb'
+    - 'lib/pair_see/too_much_stuff.rb'
+
+# Offense count: 2
+# Configuration parameters: NamePrefix, NamePrefixBlacklist, NameWhitelist.
+# NamePrefix: is_, has_, have_
+# NamePrefixBlacklist: is_, has_, have_
+# NameWhitelist: is_a?
+Style/PredicateName:
+  Exclude:
+    - 'spec/**/*'
+    - 'lib/pair_see/card_knowledge_summary.rb'
+    - 'lib/pair_see/too_much_stuff.rb'

data/.travis.yml

@@ -1,6 +1,10 @@
 language: ruby
 rvm:
   - '2.4.1'
+  - '2.3.0'
+  - '2.2.0'
+  - '2.1.0'
+  - '1.9.3'
 addons:
   code_climate:
     repo_token: cdb26718880608c44fda7463511e0151140ade238d92cb1044892472da13ca48

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+0.1.16
+======
+
+* refactoring & tests
+* knowledge debt
+* add sorting option --cards-by-commits    This goes with --cards and sorts by number of commits instead of active card days
+* add view --my-pairs            Most recent dates of pairing for user
+
 0.1.5
 =====
 * adding support for multiple git repositories specified by full path 

data/README.md

@@ -15,22 +15,40 @@ Usage cases:
 
 Example usage:
 ```
-$ pairsee --root ../../my_code --after 2012-07-10 --config ../../foo/config/config.yml
-$ pairsee --extras --root ../../my_code
-$ pairsee --latest --after 2012-09-01 # this outputs pairings by most recent by all devs who have committed since given date (purpose of this is to exclude people who are no longer committers)
+$ pairsee --after 2012-07-10 --config ../../foo/config/config.yml
+$ pairsee --extras
+$ pairsee --cards
 ```
 
 ```
 Options:
-          --root, -r <s>:   Folder in which .git folder is (default: .)
-        --config, -c <s>:   location of config file, example: ../../config/config.yml (default: bin/pairsee/../../config/config.yml)
-         --after, -a <s>:   Date since which you want to get commits, in yyyy-mm-dd format (default: 0-1-1)
-            --extras, -e:   See all commits without the name of any dev in them
-            --latest, -l:   See dates of most recent commits by pairs
-       --recommended, -o:   See active devs who have not paired (and therefore should)
-             --cards, -d:   See cards and number of commits on each
-  --cards-per-person, -s:   See cards for each dev
-              --help, -h:   Show this message
+  -c, --config=<s>          location of config file, example: ../../config/config.yml (default: config/config.yml)
+  -a, --after=<s>           Date since which you want to get commits, in yyyy-mm-dd format (default: 0-1-1)
+  -e, --extras              See all commits without the name of any dev in them
+  -l, --latest              See dates of most recent commits by pairs
+  -r, --recommended         See active devs who have not paired (and therefore should)
+  -d, --cards               See cards and number of commits on each
+  -s, --cards-by-commits    This goes with --cards and sorts by number of commits instead of active card days
+  -p, --cards-per-person    See cards for each dev
+  -k, --knowledge-debt      Knowledge debt (cards that only one person worked on)
+  -m, --my-pairs            Most recent dates of pairing for user
+  -h, --help                Show this message
+
+```
+
+Example config file (see also config/config.yml.sample)
+```
+names:
+  - Person1
+  - Person2
+  - ManyNamesPerson mnperson mprss
+card_prefix:
+  - FOO-
+  - BAR-
+roots:
+  - /Users/foo/repo1/
+  - /Users/foo/repositories/repo2
+  - /Users/foo/repositories/baz/repo3
 ```
 
 to put on path:
@@ -46,42 +64,16 @@ rspec
 rake_commit
 ```
 
-Config file: `config/config.yml`
-contains names and card prefix, a la
-```
-names: Person1 Person2 Person3
-card_prefix: FOO-
-```
-
-So if your commit log looks like
-```
-"Bob/Alice [FOO-1] wrote code"
-"Alice [FOO-1] stuff"
-"Sarah|Alice [FOO-2] code and stuff"
-```
-
-Then your config file will look like:
-```
-names: Bob Alice Sarah
-card_prefix: FOO-
-```
-
 To use PairSee with SVN, check out SVN codebase with git like: `git svn clone http://svn.example.com/project`
 
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'pair_see'
-```
-
-## Usage
-
-See example repo https://github.com/compwron/example_pair_see_use
 
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+```
+rubocop --auto-correct
+rubocop --auto-gen-config 
+```

data/Rakefile

@@ -3,4 +3,4 @@ require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => [:spec]
+task default: [:spec]

data/TODO.md

@@ -1,22 +1,5 @@
-- Fix bug in --extras where multi-name users are shown in extras
-- multiple codebases?
+- see devs on longest running cards
 - fix bug in "last commit" in -d, dates are not accurate
-- sort --latest by commit date
-- multiple card starters
-
-- Rakefile / rake_commit
 - Reduce number of git/filesystem interactions in spec
-- aggregate stats across multiple git repos
-- label for "BAD" to most-solo-commits view
-- Graph over time of cards worked on and duration
-- add COLOR to graph / outputs - use vlad's color library?
-- sort -s by # cards worked
-
-- standardize quotes
-
-Fix this bug:
-DMM-103 - - - commits: 7 - - - duration: 0 days - - - last commit: 2017-03-07 - - - commits per day: Infinity
-DMM-17 - - - commits: 71 - - - duration: -1 days - - - last commit: 2017-04-06 - - - commits per day: -71.0
-DMM-39 - - - commits: 6 - - - duration: -6 days - - - last commit: 2017-04-12 - - - commits per day: -1.0
-DMM-81 - - - commits: 3 - - - duration: -6 days - - - last commit: 2017-03-08 - - - commits per day: -0.5
-DMM-136 - - - commits: 33 - - - duration: -33 days - - - last commit: 2017-05-30 - - - commits per day: -1.0
+- increase test coverage
+- refactor away too_much_stuff.rb into objects

data/bin/bundler

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
+
 #
 # This file was generated by Bundler.
 #
@@ -7,11 +8,11 @@
 # this file is here to facilitate running it.
 #
 
-require "pathname"
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
-  Pathname.new(__FILE__).realpath)
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
 
-require "rubygems"
-require "bundler/setup"
+require 'rubygems'
+require 'bundler/setup'
 
-load Gem.bin_path("bundler", "bundler")
+load Gem.bin_path('bundler', 'bundler')

data/bin/cc-tddium-post-worker

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
+
 #
 # This file was generated by Bundler.
 #
@@ -7,11 +8,11 @@
 # this file is here to facilitate running it.
 #
 
-require "pathname"
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
-  Pathname.new(__FILE__).realpath)
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
 
-require "rubygems"
-require "bundler/setup"
+require 'rubygems'
+require 'bundler/setup'
 
-load Gem.bin_path("codeclimate-test-reporter", "cc-tddium-post-worker")
+load Gem.bin_path('codeclimate-test-reporter', 'cc-tddium-post-worker')

data/bin/coderay

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
+
 #
 # This file was generated by Bundler.
 #
@@ -7,11 +8,11 @@
 # this file is here to facilitate running it.
 #
 
-require "pathname"
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
-  Pathname.new(__FILE__).realpath)
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
 
-require "rubygems"
-require "bundler/setup"
+require 'rubygems'
+require 'bundler/setup'
 
-load Gem.bin_path("coderay", "coderay")
+load Gem.bin_path('coderay', 'coderay')

data/bin/htmldiff

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
+
 #
 # This file was generated by Bundler.
 #
@@ -7,11 +8,11 @@
 # this file is here to facilitate running it.
 #
 
-require "pathname"
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
-  Pathname.new(__FILE__).realpath)
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
 
-require "rubygems"
-require "bundler/setup"
+require 'rubygems'
+require 'bundler/setup'
 
-load Gem.bin_path("diff-lcs", "htmldiff")
+load Gem.bin_path('diff-lcs', 'htmldiff')

data/bin/ldiff

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
+
 #
 # This file was generated by Bundler.
 #
@@ -7,11 +8,11 @@
 # this file is here to facilitate running it.
 #
 
-require "pathname"
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
-  Pathname.new(__FILE__).realpath)
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
 
-require "rubygems"
-require "bundler/setup"
+require 'rubygems'
+require 'bundler/setup'
 
-load Gem.bin_path("diff-lcs", "ldiff")
+load Gem.bin_path('diff-lcs', 'ldiff')

data/bin/pairsee

@@ -2,31 +2,37 @@
 
 require_relative '../lib/pair_see/seer'
 require_relative '../lib/pair_see/person'
+require_relative '../lib/pair_see/knowledge_debt'
+require_relative '../lib/pair_see/card_knowledge_summary'
+require_relative '../lib/pair_see/pairing_event'
+require_relative '../lib/pair_see/pair_recency'
 require 'trollop'
-require 'pry'
 
 opts = Trollop.options do
-  opt :config, 'location of config file, example: ../../config/config.yml', default: "config/config.yml"
+  opt :config, 'location of config file, example: ../../config/config.yml', default: 'config/config.yml'
   opt :after, 'Date since which you want to get commits, in yyyy-mm-dd format', default: '0-1-1'
   opt :extras, 'See all commits without the name of any dev in them', default: false
   opt :latest, 'See dates of most recent commits by pairs', default: false
   opt :recommended, 'See active devs who have not paired (and therefore should)', default: false
   opt :cards, 'See cards and number of commits on each', default: false
+  opt :cards_by_commits, 'This goes with --cards and sorts by number of commits instead of active card days', default: false
   opt :cards_per_person, 'See cards for each dev', default: false
+  opt :knowledge_debt, 'Knowledge debt (cards that only one person worked on)', default: false
+  opt :my_pairs, 'Most recent dates of pairing for user', default: false
 end
 
 def run_command(opts)
   begin
     config = YAML.load_file(opts[:config])
   rescue
-    puts "Config file not found at: " + opts[:config] + " See config/config.yml.sample for an example. \n...exiting"
+    puts 'Config file not found at: ' + opts[:config] + " See config/config.yml.sample for an example. \n...exiting"
     exit
   end
   options = {
-      names: config['names'].map {|i| PairSee::Person.new(i.split(' '))}, # todo rename "names" to "people"
-      card_prefix: config['card_prefix'],
-      after_date: opts[:after],
-      repo_locations: config['roots']
+    names: config['names'].map { |i| PairSee::Person.new(i.split(' ')) }, # TODO: rename "names" to "people"
+    card_prefix: config['card_prefix'],
+    after_date: opts[:after],
+    repo_locations: config['roots']
   }
 
   seer = PairSee::Seer.new(options)
@@ -37,9 +43,17 @@ def run_command(opts)
   elsif opts[:recommended]
     seer.recommended_pairings
   elsif opts[:cards]
-    seer.pretty_card_data
+    if opts[:cards_by_commits]
+      seer.pretty_card_data_by_commits
+    else
+      seer.pretty_card_data
+    end
   elsif opts[:cards_per_person]
     seer.cards_per_person
+  elsif opts[:knowledge_debt]
+    seer.knowledge_debt
+  elsif opts[:my_pairs]
+    seer.pair_recency
   else
     seer.all_commits
   end