git-reviewer 0.5.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29e087d7ab6f4551f43884da8fcef12dbd183efd55cf0ab577fd18a950f54ccc
-  data.tar.gz: 45790fb4dafde22275319e4fdb2b25c9cb724f46f6b1ef28c5486c9a0f57b0a1
+  metadata.gz: d8591466df9e2c91bec2bd58ad020bd25b8e6c173cab87224a90e393589be979
+  data.tar.gz: f774101ec57f4d21bc73dabef64523d3ff6363f11f5e2ca3e9542f2c55758429
 SHA512:
-  metadata.gz: 17947d8ad8142a7744c7e0bc410bc358447d2e65c0051ec6404279d22ec69c5cbb98e2557e2b7a1039d9541642c488f235ee409656552be3b69f3024b0d3f1be
-  data.tar.gz: 3a380a1ed8bc27e52112ca782f4754bfc789387ccf04e247c71f16ff4e11f976085a16aa827703b8570d803d9945fe01ce133ae036edde44d72d6df5ebe90d7d
+  metadata.gz: ee1dda2c0c91704c32bf9abf6de0c55bab6b084531c0399d15820d0a8a693df986ec9fa9f40cc7014975b7ce8b5327ddb20da0a6a15d3059586f91e8e7276226
+  data.tar.gz: b86f5c2dd2f5e6370fa9974399c94599bd1b970fa0472d6d6c8da14c8b2652798777088bbbb2f26eb0b403222140ce0b7bce4907bf8dbfee8b8a6c8d8809ca25

data/README.md

@@ -1,37 +1,147 @@
 ![](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)
+![Plugin](http://img.shields.io/badge/plugin-git-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.
+[简体中文](README-zh.md)
 
-TODO: Delete this and the text above, and describe your gem
+Git Reviewer is a git plugin that solves a common problem in team collaborative development: **Who should review the code changes?**
+
+## Core Feature
+We know that git uses two operations, add and delete, to represent code changes. In fact, we can derive a third operation - edit - from the arrangement relationship between add and delete. So, when is it considered an edit? If the delete operation and the add operation are immediately adjacent, we can classify it as an edit operation.
+
+Hence, we get three types of operations: delete, add, edit. Git Reviewer analyzes based on these three operations.
+
+For the delete type, Git Reviewer considers the original author of the deleted line to be the reviewer for each line.
+
+For the edit type, Git Reviewer believes that the newly added content in this part should all be reviewed by the original author of the last deleted line that is immediately adjacent. So, why is it the last deleted line? Because the Myers diff algorithm adopted by git defaults to showing delete operations first, followed by add operations. Therefore, starting from the last deleted line, it is the newly added content that is displayed.
+
+For the add type, Git Reviewer's strategy is based on analysis of the `.gitreviewer.yml` configuration file. The `.gitreviewer.yml` file defines the `project owner`, `folder owner`, and `file owner`. At this point, Git Reviewer will match the newly added lines of the file with the content defined in `.gitreviewer.yml`.
+
+- If the file matches a file owner, then the related new type is prioritized for review by the file owner.
+- If the file matches a folder owner, then the related new type is subsequently reviewed by the folder owner.
+- If neither of the first two matches the file, then it will be reviewed by the project owner.
+
+Based on the analysis of the three operation types mentioned above, Git Reviewer will eventually generate an analysis table. This table lists information such as the reviewer, the number of files, the file ratio, the number of code lines, and the code line ratio. Git Reviewer suggests recommending and sorting reviewers based on the code line ratio.
+
+Below is an example of the analysis results for the core functionality.
+
+```sh
++------------------------------------------------------------------------+
+|                 Suggested reviewers for code changes.                  |
++--------------------+------------+------------+------------+------------+
+| Suggested Reviewer | File Count | File Ratio | Line Count | Line Ratio |
++--------------------+------------+------------+------------+------------+
+| developerA         | 5          | 50.0%      | 1000       | 50.0%      |
++--------------------+------------+------------+------------+------------+
+| developerB         | 3          | 30.0%      | 500        | 25.0%      |
++--------------------+------------+------------+------------+------------+
+| developerC         | 2          | 20.0%      | 500        | 25.0%      |
++--------------------+------------+------------+------------+------------+
+```
+
+## Additional Feature
+
+Git Reviewer also provides the functionality to analyze the distribution of authors involved in code changes. This feature is relatively simple; it analyzes the original authors of all deleted lines and the current authors of newly added lines. It also presents this information in the form of a table, listing the authors, number of files, file ratio, number of code lines, code line ratio, etc., for users to evaluate and reference.
+
+Below is an example of the analysis results for the additional functionality.
+
+```sh
++--------------------------------------------------------------------+
+|             Relevant authors involved in code changes              |
++----------------+------------+------------+------------+------------+
+| Related Author | File Count | File Ratio | Line Count | Line Ratio |
++----------------+------------+------------+------------+------------+
+| developerA     | 5          | 50.0%      | 2000       | 66.6%      |
++----------------+------------+------------+------------+------------+
+| developerB     | 3          | 30.0%      | 500        | 16.7%      |
++----------------+------------+------------+------------+------------+
+| developerC     | 2          | 30.0%      | 500        | 16.7%      |
++----------------+------------+------------+------------+------------+
+```
 
 ## Installation
 
-Install the gem and add to the application's Gemfile by executing:
+Git Reviewer can be installed via Homebrew, with the following command.
 
-    $ bundle add git-reviewer
+```sh
+$ brew install baochuquan/tap/git-reviewer
+```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+Alternatively, it can also be installed via Ruby Gem, with the following command.
 
-    $ gem install git-reviewer
+```sh
+$ gem install git-reviewer
+```
 
 ## Usage
+### Initialization
+For any Git project, before using Git Reviewer, you should first execute the initialization command in the root directory, as shown below.
+
+```sh
+$ git reviewer --init
+```
+
+The command will automatically create a `.gitreviewer.yml` file, which defines fields such as `project_owner`, `folder_owner`, and `file_owner`. The latter two are array types, allowing us to define multiple path and owner fields for a more precise division of the project.
+
+In addition, the `.gitreviewer.yml` file includes `ignore_folders` and `ignore_files` fields. These can define a series of directories or files to be excluded from the analysis, thus affecting the analysis results.
+
+Below is an example of a `.gitreviewer.yml` file. You can edit the relevant fields for a more accurate analysis.
+
+```yml
+---
+project_owner: admin,
+folder_owner:
+- owner: developerA,
+  path: /path/to/folderA
+- owner: developerB
+  path: /path/to/folderB
+ 
+file_owner:
+- owner: developerC
+  path: /path/to/fileC
+- owner: developerD
+  path: /path/to/fileD
+ 
+ignore_files:
+- path/to/file1
+- path/to/file2
+ 
+ignore_review_folders:
+- path/to/folder1
+- path/to/folder2
+```
+
+
+### Analyze
+Git Reviewer conducts the analysis based on two git branches, namely the source branch and the target branch.
+
+The source branch is the branch where the code modifications are made. By default, Git Reviewer automatically uses the current branch as the source branch. However, it is also possible to specify the source branch using the option `--source=<source-branch>`. Besides the branch name, Git Reviewer also supports Commit IDs.
+
+The target branch is the branch that is intended to be merged into. For this, Git Reviewer provides the related option `--target=<target-branch>`.
+
+Below is an example of the command used to perform analysis with Git Reviewer.
+
+```sh
+$ git reviewer --target=main
+```
 
-TODO: Write usage instructions here
+By default, Git Reviewer displays both core and additional functionality analysis results. If we only want to see the results of the core functionality, we can specify the option `--reviewer`; if we only want to see the results of the additional functionality, we can specify the option `--author`.
 
-## Development
+```sh
+$ git reviewer --target=main --reviewer
 
-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.
+$ git reviewer --target=main --author
+```
 
-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).
+To view more analysis information, we can add the `--verbose` option.
 
-## Contributing
+```sh
+$ git reviewer --target=main --verbose
+```
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/git-reviewer.
+## License
+Git Reviewer is licensed under the MIT License.

data/lib/gitreviewer/analyze/analyzer.rb

@@ -62,7 +62,9 @@ module GitReviewer
       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'])
+      folder_owner = data['folder_owner'].map { |hash| FolderOwner.new(hash["path"], hash["owner"]) }
+      file_owner = data['file_owner'].map { |hash| FileOwner.new(hash["path"], hash["owner"]) }
+      @configuration = Configuration.new(data['project_owner'], folder_owner, file_owner, data['ignore_files'], data['ignore_folders'])
     end
 
     def execute
@@ -121,7 +123,7 @@ module GitReviewer
 
     def record_author(fdiff, ldiff)
       file_name = fdiff.file_name
-      if @configuration.is_ignore?(file_name)
+      if @configuration.ignore?(file_name)
         return
       end
 
@@ -129,11 +131,15 @@ module GitReviewer
       if ldiff.operation == DiffLine::DELETE
         # 删除类型，记录为原始作者
         author = ldiff.source_line.user
-      else
+      elsif ldiff.operation == DiffLine::ADD
         # 新增类型，记录为最新作者
         author = ldiff.target_line.user
       end
 
+      if author.empty?
+        return
+      end
+
       item = @author_results[author]
       if item == nil
         item = ResultItem.new(author)
@@ -148,7 +154,7 @@ module GitReviewer
         return
       end
       file_name = fdiff.file_name
-      if @configuration.is_ignore?(file_name)
+      if @configuration.ignore?(file_name)
         return
       end
 

data/lib/gitreviewer/config/configuration.rb

@@ -9,8 +9,8 @@ module GitReviewer
 
     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"]) }
+      @folder_owner = folder_owner
+      @file_owner = file_owner
       @ignore_files = ignore_files
       @ignore_folders = ignore_folders
     end
@@ -25,27 +25,27 @@ module GitReviewer
       }
     end
 
-    def is_ignore?(file_name)
+    def 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) }
+      if @ignore_folders != nil && @ignore_folders.any?{ |folder| folder != nil && !folder.empty? && file_name.start_with?(folder) }
         return true
       end
       return false
     end
 
     def reviewer_of_file(file_name)
-      if is_ignore?(file_name)
+      if ignore?(file_name)
         return nil
       end
 
-      fowner = @file_owner.select { |owner| !owner.path.empty? && owner.path == file_name }.first
+      fowner = @file_owner.select { |owner| owner.path != nil && !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
+      downer = @folder_owner.select { |owner| owner.path != nil && !owner.path.empty? && file_name.start_with?(owner.path) }.first
       if downer != nil && downer.owner != nil
         return downer.owner
       end

data/lib/gitreviewer/option/analyze_option.rb

@@ -73,7 +73,7 @@ module GitReviewer
       end
 
       table = Terminal::Table.new do |t|
-        t.title = "Suggested reviewers for code changes."
+        t.title = "Suggested reviewers for code changes"
         t.headings = ["Suggested Reviewer", "File Count", "File Ratio", "Line Count", "Line Ratio"]
         t.rows = output_rows
       end

data/lib/gitreviewer/option/init_option.rb

@@ -40,7 +40,7 @@ module GitReviewer
       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"
+      Printer.put "`.gitreviewer.yml` created successfully. If you want to customize settings, please edit this file.\n"
     end
 
     def deep_transform_keys_to_strings(value)

data/lib/gitreviewer/version.rb

@@ -1,3 +1,3 @@
 module GitReviewer
-    VERSION = "0.5.0"
+    VERSION = "0.8.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: git-reviewer
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.8.0
 platform: ruby
 authors:
 - baochuquan
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-09 00:00:00.000000000 Z
+date: 2024-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: claide
@@ -46,12 +46,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".solargraph.yml"
-- ".vscode/launch.json"
-- Gemfile
-- Gemfile.lock
 - README.md
-- Rakefile
 - exe/git-reviewer
 - lib/gitreviewer.rb
 - lib/gitreviewer/algorithm/myers.rb
@@ -67,7 +62,6 @@ files:
 - lib/gitreviewer/utils/checker.rb
 - lib/gitreviewer/utils/printer.rb
 - lib/gitreviewer/version.rb
-- sig/git/reviewer.rbs
 homepage: https://github.com/baochuquan/git-reviewer
 licenses: []
 metadata:

data/.solargraph.yml

@@ -1,33 +0,0 @@
----
-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

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

data/Gemfile

@@ -1,13 +0,0 @@
-# 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

@@ -1,109 +0,0 @@
-PATH
-  remote: .
-  specs:
-    git-reviewer (0.5.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/Rakefile

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

data/sig/git/reviewer.rbs

@@ -1,6 +0,0 @@
-module Git
-  module Reviewer
-    VERSION: String
-    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-  end
-end