Project

mailmap

0.0
No release in over a year
Parser for Git Mailmap (.mailmap)
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies
 Project Readme

mailmap

Test Maintainability Test Coverage Gem Version

Pure Ruby implementation of Git mailmap.

Installation

Add this line to your application's Gemfile:

gem 'mailmap'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install mailmap

Usage

require 'mailmap'

# Load .mailmap file
mailmap = Mailmap::Map.load('.mailmap')

# Parse string
mailmap = Mailmap::Map.parse('Proper Name <proper@example.com> <commit@example.com>')

# Equivalent to git check-mailmap 'Commit Name' 'commit@example.com'
mailmap.resolve('Commit Name', 'commit@example.com') # => ['Proper Name', 'proper@example.com']

# Equivalent to git check-mailmap 'commit@example.com'
mailmap.resolve(nil, 'commit@example.com') # => [nil, 'proper@example.com']

# Similar to `Map#resolve` but returns nil if not found
mailmap.lookup('Nonexistent Name', 'nonexistent@example.com') #=> nil

See API reference for more information.

Development

After checking out the repo, run bundle install to install dependencies. Then, run rake test to run the tests.

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, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/manicmaniac/mailmap.

License

The gem is available as open source under the terms of the MIT License.