feat(mailmap): add bindings and api

lib/libgit2dart.dart

@@ -24,6 +24,7 @@ export 'src/credentials.dart';
 export 'src/blame.dart';
 export 'src/note.dart';
 export 'src/rebase.dart';
+export 'src/mailmap.dart';
 export 'src/features.dart';
 export 'src/error.dart';
 export 'src/git_types.dart';

lib/src/bindings/mailmap.dart

@@ -0,0 +1,158 @@
+import 'dart:ffi';
+import 'package:ffi/ffi.dart';
+import 'libgit2_bindings.dart';
+import '../error.dart';
+import '../util.dart';
+
+/// Allocate a new mailmap object.
+///
+/// This object is empty, so you'll have to add a mailmap file before you can
+/// do anything with it. The mailmap must be freed with `free()`.
+///
+/// Throws a [LibGit2Error] if error occured.
+Pointer<git_mailmap> init() {
+  final out = calloc<Pointer<git_mailmap>>();
+  final error = libgit2.git_mailmap_new(out);
+
+  if (error < 0) {
+    throw LibGit2Error(libgit2.git_error_last());
+  } else {
+    return out.value;
+  }
+}
+
+/// Create a new mailmap instance containing a single mailmap file.
+///
+/// Throws a [LibGit2Error] if error occured.
+Pointer<git_mailmap> fromBuffer(String buffer) {
+  final out = calloc<Pointer<git_mailmap>>();
+  final bufferC = buffer.toNativeUtf8().cast<Int8>();
+
+  final error = libgit2.git_mailmap_from_buffer(out, bufferC, buffer.length);
+
+  calloc.free(bufferC);
+
+  if (error < 0) {
+    throw LibGit2Error(libgit2.git_error_last());
+  } else {
+    return out.value;
+  }
+}
+
+/// Create a new mailmap instance from a repository, loading mailmap files based
+/// on the repository's configuration.
+///
+/// Mailmaps are loaded in the following order:
+///
+/// 1. `.mailmap` in the root of the repository's working directory, if present.
+/// 2. The blob object identified by the `mailmap.blob` config entry, if set.
+///   NOTE: `mailmap.blob` defaults to `HEAD:.mailmap` in bare repositories
+/// 3. The path in the `mailmap.file` config entry, if set.
+///
+/// Throws a [LibGit2Error] if error occured.
+Pointer<git_mailmap> fromRepository(Pointer<git_repository> repo) {
+  final out = calloc<Pointer<git_mailmap>>();
+  final error = libgit2.git_mailmap_from_repository(out, repo);
+
+  if (error < 0) {
+    throw LibGit2Error(libgit2.git_error_last());
+  } else {
+    return out.value;
+  }
+}
+
+/// Resolve a name and email to the corresponding real name and email.
+///
+/// Throws a [LibGit2Error] if error occured.
+List<String> resolve({
+  required Pointer<git_mailmap> mailmapPointer,
+  required String name,
+  required String email,
+}) {
+  final outRealName = calloc<Pointer<Int8>>();
+  final outRealEmail = calloc<Pointer<Int8>>();
+  final nameC = name.toNativeUtf8().cast<Int8>();
+  final emailC = email.toNativeUtf8().cast<Int8>();
+  final error = libgit2.git_mailmap_resolve(
+    outRealName,
+    outRealEmail,
+    mailmapPointer,
+    nameC,
+    emailC,
+  );
+
+  if (error < 0) {
+    calloc.free(outRealName);
+    calloc.free(outRealEmail);
+    calloc.free(nameC);
+    calloc.free(emailC);
+    throw LibGit2Error(libgit2.git_error_last());
+  } else {
+    final realName = outRealName.value.cast<Utf8>().toDartString();
+    final realEmail = outRealEmail.value.cast<Utf8>().toDartString();
+    calloc.free(outRealName);
+    calloc.free(outRealEmail);
+    calloc.free(nameC);
+    calloc.free(emailC);
+
+    return [realName, realEmail];
+  }
+}
+
+/// Resolve a signature to use real names and emails with a mailmap.
+///
+/// Throws a [LibGit2Error] if error occured.
+Pointer<git_signature> resolveSignature({
+  required Pointer<git_mailmap> mailmapPointer,
+  required Pointer<git_signature> signaturePointer,
+}) {
+  final out = calloc<Pointer<git_signature>>();
+  final error = libgit2.git_mailmap_resolve_signature(
+    out,
+    mailmapPointer,
+    signaturePointer,
+  );
+
+  if (error < 0) {
+    throw LibGit2Error(libgit2.git_error_last());
+  } else {
+    return out.value;
+  }
+}
+
+/// Add a single entry to the given mailmap object. If the entry already exists,
+/// it will be replaced with the new entry.
+///
+/// Throws a [LibGit2Error] if error occured.
+void addEntry({
+  required Pointer<git_mailmap> mailmapPointer,
+  String? realName,
+  String? realEmail,
+  String? replaceName,
+  required String replaceEmail,
+}) {
+  final realNameC = realName?.toNativeUtf8().cast<Int8>() ?? nullptr;
+  final realEmailC = realEmail?.toNativeUtf8().cast<Int8>() ?? nullptr;
+  final replaceNameC = replaceName?.toNativeUtf8().cast<Int8>() ?? nullptr;
+  final replaceEmailC = replaceEmail.toNativeUtf8().cast<Int8>();
+
+  final error = libgit2.git_mailmap_add_entry(
+    mailmapPointer,
+    realNameC,
+    realEmailC,
+    replaceNameC,
+    replaceEmailC,
+  );
+
+  calloc.free(realNameC);
+  calloc.free(realEmailC);
+  calloc.free(replaceNameC);
+  calloc.free(replaceEmailC);
+
+  if (error < 0) {
+    throw LibGit2Error(libgit2.git_error_last());
+  }
+}
+
+/// Free the mailmap and its associated memory.
+void free(Pointer<git_mailmap> mm) => libgit2.git_mailmap_free(mm);

lib/src/mailmap.dart

@@ -0,0 +1,103 @@
+import 'dart:ffi';
+import 'package:libgit2dart/libgit2dart.dart';
+import 'bindings/libgit2_bindings.dart';
+import 'bindings/mailmap.dart' as bindings;
+import 'util.dart';
+
+class Mailmap {
+  /// Initializes a new instance of [Mailmap] class from provided
+  /// pointer to mailmap object in memory.
+  Mailmap(this._mailmapPointer);
+
+  /// Initializes a new instance of [Mailmap] class.
+  ///
+  /// This object is empty, so you'll have to add a mailmap file before you can
+  /// do anything with it. Must be freed with `free()`.
+  ///
+  /// Throws a [LibGit2Error] if error occured.
+  Mailmap.empty() {
+    libgit2.git_libgit2_init();
+
+    _mailmapPointer = bindings.init();
+  }
+
+  /// Initializes a new instance of [Mailmap] class from provided buffer.
+  ///
+  /// Must be freed with `free()`.
+  ///
+  /// Throws a [LibGit2Error] if error occured.
+  Mailmap.fromBuffer(String buffer) {
+    libgit2.git_libgit2_init();
+
+    _mailmapPointer = bindings.fromBuffer(buffer);
+  }
+
+  /// Initializes a new instance of [Mailmap] class from a repository, loading
+  /// mailmap files based on the repository's configuration.
+  ///
+  /// Mailmaps are loaded in the following order:
+  ///
+  /// 1. `.mailmap` in the root of the repository's working directory, if present.
+  /// 2. The blob object identified by the `mailmap.blob` config entry, if set.
+  ///   NOTE: `mailmap.blob` defaults to `HEAD:.mailmap` in bare repositories
+  /// 3. The path in the `mailmap.file` config entry, if set.
+  ///
+  /// Must be freed with `free()`.
+  ///
+  /// Throws a [LibGit2Error] if error occured.
+  Mailmap.fromRepository(Repository repo) {
+    _mailmapPointer = bindings.fromRepository(repo.pointer);
+  }
+
+  late final Pointer<git_mailmap> _mailmapPointer;
+
+  /// Pointer to memory address for allocated mailmap object.
+  Pointer<git_mailmap> get pointer => _mailmapPointer;
+
+  /// Returns list containing resolved [name] and [email] to the corresponding real name
+  /// and real email respectively.
+  ///
+  /// Throws a [LibGit2Error] if error occured.
+  List<String> resolve({
+    required String name,
+    required String email,
+  }) {
+    return bindings.resolve(
+      mailmapPointer: _mailmapPointer,
+      name: name,
+      email: email,
+    );
+  }
+
+  /// Resolves a signature to use real names and emails with a mailmap.
+  ///
+  /// Throws a [LibGit2Error] if error occured.
+  Signature resolveSignature(Signature signature) {
+    return Signature(bindings.resolveSignature(
+      mailmapPointer: _mailmapPointer,
+      signaturePointer: signature.pointer,
+    ));
+  }
+
+  /// Adds a single entry to the given mailmap object. If the entry already exists,
+  /// it will be replaced with the new entry.
+  ///
+  /// Throws a [LibGit2Error] if error occured.
+  void addEntry({
+    String? realName,
+    String? realEmail,
+    String? replaceName,
+    required String replaceEmail,
+  }) {
+    bindings.addEntry(
+      mailmapPointer: _mailmapPointer,
+      realName: realName,
+      realEmail: realEmail,
+      replaceName: replaceName,
+      replaceEmail: replaceEmail,
+    );
+  }
+
+  /// Releases memory allocated for mailmap object.
+  void free() => bindings.free(_mailmapPointer);
+}

test/assets/mailmaprepo/.gitdir/COMMIT_EDITMSG

@@ -0,0 +1 @@
+add .mailmap

test/assets/mailmaprepo/.gitdir/HEAD

@@ -0,0 +1 @@
+ref: refs/heads/master

test/assets/mailmaprepo/.gitdir/ORIG_HEAD

@@ -0,0 +1 @@
+c68ff54aabf660fcdd9a2838d401583fe31249e3

test/assets/mailmaprepo/.gitdir/config

@@ -0,0 +1,9 @@
+[core]
+	repositoryformatversion = 0
+	filemode = true
+	bare = false
+	logallrefupdates = true
+  editor = vim
+[remote "origin"]
+	url = git://github.com/SkinnyMind/libgit2dart.git
+	fetch = +refs/heads/*:refs/remotes/origin/*

test/assets/mailmaprepo/.gitdir/description

@@ -0,0 +1 @@
+Unnamed repository; edit this file 'description' to name the repository.

test/assets/mailmaprepo/.gitdir/hooks/applypatch-msg.sample

@@ -0,0 +1,15 @@
+#!/usr/bin/sh
+#
+# An example hook script to check the commit log message taken by
+# applypatch from an e-mail message.
+#
+# The hook should exit with non-zero status after issuing an
+# appropriate message if it wants to stop the commit.  The hook is
+# allowed to edit the commit message file.
+#
+# To enable this hook, rename this file to "applypatch-msg".
+
+. git-sh-setup
+commitmsg="$(git rev-parse --git-path hooks/commit-msg)"
+test -x "$commitmsg" && exec "$commitmsg" ${1+"$@"}
+:

test/assets/mailmaprepo/.gitdir/hooks/commit-msg.sample

@@ -0,0 +1,24 @@
+#!/usr/bin/sh
+#
+# An example hook script to check the commit log message.
+# Called by "git commit" with one argument, the name of the file
+# that has the commit message.  The hook should exit with non-zero
+# status after issuing an appropriate message if it wants to stop the
+# commit.  The hook is allowed to edit the commit message file.
+#
+# To enable this hook, rename this file to "commit-msg".
+
+# Uncomment the below to add a Signed-off-by line to the message.
+# Doing this in a hook is a bad idea in general, but the prepare-commit-msg
+# hook is more suited to it.
+#
+# SOB=$(git var GIT_AUTHOR_IDENT | sed -n 's/^\(.*>\).*$/Signed-off-by: \1/p')
+# grep -qs "^$SOB" "$1" || echo "$SOB" >> "$1"
+
+# This example catches duplicate Signed-off-by lines.
+
+test "" = "$(grep '^Signed-off-by: ' "$1" |
+	 sort | uniq -c | sed -e '/^[ 	]*1[ 	]/d')" || {
+	echo >&2 Duplicate Signed-off-by lines.
+	exit 1
+}

test/assets/mailmaprepo/.gitdir/hooks/fsmonitor-watchman.sample

@@ -0,0 +1,173 @@
+#!/usr/bin/perl
+
+use strict;
+use warnings;
+use IPC::Open2;
+
+# An example hook script to integrate Watchman
+# (https://facebook.github.io/watchman/) with git to speed up detecting
+# new and modified files.
+#
+# The hook is passed a version (currently 2) and last update token
+# formatted as a string and outputs to stdout a new update token and
+# all files that have been modified since the update token. Paths must
+# be relative to the root of the working tree and separated by a single NUL.
+#
+# To enable this hook, rename this file to "query-watchman" and set
+# 'git config core.fsmonitor .git/hooks/query-watchman'
+#
+my ($version, $last_update_token) = @ARGV;
+
+# Uncomment for debugging
+# print STDERR "$0 $version $last_update_token\n";
+
+# Check the hook interface version
+if ($version ne 2) {
+	die "Unsupported query-fsmonitor hook version '$version'.\n" .
+	    "Falling back to scanning...\n";
+}
+
+my $git_work_tree = get_working_dir();
+
+my $retry = 1;
+
+my $json_pkg;
+eval {
+	require JSON::XS;
+	$json_pkg = "JSON::XS";
+	1;
+} or do {
+	require JSON::PP;
+	$json_pkg = "JSON::PP";
+};
+
+launch_watchman();
+
+sub launch_watchman {
+	my $o = watchman_query();
+	if (is_work_tree_watched($o)) {
+		output_result($o->{clock}, @{$o->{files}});
+	}
+}
+
+sub output_result {
+	my ($clockid, @files) = @_;
+
+	# Uncomment for debugging watchman output
+	# open (my $fh, ">", ".git/watchman-output.out");
+	# binmode $fh, ":utf8";
+	# print $fh "$clockid\n@files\n";
+	# close $fh;
+
+	binmode STDOUT, ":utf8";
+	print $clockid;
+	print "\0";
+	local $, = "\0";
+	print @files;
+}
+
+sub watchman_clock {
+	my $response = qx/watchman clock "$git_work_tree"/;
+	die "Failed to get clock id on '$git_work_tree'.\n" .
+		"Falling back to scanning...\n" if $? != 0;
+
+	return $json_pkg->new->utf8->decode($response);
+}
+
+sub watchman_query {
+	my $pid = open2(\*CHLD_OUT, \*CHLD_IN, 'watchman -j --no-pretty')
+	or die "open2() failed: $!\n" .
+	"Falling back to scanning...\n";
+
+	# In the query expression below we're asking for names of files that
+	# changed since $last_update_token but not from the .git folder.
+	#
+	# To accomplish this, we're using the "since" generator to use the
+	# recency index to select candidate nodes and "fields" to limit the
+	# output to file names only. Then we're using the "expression" term to
+	# further constrain the results.
+	if (substr($last_update_token, 0, 1) eq "c") {
+		$last_update_token = "\"$last_update_token\"";
+	}
+	my $query = <<"	END";
+		["query", "$git_work_tree", {
+			"since": $last_update_token,
+			"fields": ["name"],
+			"expression": ["not", ["dirname", ".git"]]
+		}]
+	END
+
+	# Uncomment for debugging the watchman query
+	# open (my $fh, ">", ".git/watchman-query.json");
+	# print $fh $query;
+	# close $fh;
+
+	print CHLD_IN $query;
+	close CHLD_IN;
+	my $response = do {local $/; <CHLD_OUT>};
+
+	# Uncomment for debugging the watch response
+	# open ($fh, ">", ".git/watchman-response.json");
+	# print $fh $response;
+	# close $fh;
+
+	die "Watchman: command returned no output.\n" .
+	"Falling back to scanning...\n" if $response eq "";
+	die "Watchman: command returned invalid output: $response\n" .
+	"Falling back to scanning...\n" unless $response =~ /^\{/;
+
+	return $json_pkg->new->utf8->decode($response);
+}
+
+sub is_work_tree_watched {
+	my ($output) = @_;
+	my $error = $output->{error};
+	if ($retry > 0 and $error and $error =~ m/unable to resolve root .* directory (.*) is not watched/) {
+		$retry--;
+		my $response = qx/watchman watch "$git_work_tree"/;
+		die "Failed to make watchman watch '$git_work_tree'.\n" .
+		    "Falling back to scanning...\n" if $? != 0;
+		$output = $json_pkg->new->utf8->decode($response);
+		$error = $output->{error};
+		die "Watchman: $error.\n" .
+		"Falling back to scanning...\n" if $error;
+
+		# Uncomment for debugging watchman output
+		# open (my $fh, ">", ".git/watchman-output.out");
+		# close $fh;
+
+		# Watchman will always return all files on the first query so
+		# return the fast "everything is dirty" flag to git and do the
+		# Watchman query just to get it over with now so we won't pay
+		# the cost in git to look up each individual file.
+		my $o = watchman_clock();
+		$error = $output->{error};
+
+		die "Watchman: $error.\n" .
+		"Falling back to scanning...\n" if $error;
+
+		output_result($o->{clock}, ("/"));
+		$last_update_token = $o->{clock};
+
+		eval { launch_watchman() };
+		return 0;
+	}
+
+	die "Watchman: $error.\n" .
+	"Falling back to scanning...\n" if $error;
+
+	return 1;
+}
+
+sub get_working_dir {
+	my $working_dir;
+	if ($^O =~ 'msys' || $^O =~ 'cygwin') {
+		$working_dir = Win32::GetCwd();
+		$working_dir =~ tr/\\/\//;
+	} else {
+		require Cwd;
+		$working_dir = Cwd::cwd();
+	}
+
+	return $working_dir;
+}

test/assets/mailmaprepo/.gitdir/hooks/post-update.sample

@@ -0,0 +1,8 @@
+#!/usr/bin/sh
+#
+# An example hook script to prepare a packed repository for use over
+# dumb transports.
+#
+# To enable this hook, rename this file to "post-update".
+
+exec git update-server-info

test/assets/mailmaprepo/.gitdir/hooks/pre-applypatch.sample

@@ -0,0 +1,14 @@
+#!/usr/bin/sh
+#
+# An example hook script to verify what is about to be committed
+# by applypatch from an e-mail message.
+#
+# The hook should exit with non-zero status after issuing an
+# appropriate message if it wants to stop the commit.
+#
+# To enable this hook, rename this file to "pre-applypatch".
+
+. git-sh-setup
+precommit="$(git rev-parse --git-path hooks/pre-commit)"
+test -x "$precommit" && exec "$precommit" ${1+"$@"}
+:

test/assets/mailmaprepo/.gitdir/hooks/pre-commit.sample

@@ -0,0 +1,49 @@
+#!/usr/bin/sh
+#
+# An example hook script to verify what is about to be committed.
+# Called by "git commit" with no arguments.  The hook should
+# exit with non-zero status after issuing an appropriate message if
+# it wants to stop the commit.
+#
+# To enable this hook, rename this file to "pre-commit".
+
+if git rev-parse --verify HEAD >/dev/null 2>&1
+then
+	against=HEAD
+else
+	# Initial commit: diff against an empty tree object
+	against=$(git hash-object -t tree /dev/null)
+fi
+
+# If you want to allow non-ASCII filenames set this variable to true.
+allownonascii=$(git config --type=bool hooks.allownonascii)
+
+# Redirect output to stderr.
+exec 1>&2
+
+# Cross platform projects tend to avoid non-ASCII filenames; prevent
+# them from being added to the repository. We exploit the fact that the
+# printable range starts at the space character and ends with tilde.
+if [ "$allownonascii" != "true" ] &&
+	# Note that the use of brackets around a tr range is ok here, (it's
+	# even required, for portability to Solaris 10's /usr/bin/tr), since
+	# the square bracket bytes happen to fall in the designated range.
+	test $(git diff --cached --name-only --diff-filter=A -z $against |
+	  LC_ALL=C tr -d '[ -~]\0' | wc -c) != 0
+then
+	cat <<\EOF
+Error: Attempt to add a non-ASCII file name.
+
+This can cause problems if you want to work with people on other platforms.
+
+To be portable it is advisable to rename the file.
+
+If you know what you are doing you can disable this check using:
+
+  git config hooks.allownonascii true
+EOF
+	exit 1
+fi
+
+# If there are whitespace errors, print the offending file names and fail.
+exec git diff-index --check --cached $against --

test/assets/mailmaprepo/.gitdir/hooks/pre-merge-commit.sample

@@ -0,0 +1,13 @@
+#!/usr/bin/sh
+#
+# An example hook script to verify what is about to be committed.
+# Called by "git merge" with no arguments.  The hook should
+# exit with non-zero status after issuing an appropriate message to
+# stderr if it wants to stop the merge commit.
+#
+# To enable this hook, rename this file to "pre-merge-commit".
+
+. git-sh-setup
+test -x "$GIT_DIR/hooks/pre-commit" &&
+        exec "$GIT_DIR/hooks/pre-commit"
+:

test/assets/mailmaprepo/.gitdir/hooks/pre-push.sample

@@ -0,0 +1,53 @@
+#!/usr/bin/sh
+
+# An example hook script to verify what is about to be pushed.  Called by "git
+# push" after it has checked the remote status, but before anything has been
+# pushed.  If this script exits with a non-zero status nothing will be pushed.
+#
+# This hook is called with the following parameters:
+#
+# $1 -- Name of the remote to which the push is being done
+# $2 -- URL to which the push is being done
+#
+# If pushing without using a named remote those arguments will be equal.
+#
+# Information about the commits which are being pushed is supplied as lines to
+# the standard input in the form:
+#
+#   <local ref> <local oid> <remote ref> <remote oid>
+#
+# This sample shows how to prevent push of commits where the log message starts
+# with "WIP" (work in progress).
+
+remote="$1"
+url="$2"
+
+zero=$(git hash-object --stdin </dev/null | tr '[0-9a-f]' '0')
+
+while read local_ref local_oid remote_ref remote_oid
+do
+	if test "$local_oid" = "$zero"
+	then
+		# Handle delete
+		:
+	else
+		if test "$remote_oid" = "$zero"
+		then
+			# New branch, examine all commits
+			range="$local_oid"
+		else
+			# Update to existing branch, examine new commits
+			range="$remote_oid..$local_oid"
+		fi
+
+		# Check for WIP commit
+		commit=$(git rev-list -n 1 --grep '^WIP' "$range")
+		if test -n "$commit"
+		then
+			echo >&2 "Found WIP commit in $local_ref, not pushing"
+			exit 1
+		fi
+	fi
+done
+
+exit 0

test/assets/mailmaprepo/.gitdir/hooks/pre-rebase.sample

@@ -0,0 +1,169 @@
+#!/usr/bin/sh
+#
+# Copyright (c) 2006, 2008 Junio C Hamano
+#
+# The "pre-rebase" hook is run just before "git rebase" starts doing
+# its job, and can prevent the command from running by exiting with
+# non-zero status.
+#
+# The hook is called with the following parameters:
+#
+# $1 -- the upstream the series was forked from.
+# $2 -- the branch being rebased (or empty when rebasing the current branch).
+#
+# This sample shows how to prevent topic branches that are already
+# merged to 'next' branch from getting rebased, because allowing it
+# would result in rebasing already published history.
+
+publish=next
+basebranch="$1"
+if test "$#" = 2
+then
+	topic="refs/heads/$2"
+else
+	topic=`git symbolic-ref HEAD` ||
+	exit 0 ;# we do not interrupt rebasing detached HEAD
+fi
+
+case "$topic" in
+refs/heads/??/*)
+	;;
+*)
+	exit 0 ;# we do not interrupt others.
+	;;
+esac
+
+# Now we are dealing with a topic branch being rebased
+# on top of master.  Is it OK to rebase it?
+
+# Does the topic really exist?
+git show-ref -q "$topic" || {
+	echo >&2 "No such branch $topic"
+	exit 1
+}
+
+# Is topic fully merged to master?
+not_in_master=`git rev-list --pretty=oneline ^master "$topic"`
+if test -z "$not_in_master"
+then
+	echo >&2 "$topic is fully merged to master; better remove it."
+	exit 1 ;# we could allow it, but there is no point.
+fi
+
+# Is topic ever merged to next?  If so you should not be rebasing it.
+only_next_1=`git rev-list ^master "^$topic" ${publish} | sort`
+only_next_2=`git rev-list ^master           ${publish} | sort`
+if test "$only_next_1" = "$only_next_2"
+then
+	not_in_topic=`git rev-list "^$topic" master`
+	if test -z "$not_in_topic"
+	then
+		echo >&2 "$topic is already up to date with master"
+		exit 1 ;# we could allow it, but there is no point.
+	else
+		exit 0
+	fi
+else
+	not_in_next=`git rev-list --pretty=oneline ^${publish} "$topic"`
+	/usr/bin/perl -e '
+		my $topic = $ARGV[0];
+		my $msg = "* $topic has commits already merged to public branch:\n";
+		my (%not_in_next) = map {
+			/^([0-9a-f]+) /;
+			($1 => 1);
+		} split(/\n/, $ARGV[1]);
+		for my $elem (map {
+				/^([0-9a-f]+) (.*)$/;
+				[$1 => $2];
+			} split(/\n/, $ARGV[2])) {
+			if (!exists $not_in_next{$elem->[0]}) {
+				if ($msg) {
+					print STDERR $msg;
+					undef $msg;
+				}
+				print STDERR " $elem->[1]\n";
+			}
+		}
+	' "$topic" "$not_in_next" "$not_in_master"
+	exit 1
+fi
+
+<<\DOC_END
+
+This sample hook safeguards topic branches that have been
+published from being rewound.
+
+The workflow assumed here is:
+
+ * Once a topic branch forks from "master", "master" is never
+   merged into it again (either directly or indirectly).
+
+ * Once a topic branch is fully cooked and merged into "master",
+   it is deleted.  If you need to build on top of it to correct
+   earlier mistakes, a new topic branch is created by forking at
+   the tip of the "master".  This is not strictly necessary, but
+   it makes it easier to keep your history simple.
+
+ * Whenever you need to test or publish your changes to topic
+   branches, merge them into "next" branch.
+
+The script, being an example, hardcodes the publish branch name
+to be "next", but it is trivial to make it configurable via
+$GIT_DIR/config mechanism.
+
+With this workflow, you would want to know:
+
+(1) ... if a topic branch has ever been merged to "next".  Young
+    topic branches can have stupid mistakes you would rather
+    clean up before publishing, and things that have not been
+    merged into other branches can be easily rebased without
+    affecting other people.  But once it is published, you would
+    not want to rewind it.
+
+(2) ... if a topic branch has been fully merged to "master".
+    Then you can delete it.  More importantly, you should not
+    build on top of it -- other people may already want to
+    change things related to the topic as patches against your
+    "master", so if you need further changes, it is better to
+    fork the topic (perhaps with the same name) afresh from the
+    tip of "master".
+
+Let's look at this example:
+
+		   o---o---o---o---o---o---o---o---o---o "next"
+		  /       /           /           /
+		 /   a---a---b A     /           /
+		/   /               /           /
+	       /   /   c---c---c---c B         /
+	      /   /   /             \         /
+	     /   /   /   b---b C     \       /
+	    /   /   /   /             \     /
+    ---o---o---o---o---o---o---o---o---o---o---o "master"
+
+
+A, B and C are topic branches.
+
+ * A has one fix since it was merged up to "next".
+
+ * B has finished.  It has been fully merged up to "master" and "next",
+   and is ready to be deleted.
+
+ * C has not merged to "next" at all.
+
+We would want to allow C to be rebased, refuse A, and encourage
+B to be deleted.
+
+To compute (1):
+
+	git rev-list ^master ^topic next
+	git rev-list ^master        next
+
+	if these match, topic has not merged in next at all.
+
+To compute (2):
+
+	git rev-list master..topic
+
+	if this is empty, it is fully merged to "master".
+
+DOC_END

test/assets/mailmaprepo/.gitdir/hooks/pre-receive.sample

@@ -0,0 +1,24 @@
+#!/usr/bin/sh
+#
+# An example hook script to make use of push options.
+# The example simply echoes all push options that start with 'echoback='
+# and rejects all pushes when the "reject" push option is used.
+#
+# To enable this hook, rename this file to "pre-receive".
+
+if test -n "$GIT_PUSH_OPTION_COUNT"
+then
+	i=0
+	while test "$i" -lt "$GIT_PUSH_OPTION_COUNT"
+	do
+		eval "value=\$GIT_PUSH_OPTION_$i"
+		case "$value" in
+		echoback=*)
+			echo "echo from the pre-receive-hook: ${value#*=}" >&2
+			;;
+		reject)
+			exit 1
+		esac
+		i=$((i + 1))
+	done
+fi

test/assets/mailmaprepo/.gitdir/hooks/prepare-commit-msg.sample

@@ -0,0 +1,42 @@
+#!/usr/bin/sh
+#
+# An example hook script to prepare the commit log message.
+# Called by "git commit" with the name of the file that has the
+# commit message, followed by the description of the commit
+# message's source.  The hook's purpose is to edit the commit
+# message file.  If the hook fails with a non-zero status,
+# the commit is aborted.
+#
+# To enable this hook, rename this file to "prepare-commit-msg".
+
+# This hook includes three examples. The first one removes the
+# "# Please enter the commit message..." help message.
+#
+# The second includes the output of "git diff --name-status -r"
+# into the message, just before the "git status" output.  It is
+# commented because it doesn't cope with --amend or with squashed
+# commits.
+#
+# The third example adds a Signed-off-by line to the message, that can
+# still be edited.  This is rarely a good idea.
+
+COMMIT_MSG_FILE=$1
+COMMIT_SOURCE=$2
+SHA1=$3
+
+/usr/bin/perl -i.bak -ne 'print unless(m/^. Please enter the commit message/..m/^#$/)' "$COMMIT_MSG_FILE"
+
+# case "$COMMIT_SOURCE,$SHA1" in
+#  ,|template,)
+#    /usr/bin/perl -i.bak -pe '
+#       print "\n" . `git diff --cached --name-status -r`
+# 	 if /^#/ && $first++ == 0' "$COMMIT_MSG_FILE" ;;
+#  *) ;;
+# esac
+
+# SOB=$(git var GIT_COMMITTER_IDENT | sed -n 's/^\(.*>\).*$/Signed-off-by: \1/p')
+# git interpret-trailers --in-place --trailer "$SOB" "$COMMIT_MSG_FILE"
+# if test -z "$COMMIT_SOURCE"
+# then
+#   /usr/bin/perl -i.bak -pe 'print "\n" if !$first_line++' "$COMMIT_MSG_FILE"
+# fi

test/assets/mailmaprepo/.gitdir/hooks/push-to-checkout.sample

@@ -0,0 +1,78 @@
+#!/usr/bin/sh
+
+# An example hook script to update a checked-out tree on a git push.
+#
+# This hook is invoked by git-receive-pack(1) when it reacts to git
+# push and updates reference(s) in its repository, and when the push
+# tries to update the branch that is currently checked out and the
+# receive.denyCurrentBranch configuration variable is set to
+# updateInstead.
+#
+# By default, such a push is refused if the working tree and the index
+# of the remote repository has any difference from the currently
+# checked out commit; when both the working tree and the index match
+# the current commit, they are updated to match the newly pushed tip
+# of the branch. This hook is to be used to override the default
+# behaviour; however the code below reimplements the default behaviour
+# as a starting point for convenient modification.
+#
+# The hook receives the commit with which the tip of the current
+# branch is going to be updated:
+commit=$1
+
+# It can exit with a non-zero status to refuse the push (when it does
+# so, it must not modify the index or the working tree).
+die () {
+	echo >&2 "$*"
+	exit 1
+}
+
+# Or it can make any necessary changes to the working tree and to the
+# index to bring them to the desired state when the tip of the current
+# branch is updated to the new commit, and exit with a zero status.
+#
+# For example, the hook can simply run git read-tree -u -m HEAD "$1"
+# in order to emulate git fetch that is run in the reverse direction
+# with git push, as the two-tree form of git read-tree -u -m is
+# essentially the same as git switch or git checkout that switches
+# branches while keeping the local changes in the working tree that do
+# not interfere with the difference between the branches.
+
+# The below is a more-or-less exact translation to shell of the C code
+# for the default behaviour for git's push-to-checkout hook defined in
+# the push_to_deploy() function in builtin/receive-pack.c.
+#
+# Note that the hook will be executed from the repository directory,
+# not from the working tree, so if you want to perform operations on
+# the working tree, you will have to adapt your code accordingly, e.g.
+# by adding "cd .." or using relative paths.
+
+if ! git update-index -q --ignore-submodules --refresh
+then
+	die "Up-to-date check failed"
+fi
+
+if ! git diff-files --quiet --ignore-submodules --
+then
+	die "Working directory has unstaged changes"
+fi
+
+# This is a rough translation of:
+#
+#   head_has_history() ? "HEAD" : EMPTY_TREE_SHA1_HEX
+if git cat-file -e HEAD 2>/dev/null
+then
+	head=HEAD
+else
+	head=$(git hash-object -t tree --stdin </dev/null)
+fi
+
+if ! git diff-index --quiet --cached --ignore-submodules $head --
+then
+	die "Working directory has staged changes"
+fi
+
+if ! git read-tree -u -m "$commit"
+then
+	die "Could not update working tree to new HEAD"
+fi

test/assets/mailmaprepo/.gitdir/hooks/update.sample

@@ -0,0 +1,128 @@
+#!/usr/bin/sh
+#
+# An example hook script to block unannotated tags from entering.
+# Called by "git receive-pack" with arguments: refname sha1-old sha1-new
+#
+# To enable this hook, rename this file to "update".
+#
+# Config
+# ------
+# hooks.allowunannotated
+#   This boolean sets whether unannotated tags will be allowed into the
+#   repository.  By default they won't be.
+# hooks.allowdeletetag
+#   This boolean sets whether deleting tags will be allowed in the
+#   repository.  By default they won't be.
+# hooks.allowmodifytag
+#   This boolean sets whether a tag may be modified after creation. By default
+#   it won't be.
+# hooks.allowdeletebranch
+#   This boolean sets whether deleting branches will be allowed in the
+#   repository.  By default they won't be.
+# hooks.denycreatebranch
+#   This boolean sets whether remotely creating branches will be denied
+#   in the repository.  By default this is allowed.
+#
+
+# --- Command line
+refname="$1"
+oldrev="$2"
+newrev="$3"
+
+# --- Safety check
+if [ -z "$GIT_DIR" ]; then
+	echo "Don't run this script from the command line." >&2
+	echo " (if you want, you could supply GIT_DIR then run" >&2
+	echo "  $0 <ref> <oldrev> <newrev>)" >&2
+	exit 1
+fi
+
+if [ -z "$refname" -o -z "$oldrev" -o -z "$newrev" ]; then
+	echo "usage: $0 <ref> <oldrev> <newrev>" >&2
+	exit 1
+fi
+
+# --- Config
+allowunannotated=$(git config --type=bool hooks.allowunannotated)
+allowdeletebranch=$(git config --type=bool hooks.allowdeletebranch)
+denycreatebranch=$(git config --type=bool hooks.denycreatebranch)
+allowdeletetag=$(git config --type=bool hooks.allowdeletetag)
+allowmodifytag=$(git config --type=bool hooks.allowmodifytag)
+
+# check for no description
+projectdesc=$(sed -e '1q' "$GIT_DIR/description")
+case "$projectdesc" in
+"Unnamed repository"* | "")
+	echo "*** Project description file hasn't been set" >&2
+	exit 1
+	;;
+esac
+
+# --- Check types
+# if $newrev is 0000...0000, it's a commit to delete a ref.
+zero=$(git hash-object --stdin </dev/null | tr '[0-9a-f]' '0')
+if [ "$newrev" = "$zero" ]; then
+	newrev_type=delete
+else
+	newrev_type=$(git cat-file -t $newrev)
+fi
+
+case "$refname","$newrev_type" in
+	refs/tags/*,commit)
+		# un-annotated tag
+		short_refname=${refname##refs/tags/}
+		if [ "$allowunannotated" != "true" ]; then
+			echo "*** The un-annotated tag, $short_refname, is not allowed in this repository" >&2
+			echo "*** Use 'git tag [ -a | -s ]' for tags you want to propagate." >&2
+			exit 1
+		fi
+		;;
+	refs/tags/*,delete)
+		# delete tag
+		if [ "$allowdeletetag" != "true" ]; then
+			echo "*** Deleting a tag is not allowed in this repository" >&2
+			exit 1
+		fi
+		;;
+	refs/tags/*,tag)
+		# annotated tag
+		if [ "$allowmodifytag" != "true" ] && git rev-parse $refname > /dev/null 2>&1
+		then
+			echo "*** Tag '$refname' already exists." >&2
+			echo "*** Modifying a tag is not allowed in this repository." >&2
+			exit 1
+		fi
+		;;
+	refs/heads/*,commit)
+		# branch
+		if [ "$oldrev" = "$zero" -a "$denycreatebranch" = "true" ]; then
+			echo "*** Creating a branch is not allowed in this repository" >&2
+			exit 1
+		fi
+		;;
+	refs/heads/*,delete)
+		# delete branch
+		if [ "$allowdeletebranch" != "true" ]; then
+			echo "*** Deleting a branch is not allowed in this repository" >&2
+			exit 1
+		fi
+		;;
+	refs/remotes/*,commit)
+		# tracking branch
+		;;
+	refs/remotes/*,delete)
+		# delete tracking branch
+		if [ "$allowdeletebranch" != "true" ]; then
+			echo "*** Deleting a tracking branch is not allowed in this repository" >&2
+			exit 1
+		fi
+		;;
+	*)
+		# Anything else (is there anything else?)
+		echo "*** Update hook: unknown type of update to ref $refname of type $newrev_type" >&2
+		exit 1
+		;;
+esac
+
+# --- Finished
+exit 0

test/assets/mailmaprepo/.gitdir/info/exclude

@@ -0,0 +1,6 @@
+# git ls-files --others --exclude-from=.git/info/exclude
+# Lines that start with '#' are comments.
+# For a project mostly in C, the following would be a good set of
+# exclude patterns (uncomment them if you want to use them):
+# *.[oa]
+# *~

test/assets/mailmaprepo/.gitdir/logs/HEAD

@@ -0,0 +1,12 @@
+0000000000000000000000000000000000000000 f17d0d48eae3aa08cecf29128a35e310c97b3521 Aleksey Kulikov <skinny.mind@gmail.com> 1626090830 +0300	commit (initial): init
+f17d0d48eae3aa08cecf29128a35e310c97b3521 f17d0d48eae3aa08cecf29128a35e310c97b3521 Aleksey Kulikov <skinny.mind@gmail.com> 1626090891 +0300	checkout: moving from master to feature
+f17d0d48eae3aa08cecf29128a35e310c97b3521 6cbc22e509d72758ab4c8d9f287ea846b90c448b Aleksey Kulikov <skinny.mind@gmail.com> 1626091020 +0300	commit: add feature file
+6cbc22e509d72758ab4c8d9f287ea846b90c448b fc38877b2552ab554752d9a77e1f48f738cca79b Aleksey Kulikov <skinny.mind@gmail.com> 1626091054 +0300	commit: edit feature file
+fc38877b2552ab554752d9a77e1f48f738cca79b f17d0d48eae3aa08cecf29128a35e310c97b3521 Aleksey Kulikov <skinny.mind@gmail.com> 1626091067 +0300	checkout: moving from feature to master
+f17d0d48eae3aa08cecf29128a35e310c97b3521 c68ff54aabf660fcdd9a2838d401583fe31249e3 Aleksey Kulikov <skinny.mind@gmail.com> 1626091171 +0300	commit: add .gitignore
+c68ff54aabf660fcdd9a2838d401583fe31249e3 78b8bf123e3952c970ae5c1ce0a3ea1d1336f6e8 Aleksey Kulikov <skinny.mind@gmail.com> 1626091184 +0300	merge feature: Merge made by the 'recursive' strategy.
+78b8bf123e3952c970ae5c1ce0a3ea1d1336f6e8 fc38877b2552ab554752d9a77e1f48f738cca79b Aleksey Kulikov <skinny.mind@gmail.com> 1626091245 +0300	checkout: moving from master to feature
+fc38877b2552ab554752d9a77e1f48f738cca79b 5aecfa0fb97eadaac050ccb99f03c3fb65460ad4 Aleksey Kulikov <skinny.mind@gmail.com> 1626091274 +0300	commit: add another feature file
+5aecfa0fb97eadaac050ccb99f03c3fb65460ad4 78b8bf123e3952c970ae5c1ce0a3ea1d1336f6e8 Aleksey Kulikov <skinny.mind@gmail.com> 1626091285 +0300	checkout: moving from feature to master
+78b8bf123e3952c970ae5c1ce0a3ea1d1336f6e8 821ed6e80627b8769d170a293862f9fc60825226 Aleksey Kulikov <skinny.mind@gmail.com> 1630568461 +0300	commit: add subdirectory file
+821ed6e80627b8769d170a293862f9fc60825226 140f93d01f89bf9904bc38dccc8f5b6c1148af34 Aleksey Kulikov <skinny.mind@gmail.com> 1633534458 +0300	commit: add .mailmap

test/assets/mailmaprepo/.gitdir/logs/refs/heads/feature

@@ -0,0 +1,4 @@
+0000000000000000000000000000000000000000 f17d0d48eae3aa08cecf29128a35e310c97b3521 Aleksey Kulikov <skinny.mind@gmail.com> 1626090891 +0300	branch: Created from HEAD
+f17d0d48eae3aa08cecf29128a35e310c97b3521 6cbc22e509d72758ab4c8d9f287ea846b90c448b Aleksey Kulikov <skinny.mind@gmail.com> 1626091020 +0300	commit: add feature file
+6cbc22e509d72758ab4c8d9f287ea846b90c448b fc38877b2552ab554752d9a77e1f48f738cca79b Aleksey Kulikov <skinny.mind@gmail.com> 1626091054 +0300	commit: edit feature file
+fc38877b2552ab554752d9a77e1f48f738cca79b 5aecfa0fb97eadaac050ccb99f03c3fb65460ad4 Aleksey Kulikov <skinny.mind@gmail.com> 1626091274 +0300	commit: add another feature file

test/assets/mailmaprepo/.gitdir/logs/refs/heads/master

@@ -0,0 +1,5 @@
+0000000000000000000000000000000000000000 f17d0d48eae3aa08cecf29128a35e310c97b3521 Aleksey Kulikov <skinny.mind@gmail.com> 1626090830 +0300	commit (initial): init
+f17d0d48eae3aa08cecf29128a35e310c97b3521 c68ff54aabf660fcdd9a2838d401583fe31249e3 Aleksey Kulikov <skinny.mind@gmail.com> 1626091171 +0300	commit: add .gitignore
+c68ff54aabf660fcdd9a2838d401583fe31249e3 78b8bf123e3952c970ae5c1ce0a3ea1d1336f6e8 Aleksey Kulikov <skinny.mind@gmail.com> 1626091184 +0300	merge feature: Merge made by the 'recursive' strategy.
+78b8bf123e3952c970ae5c1ce0a3ea1d1336f6e8 821ed6e80627b8769d170a293862f9fc60825226 Aleksey Kulikov <skinny.mind@gmail.com> 1630568461 +0300	commit: add subdirectory file
+821ed6e80627b8769d170a293862f9fc60825226 140f93d01f89bf9904bc38dccc8f5b6c1148af34 Aleksey Kulikov <skinny.mind@gmail.com> 1633534458 +0300	commit: add .mailmap

test/assets/mailmaprepo/.gitdir/logs/refs/notes/commits

@@ -0,0 +1,2 @@
+0000000000000000000000000000000000000000 af1bbb249ea750bbfa66c1e7fd879622c2dbfe3a Aleksey Kulikov <skinny.mind@gmail.com> 1633093379 +0300	notes: Notes added by 'git notes add'
+af1bbb249ea750bbfa66c1e7fd879622c2dbfe3a 00eb1490ff4e39fa29c0ef352a9f93989b7018f8 Aleksey Kulikov <skinny.mind@gmail.com> 1633093431 +0300	notes: Notes added by 'git notes add'

test/assets/mailmaprepo/.gitdir/objects/5a/ecfa0fb97eadaac050ccb99f03c3fb65460ad4

@@ -0,0 +1,3 @@
+x
¥ÎMNÄ0@aÖ9…÷H£ü6±„¬9…;LÔ¦A<C2A6>inOïÀö->½2zol0/ó<10>äl­ˆ&k¬AÄ1j.Þ/œ‹&´˜PýÐ!û„Z\J1f‚¥‚<>Á2RŒbªO5ºT
+EÌŠÎy|n²>ä	_çÖÖño<>µíûóÖÛÎß<>Úv+£¿ƒYì¢ÑØèáU;­ÕU¯Ñ)ÿ 1ícÞ/¥
+Íó¨mõc¯Q²

test/assets/mailmaprepo/.gitdir/objects/82/1ed6e80627b8769d170a293862f9fc60825226

@@ -0,0 +1 @@
+x
¥ΞAnΓ Fα®9Εμ#EƒΗ`,EU»ξ)0ό΄ΘΖTGςν›;tϋ<16>^¨¥δNΓθήzΘ;‰ΡΜ°Π<C2B0>‡`ΣδΐΒzIΡLaN"cRΏΎaο4ΉΕ-I™Νζ‰=LΠ
μ^G-b“…Sώμ?µΡη†υΐE_η–Χϊ¤Η±ζ}Ώξ%οργ»ψΌέC-ο¤­°±n΄<6E>n,ΜκU_£<1D> ”<>‘<EFBFBD>s‰Ή!τΪ.Jyƒϊy<>Pα

test/assets/mailmaprepo/.gitdir/objects/c6/8ff54aabf660fcdd9a2838d401583fe31249e3

@@ -0,0 +1 @@
+x
¥ÎAnà @Ñ®9Åì+Y3€
HQÕ®{Š
Æ.²<>È!•rûäÙþÅÓO½Ö2@[ú§k´Gɉq66¬1¡×~áèç<18>$ëÄ,„Q]ù”6`%—1[/,†}’´ê@Ú³™Å¦à¢™5)¾<>¿~ÂÏ!ûMð{?ÊÞÿárÛKk<4B>©––¿·Êå˜R¯_@‹^09‚O4ˆêU_£CÞ çÓVFÙZ?E=
Ý<Mj

test/assets/mailmaprepo/.gitdir/objects/fc/38877b2552ab554752d9a77e1f48f738cca79b

@@ -0,0 +1 @@
+x
¥<>KnΓ0³Φ)ΈΠ4υ‚Ά]χϊP<CF8A>`Λ.l9€o_ί΅Ϋ·<CEAB>™—ΦΦjbΎυMΨfΦ%<0E>#<19>µ+h¬σVƒΗ!Za²κ7l²t0)&"Ρθ³%«]<5D><>\φ…<CF86>•ΰΨD<CEA8>‰ΩE<15>ώZ7ψ<37>eΪε„οc®Σϊ†η>Υe9­.ωσ§…:?<3F>Ϊ>`0tιΤwΥµ^΅]ώ<>P’―«EB?6<>RgQϋM§

test/assets/mailmaprepo/.gitdir/refs/heads/feature

@@ -0,0 +1 @@
+5aecfa0fb97eadaac050ccb99f03c3fb65460ad4

test/assets/mailmaprepo/.gitdir/refs/heads/master

@@ -0,0 +1 @@
+140f93d01f89bf9904bc38dccc8f5b6c1148af34

test/assets/mailmaprepo/.gitdir/refs/notes/commits

@@ -0,0 +1 @@
+00eb1490ff4e39fa29c0ef352a9f93989b7018f8

test/assets/mailmaprepo/.gitdir/refs/tags/v0.1

@@ -0,0 +1 @@
+78b8bf123e3952c970ae5c1ce0a3ea1d1336f6e8

test/assets/mailmaprepo/.gitdir/refs/tags/v0.2

@@ -0,0 +1 @@
+f0fdbf506397e9f58c59b88dfdd72778ec06cc0c

test/assets/mailmaprepo/.mailmap

@@ -0,0 +1,8 @@
+# Simple Comment line
+<cto@company.xx>                       <cto@coompany.xx>
+Some Dude <some@dude.xx>         nick1 <bugs@company.xx>
+Other Author <other@author.xx>    nick2 <bugs@company.xx>
+Other Author <other@author.xx>         <nick2@company.xx>
+Phil Hill <phil@company.xx>  # Comment at end of line
+<joseph@company.xx>             Joseph <bugs@company.xx>
+Santa Claus <santa.claus@northpole.xx> <me@company.xx>

test/assets/mailmaprepo/feature_file

@@ -0,0 +1 @@
+Feature edit

test/assets/mailmaprepo/gitignore

@@ -0,0 +1 @@
+*.swp

test/describe_test.dart

@@ -1,5 +1,4 @@
 import 'dart:io';
-import 'package:libgit2dart/src/git_types.dart';
 import 'package:test/test.dart';
 import 'package:libgit2dart/libgit2dart.dart';
 import 'helpers/util.dart';

test/mailmap_test.dart

@@ -0,0 +1,210 @@
+import 'dart:io';
+import 'package:test/test.dart';
+import 'package:libgit2dart/libgit2dart.dart';
+import 'helpers/util.dart';
+
+void main() {
+  const testMailmap = """
+# Simple Comment line
+<cto@company.xx>                       <cto@coompany.xx>
+Some Dude <some@dude.xx>         nick1 <bugs@company.xx>
+Other Author <other@author.xx>    nick2 <bugs@company.xx>
+Other Author <other@author.xx>         <nick2@company.xx>
+Phil Hill <phil@company.xx>  # Comment at end of line
+<joseph@company.xx>             Joseph <bugs@company.xx>
+Santa Claus <santa.claus@northpole.xx> <me@company.xx>
+""";
+
+  const testEntries = [
+    {
+      'realName': null,
+      'realEmail': "cto@company.xx",
+      'name': null,
+      'email': "cto@coompany.xx",
+    },
+    {
+      'realName': "Some Dude",
+      'realEmail': "some@dude.xx",
+      'name': "nick1",
+      'email': "bugs@company.xx",
+    },
+    {
+      'realName': "Other Author",
+      'realEmail': "other@author.xx",
+      'name': "nick2",
+      'email': "bugs@company.xx",
+    },
+    {
+      'realName': "Other Author",
+      'realEmail': "other@author.xx",
+      'name': null,
+      'email': "nick2@company.xx",
+    },
+    {
+      'realName': "Phil Hill",
+      'realEmail': null,
+      'name': null,
+      'email': "phil@company.xx",
+    },
+    {
+      'realName': null,
+      'realEmail': "joseph@company.xx",
+      'name': "Joseph",
+      'email': "bugs@company.xx",
+    },
+    {
+      'realName': "Santa Claus",
+      'realEmail': "santa.claus@northpole.xx",
+      'name': null,
+      'email': "me@company.xx",
+    },
+  ];
+
+  const testResolve = [
+    {
+      'realName': "Brad",
+      'realEmail': "cto@company.xx",
+      'name': "Brad",
+      'email': "cto@coompany.xx",
+    },
+    {
+      'realName': "Brad L",
+      'realEmail': "cto@company.xx",
+      'name': "Brad L",
+      'email': "cto@coompany.xx",
+    },
+    {
+      'realName': "Some Dude",
+      'realEmail': "some@dude.xx",
+      'name': "nick1",
+      'email': "bugs@company.xx",
+    },
+    {
+      'realName': "Other Author",
+      'realEmail': "other@author.xx",
+      'name': "nick2",
+      'email': "bugs@company.xx",
+    },
+    {
+      'realName': "nick3",
+      'realEmail': "bugs@company.xx",
+      'name': "nick3",
+      'email': "bugs@company.xx",
+    },
+    {
+      'realName': "Other Author",
+      'realEmail': "other@author.xx",
+      'name': "Some Garbage",
+      'email': "nick2@company.xx",
+    },
+    {
+      'realName': "Phil Hill",
+      'realEmail': "phil@company.xx",
+      'name': "unknown",
+      'email': "phil@company.xx",
+    },
+    {
+      'realName': "Joseph",
+      'realEmail': "joseph@company.xx",
+      'name': "Joseph",
+      'email': "bugs@company.xx",
+    },
+    {
+      'realName': "Santa Claus",
+      'realEmail': "santa.claus@northpole.xx",
+      'name': "Clause",
+      'email': "me@company.xx",
+    },
+    {
+      'realName': "Charles",
+      'realEmail': "charles@charles.xx",
+      'name': "Charles",
+      'email': "charles@charles.xx",
+    },
+  ];
+
+  late Repository repo;
+  late Directory tmpDir;
+
+  setUp(() async {
+    tmpDir = await setupRepo(Directory('test/assets/mailmaprepo/'));
+    repo = Repository.open(tmpDir.path);
+  });
+
+  tearDown(() async {
+    repo.free();
+    await tmpDir.delete(recursive: true);
+  });
+
+  group('Mailmap', () {
+    test('successfully initializes', () {
+      final empty = Mailmap.empty();
+      expect(empty, isA<Mailmap>());
+
+      empty.free();
+    });
+
+    test('successfully initializes from provided buffer', () {
+      final mailmap = Mailmap.fromBuffer(testMailmap);
+      expect(mailmap, isA<Mailmap>());
+
+      for (var entry in testResolve) {
+        expect(
+          mailmap.resolve(name: entry['name']!, email: entry['email']!),
+          [entry['realName'], entry['realEmail']],
+        );
+      }
+
+      mailmap.free();
+    });
+
+    test('successfully initializes from repository', () {
+      final mailmap = Mailmap.fromRepository(repo);
+      expect(mailmap, isA<Mailmap>());
+
+      for (var entry in testResolve) {
+        expect(
+          mailmap.resolve(name: entry['name']!, email: entry['email']!),
+          [entry['realName'], entry['realEmail']],
+        );
+      }
+
+      mailmap.free();
+    });
+
+    test('successfully resolves names and emails when mailmap is empty', () {
+      final mailmap = Mailmap.empty();
+
+      for (var entry in testResolve) {
+        expect(
+          mailmap.resolve(name: entry['name']!, email: entry['email']!),
+          [entry['name'], entry['email']],
+        );
+      }
+
+      mailmap.free();
+    });
+
+    test('successfully adds entries and resolves them', () {
+      final mailmap = Mailmap.empty();
+
+      for (var entry in testEntries) {
+        mailmap.addEntry(
+          realName: entry['realName'],
+          realEmail: entry['realEmail'],
+          replaceName: entry['name'],
+          replaceEmail: entry['email']!,
+        );
+      }
+
+      for (var entry in testResolve) {
+        expect(
+          mailmap.resolve(name: entry['name']!, email: entry['email']!),
+          [entry['realName'], entry['realEmail']],
+        );
+      }
+
+      mailmap.free();
+    });
+  });
+}