danger-mailmap 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1a6890a42c82be33ac74ca8bc09f3c1501d5ced1826a7683fbabfac5ed4d2fad
+  data.tar.gz: 12e2dca8b920de1bef3877252ca9211326b1f7321ae2522e5156751117e64605
+SHA512:
+  metadata.gz: de569e1756ca41037464fc4d5c9510bdf2cfc617c6d3f9b4edd10df5f9d76630a4311e0db56f3851299b9199e14e3a8eae1e6baa7ee87a6951c21482e41a400e
+  data.tar.gz: 2c9b4efb26ab04ff252be3047ac18e07f062e088b6ebf23942f252d301b88af34ddde43ed29eccd500f0271a16cf9352e17f304f576eacad5e50c19852fb572e

data/lib/danger_mailmap/gem_version.rb

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

data/lib/danger_mailmap/request_sources_refinements.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require 'danger'
+
+module DangerMailmap
+  # Collection of refinements of classes in {Danger::RequestSources}.
+  module RequestSourcesRefinements
+    refine Danger::RequestSources::BitbucketServer do
+      def base_branch
+        pr_json[:toRef][:id].sub('refs/heads/', '')
+      end
+
+      def head_branch
+        pr_json[:fromRef][:id].sub('refs/heads/', '')
+      end
+    end
+
+    refine Danger::RequestSources::GitHub do
+      def base_branch
+        pr_json['base']['ref']
+      end
+
+      def head_branch
+        pr_json['head']['ref']
+      end
+    end
+
+    refine Danger::RequestSources::VSTS do
+      def base_branch
+        pr_json[:targetRefName].sub('refs/heads/', '')
+      end
+
+      def head_branch
+        pr_json[:sourceRefName].sub('refs/heads/', '')
+      end
+    end
+
+    refine Danger::RequestSources::GitLab do
+      def base_branch
+        mr_json.source_branch
+      end
+
+      def head_branch
+        mr_json.target_branch
+      end
+    end
+
+    refine Danger::RequestSources::BitbucketCloud do
+      def base_branch
+        pr_json[:destination][:branch][:name]
+      end
+
+      def head_branch
+        pr_json[:source][:branch][:name]
+      end
+    end
+
+    refine Danger::RequestSources::LocalOnly do
+      def base_branch
+        commit = ci_source.base_commit
+        scm.exec("rev-parse --quiet --verify #{commit}").empty? ? nil : commit
+      end
+
+      def head_branch
+        commit = ci_source.head_commit
+        scm.exec("rev-parse --quiet --verify #{commit}").empty? ? nil : commit
+      end
+    end
+  end
+end

data/lib/danger_mailmap/suggestion_formatter.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require 'pathname'
+
+module DangerMailmap
+  # A class to format suggestion to fix warnings.
+  class SuggestionFormatter
+    using ::DangerMailmap::RequestSourcesRefinements
+
+    HOW_TO_FIX_URL = 'https://github.com/manicmaniac/danger-mailmap#how-to-fix'
+    private_constant :HOW_TO_FIX_URL
+
+    def initialize(request_source, git_working_dir)
+      @request_source = request_source
+      @git_working_dir = git_working_dir
+    end
+
+    def suggestion(path, emails)
+      <<~MARKDOWN
+        <blockquote>
+        <details><summary>If it is the first time for you to contribute to this repository, add your name and email to mailmap.</summary>
+
+        ```sh
+        #{mailmap_script(path, emails)}
+        ```
+
+        </details>
+
+        <details><summary>If you want to use another name and email, rewrite commits and push them.</summary>
+
+        ```sh
+        #{filter_branch_script(emails)}
+        ```
+
+        </details>
+
+        <details><summary>If you did not tell your name and email to Git, configure Git.</summary>
+
+        ```sh
+        git config --global user.email 'correct@example.com'
+        git config --global user.name 'Correct Name'
+        ```
+
+        </details>
+
+        Visit [#{HOW_TO_FIX_URL}](#{HOW_TO_FIX_URL}) for more information.
+        </blockquote>
+      MARKDOWN
+    end
+
+    def mailmap_script(path, emails)
+      path = git_relative_path(path)
+      emails.map { |email| "echo 'Correct Name <#{email}>' >> #{path}" }.join("\n")
+    end
+
+    def filter_branch_script(emails) # rubocop:disable Metrics/MethodLength
+      base = @request_source.base_branch || '"${BASE_COMMIT_HERE}"'
+      head = @request_source.head_branch || 'HEAD'
+      script = +"git filter-branch --env-filter '\n"
+      emails.each do |email|
+        script << indent(4, <<~SHELL)
+          if [ "$GIT_AUTHOR_EMAIL" = "#{email}" ]; then
+              GIT_AUTHOR_EMAIL="correct@example.com"
+              GIT_AUTHOR_NAME="Correct Name"
+          fi
+          if [ "$GIT_COMMITTER_EMAIL" = "#{email}" ]; then
+              GIT_COMMITTER_EMAIL="correct@example.com"
+              GIT_COMMITTER_NAME="Correct Name"
+          fi
+        SHELL
+      end
+      script << "' --tag-name-filter cat #{base}...#{head}"
+    end
+
+    private
+
+    def git_relative_path(path)
+      Pathname.new(path).relative_path_from(@git_working_dir).to_s
+    end
+
+    def indent(size, string)
+      string.lines.map { |line| (' ' * size) + line }.join
+    end
+  end
+end

data/lib/danger_plugin.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+require 'danger_mailmap/request_sources_refinements'
+require 'danger_mailmap/suggestion_formatter'
+require 'mailmap'
+require 'set'
+require 'shellwords'
+
+module Danger
+  # A Danger plugin to check if .mailmap has a canonical name of author and committer.
+  #
+  # @example Check all commits in the pull request against the top-level .mailmap.
+  #
+  #          mailmap.check
+  #
+  # @example Check against mailmap file in custom location with ignoring some users.
+  #
+  #          mailmap.allowed_patterns = [
+  #            /.+@(users\.noreply\.)?github\.com/,
+  #            'good@example.com'
+  #          ]
+  #          mailmap.check '/path/to/mailmap'
+  #
+  # @see  manicmaniac/danger-mailmap
+  # @tags git, mailmap
+  class DangerMailmap < Plugin
+    # Regular expression patterns of email where `danger-mailmap` does not warn like allow-list.
+    # If a string is set, it is considered as fixed pattern.
+    # @return [Array<String, Regexp>]
+    attr_accessor :allowed_patterns
+
+    # If `true`, `danger-mailmap` will add suggestion comments to a pull request (`true` by default).
+    # @return [Boolean]
+    attr_accessor :show_suggestion
+
+    def initialize(*args)
+      super(*args)
+      self.show_suggestion = true
+    end
+
+    # Check whether if an author of each commits has proper email.
+    #
+    # @param [String] path Path to .mailmap file (default $GIT_WORK_TREE/.mailmap).
+    # @return [void]
+    def check(path = nil)
+      path = path ? File.expand_path(path) : File.join(git_working_dir, '.mailmap')
+      mailmap = Mailmap::Map.load(path)
+      commits_by_emails = commits_by_unknown_emails(mailmap)
+      return if commits_by_emails.empty?
+
+      commits_by_emails.each { |email, commits| warn(format_warning(path, email, commits)) }
+      markdown(suggestion(path, commits_by_emails.keys)) if show_suggestion
+    end
+
+    private
+
+    def format_warning(path, email, commits)
+      revisions = commits.map(&:sha).join(', ')
+      "`#{email}` is not included in #{link_to(path)} (#{revisions})"
+    end
+
+    def git_working_dir
+      @git_working_dir ||= Dir.chdir(env.scm.folder) do
+        env.scm.exec('rev-parse --show-toplevel')
+      end
+    end
+
+    def git_relative_path(path)
+      Pathname.new(path).relative_path_from(git_working_dir).to_s
+    end
+
+    def link_to(path)
+      relative_path = git_relative_path(path)
+      scm_plugin = @dangerfile.respond_to?(danger.scm_provider) ? @dangerfile.public_send(danger.scm_provider) : nil
+      method_name = %i[markdown_link html_link].detect { |name| scm_plugin.respond_to?(name) }
+      method_name ? scm_plugin.public_send(method_name, relative_path, full_path: false) : relative_path
+    end
+
+    def commits_by_unknown_emails(mailmap)
+      commits_by_emails.reject { |email, _| allowed_patterns_include?(email) || mailmap.include_email?(email) }
+    end
+
+    def commits_by_emails
+      commits_by_emails = Hash.new do |hash, key|
+        hash[key] = Set.new
+      end
+      git.commits.each do |commit|
+        commits_by_emails[commit.author.email] << commit
+        commits_by_emails[commit.committer.email] << commit
+      end
+      commits_by_emails
+    end
+
+    def allowed_patterns_include?(email)
+      allowed_patterns&.any? do |pattern|
+        if pattern.is_a?(Regexp)
+          email =~ pattern
+        else
+          email == pattern
+        end
+      end
+    end
+
+    def suggestion(path, emails)
+      formatter = ::DangerMailmap::SuggestionFormatter.new(env.request_source, git_working_dir)
+      formatter.suggestion(path, emails)
+    end
+  end
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: danger-mailmap
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ryosuke Ito
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-12-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: danger-plugin-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: mailmap
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+description: A Danger plugin to check if .mailmap has a canonical name of author and
+  committer
+email:
+- rito.0305@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/danger_mailmap/gem_version.rb
+- lib/danger_mailmap/request_sources_refinements.rb
+- lib/danger_mailmap/suggestion_formatter.rb
+- lib/danger_plugin.rb
+homepage: https://github.com/manicmaniac/danger-mailmap
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+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: A Danger plugin to check if .mailmap has a canonical name of author and committer
+test_files: []