authors.py

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# Copyright (c) 2017, Michael Thies
# Copyright (c) 2017, Sascha Schade
# Copyright (c) 2017-2018, Niklas Hauser
#
# This file is part of the modm project.
#
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
# -----------------------------------------------------------------------------

import subprocess, locale
from collections import defaultdict
import argparse
import re

author_handles = {
    "Akos Becsey": "becseya",
    "Alexander Solovets": "mbait",
    "Amar": "fb39ca4",
    "Amarok McLion": "amarokmclion",
    "Andre Gilerson": "AndreGilerson",
    "Andrey Kunitsyn": "andryblack",
    "Antal Szabó": "Sh4rK",
    "Arjun Sarin": None,
    "Artiom": "Artiom9",
    "Benjamin Carrick": "nesos",
    "Benjamin Weps": "nesos",
    "Caleb Chalmers": "calebchalmers",
    "Carl Treudler": "cajt",
    "Cerem Cem ASLAN": "ceremcem",
    "Christian Menard": "chrism333",
    "Christoph Rüdi": None,
    "Christopher Durand": "chris-durand",
    "Daniel Krebs": "daniel-k",
    "David Hebbeker": "dhebbeker",
    "Dima Barsky": "kapacuk",
    "Erik Henriksson": "henrikssn",
    "Fabian Greif": "dergraaf",
    "Felix Petriconi": "FelixPetriconi",
    "Frank Altheim": "frnktank",
    "Georgi Grinshpun": "georgi-g",
    "Hannes Ellinger": "el-han",
    "Hans Schily": "RzwoDzwo",
    "Henrik Hose": "hshose",
    "Jacob Schultz Andersen": "jasa",
    "Jakob Riepler": "XDjackieXD",
    "Jan-Gerd Meß": "jgmess-dlr",
    "Jeff McBride": "mcbridejc",
    "Jens Böckmann": "jensboe",
    "Jonas Kazem Andersen": "JKazem",
    "Julia Gutheil": None,
    "Jörg Ebeling": "Apehaenger",
    "Jörg Hoffmann": "19joho66",
    "Joshua": "JeyRunner",
    "Kaelin Laundry": "WasabiFan",
    "Kevin Läufer": "ekiwi",
    "Klaus Schnass": "klsc-zeat",
    "Linas Nikiperavicius": "linasnikis",
    "Lucas Mösch": "lmoesch",
    "Luiz Gili": "lgili",
    "Lukas Güldenstein": "gueldenstone",
    "Marco Miralles": "minco3",
    "Marten Junga": "Maju-Ketchup",
    "Martin Esser": "Scabber",
    "Martin Rosekeit": "thundernail",
    "Matthew Arnold": "MatthewMArnold",
    "Mattis Kieffer": "mat-kie",
    "Michael Jossen": "Javask",
    "Michael Thies": "mhthies",
    "Mike Wolfram": "mikewolfram",
    "Nick Sarten": "genbattle",
    "Niclas Rohrer": None,
    "Nicolai Bruhn": "nicoBruhn",
    "Niklas Hauser": "salkinium",
    "Niklas Meyer": "Zweistein885",
    "Nikolay Semenov": "cocasema",
    "Odin Holmes": "odinthenerd",
    "Patrick Servello": "patrick--",
    "Pavel Pletenev": "ASMfreaK",
    "Philipp Graf": "luxarf",
    "Raphael Lehmann": "rleh",
    "Rasmus Kleist": "rasmuskleist",
    "Sarah Vilete": "sarahvilete",
    "Sascha Schade": "strongly-typed",
    "Sebastian Birke": "se-bi",
    "Sebastian Tibor Bakonyvari": "twast92",
    "Sergey Pluzhnikov": "ser-plu",
    "Sergiy Yevtushenko": "siy",
    "Steven Macías": "StevenMacias",
    "Tarik TIRE": "7Kronos",
    "Thomas Figueroa": "OperativeF",
    "Thomas Rush": "tarush53",
    "Thomas Sommer": "TomSaw",
    "Thorsten Lajewski": "TheTh0r",
    "Tomasz Chyrowicz": "tomchy",
    "Tomasz Wasilczyk": "twasilczyk",
    "Valeriy Osipov": "SgtPepperFTW",
    "Victor Costa": "victorandrehc",
    "Vishwanath Martur": "vishwamartur",
    "Vivien Henry": "lukh",
    "Zawadniak Pedro": "PDR5",
    "Álan Crístoffer": "acristoffers",
}

def get_author_log(since = None, until = None, handles = False, count = False):
    sl_command = "git shortlog -sn"
    if since is not None:
        sl_command += " --since=\"{}\"".format(since)
    if until is not None:
        sl_command += " --until=\"{}\"".format(until)
    # get the shortlog summary
    output = subprocess.Popen(sl_command, shell=True, stdout=subprocess.PIPE)\
            .stdout.read().decode(locale.getpreferredencoding())
    # parse the shortlog
    shortlog = defaultdict(int)
    for line in output.splitlines():
        commits, author = line.split("\t")
        shortlog[author] += int(commits)

    # get co-authors of the commits
    co_author_command = "git log --format='%(trailers:key=Co-authored-by)'"
    if since is not None:
        co_author_command += " --since=\"{}\"".format(since)
    if until is not None:
        co_author_command += " --until=\"{}\"".format(until)
    co_author_command += " | grep -v '^$' | sed -e 's/[Cc]o-authored-by: /\t/g' | sort | uniq -c"
    output = subprocess.Popen(co_author_command, shell=True, stdout=subprocess.PIPE)\
            .stdout.read().decode(locale.getpreferredencoding())
    for line in output.splitlines():
        commits, author = line.split("\t")
        author = re.findall(r"(?P<name>[^<>]+) <.+>", author)[0]
        shortlog[author] += int(commits)

    # convert to list of tuples for sorting
    commit_tuples = [(c, a) for a, c in shortlog.items()]
    if count:
        # sort by number of commits, then alphabetically by author
        commit_tuples.sort(key=lambda a: (-a[0], a[1]))
    else:
        # sort by name
        commit_tuples.sort(key=lambda a: a[1])

    output = []
    for (commits, author) in commit_tuples:
        out = "- " + author
        if handles and author in author_handles and author_handles[author] is not None:
            out += u" (@{})".format(author_handles[author])
        if count:
            out = u"{:4}  {}".format(commits, out)
        output.append(out)
    return output


if __name__ == "__main__":
    parser = argparse.ArgumentParser(description="Author statistics of modm.")
    parser.add_argument("--handles", dest="with_handles", action="store_true",
                        help="adds the GitHub handle to the author if known")
    parser.add_argument("--count", dest="with_count", action="store_true",
                        help="adds and sorts authors by commit count")
    parser.add_argument("--shoutout", dest="with_shoutout", action="store_true",
                        help="annotates first time contributers")
    parser.add_argument("--since", dest="since", default=None,
                        help="evaluates the git history from this date")
    parser.add_argument("--until", dest="until", default=None,
                        help="evaluates the git history until this date")

    args = parser.parse_args()
    log_authors = get_author_log(since=args.since, until=args.until,
                                 handles=args.with_handles, count=args.with_count)

    new_authors = []
    if args.with_shoutout and args.since:
        previous_authors = get_author_log(until=args.since)
        new_authors = get_author_log(since=args.since, until=args.until)
        new_authors = [a for a in new_authors if a not in previous_authors]

    authors = []
    for author in log_authors:
        if any(a in author for a in new_authors):
            author += u" 🎉"
        authors.append(author)
    print("\n".join(authors))