mailmap 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d659e60a379065bd575a324d915c318d797f23aecfddf90e9c06486c737813fd
-  data.tar.gz: 6fc69c39af05df32d2f21239f4aee331b50dae610b6e71aacaefbe21db3ce6c8
+  metadata.gz: 1236a9dbb2ff8d02ed3ba7a2929e4528ba188613ad2bcaa8f259f7072d02d795
+  data.tar.gz: f9ac429f3be5c2d76192dd4b193e4c40610ad46226c5461cc7fd1094e1647268
 SHA512:
-  metadata.gz: e5f8d9ed92f6e40525ee41c6b54fe459ea427c3df589e978a80b7a8dcbafbf91707c590e001493c31a71c3f98c600db058aef7580e2107e2ba3452fe20d5414b
-  data.tar.gz: '08d9415b709f531e9532bd89698a7a3cac9fdee485061a9ebd42d4daee32f17c2b39c674cde06f5cc0b460518d71ab04a96f9bd056b5509b4785878a477ff22b'
+  metadata.gz: 9cbaa85e7523f26fcc8774155f7b7468bf0e1cba53fa3ede308ca4af8f2d37fbe96980cc172ebfc6217da650dfca6640e2d9b27a9fee42738e29581003a1188d
+  data.tar.gz: d3e8d3d9055781eafa4aeb89feddac292974db35b380142e27d611a596a88db40abb6ba52121bf5ae1a610792c4e09d3feccb9934d1346822ee37adfed60bcfb

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Ryosuke Ito
+
+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,73 @@
+# mailmap
+
+[![Test](https://github.com/manicmaniac/mailmap/actions/workflows/main.yml/badge.svg)](https://github.com/manicmaniac/mailmap/actions/workflows/main.yml)
+[![Maintainability](https://api.codeclimate.com/v1/badges/d43e7ca25cb834a37a99/maintainability)](https://codeclimate.com/github/manicmaniac/mailmap/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/d43e7ca25cb834a37a99/test_coverage)](https://codeclimate.com/github/manicmaniac/mailmap/test_coverage)
+[![Gem Version](https://badge.fury.io/rb/mailmap.svg)](https://rubygems.org/gems/mailmap)
+
+Pure Ruby implementation of [Git mailmap](https://git-scm.com/docs/gitmailmap).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mailmap'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install mailmap
+
+## Usage
+
+```ruby
+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](https://www.rubydoc.info/gems/mailmap) for more information.
+
+## Command Line
+
+This gem includes command-line tool named `check-mailmap`.
+It is pure Ruby implementation of [`git check-mailmap`](https://git-scm.com/docs/git-check-mailmap) and is intended to be a drop-in replacement for `git check-mailmap`.
+
+```sh
+$ bundle exec check-mailmap --help
+usage: check-mailmap [<options>] <contact>...
+    -f, --file=FILE                  path to the .mailmap file (default: ./.mailmap)
+        --stdin                      also read contacts from stdin
+```
+
+## 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](https://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](https://opensource.org/licenses/MIT).

data/exe/check-mailmap

@@ -0,0 +1,50 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+
+require 'mailmap'
+require 'optparse'
+
+# An error raised when a contact cannot be parsed.
+class ContactParseError < StandardError
+  def initialize(contact)
+    super("fatal: unable to parse contact: #{contact}")
+  end
+end
+
+mailmap_path = '.mailmap'
+parser = OptionParser.new do |opts|
+  opts.banner = 'usage: check-mailmap [<options>] <contact>...'
+  opts.version = Mailmap::VERSION
+
+  opts.on('-f FILE', '--file=FILE', 'path to the .mailmap file (default: ./.mailmap)') do |file|
+    mailmap_path = file
+  end
+
+  opts.on('--stdin', 'also read contacts from stdin') do
+    ARGV.concat($stdin.readlines(chomp: true))
+  end
+end
+parser.parse!
+abort(parser.help) if ARGV.empty?
+
+begin
+  ARGV.each do |contact|
+    matched = contact.match(/^(?<name>.+?)?<(?<email>.+?)>$/)
+    raise ContactParseError, contact unless matched
+
+    commit_name_or_nil = matched[:name]&.strip
+    commit_email = matched[:email] or abort
+    mailmap = Mailmap::Map.load(mailmap_path)
+    proper_name, proper_email = mailmap.resolve(commit_name_or_nil, commit_email)
+    puts "#{proper_name} <#{proper_email}>".strip
+  rescue Mailmap::ParserError
+    puts "#{commit_name_or_nil} <#{commit_email}>".strip
+  end
+rescue ContactParseError => e
+  warn(e.message)
+  exit(128)
+rescue StandardError => e
+  abort("fatal: #{e.message}")
+end

data/lib/mailmap/map.rb

@@ -101,30 +101,44 @@ module Mailmap
       string.each_line.with_index(1) do |line, line_number|
         next if line.start_with?('#')
 
-        parse_name_and_email(line, line_number)
+        tokens = tokenize_name_and_email(line)
+        proper_name, proper_email, commit_name, commit_email = parse_name_and_email(tokens, line_number)
+        @map[commit_email.downcase][commit_name&.downcase] = [proper_name, proper_email]
       end
     end
 
-    def parse_name_and_email(line, line_number) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-      # @type var names: Array[String]
-      names = []
-      # @type var emails: Array[String]
-      emails = []
+    def tokenize_name_and_email(line)
+      # @type var tokens: Array[[Symbol, String]]
+      tokens = []
       scanner = StringScanner.new(line)
       2.times do
         scanner.skip(/\s+/)
-        scanner.scan(/[^<]+/).then { |s| names << s.rstrip if s }
-        scanner.skip(/</)
-        scanner.scan(/[^>]+/).then { |s| emails << s if s }
-        scanner.skip(/>/)
+        scanner.scan(/[^<]+/)&.then { |s| tokens << [:name, s.rstrip] }
+        scanner.scan(/<(.*?)>/)&.then { |s| tokens << [:email, unquote_email(s)] }
+        scanner.skip(/\s*#.*$/)
       end
-      commit_email = emails.pop&.downcase
-      raise ParserError, "Missing commit email at line #{line_number}" unless commit_email
+      tokens
+    end
+
+    PATTERNS = {
+      %i[name email] => %i[proper_name commit_email],
+      %i[email email] => %i[proper_email commit_email],
+      %i[name email email] => %i[proper_name proper_email commit_email],
+      %i[email name email] => %i[proper_email commit_name commit_email],
+      %i[name email name email] => %i[proper_name proper_email commit_name commit_email]
+    }.freeze
+    private_constant :PATTERNS
+
+    def parse_name_and_email(tokens, line_number)
+      types = tokens.map(&:first)
+      values = tokens.map(&:last)
+      fields = PATTERNS[types] or raise ParserError, "Invalid format at line #{line_number}"
+      entry = fields.zip(values).to_h
+      [entry[:proper_name], entry[:proper_email], entry[:commit_name], entry.fetch(:commit_email)]
+    end
 
-      proper_email = emails.pop
-      proper_name = names.shift
-      commit_name = names.shift&.downcase
-      @map[commit_email][commit_name] = [proper_name, proper_email]
+    def unquote_email(email)
+      email.delete_prefix('<').delete_suffix('>')
     end
   end
 end

data/lib/mailmap/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Mailmap
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/sig/_exe/check-mailmap.rbs

@@ -0,0 +1,3 @@
+class ContactParseError < StandardError
+  def initialize: (String contact) -> void
+end

data/sig/_test/exe/check_mailmap_compatibility_test.rbs

@@ -0,0 +1,5 @@
+class CheckMailmapCompatibilityTest < Minitest::Test
+  @mailmap: Tempfile
+
+  def check_mailmap: (*String args, ?mailmap_path: String?) -> [String, String, Integer?]
+end

data/sig/_test/exe/check_mailmap_test.rbs

@@ -0,0 +1,12 @@
+class CheckMailmapTest < Minitest::Test
+  private
+
+  EXECUTABLE_PATH: String
+
+  def check_mailmap: (*untyped args, ?mailmap_path: String?, ?stdin_data: String?) -> [String, String, Process::Status]
+end
+
+# https://github.com/ruby/rbs/blob/v3.8.1/stdlib/open3/0/open3.rbs
+module Open3
+  def self.capture3: (*untyped args) -> [String, String, Process::Status]
+end

data/sig/_test/lib/mailmap/map_test.rbs

@@ -0,0 +1,4 @@
+module Mailmap
+  class MapTest < Minitest::Test
+  end
+end

data/sig/_test/lib/mailmap_test.rbs

@@ -0,0 +1,2 @@
+class MailmapTest < Minitest::Test
+end

data/sig/lib/mailmap/map.rbs

@@ -0,0 +1,30 @@
+# TypeProf 0.21.2
+
+# Classes
+module Mailmap
+  class ParserError < StandardError
+  end
+
+  class Map
+    include Enumerable[[String?, String?, String?, String]]
+    @map: Hash[String, Hash[String?, [String?, String?]]]
+
+    def self.load: (String path) -> Map
+    alias self.parse self.new
+    def initialize: (String string) -> void
+    def each: ?{ (String?, String?, String?, String) -> void } -> (Enumerator[[String?, String?, String?, String], void] | Map)
+    def lookup: (String? commit_name_or_nil, String commit_email) -> [String?, String?]?
+    def resolve: (String commit_name_or_nil, String commit_email) -> [String, String]
+               | (nil commit_name_or_nil, String commit_email) -> [String?, String]
+               | (String? commit_name_or_nil, String commit_email) -> [String?, String]
+    def include_name?: (String name) -> bool
+    def include_email?: (String email) -> bool
+
+    private
+    def parse: (String string) -> void
+    def tokenize_name_and_email: (String line) -> Array[[Symbol, String]]
+    PATTERNS: Hash[Array[Symbol], Array[Symbol]]
+    def parse_name_and_email: (Array[[Symbol, String]] tokens, Integer line_number) -> [String?, String?, String?, String]
+    def unquote_email: (String email) -> String
+  end
+end

data/sig/lib/mailmap/version.rbs

@@ -0,0 +1,3 @@
+module Mailmap
+  VERSION: String
+end

metadata

@@ -1,33 +1,45 @@
 --- !ruby/object:Gem::Specification
 name: mailmap
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Ryosuke Ito
-autorequire:
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2023-03-29 00:00:00.000000000 Z
+date: 2025-02-09 00:00:00.000000000 Z
 dependencies: []
-description: Parser for Git Mailmap (.mailmap)
+description: |
+  A pure Ruby implementation of Git mailmap.
+  This library allows you to parse mailmap programmatically without depending on Git.
 email:
 - rito.0305@gmail.com
-executables: []
+executables:
+- check-mailmap
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE.txt
+- README.md
+- exe/check-mailmap
 - lib/mailmap.rb
 - lib/mailmap/map.rb
 - lib/mailmap/version.rb
+- sig/_exe/check-mailmap.rbs
+- sig/_test/exe/check_mailmap_compatibility_test.rbs
+- sig/_test/exe/check_mailmap_test.rbs
+- sig/_test/lib/mailmap/map_test.rbs
+- sig/_test/lib/mailmap_test.rbs
+- sig/lib/mailmap/map.rbs
+- sig/lib/mailmap/version.rbs
 homepage: https://github.com/manicmaniac/mailmap
 licenses:
 - MIT
 metadata:
-  rubygems_mfa_required: 'true'
+  bug_tracker_uri: https://github.com/manicmaniac/mailmap/issues
+  documentation_uri: https://www.rubydoc.info/gems/mailmap
   homepage_uri: https://github.com/manicmaniac/mailmap
-  source_code_uri: https://github.com/manicmaniac/mailmap
-post_install_message:
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -42,8 +54,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Parser for Git Mailmap (.mailmap)
 test_files: []