mailmap 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 584d60df1c3057edf1c979959458b13eb2dbceb6e9bbf3654bf0619c06446d86
-  data.tar.gz: 7608f1b15f967216efc0a5832e71fd569ea3873de42f2b3c228b02a52d1c2809
+  metadata.gz: 4eddd3d4d856573b2f0886a08f721b9743db7135db526e2931106827cd3fd3cd
+  data.tar.gz: d030d00fcaede82db18bd7978efa7c262344d2ed561dab7dc248c299935c45dd
 SHA512:
-  metadata.gz: 73665faa795d942fc8a5becca8607675b9750e095d7f46edcfc6a95e07c34f18feb9b4b8c698dfdcaf8d60df3afc74544d85a26b30a01c792e23db3bc3c334aa
-  data.tar.gz: bcb90879d1d7cda6ff780635d2c7e97a712ada42b9e7d00f4093214ed90ec337e903fc6ce7dae2ca31c8be644a033f1f5bdd2747f824dbc165c9a72f523c5352
+  metadata.gz: b8c963050607ed6da6240013aba42103c553b33cb490a58ba0f4ed147a3f54168f0796bdce4e96cc9b2f5e6aae2375c06ec48685aa2e57cae1d2c86dd08499c7
+  data.tar.gz: bf65c0613576ef87a0efe85bbdde22e4cf84036a5fc74a4bb11c4575914fab1e952d4c55a6c4b7a4abbb663894ea8450452bb1cba9e57847eaf87af215051665

data/lib/mailmap/map.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'forwardable'
 require 'strscan'
 
 module Mailmap
@@ -10,9 +9,7 @@ module Mailmap
 
   # A Map represents a .mailmap file.
   class Map
-    extend Forwardable
-
-    def_delegators :each, *Enumerable.instance_methods(false)
+    include Enumerable
 
     class << self
       # Load a mailmap file and return Map object.
@@ -28,18 +25,20 @@ module Mailmap
 
     # @param string [String] the string in .mailmap format
     def initialize(string)
+      # @type ivar @map: Hash[String, Hash[String?, String?]]
       @map = Hash.new { |h, k| h[k] = {} }
       parse(string)
     end
 
     def each
-      return enum_for(:each) unless block_given?
+      return enum_for unless block_given?
 
       @map.each do |commit_email, entries_by_commit_name|
         entries_by_commit_name.each do |commit_name, (proper_name, proper_email)|
-          yield [proper_name, proper_email, commit_name, commit_email]
+          yield proper_name, proper_email, commit_name, commit_email
         end
       end
+      self
     end
 
     # Look up the person's canonical name and email address.
@@ -47,7 +46,9 @@ module Mailmap
     #
     # @param commit_name_or_nil [String, nil] the name in commit or nil
     # @param commit_email [String] the name in commit
-    # @return [Array<String>] if found, a pair of proper name and email or nil
+    # @return [(String, String)] if found, a pair of proper name and email
+    # @return [(String, nil)] if only proper name is found
+    # @return [(nil, String)] if only proper email is found
     # @return [nil] if not found
     def lookup(commit_name_or_nil, commit_email)
       commit_name = commit_name_or_nil&.downcase
@@ -56,12 +57,13 @@ module Mailmap
       hash[commit_name] || hash[nil]
     end
 
-    # Like `git-check-mailmap` command, look up the person's canonical name and email address.
+    # Like +git-check-mailmap+ command, look up the person's canonical name and email address.
     # If found, return them; otherwise return the input as-is.
     #
     # @param commit_name_or_nil [String, nil] the name in commit or nil
     # @param commit_email [String] the email in commit
-    # @return [Array<String>] a pair of proper name and email
+    # @return [(String, String)] a pair of proper name and email
+    # @return [(nil, String)] if proper name is not found and +commit_name+ is not provided
     def resolve(commit_name_or_nil, commit_email)
       proper_name, proper_email = lookup(commit_name_or_nil, commit_email)
       proper_name ||= commit_name_or_nil
@@ -76,7 +78,7 @@ module Mailmap
     # @return [Boolean]
     def include_name?(name)
       name = name.downcase
-      any? do |(proper_name, _proper_email, commit_name, _commit_email)|
+      any? do |proper_name, _proper_email, commit_name, _commit_email|
         proper_name&.downcase == name || commit_name == name
       end
     end
@@ -88,7 +90,7 @@ module Mailmap
     # @return [Boolean]
     def include_email?(email)
       email = email.downcase
-      any? do |(_proper_name, proper_email, _commit_name, commit_email)|
+      any? do |_proper_name, proper_email, _commit_name, commit_email|
         proper_email&.downcase == email || commit_email == email
       end
     end
@@ -104,7 +106,9 @@ module Mailmap
     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 = []
       scanner = StringScanner.new(line)
       2.times do
@@ -114,9 +118,9 @@ module Mailmap
         scanner.scan(/[^>]+/).then { |s| emails << s if s }
         scanner.skip(/>/)
       end
-      raise ParserError, "Missing commit email at line #{line_number}" if emails.empty?
-
       commit_email = emails.pop&.downcase
+      raise ParserError, "Missing commit email at line #{line_number}" unless commit_email
+
       proper_email = emails.pop
       proper_name = names.shift
       commit_name = names.shift&.downcase

data/lib/mailmap/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailmap
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Ryosuke Ito
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-07 00:00:00.000000000 Z
+date: 2023-01-27 00:00:00.000000000 Z
 dependencies: []
 description: Parser for Git Mailmap (.mailmap)
 email: