code_review_leaderboard 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3ea19e0fe90de7406b88709534c96a763242d73b1261da1a6a537d8cfad02177
+  data.tar.gz: 1cdb5d628849d5efd3fca8239877ffd5b35697c1ff5372f3b8d5bf0ef7f6fdfd
+SHA512:
+  metadata.gz: e9f929c12080ad9225cc22355acc68d0c9e307280cde01a852c0f53548608c905e5bcd19996473100c8ebc741adac629b566508714a7c8667bd006ff05cfff67
+  data.tar.gz: 73d9e6e9d18e66e93319c1cd96a1ac95a04eef267b495ef67cef585ddce5df87bc8b244d98713eaacfdda1978be634473ed8db9e3070a7471f8d42e25c9303c3

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-02-10
+
+- Initial release

data/README.md

@@ -0,0 +1,55 @@
+# Code Review Leaderboard
+
+Create a leaderboard of code reviewers for your repository or organization.
+
+Find out who is the most active reviewer in your team, who is the most thorough, and who is the most critical.
+
+## Examples
+
+<div align="center">
+  <img width="750" alt="Screenshot 2024-02-10 at 21 08 05" src="https://github.com/markokajzer/code-review-leaderboard/assets/9379317/4a774c51-5fc3-4c2d-bf0d-3d784dd4b04a">
+</div>
+
+Reviews are counted by the following rules:
+1. Completed within the last 30 days
+2. Multiple comments only count once.
+3. If a reviewer both approves/rejects a pull request _and_ comments, the comments do not count extra.
+4. Approvals and rejections always count.
+
+For a repository of 718 repositories and 526 reviews, the script takes roughly 1 minute.
+
+## Installation
+
+Install the gem:
+
+    $ gem install code_review_leaderboard
+
+## Usage
+
+To use the gem, you will need to provide a GitHub access token. You can create a new access token by following the instructions [here](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line). If you want to inspect the repositories of an organization, make sure the organization in question allows access to their repositories from personal access tokens. You can check that from `https://github.com/organizations/<name>/settings/personal-access-tokens`.
+
+To inspect the reviews of a single repository, run:
+
+    $ code_review_leaderboard --access_token ACCESS_TOKEN --repository REPOSITORY
+
+You can also provide multiple repositories:
+
+    $ code_review_leaderboard --access_token ACCESS_TOKEN --repository REPOSITORY1 REPOSITORY2
+
+Finally, you can also inspect the repositories of an organization:
+
+    $ code_review_leaderboard --access_token ACCESS_TOKEN --organization ORGANIZATION
+
+## Configuration
+
+You can either configure the gem via command line arguments or by setting environment variables. Command line arguments take precedence.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rspec` to run the tests. 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`. You can then run it with `bundle exec <executable>`. 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/markokajzer/code-review-leaderboard.

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/exe/code_review_leaderboard

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+base_path = File.expand_path("../lib", __dir__)
+$LOAD_PATH.unshift(base_path)
+
+require "active_support/core_ext/object/blank"
+
+require "code_review_leaderboard"
+
+CodeReviewLeaderboard.initialize!
+CodeReviewLeaderboard.start

data/lib/adapters/github.rb

@@ -0,0 +1,25 @@
+require "active_support"
+require "active_support/core_ext/module/delegation"
+
+require "octokit"
+
+module CodeReviewLeaderboard
+  module Adapters
+    module Github
+      extend self
+
+      delegate :organization_repositories,
+        :pull_requests,
+        :pull_request_reviews,
+        to: :client
+
+      def client
+        @client ||= Octokit::Client.new(access_token: Config.access_token)
+      end
+
+      def per_page
+        client.per_page || 30
+      end
+    end
+  end
+end

data/lib/async/wait_all.rb

@@ -0,0 +1,9 @@
+require "async/barrier"
+
+def WaitAll(&block)
+  barrier = Async::Barrier.new
+
+  yield barrier
+
+  barrier.wait
+end

data/lib/async/wait_all_throttled.rb

@@ -0,0 +1,23 @@
+require "async"
+require "async/barrier"
+require "async/semaphore"
+
+require_relative "wait_all"
+
+def WaitAllThrottled(array, concurrency: 5, &block)
+  result = []
+
+  WaitAll do |barrier|
+    semaphore = Async::Semaphore.new(concurrency, parent: barrier)
+
+    Async do
+      array.each do |item|
+        semaphore.async(parent: barrier) do
+          result << yield(item)
+        end
+      end
+    end
+  end
+
+  result.flatten
+end

data/lib/code_review_leaderboard/argument_parser.rb

@@ -0,0 +1,25 @@
+require "optparse"
+
+module CodeReviewLeaderboard
+  module ArgumentParser
+    extend self
+
+    def parse!(args: ARGV)
+      {}.tap do |options|
+        OptionParser.new do |opts|
+          opts.banner = "Usage: leaderboard [options]"
+
+          opts.on("-t", "--access-token ACCESS_TOKEN", "Specify the access token") { |token| options[:access_token] = token }
+          opts.on("-r", "--repo", "--repository repository,repository", Array, "Specify the repository") { |repositories| options[:repositories] = repositories }
+          opts.on("-o", "--org", "--organization organization", "Specify the organization") { |organization| options[:organization] = organization }
+          opts.on("-v", "--verbose", "Run verbosely") { options[:log_level] = :debug }
+
+          opts.on("-h", "--help", "Show this message") do
+            puts opts
+            exit
+          end
+        end.parse!(args)
+      end
+    end
+  end
+end

data/lib/code_review_leaderboard/config.rb

@@ -0,0 +1,41 @@
+require "active_support"
+require "active_support/configurable"
+require "active_support/core_ext/module/delegation"
+
+require_relative "argument_parser"
+
+module CodeReviewLeaderboard
+  ConfigurationError = Class.new(StandardError)
+
+  module Config
+    extend self
+
+    include ActiveSupport::Configurable
+
+    config_accessor :access_token
+    config_accessor :repositories, default: []
+    config_accessor :organization
+    config_accessor :log_level, default: :info
+
+    def initialize!
+      initialize_from_args!
+      initialize_from_env!
+    end
+
+    def initialize_from_args!
+      options = ArgumentParser.parse!
+
+      self.access_token = options[:access_token]
+      self.organization = options[:organization]
+      self.repositories = options[:repositories] if options[:repositories].present?
+      self.log_level = options[:log_level]
+    end
+
+    def initialize_from_env!
+      self.access_token ||= ENV["ACCESS_TOKEN"]
+      self.organization ||= ENV["ORGANIZATION"]
+      self.repositories = repositories.presence || ENV["REPOSITORY"].to_s.split(",")
+      self.log_level ||= ENV["LOG_LEVEL"]
+    end
+  end
+end

data/lib/code_review_leaderboard/formatter.rb

@@ -0,0 +1,35 @@
+require "terminal-table"
+
+module CodeReviewLeaderboard
+  class Formatter
+    def initialize(tally)
+      @tally = tally
+    end
+
+    def to_table
+      Terminal::Table.new(headings:) do |rows|
+        totals.each do |user, reviews|
+          rows << [user, reviews[:total], reviews[:approved], reviews[:changes_requested], reviews[:commented]]
+        end
+      end
+    end
+
+    private
+
+    attr_reader :tally
+
+    def totals
+      tally.each_with_object({}) do |review, totals|
+        totals[review[:user].to_sym] ||= Hash.new(0)
+        totals[review[:user].to_sym][review[:state]] += 1
+        totals[review[:user].to_sym][:total] += 1
+      end
+        .sort_by { _2[:total] }
+        .reverse
+    end
+
+    def headings
+      ["Login", "Total", "Approved", "Changes Requested", "Commented"]
+    end
+  end
+end

data/lib/code_review_leaderboard/organization.rb

@@ -0,0 +1,35 @@
+require "active_support"
+require "active_support/core_ext/numeric/time"
+
+require "adapters/github"
+require_relative "config"
+
+require_relative "repository"
+
+module CodeReviewLeaderboard
+  class Organization
+    attr_reader :name
+
+    def initialize(name:)
+      @name = name
+    end
+
+    def repos(since: 30.days.ago)
+      fetch_repos(since:).map { Repository.new(name: _1.full_name) }
+    end
+
+    private
+
+    def fetch_repos(since:)
+      (1..).each_with_object([]) do |page, repos|
+        repo_chunk =
+          Adapters::Github
+            .organization_repositories(name, type: "sources", sort: "pushed", page:)
+            .filter { _1.pushed_at > since }
+        repos.concat(repo_chunk)
+
+        return repos if repo_chunk.size < Adapters::Github.per_page
+      end
+    end
+  end
+end

data/lib/code_review_leaderboard/pulls.rb

@@ -0,0 +1,42 @@
+require "active_support"
+require "active_support/core_ext/numeric/time"
+
+require "adapters/github"
+require_relative "config"
+
+module CodeReviewLeaderboard
+  class Pulls
+    PER_PAGE = 100
+
+    class << self
+      def for(repository:, since: 30.days.ago)
+        new(repository:, since:).pulls
+      end
+    end
+
+    def initialize(repository:, since:)
+      @repository = repository
+      @since = since
+    end
+
+    def pulls
+      fetch_pulls
+    end
+
+    private
+
+    attr_reader :repository, :since
+
+    def fetch_pulls
+      (1..).each_with_object([]) do |page, pulls|
+        pulls_chunk =
+          Adapters::Github
+            .pull_requests(repository.name, state: "all", per_page: PER_PAGE, page:)
+            .filter { _1.created_at > since }
+        pulls.concat(pulls_chunk)
+
+        return pulls if pulls_chunk.size < PER_PAGE
+      end
+    end
+  end
+end

data/lib/code_review_leaderboard/repository.rb

@@ -0,0 +1,19 @@
+require_relative "pulls"
+
+module CodeReviewLeaderboard
+  class Repository
+    attr_reader :name
+
+    def initialize(name:)
+      @name = name
+    end
+
+    def pulls
+      Pulls.for(repository: self)
+    end
+
+    def ==(other)
+      name == other.name
+    end
+  end
+end

data/lib/code_review_leaderboard/reviews.rb

@@ -0,0 +1,46 @@
+require_relative "config"
+
+module CodeReviewLeaderboard
+  class Reviews
+    class << self
+      def for(pull:, since: 30.days.ago)
+        new(pull:, since:).reviews
+      end
+    end
+
+    def initialize(pull:, since: 30.days.ago)
+      @pull = pull
+      @since = since
+    end
+
+    def reviews
+      puts "Fetching reviews for #{repository}##{pull.number}..." if Config.log_level == :debug
+
+      comments, reviews =
+        fetch_reviews
+          .map { {user: _1.user.login, state: _1.state.downcase.to_sym} }
+          .uniq
+          .partition { _1[:state] == :commented }
+
+      # Do not count comments if already otherwise reviewed
+      comments.filter! do |commenter|
+        reviews.none? { |reviewer| reviewer[:user] == commenter[:user] }
+      end
+
+      reviews + comments
+    end
+
+    private
+
+    attr_reader :pull, :since
+
+    def fetch_reviews
+      Adapters::Github.pull_request_reviews(repository, pull.number)
+        .filter { _1.submitted_at > since }
+    end
+
+    def repository
+      pull.base.repo.full_name
+    end
+  end
+end

data/lib/code_review_leaderboard/spinner.rb

@@ -0,0 +1,19 @@
+require "whirly"
+
+module CodeReviewLeaderboard
+  module Spinner
+    extend self
+
+    delegate :status=, to: Whirly
+
+    def start
+      result = nil
+
+      Whirly.start(spinner: "dots", stop: "✔") do
+        result = yield
+      end
+
+      result
+    end
+  end
+end

data/lib/code_review_leaderboard/version.rb

@@ -0,0 +1,3 @@
+module CodeReviewLeaderboard
+  VERSION = "0.1.0"
+end

data/lib/code_review_leaderboard.rb

@@ -0,0 +1,64 @@
+require_relative "code_review_leaderboard/version"
+
+require_relative "async/wait_all_throttled"
+
+require "code_review_leaderboard/config"
+require "code_review_leaderboard/formatter"
+require "code_review_leaderboard/organization"
+require "code_review_leaderboard/pulls"
+require "code_review_leaderboard/repository"
+require "code_review_leaderboard/reviews"
+require "code_review_leaderboard/spinner"
+
+module CodeReviewLeaderboard
+  extend self
+
+  def initialize!
+    Config.initialize!
+
+    raise ConfigurationError, "Access token is required" if Config.access_token.nil?
+    raise ConfigurationError, "Repository or owner is required" if Config.repositories.empty? && Config.organization.blank?
+  end
+
+  def start
+    puts "Found #{repositories.size} repositories" if Config.organization.present? && Config.log_level == :debug
+    puts "Found #{pulls.size} pull requests."
+    puts "Found #{reviews.size} reviews."
+    puts
+
+    puts Formatter.new(reviews).to_table
+  end
+
+  private
+
+  def repositories
+    @@repositories ||= if Config.repositories.present?
+      Config.repositories.map { Repository.new(name: _1) }
+    else
+      Spinner.start do
+        Spinner.status = "Fetching repos for #{Config.organization}..."
+        Organization.new(name: Config.organization).repos
+      end
+    end
+  end
+  alias_method :load_repositories, :repositories
+
+  def pulls
+    # Load before we enter the next spinner so we do not end up nesting them
+    load_repositories
+
+    @@pulls ||= Spinner.start do
+      Spinner.status = "Fetching pull requests..."
+
+      WaitAllThrottled(repositories) { _1.pulls }
+    end
+  end
+
+  def reviews
+    @@reviews ||= Spinner.start do
+      Spinner.status = "Fetching reviews..."
+
+      WaitAllThrottled(pulls) { Reviews.for(pull: _1) }
+    end
+  end
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: code_review_leaderboard
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- markokajzer
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-02-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday-retry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: async
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: whirly
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: paint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- markokajzer91@gmail.com
+executables:
+- code_review_leaderboard
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- README.md
+- Rakefile
+- exe/code_review_leaderboard
+- lib/adapters/github.rb
+- lib/async/wait_all.rb
+- lib/async/wait_all_throttled.rb
+- lib/code_review_leaderboard.rb
+- lib/code_review_leaderboard/argument_parser.rb
+- lib/code_review_leaderboard/config.rb
+- lib/code_review_leaderboard/formatter.rb
+- lib/code_review_leaderboard/organization.rb
+- lib/code_review_leaderboard/pulls.rb
+- lib/code_review_leaderboard/repository.rb
+- lib/code_review_leaderboard/reviews.rb
+- lib/code_review_leaderboard/spinner.rb
+- lib/code_review_leaderboard/version.rb
+homepage: https://github.com/markokajzer/code-review-leaderboard
+licenses: []
+metadata:
+  homepage_uri: https://github.com/markokajzer/code-review-leaderboard
+  source_code_uri: https://github.com/markokajzer/code-review-leaderboard
+  changelog_uri: https://github.com/markokajzer/code-review-leaderboard/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.4
+signing_key:
+specification_version: 4
+summary: Create a leaderboard for code review in your repository or organization
+test_files: []