git-keyword-stats 1.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4efc6dfce8350cfb5ef60080d87c17b8b4fa6826
+  data.tar.gz: ade0bb9c2d70beef3a5d5bb71a67af84d4e7ec72
+SHA512:
+  metadata.gz: 508f25955d470cff2e8f0255aff60741fadb3371cffead26454cefdc505cece4f17c118254d73980db44136ca10aeff2550754fa14e6724c656eb806ca198882
+  data.tar.gz: ae6fece3018420e9471b401ffcbe5882d4b69b42ba482d9b07e862257b5fa681a688712d68c89d146c4e9c9b9d4bb3b26c119f1bad460c3854659fd91b105ecc

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Lukáš Mešťan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,69 @@
+[![Gem Version](https://badge.fury.io/rb/git-keyword-stats.svg)](https://badge.fury.io/rb/git-keyword-stats)
+
+Inspired by [git-swear-stats], [the Linux Kernel Fuck Count] and [its descendent],
+`git-keyword-stats` will give you some interesting statistics on keywording in a
+git repository's commit messages.
+
+[the Linux Kernel Fuck Count]: http://durak.org/sean/pubs/kfc/
+[its descendent]: http://www.vidarholen.net/contents/wordcount/
+[git-swear-stats]: https://github.com/xiongchiamiov/git-swear-stats
+
+# Installation
+
+    $ gem install git-keyword-stats
+
+# Usage
+
+    $ git-keyword-stats --help
+    git-keyword-stats
+    
+    Usage:
+       git-keyword-stats [options] [messages|diffs]
+    
+    Options:
+       -h, --help           Show this screen.
+       --debug              Print out debug messages.
+       --include-merges     Look at merge commits.
+       --no-progress        Don't print out progress information.
+       --last-month         Log since 1 month ago
+       --since=<sn>         Log since XY ago
+       --until=<un>         Log until XY ago
+       --config=<file>      Config file path
+
+
+# Example Output
+
+### With default keywords (bugfix,clear,typo,hotfix,debug,bug)
+
+    $ git keyword-stats 
+    Reading in git log... done!
+    Parsing git log.
+    
+    +----------------+------+-------+-----+-------+--------+
+    | Author/Keyword | typo | clear | bug | debug | readme |
+    +----------------+------+-------+-----+-------+--------+
+    | arzzen         | 2    | 2     | 1   | 2     | 0      |
+    | xiongchiamiov  | 0    | 0     | 0   | 8     | 1      |
+    | James Pearson  | 0    | 0     | 0   | 5     | 0      |
+    +----------------+------+-------+-----+-------+--------+
+    | Overall        | 2    | 2     | 1   | 15    | 1      |
+    +----------------+------+-------+-----+-------+--------+
+
+### With custom keywords file
+
+    $ git keyword-stats --config="path/to/file.yml"
+    
+    # example config file (cat path/to/file.yml)
+    
+    keywords:
+        - 'bugfix'
+        - '^(clear)$'
+        - 'typo'
+        - 'hotfix'
+        - 'readme'
+        - 'debug'
+        - '^(bug)$'
+        - '^(hot|typo|bug)fix$' 
+        
+        
+

data/Rakefile

@@ -0,0 +1,3 @@
+require 'mg'
+MG.new 'git-keyword-stats.gemspec'
+

data/bin/default.yml

@@ -0,0 +1,9 @@
+keywords:
+  - 'bugfix'
+  - '^clear$'
+  - 'typo'
+  - 'hotfix'
+  - 'readme'
+  - 'debug'
+  - '^bug$'
+  - '^(hot|typo|bug)fix$'  

data/bin/english.yml

@@ -0,0 +1,9 @@
+keywords:
+  - 'bugfix'
+  - '^(clear)$'
+  - 'typo'
+  - 'hotfix'
+  - 'readme'
+  - 'debug'
+  - '^(bug)$'
+  - '^(hot|typo|bug)fix$'  

data/bin/git-keyword-stats

@@ -0,0 +1,180 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+# May you recognize your weaknesses and share your strengths.
+# May you share freely, never taking more than you give.
+# May you find love and love everyone you find.
+
+require 'docopt'
+require 'git'
+require 'pp'
+require 'terminal-table'
+require 'yaml'
+
+# Git intercepts `git keyword-stats --help`, so unfortunately most people won't
+# see this usage message.  Docopt is still a great way to do parsing, though.
+doc = <<DOCOPT
+git-keyword-stats
+
+Usage:
+   git-keyword-stats [options] [messages|diffs]
+
+Options:
+   -h, --help               Show this screen.
+   --debug                  Print out debug messages.
+   --include-merges         Look at merge commits.
+   --no-progress            Don't print out progress information.
+   --last-month             Log since 1 month ago
+   --since=<sn>             Log since XY ago
+   --until=<un>             Log until XY ago
+   --config=<file>          Config file path
+
+Readme:
+   https://github.com/arzzen/git-keyword-stats
+
+DOCOPT
+begin
+   options = Docopt::docopt doc
+rescue Docopt::Exit => e
+   puts e.message
+   exit 1
+end
+pp options if options['--debug']
+
+default = [
+   '^bugfix$',
+   '^clear$',
+   '^typo$',
+   '^hotfix$',
+   '^debug$',
+   '^bug$'
+]
+
+if options['--config']
+    config = YAML.load_file(options['--config'])
+    keywords = config['keywords'] 
+else 
+    keywords = default
+end
+
+wordDelimiters = %r{[ \-_.,!?;:*"'|{}()\n]}
+
+wordStats = {}
+wordStats.default = 0
+authorStats = {}
+
+repo = Git.open '.'
+# By default, we only get up to 30 commits in the log.  By digging through the
+# source, I found that passing nil to repo.log() ends up setting the limit to
+# nil, and thus giving us all commits.
+print 'Reading in git log... ' if not options['--no-progress']
+
+log = repo.log nil
+
+if options['--last-month']
+    log.since("1 month ago")     
+end
+    
+if options['--since']
+    log.since(options['--since'])
+end
+
+if options['--until'] 
+    log.until(options['--until'])
+end
+
+puts 'done!' if not options['--no-progress']
+
+print 'Parsing git log' if not options['--no-progress']
+log.each_with_index do |commit, i|
+   # Merges often have data in them from other commits, pull request
+   # descriptions, etc., so it's not really fair to count them.
+   # Git::Log unfortunately appears to have no way of passing --no-merges
+   # through to the underlying binary, so we have to check merges on a
+   # commit-by-commit basis instead.
+   next if not options['--include-merges'] and commit.parents.count > 1
+   
+   author = commit.author.name
+   if not authorStats.key? author
+      authorStats[author] = {}
+      authorStats[author].default = 0
+   end
+   
+   if !options['diffs']
+      # Splitting on words makes our regexes a little simpler.
+      commit.message.split(wordDelimiters).each do |word|
+         word.downcase! # A little bit of normalization.
+         keywords.each do |keyword|
+	     if word =~ /#{keyword}/
+               wordStats[word] += 1
+               authorStats[author][word] += 1
+               if options['--debug']
+                  puts '-'*80
+                  puts author
+                  puts commit.message
+                  puts '-'*80
+               end
+            end
+         end
+      end
+   end
+   
+   if !options['messages']
+      # The git module doesn't handle a diff on the initial commit very well - by
+      # which I mean it throws an exception.
+      # TODO: Monkeypatch the shit out of Git::Commit.
+      next if commit.parents.count == 0
+      
+      diff = commit.diff_parent.to_s.force_encoding 'iso-8859-1'
+      # We only want to look at stuff they did, not surrounding things.  We'll
+      # approximate this by grepping through lines "added".
+      lines = diff.split("\n")
+      # Drop the first four lines to get rid of the diff header.
+      lines.drop(4).keep_if {|line| line =~ /^\+/}.each do |line|
+         line[1..-1].split(wordDelimiters).each do |word|
+            word.downcase! # A little bit of normalization.
+            keywords.each do |keyword|
+               if word =~ /#{keyword}/
+                  wordStats[word] += 1
+                  authorStats[author][word] += 1
+                  if options['--debug']
+                     puts '-'*80
+                     puts author
+                     puts line
+                     puts '-'*80
+                  end
+               end
+            end
+         end
+      end
+   end
+   
+   # For large repos, parsing can take a while; let users know something is
+   # happening.
+   print '.' if i % 100 == 0 and not options['--no-progress']
+end
+puts if not options['--no-progress']
+
+# People who haven't sworn at all aren't very interesting.
+authorStats.delete_if {|author, keywords| keywords.empty?}
+
+pp wordStats if options['--debug']
+pp authorStats if options['--debug']
+
+# Draw table
+puts ''
+subject = 'Author/Keyword'
+table = Terminal::Table.new
+table.headings = header = [subject] + wordStats.keys
+authorStats.each do |author, stats|
+   row = []
+   stats[subject] = author # Cheat a little for the first column.
+   header.each {|keyword| row << stats[keyword]}
+   table.add_row row
+end
+
+wordStats = Hash[0, 'Overall'].merge!(wordStats)
+table.add_separator
+table.add_row wordStats.values
+puts table
+puts ''

data/bin/slovak.yml

@@ -0,0 +1,13 @@
+keywords:
+  - 'chyba'
+  - '^oprava$'
+  - '^preklep$'
+  - '^uprava$'
+  - '^test$'
+  - 'upravenie'
+  - 'upravy'
+  - 'prerobenie'
+  - 'doladenie'
+  - 'doladovanie'
+  - 'osetrenie'
+  - 'debug'

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: git-keyword-stats
+version: !ruby/object:Gem::Version
+  version: 1.0.3
+platform: ruby
+authors:
+- James Pearson
+- Lukas Mestan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: docopt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Gather statistics on keywording in a repo.
+email:
+- lukas.mestan@gmail.com
+executables:
+- git-keyword-stats
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- LICENSE
+- README.md
+- Rakefile
+- bin/default.yml
+- bin/english.yml
+- bin/git-keyword-stats
+- bin/slovak.yml
+homepage: https://github.com/arzzen/git-keyword-stats
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Gather statistics on keywording in a repo.
+test_files: []