git-reviewer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 26093e3ace921d56e1cc429eab08775761614af03564508982f0a5f2b1490b8b
+  data.tar.gz: f7caa02138858499bc212b4ecf3e34d4d66a6a5edb6b11c9a844716c757dc85d
+SHA512:
+  metadata.gz: d8dc85d6db503350493a26338cd55666486034a8de07eb630d566629b5267e0a10ef13190f460811a1b8c2ced1a221c6dbca95229aee26d5b324c917684b2edf
+  data.tar.gz: fdcefb88e454e9d49407475975454f25868f96fdd39ad041ef02fd3f9f5009cfdf82b8efcf5cdfe047988f2efe2dddf8ee2dcbddbb1016cece0eed948aa0b84b

data/.solargraph.yml

@@ -0,0 +1,33 @@
+---
+include:
+- "**/*.rb"
+exclude:
+- spec/**/*
+- test/**/*
+- vendor/**/*
+- ".bundle/**/*"
+require: []
+domains: []
+reporters:
+- rubocop
+- require_not_found
+formatter:
+  rubocop:
+    cops: safe
+    except: []
+    only: []
+    extra_args: []
+require_paths: []
+plugins: []
+max_files: 5000
+
+interpreter:
+  name: "ruby"
+  version: "2.6.3"
+
+require_paths:
+  - "lib"
+
+gems:
+  - "claide"
+  - "rspec"

data/.vscode/launch.json

@@ -0,0 +1,14 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "type": "rdbg",
+            "name": "Debug",
+            "request": "launch",
+            "cwd": "${workspaceFolder}",
+            "command": "bundle exec ruby",
+            "script": "${workspaceFolder}/exe/git-reviewer",
+            "args": ["--target=main", "--verbose"]
+        }
+    ]
+}

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+#source "https://rubygems.org"
+source "https://gems.ruby-china.com/"
+
+# Specify your gem's dependencies in git-reviewer.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem 'debug'
+gem "solargraph"
+gem "terminal-table"

data/Gemfile.lock

@@ -0,0 +1,109 @@
+PATH
+  remote: .
+  specs:
+    git-reviewer (0.1.0)
+      claide (~> 1.0.3)
+      terminal-table
+
+GEM
+  remote: https://gems.ruby-china.com/
+  specs:
+    ast (2.4.2)
+    backport (1.2.0)
+    benchmark (0.3.0)
+    claide (1.0.3)
+    debug (1.8.0)
+      irb (>= 1.5.0)
+      reline (>= 0.3.1)
+    diff-lcs (1.5.1)
+    e2mmap (0.1.0)
+    io-console (0.7.2)
+    irb (1.6.3)
+      reline (>= 0.3.0)
+    jaro_winkler (1.5.6)
+    json (2.7.1)
+    kramdown (2.4.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    nokogiri (1.13.10-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.13.10-x86_64-darwin)
+      racc (~> 1.4)
+    parallel (1.24.0)
+    parser (3.3.0.5)
+      ast (~> 2.4.1)
+      racc
+    racc (1.7.3)
+    rainbow (3.1.1)
+    rake (13.1.0)
+    rbs (2.8.4)
+    regexp_parser (2.9.0)
+    reline (0.5.0)
+      io-console (~> 0.5)
+    reverse_markdown (2.1.1)
+      nokogiri
+    rexml (3.2.6)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rubocop (1.50.2)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    solargraph (0.50.0)
+      backport (~> 1.2)
+      benchmark
+      bundler (~> 2.0)
+      diff-lcs (~> 1.4)
+      e2mmap
+      jaro_winkler (~> 1.5)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.1)
+      parser (~> 3.0)
+      rbs (~> 2.0)
+      reverse_markdown (~> 2.0)
+      rubocop (~> 1.38)
+      thor (~> 1.0)
+      tilt (~> 2.0)
+      yard (~> 0.9, >= 0.9.24)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    thor (1.3.1)
+    tilt (2.3.0)
+    unicode-display_width (2.5.0)
+    yard (0.9.36)
+
+PLATFORMS
+  arm64-darwin-22
+  x86_64-darwin-22
+
+DEPENDENCIES
+  debug
+  git-reviewer!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  solargraph
+  terminal-table
+
+BUNDLED WITH
+   2.3.9

data/README.md

@@ -0,0 +1,37 @@
+![](https://chuquan-public-r-001.oss-cn-shanghai.aliyuncs.com/sketch-images/git-reviewer-02.png)
+
+![Platform](http://img.shields.io/badge/platform-macOS-blue.svg?style=flat)
+![Platform](http://img.shields.io/badge/platform-Linux-blue.svg?style=flat)
+![Platform](http://img.shields.io/badge/platform-Windows-blue.svg?style=flat)
+![Language](http://img.shields.io/badge/language-ruby-brightgreen.svg?style=flat)
+![Tool](http://img.shields.io/badge/tool-homebrew-orange.svg?style=flat)
+![License](http://img.shields.io/badge/license-MIT-red.svg?style=flat)
+# Git::Reviewer
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/git/reviewer`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add git-reviewer
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install git-reviewer
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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/[USERNAME]/git-reviewer.

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/exe/git-reviewer

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/gitreviewer'
+
+GitReviewer::Command.run(ARGV)

data/lib/gitreviewer/algorithm/myers.rb

@@ -0,0 +1,169 @@
+require_relative '../analyze/blame_tree'
+require_relative '../analyze/diff_tree'
+
+module GitReviewer
+  class Myers
+    # Type: BlameFile
+    attr_accessor :source, :target
+
+    def initialize(source, target)
+      self.source = source
+      self.target = target
+    end
+
+    def resolve
+      # 字符串 a 和 b 的长度，分别为 n 和 m
+      m = source.blame_lines.count
+      n = target.blame_lines.count
+
+      # 用于存储每条 K 线上最佳位置的 Map
+      v = { 1 => 0 }
+      # 用于存储所有深度的所有最佳位置的 Map，用于回溯编辑路径
+      vs = { 0 => { 1 => 0 } }
+
+      loop do
+        # 外层循环，遍历深度
+        (0..m + n).each do |d|
+          tmp = {}
+          # 内层循环，宽度优先搜索，遍历 K 线
+          (-d..d).step(2) do |k|
+            down = ((k == -d) || ((k != d) && v[k + 1] > v[k - 1]))
+            k_prev = down ? k + 1 : k - 1
+            # 获取移动的起点位置
+            x_start = v[k_prev]
+            y_start = x_start - k_prev
+            # 获取移动一步的中间位置，向右或向下
+            x_mid = down ? x_start : x_start + 1
+            y_mid = x_mid - k
+            # 获取移动的终点位置，后续可能会向右下移动。
+            x_end = x_mid
+            y_end = y_mid
+
+            # 向右下移动，深度始终不变
+            while x_end < m && y_end < n && source.blame_lines[x_end] == target.blame_lines[y_end]
+              x_end += 1
+              y_end += 1
+            end
+
+            # 记录对应 K 线所能达到的最佳位置
+            v[k] = x_end
+
+            tmp[k] = x_end
+
+            # 如果两个字符串均到达末端，表示找到了终点，可以结束查找
+            if x_end == m && y_end == n
+              vs[d] = tmp
+              # 生成最短编辑路径
+              snakes = route(vs, m, n, d)
+              # 打印最短编辑路径
+              result = build_diff(snakes)
+              return result
+            end
+          end
+          # 记录深度为 D 的所有 K 线的最佳位置
+          vs[d] = tmp
+        end
+      end
+    end
+
+    def route(vs, m, n, d)
+      snakes = []
+      # 定义位置结构
+      pos = { x: m, y: n }
+
+      # 回溯最短编辑路径
+      while d > 0
+        v = vs[d]
+        v_prev = vs[d - 1]
+
+        k = pos[:x] - pos[:y]
+        # 判断之前位置到当前位置最开始移动的方式，向下或向右
+        down = ((k == -d) || ((k != d) && (v_prev[k + 1] > v_prev[k - 1])))
+        k_prev = down ? k + 1 : k - 1
+
+        # 当前位置
+        x_end = v[k]
+        y_end = x_end - k
+
+        # 之前位置
+        x_start = v_prev[k_prev]
+        y_start = x_start - k_prev
+
+        # 中间走斜线时的起始位置
+        x_mid = down ? x_start : x_start + 1
+        y_mid = x_mid - k
+
+        snakes.unshift([x_start, x_mid, x_end])
+
+        pos[:x] = x_start
+        pos[:y] = y_start
+
+        d -= 1
+      end
+      snakes
+    end
+
+    def build_diff(snakes)
+      diff_result = []
+      y_offset = 0
+
+      snakes.each_with_index do |snake, index|
+        s = snake[0]
+        m = snake[1]
+        e = snake[2]
+
+        # 如果是第一个差异，并且差异的开始点不是字符串头（即两字符串在开始部分有相同子字符串）
+        if index === 0 && s != 0
+          # 所有相同字符，直到s
+          (0..s - 1).each do |j|
+            diff_line = DiffLine.new(source.blame_lines[s], target.blame_lines[y_offset], DiffLine::UNCHANGE)
+            diff_result.append(diff_line)
+            y_offset += 1
+          end
+        end
+        if m - s == 1
+          # 用红色打印删除的字符
+          diff_line = DiffLine.new(source.blame_lines[s], nil, DiffLine::DELETE)
+          diff_result.append(diff_line)
+        else
+          # 用绿色打印插入的字符
+          diff_line = DiffLine.new(nil, target.blame_lines[y_offset], DiffLine::ADD)
+          diff_result.append(diff_line)
+          y_offset += 1
+        end
+        # 相同的字符
+        (0..e - m - 1).each do |i|
+          diff_line = DiffLine.new(source.blame_lines[s], target.blame_lines[y_offset], DiffLine::UNCHANGE)
+          diff_result.append(diff_line)
+          y_offset += 1
+        end
+      end
+
+      # 确定属性
+      operation = DiffFile::UNKNOWN
+      binary = false
+      if source.exist? && target.exist?
+        operation = DiffFile::MODIFY
+        binary = target.binary?
+      elsif source.exist? && !target.exist?
+        operation = DiffFile::DELETE
+        binary = source.binary?
+      elsif !source.exist? && target.exist?
+        operation = DiffFile::ADD
+        binary = target.binary?
+      else
+        operation = DiffFile::UNKNOWN
+        binary = false
+      end
+
+      # 确定结果
+      result = DiffFile.new(source.file_name, diff_result, operation, binary)
+
+      # # 打印内容
+      result.print_meta_info
+      Printer.verbose_put "#{result.format_line_diff}"
+
+      return result
+    end
+  end
+end

data/lib/gitreviewer/analyze/analyzer.rb

@@ -0,0 +1,172 @@
+require 'open3'
+require_relative 'blame_tree'
+require_relative 'builder'
+require_relative '../utils/printer'
+require_relative '../utils/checker'
+require_relative '../config/configuration'
+require_relative 'result_item'
+
+module GitReviewer
+
+
+  class Analyzer
+    attr_accessor :source_branch        # source branch
+    attr_accessor :target_branch        # target branch
+    attr_accessor :builder              # blame builder
+
+    attr_accessor :author_results       #
+    attr_accessor :reviewer_results     #
+    attr_accessor :configuration        # 配置信息 Configuration
+
+    def initialize(source_branch, target_branch)
+      @source_branch = source_branch
+      @target_branch = target_branch
+      @author_results = Hash.new
+      @reviewer_results = Hash.new
+    end
+
+
+    def setup_builder
+      # 构建 BlameTree
+      @builder = Builder.new(@source_branch, @target_branch)
+      @builder.build
+
+      if @builder.source_blame.blame_files.count == 0
+        Printer.warning "Warning: no blame file for source blame branch<#{@source_branch}>"
+        exit 1
+      end
+
+      if @builder.target_blame.blame_files.count == 0
+        Printer.warning "Warning: no blame file for target blame branch<#{@target_branch}>"
+        exit 1
+      end
+
+      if @builder.source_blame.blame_files.count != @builder.target_blame.blame_files.count
+        Printer.red "Error: internal error. The number of files is not equal."
+        exit 1
+      end
+
+      if @builder.diff_files == nil
+        Printer.red "Error: internal error. The diff files of builder is nil."
+        exit 1
+      end
+    end
+
+    def setup_configuration
+      file_name = ".gitreviewer.yml"
+      file_exist = File.exist?(file_name)
+      # 检测配置文件
+      if !file_exist
+        Printer.red "Error: `.gitreviewer.yml` not exist in current directory. Please execute `git reviewer --init` first."
+        exit 1
+      end
+      # 解析配置文件
+      data = YAML.load_file(file_name)
+      @configuration = Configuration.new(data['project_owner'], data['folder_owner'], data['file_owner'], data['ignore_files'], data['ignore_folders'])
+    end
+
+    def execute
+      setup_builder
+      setup_configuration
+      analyze_author
+      analyze_reviewer
+    end
+
+    def analyze_author
+      @builder.diff_files.each do |fdiff|
+        fdiff.diff_lines.each_with_index do |ldiff, index|
+        record_author(fdiff, ldiff)
+        end
+      end
+    end
+
+    def analyze_reviewer
+      @builder.diff_files.each do |fdiff|
+        reviewer = nil
+        lines = 0
+
+        # 其他操作按行计算权重
+        fdiff.diff_lines.each_with_index do |ldiff, index|
+          if ldiff.operation == DiffLine::DELETE
+            # 删除行: 由原作者 review
+            reviewer = ldiff.source_line.user
+            record_reviewer(fdiff, reviewer, 1)
+          elsif ldiff.operation == DiffLine::ADD
+            # 新增行
+            if reviewer != nil
+              # 紧随删除，由删除行的原作者 review
+              lines += 1
+            else
+              # 非紧随删除，由 configuration 决定谁来 review
+              reviewer = @configuration.reviewer_of_file(fdiff.file_name)
+            record_reviewer(fdiff, reviewer, 1)
+            end
+          else
+            # 未变化
+            if reviewer != nil
+              # 处理编辑类型
+              record_reviewer(fdiff, reviewer, lines)
+              reviewer = nil
+              lines = 0
+            end
+          end
+
+          # 最后一行
+          if index == fdiff.diff_lines.count - 1 && reviewer != nil
+            record_reviewer(fdiff, reviewer, lines)
+          end
+        end
+      end
+    end
+
+    def record_author(fdiff, ldiff)
+      file_name = fdiff.file_name
+      if @configuration.is_ignore?(file_name)
+        return
+      end
+
+      author = ""
+      if ldiff.operation == DiffLine::DELETE
+        # 删除类型，记录为原始作者
+        author = ldiff.source_line.user
+      else
+        # 新增类型，记录为最新作者
+        author = ldiff.target_line.user
+      end
+
+      item = @author_results[author]
+      if item == nil
+        item = ResultItem.new(author)
+      end
+      item.add_file_name(file_name)
+      item.add_line_count(1)
+      @author_results[author] = item
+    end
+
+    def record_reviewer(fdiff, reviewer, lines)
+      if reviewer == nil
+        return
+      end
+      file_name = fdiff.file_name
+      if @configuration.is_ignore?(file_name)
+        return
+      end
+
+      item = @reviewer_results[reviewer]
+      if item == nil
+        item = ResultItem.new(reviewer)
+      end
+      item.add_file_name(file_name)
+      item.add_line_count(lines)
+      @reviewer_results[reviewer] = item
+    end
+
+    def print_author_result
+      print @author_results
+    end
+
+    def print_reviewer_result
+      print @reviewer_results
+    end
+  end
+end

data/lib/gitreviewer/analyze/blame_tree.rb

@@ -0,0 +1,68 @@
+require 'digest'
+
+module GitReviewer
+  # BlameBranch
+  class BlameBranch
+    attr_accessor :branch
+    attr_accessor :blame_files
+
+    def initialize(branch, blame_files)
+      @branch = branch
+      @blame_files = blame_files
+    end
+  end
+
+  # BlameFile
+  class BlameFile
+    attr_accessor :file_name
+    attr_accessor :blame_lines
+
+    attr_writer :exist
+    attr_writer :binary
+
+    # 文件是否存在
+    def exist?
+      @exist
+    end
+
+    # 文件是否是二进制
+    def binary?
+      @binary
+    end
+
+    def initialize(file_name, blame_lines, exist, binary)
+      @file_name = file_name
+      @blame_lines = blame_lines
+      @exist = exist
+      @binary = binary
+    end
+  end
+
+  # BlameLine
+  class BlameLine
+    attr_accessor :hash
+    attr_accessor :user
+    attr_accessor :date
+    attr_accessor :line
+    attr_accessor :code
+    attr_accessor :description
+
+    def initialize(hash, user, date, line, code)
+      @hash = hash
+      @user = user
+      @date = date
+      @line = line
+      @code = code
+      @description = code
+    end
+
+    # 用于 Myers 中进行判等操作
+    def ==(other)
+      other.is_a?(BlameLine) && other.code == @code
+    end
+
+    def format_line
+      format('%5d', line)
+    end
+  end
+end