mailmap 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cdc12709b9e48412d76d01f4f75c018bb0822e6d3e25ced6527cdca9c507a97f
+  data.tar.gz: e3a713e40d6f7ae4134ac8c1021558e01aa23f9f3dae5fb039bfc724c6a648dd
+SHA512:
+  metadata.gz: df1d46c1608c78dae83f1359b13af597a24d11cf531d44bd4aa9d6f8fd71e1d89779ff3018f357d7bd17c46e628e985905a7906a593bf9e23f55af4dbcdee7e8
+  data.tar.gz: 1519019ddacc4d53af233a9638bbc7717df61a15457cbc88d356dc964c23c8608f0f4eb565e646f6b834ee2143643be3948e80def17195d669f4e090fbbc2c83

data/lib/mailmap/map.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+require 'strscan'
+
+module Mailmap
+  # This exception is raised if a parser error occurs.
+  class ParserError < StandardError
+  end
+
+  # A Map represents a .mailmap file.
+  class Map
+    extend Forwardable
+
+    def_delegators :each, *Enumerable.instance_methods(false)
+
+    class << self
+      # Load a mailmap file and return Map object.
+      #
+      # @param path [String] the path to .mailmap file
+      # @return [Map]
+      def load(path)
+        new(File.read(path))
+      end
+
+      alias parse new
+    end
+
+    # @param string [String] the string in .mailmap format
+    def initialize(string)
+      @map = Hash.new { |h, k| h[k] = {} }
+      parse(string)
+    end
+
+    def each
+      return enum_for(:each) 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]
+        end
+      end
+    end
+
+    # Look up the person's canonical name and email address.
+    # If found, return them; otherwise return nil.
+    #
+    # @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 [nil] if not found
+    def lookup(commit_name_or_nil, commit_email)
+      commit_name = commit_name_or_nil&.downcase
+      commit_email = commit_email.downcase
+      hash = @map[commit_email]
+      hash[commit_name] || hash[nil]
+    end
+
+    # 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
+    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
+      proper_email ||= commit_email
+      [proper_name, proper_email]
+    end
+
+    # Return true if the name is defined as either of proper or commit name, otherwise false.
+    # The comparison is case-insensitive.
+    #
+    # @param name [String] the name
+    # @return [Boolean]
+    def include_name?(name)
+      name = name.downcase
+      any? do |(proper_name, _proper_email, commit_name, _commit_email)|
+        proper_name.downcase == name || commit_name == name
+      end
+    end
+
+    # Return true if the email is defined as either of proper or commit email, otherwise false.
+    # The comparison is case-insensitive.
+    #
+    # @param email [String] the email
+    # @return [Boolean]
+    def include_email?(email)
+      email = email.downcase
+      any? do |(_proper_name, proper_email, _commit_name, commit_email)|
+        proper_email.downcase == email || commit_email == email
+      end
+    end
+
+    private
+
+    def parse(string)
+      string.each_line.with_index(1) do |line, line_number|
+        next if line.start_with?('#')
+
+        parse_name_and_email(line, line_number)
+      end
+    end
+
+    def parse_name_and_email(line, line_number) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+      names = []
+      emails = []
+      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(/>/)
+      end
+      raise ParserError, "Missing commit email at line #{line_number}" if emails.empty?
+
+      commit_email = emails.pop&.downcase
+      proper_email = emails.pop
+      proper_name = names.shift
+      commit_name = names.shift&.downcase
+      @map[commit_email][commit_name] = [proper_name, proper_email]
+    end
+  end
+end

data/lib/mailmap/version.rb

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

data/lib/mailmap.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'mailmap/map'
+require 'mailmap/version'

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: mailmap
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ryosuke Ito
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-12-05 00:00:00.000000000 Z
+dependencies: []
+description: Parser for Git Mailmap (.mailmap)
+email:
+- rito.0305@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/mailmap.rb
+- lib/mailmap/map.rb
+- lib/mailmap/version.rb
+homepage: https://github.com/manicmaniac/mailmap
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+  homepage_uri: https://github.com/manicmaniac/mailmap
+  source_code_uri: https://github.com/manicmaniac/mailmap
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: Parser for Git Mailmap (.mailmap)
+test_files: []