git-reviewer 0.1.0

data/lib/gitreviewer/analyze/builder.rb

@@ -0,0 +1,141 @@
+require 'open3'
+require_relative 'blame_tree'
+require_relative '../utils/printer'
+require_relative '../utils/checker'
+require_relative '../algorithm/myers'
+
+module GitReviewer
+  class Builder
+    attr_accessor :source_branch         # source branch
+    attr_accessor :target_branch
+    attr_accessor :source_blame          # BlameBranch
+    attr_accessor :target_blame          # BlameBranch
+
+    attr_accessor :diff_files                # Array<DiffFiles>
+
+    def initialize(source_branch, target_branch)
+      @source_branch = source_branch
+      @target_branch = target_branch
+    end
+
+    def build
+      # 遍历分支改动的每个文件，得到 BlameFile 数组
+      files = Checker.diff_files(@source_branch, @target_branch)
+      header_length = 0
+
+      if files == nil || files.count == 0
+        Printer.warning "Warning: there are no analyzable differences between the target branch and source branch."
+        exit 0
+      else
+        header = "============ Diff files between source<#{@source_branch}> and target<#{@target_branch}> ============"
+        header_length = header.length
+        footer = "=" * header_length
+
+        Printer.verbose_put header
+        Printer.verbose_put files
+        Printer.verbose_put footer
+        Printer.verbose_put "\n"
+      end
+
+      # 构建 source branch 的 BlameBranch
+      source_header_title = " Source Blame Files "
+      target_header_title = " Target Blame Files "
+      source_prefix_length = (header_length - source_header_title.length) / 2
+      target_prefix_length = (header_length - target_header_title.length) / 2
+      source_header = "=" * source_prefix_length + source_header_title + "=" * (header_length - source_prefix_length - source_header_title.length)
+      target_header = "=" * target_prefix_length + target_header_title + "=" * (header_length - target_prefix_length - target_header_title.length)
+      footer = "=" * header_length
+
+      # 打印 source branch Log
+      Printer.verbose_put source_header
+      files.each do |file_name|
+        Printer.verbose_put "#{file_name}"
+      end
+      Printer.verbose_put footer
+      Printer.verbose_put "\n"
+
+      # 打印 target branch Log
+      Printer.verbose_put target_header
+      files.each do |file_name|
+        Printer.verbose_put "#{file_name}"
+      end
+      Printer.verbose_put footer
+      Printer.verbose_put "\n"
+
+      # 构建 source branch & target branch
+      @source_blame = blame_branch(@source_branch, files)
+      @target_blame = blame_branch(@target_branch, files)
+
+      # 构建 diff_files
+      @diff_files = []
+      @source_blame.blame_files.each_with_index do |sfile, index|
+        tfile = @target_blame.blame_files[index]
+        # Diff 时需要交换 tfile 和 sfile
+        myers = Myers.new(tfile, sfile)
+        @diff_files.append(myers.resolve)
+      end
+
+      # 打印 Code Diff
+
+    end
+
+    def blame_branch(branch, files)
+      blame_files = []
+      files.each do |file_name|
+        bf = BlameFile.new("", [], false, false)
+
+        if Checker.is_file_exist?(branch, file_name) then
+          if Checker.is_file_binary?(branch, file_name)
+            bf = BlameFile.new(file_name, [], true, true)
+          else
+            bf = blame_file(branch, file_name)
+          end
+        else
+          bf = BlameFile.new(file_name, [], false, false)
+        end
+        blame_files.append(bf)
+      end
+      result = BlameBranch.new(branch, blame_files)
+      return result
+    end
+
+    def blame_file(branch, file_name)
+      blame_lines = []
+      content = Checker.snapshot_of_blame_file(branch, file_name)
+      # 遍历文件的每一行，得到 BlameLine 数组
+      content.lines do |line|
+        blame_lines.append(blame_line(line))
+      end
+
+      result = BlameFile.new(file_name, blame_lines, true, false)
+      return result
+    end
+
+    def blame_line(text)
+      # 获取哈希值
+      hash = text.slice!(0, 40)
+      rest = text.strip
+      # 移除 (
+      rest = rest[1..-1]
+      # 根据时间格式进行拆分
+      pattern = /\b\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2} [+-]\d{4}\b/
+      pattern_index = rest.index(pattern)
+      pattern_index = pattern_index + 25      # 2022-04-08 06:19:37 -0200 长度为 25
+      # 根据特定位置进行拆分
+      user_date = rest.slice(0, pattern_index)
+      rest = rest.slice(pattern_index , rest.length)
+      # user_date, rest = rest.split("+", 2)
+      user_date = user_date.strip
+      # 提取作者，日期。日期：提取倒数 19 个字符
+      date = user_date.slice!(-25, 25)
+      date = date.strip
+      user = user_date.strip
+      # # 提取行号，代码
+      line, code = rest.split(")", 2)
+      line = line.strip
+      # 结果
+      result = BlameLine.new(hash, user, date, line, code)
+      return result
+    end
+  end
+end

data/lib/gitreviewer/analyze/diff_tree.rb

@@ -0,0 +1,154 @@
+require_relative 'blame_tree'
+require_relative '../utils/printer'
+require 'terminal-table'
+
+module GitReviewer
+
+  class DiffFile
+    UNKNOWN = 0     # 未知情况，理论上不存在
+    DELETE = 1      # 删除文件
+    ADD = 2         # 新增文件
+    MODIFY = 3      # 修改文件
+
+    attr_accessor :operation
+    attr_accessor :file_name
+    attr_accessor :diff_lines
+
+    attr_writer :binary
+
+    def binary?
+      @binary
+    end
+
+    def initialize(file_name, diff_lines, operation, binary)
+      @file_name = file_name
+      @diff_lines = diff_lines
+      @operation = operation
+      @binary = binary
+    end
+
+    def print_meta_info
+      rows = [
+        ["filename", file_name],
+        ["operation", format_operation],
+        ["binary", binary?]
+      ]
+      table = Terminal::Table.new do |t|
+        t.rows = rows
+      end
+      Printer.verbose_put table
+    end
+
+    def format_property
+      result = ""
+      case @operation
+      when DiffFile::UNKNOWN
+        result += "operation: UNKNOWN \n"
+      when DiffFile::DELETE
+        result += "operation: DELETE \n"
+      when DiffFile::ADD
+        result += "operation: ADD \n"
+      when DiffFile::MODIFY
+        result += "operation: MODIFY \n"
+      end
+
+      if binary?
+        result += "binary: true \n"
+      else
+        result += "binary: false \n"
+      end
+      return result
+    end
+
+    def format_operation
+      case @operation
+      when DiffFile::UNKNOWN
+        return "UNKNOWN"
+      when DiffFile::DELETE
+        return "DELETE"
+      when DiffFile::ADD
+        return "ADD"
+      when DiffFile::MODIFY
+        return "MODIFY"
+      end
+    end
+
+    def format_file_name
+       return "filename: #{file_name}\n"
+    end
+
+    def format_line_diff
+      name_max_length = 0
+      result = []
+
+      diff_lines.each_with_index do |line, index|
+        name_max_length = [name_max_length, line.format_user.length].max
+
+        if line.is_unchange
+          if result.size == 0 || !result.last.is_unchange
+            result.append(line)
+          end
+        else
+          result.append(line)
+        end
+      end
+
+      name_max_length += 2
+
+      format_content = ""
+      result.each do |line|
+        if line.operation == DiffLine::DELETE
+          format_content += "\033[0;31m#{line.source_line.user.rjust(name_max_length)} #{line.source_line.format_line} - #{line.source_line.description}\033[0m\n"
+        elsif line.operation == DiffLine::ADD
+          format_content += "\033[0;32m#{line.target_line.user.rjust(name_max_length)} #{line.target_line.format_line} + #{line.target_line.description}\033[0m\n"
+        else
+          format_content += "...\n"
+        end
+      end
+
+      return format_content
+    end
+  end
+
+  class DiffLine
+    UNCHANGE = 0    # 未变化
+    DELETE = 1      # 删除行
+    ADD = 2         # 新增行
+
+    # 对于 UNCHANGE 操作，sLine 有值，tLine 有值
+    # 对于 DELETE 操作，sLine 有值，tLine 无值
+    # 对于 ADD 操作，sLine 无值，tLine 有值
+
+    attr_accessor :source_line        # 原始行, BlameLine
+    attr_accessor :target_line        # 目标行, BlameLine
+    attr_accessor :operation
+
+    def initialize(source_line, target_line, operation)
+      @source_line = source_line
+      @target_line = target_line
+      @operation = operation
+    end
+
+    def is_unchange
+      operation == UNCHANGE
+    end
+
+    def s_line_number
+      source_line.line
+    end
+
+    def t_line_number
+      target_line.line
+    end
+
+    def format_user
+      if operation == DiffLine::DELETE
+        return source_line.user
+      elsif operation == DiffLine::ADD
+        return target_line.user
+      else
+        return source_line.user
+      end
+    end
+  end
+end

data/lib/gitreviewer/analyze/result_item.rb

@@ -0,0 +1,31 @@
+require 'set'
+
+module GitReviewer
+  class ResultItem
+    attr_accessor :name
+    attr_accessor :file_count
+    attr_accessor :line_count
+
+    attr_accessor :file_names
+
+    def initialize(name)
+      @name = name
+      @file_count = 0
+      @line_count = 0
+      @file_names = Set.new
+    end
+
+    def add_file_name(name)
+      @file_names.add(name)
+      @file_count = file_names.count
+    end
+
+    def add_file_count(count)
+      @ile_count += count
+    end
+
+    def add_line_count(count)
+      @line_count += count
+    end
+  end
+end

data/lib/gitreviewer/command.rb

@@ -0,0 +1,112 @@
+require 'claide'
+require_relative './analyze/blame_tree'
+require_relative './analyze/builder'
+require_relative './analyze/analyzer'
+require_relative './algorithm/myers'
+require_relative './option/init_option'
+require_relative './utils/checker'
+require_relative './option/analyze_option'
+
+module GitReviewer
+
+  class Command < CLAide::Command
+
+    self.abstract_command = false
+
+    self.description = <<-DESC
+      git-reviewer is a git plugin used to analyze who should review a Merge Request or Pull Request, and more details related to code modifications.
+    DESC
+
+    self.command = 'git-reviewer'
+
+    def self.options
+      [
+        ['--init', 'Initialize the code review configuration file of the Git repository. It will generate a `gitreviewer.yml` file if needed.'],
+        ['--target', 'The target branch to be analyzed, which is the same as the target branch selected when creating a Merge Request or Pull Request.'],
+        ['--source', 'Optional, if not specified, the default is the current branch pointed to by Git HEAD. The source branch to be analyzed, which is the same as the source branch selected when creating a Merge Request or Pull Request. '],
+        ['--author', 'Only analyze relevant authors involved in code changes.'],
+        ['--reviewer', 'Only analyze suggested reviewers for code changes.'],
+    ].concat(super)
+    end
+
+    def initialize(argv)
+      @init = argv.flag?('init', false)
+      @target = argv.option('target')
+      @source = argv.option('source')
+      @analyze_reviewer = argv.flag?('reviewer', false)
+      @analyze_author = argv.flag?('author', false)
+      @version = argv.flag?('version', false)
+      super
+    end
+
+    def run
+      # 处理 help 选项
+      if @help_arg
+        help!
+        return
+      end
+
+      # 处理 version 选项
+      if @version
+        Printer.put "git-reviewer #{GitReviewer::VERSION}"
+        return
+      end
+
+      # 处理 init 选项
+      if @init
+        initOption = InitOption.new
+        initOption.execute
+        return
+      end
+
+      # 分析
+      analyze
+    end
+
+    def analyze
+      # 检查环境
+      if !Checker.is_git_repository_exist?
+        Printer.red "Error: git repository not exist. Please execute the command in the root director of a git repository."
+        exit 1
+      end
+      # 检查参数
+      if !@analyze_author && !@analyze_reviewer
+        # 如果两个选项均没有，则默认分析作者和审查者
+        @analyze_author = true
+        @analyze_reviewer = true
+      end
+      # 设置默认分支
+      if @source == nil
+        # 默认 source 为当前分支
+        @source = Checker.current_git_branch
+      end
+      if @target == nil
+        Printer.red "Error: target branch cannot be nil or empty. Please use `--target=<branch>` to specify the target branch."
+        exit 1
+      end
+
+      # 检查分支
+      if @source != nil && @target != nil
+        # source 分支
+        if !Checker.is_git_branch_exist?(@source)
+          Printer.red "Error: source branch `#{@source}` not exist."
+          exit 1
+        end
+        # target 分支
+        if !Checker.is_git_branch_exist?(@target)
+          Printer.red "Error: target branch `#{@target}` not exist."
+          exit 1
+        end
+        # source、target 判重
+        if @source == @target
+          Printer.red "Error: source branch and target branch should not be the same."
+          exit 1
+        end
+      end
+
+      # 执行分析
+      analyzeOption = AnalyzeOption.new(@source, @target, @analyze_author, @analyze_reviewer, @verbose)
+      analyzeOption.execute
+    end
+  end
+end

data/lib/gitreviewer/config/configuration.rb

@@ -0,0 +1,93 @@
+
+module GitReviewer
+  class Configuration
+    attr_accessor :project_owner                # String
+    attr_accessor :folder_owner                 # Array<FolderOwner>
+    attr_accessor :file_owner                   # Array<FileReOwner>
+    attr_accessor :ignore_files                 # Array<String>
+    attr_accessor :ignore_folders               # Array<String>
+
+    def initialize(project_owner, folder_owner, file_owner, ignore_files, ignore_folders)
+      @project_owner = project_owner
+      @folder_owner = folder_owner.map { |hash| FolderOwner.new(hash["path"], hash["owner"]) }
+      @file_owner = file_owner.map { |hash| FileOwner.new(hash["path"], hash["owner"]) }
+      @ignore_files = ignore_files
+      @ignore_folders = ignore_folders
+    end
+
+    def to_hash
+      {
+        project_owner: @project_owner,
+        folder_owner: @folder_owner.map(&:to_hash),
+        file_owner: @file_owner.map(&:to_hash),
+        ignore_files: @ignore_files,
+        ignore_folders: @ignore_folders
+      }
+    end
+
+    def is_ignore?(file_name)
+      if @ignore_files != nil && @ignore_files.include?(file_name)
+        return true
+      end
+      if @ignore_folders != nil && @ignore_folders.any?{ |folder| !folder.empty? && file_name.start_with?(folder) }
+        return true
+      end
+      return false
+    end
+
+    def reviewer_of_file(file_name)
+      if is_ignore?(file_name)
+        return nil
+      end
+
+      fowner = @file_owner.select { |owner| !owner.path.empty? && owner.path == file_name }.first
+      if fowner != nil && fowner.owner != nil
+        return fowner.owner
+      end
+
+      downer = @folder_owner.select { |owner| !owner.path.empty? && file_name.start_with?(owner.path) }.first
+      if downer != nil && downer.owner != nil
+        return downer.owner
+      end
+
+      if @project_owner == nil || @project_owner.empty?
+        return "<project owner>"
+      end
+      return @project_owner
+    end
+  end
+
+  class FileOwner
+    attr_accessor :path
+    attr_accessor :owner
+
+    def initialize(path, owner)
+      @path = path
+      @owner = owner
+    end
+
+    def to_hash
+      {
+        path: @path,
+        owner: @owner
+      }
+    end
+  end
+
+  class FolderOwner
+    attr_accessor :path
+    attr_accessor :owner
+
+    def initialize(path, owner)
+      @path = path
+      @owner = owner
+    end
+
+    def to_hash
+      {
+        path: @path,
+        owner: @owner
+      }
+    end
+  end
+end

data/lib/gitreviewer/option/analyze_option.rb

@@ -0,0 +1,85 @@
+require_relative '../analyze/analyzer'
+require 'terminal-table'
+
+module GitReviewer
+
+  class AnalyzeOption
+    attr_accessor :source
+    attr_accessor :target
+    attr_accessor :analyze_author
+    attr_accessor :analyze_reviewer
+
+
+    attr_accessor :analyzer
+
+    def initialize(source, target, analyze_author, analyze_reviewer, verbose)
+      @source = source
+      @target = target
+      @analyze_author = analyze_author
+      @analyze_reviewer = analyze_reviewer
+      @analyzer = Analyzer.new(source, target)
+      Printer.verbose = verbose
+    end
+
+    def execute
+      @analyzer.execute
+
+      if analyze_author
+        show_analyze_author
+      end
+
+      if analyze_reviewer
+        show_analyze_reviewer
+      end
+    end
+
+    def show_analyze_author
+      results = @analyzer.author_results.values
+      if results.size <= 0
+        return
+      end
+      results = results.sort_by { |item| item.line_count }.reverse
+      total_file = results.sum { |item| item.file_count }
+      total_line = results.sum { |item| item.line_count }
+      output_rows = []
+      results.each do |item|
+        file_ratio = item.file_count.to_f / total_file.to_f * 100
+        line_ratio = item.line_count.to_f / total_line.to_f * 100
+        output_rows << [item.name, item.file_count, "#{file_ratio.round(2)}%", item.line_count, "#{line_ratio.round(2)}%"]
+      end
+
+      table = Terminal::Table.new do |t|
+        t.title = "Relevant authors involved in code changes"
+        t.headings = ["Related Author", "File Count", "File Ratio", "Line Count", "Line Ratio"]
+        t.rows = output_rows
+      end
+      puts table
+      puts "\n"
+    end
+
+    def show_analyze_reviewer
+      results = @analyzer.reviewer_results.values
+      if results.size <= 0
+        return
+      end
+      results = results.sort_by { |item| item.line_count }.reverse
+      total_file = results.sum { |item| item.file_count }
+      total_line = results.sum { |item| item.line_count }
+      output_rows = []
+      results.each do |item|
+        file_ratio = item.file_count.to_f / total_file.to_f * 100
+        line_ratio = item.line_count.to_f / total_line.to_f * 100
+        output_rows << [item.name, item.file_count, "#{file_ratio.round(2)}%", item.line_count, "#{line_ratio.round(2)}%"]
+      end
+
+      table = Terminal::Table.new do |t|
+        t.title = "Suggested reviewers for code changes."
+        t.headings = ["Suggested Reviewer", "File Count", "File Ratio", "Line Count", "Line Ratio"]
+        t.rows = output_rows
+      end
+
+      puts table
+      puts "\n"
+    end
+  end
+end

data/lib/gitreviewer/option/init_option.rb

@@ -0,0 +1,57 @@
+require_relative '../config/configuration'
+require_relative '../utils/printer'
+require 'yaml'
+
+
+module GitReviewer
+
+  class InitOption
+    attr_accessor :fileExist
+
+    def execute
+      # 判断当前 .gitreviewer 文件是否存在
+      check_file_exist
+
+      # 如果不存在，则创建 .gitreviewer.yml
+      if !@fileExist
+        create_default_file
+      end
+    end
+
+    def check_file_exist
+      file_name = ".gitreviewer.yml"
+      @fileExist = File.exist?(file_name)
+      if @fileExist
+        Printer.yellow "`.gitreviewer.yml` already exists. Please do not init again."
+        exit 1
+      end
+    end
+
+    def create_default_file()
+      project_owner = "<project owner>"
+      folder_owner = FolderOwner.new("", "")
+      file_owner = FileOwner.new("", "")
+      config = Configuration.new(project_owner, [folder_owner], [file_owner], [""], [""])
+      data = config.to_hash
+      data = deep_transform_keys_to_strings(data)
+      yaml = YAML.dump(data)
+      head = "# `.gitreviewer.yml` is used for a git plugin: git-reviewer.\n# For detailed information about git-reviewer, please refer to https://github.com/baochuquan/git-reviewer\n"
+      content = head + yaml
+      File.open('.gitreviewer.yml', 'w') do |file|
+        file.write(content)
+      end
+      Printer.put "`.gitreviewer.yml` has been created. If you want to customize settings, please edit this file.\n"
+    end
+
+    def deep_transform_keys_to_strings(value)
+      case value
+      when Hash
+        value.transform_keys(&:to_s).transform_values { |v| deep_transform_keys_to_strings(v) }
+      when Array
+        value.map { |v| deep_transform_keys_to_strings(v) }
+      else
+        value  # 如果既不是哈希也不是数组，直接返回原值
+      end
+    end
+  end
+end