codeowners 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 162d8c21d1f878a18c07817645f62191d2e4996d58533f819e6ebf102e7409fb
+  data.tar.gz: 4e06893a39070f1c34178f62e31e9afea773096bb121d98cdefea1620825bd2a
+SHA512:
+  metadata.gz: 579bbfb6ce368e0407d6d17f644e352b9f9823fd9ed71850189917d272e1ffe6177dd10650f0604172f7a4318d51cd550530c738397f8d90becff8348fbb701a
+  data.tar.gz: 250bb637dfa66ef6cd4455c489e980e5475b1e67f5684cd70791dba1fe58b8d0e126d11031b3cd3b1f5eb1b6e0b5b5eb870f87e3bc6d7234d9713c1d299bbcd0

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+.rubocop-*

data/.rubocop.yml

@@ -0,0 +1 @@
+inherit_from: https://raw.githubusercontent.com/jodosha/dotfiles/master/rubocop.yml

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Codeowners
+Simple CLI to interact with GitHub CODEOWNERS
+
+## v0.0.1 - 2020-06-12
+### Added
+- [Luca Guidi] Added `codeowners contributors`
+- [Luca Guidi] Added `codeowners list`
+- [Luca Guidi] Added `codeowners --help`

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in codeowners.gemspec
+gemspec
+
+gem "rake", "~> 12.0"

data/README.md

@@ -0,0 +1,64 @@
+# Codeowners
+
+Simple CLI to interact with GitHub CODEOWNERS.
+
+## Installation
+
+Install as:
+
+```shell
+$ gem install codeowners
+```
+
+## Usage
+
+### List
+
+List code owners for a file, if any.
+
+```shell
+$ codeowners list path/to/file
+@company/team-a @company/team-b
+```
+
+### Contributors
+
+List code contributors for a file.
+This is useful to guess who can be a candidate to own a file.
+
+```shell
+$ codeowners contributors path/to/file
+path/to/file
+
+Person One <person.one@company.com> / +106, -0
+Person Two <person.two@company.com> / +12, -2
+```
+
+### Help
+
+For a complete set of options, please run:
+
+```shell
+$ codeowners --help
+$ codeowners COMMAND --help
+```
+
+## 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 run `codeowners` executable during development:
+
+```shell
+$ bundle exec exe/codeowners contributors path/to/file --base-directory=/path/to/git/repository/to/analyze
+```
+
+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 tags, 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/jodosha/codeowners.
+
+## Copyright
+
+&copy; 2020 - Luca Guidi - https://lucaguidi.com

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "codeowners"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/codeowners.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "lib/codeowners/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "codeowners"
+  spec.version       = Codeowners::VERSION
+  spec.authors       = ["Luca Guidi"]
+  spec.email         = ["me@lucaguidi.com"]
+
+  spec.summary       = "GitHub Codeowners check and guess"
+  spec.description   = "Check GitHub Codeowners and guess which team should be assigned to a file"
+  spec.homepage      = "https://lucaguidi.com"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/jodosha/codeowners"
+  spec.metadata["changelog_uri"] = "https://github.com/jodosha/codeowners/blob/master/CHANGELOG.md"
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "dry-cli", "~> 0.6"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "byebug"
+end

data/exe/codeowners

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "codeowners/cli"
+
+Dry::CLI.new(Codeowners::CLI::Commands).call

data/lib/codeowners.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Codeowners
+  require "codeowners/version"
+  require "codeowners/result"
+  require "codeowners/list_owners"
+  require "codeowners/list_contributors"
+
+  class Error < StandardError
+  end
+
+  class SystemCallError < Error
+  end
+end

data/lib/codeowners/cli.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require "codeowners"
+require "dry/cli"
+
+module Codeowners
+  module CLI
+    module Commands
+      extend Dry::CLI::Registry
+
+      class Command < Dry::CLI::Command
+        def initialize(out: $stdout)
+          @out = out
+        end
+
+        private
+
+        attr_reader :out
+      end
+
+      class Version < Command
+        desc "Print version"
+
+        def call(*)
+          out.puts "v#{Codeowners::VERSION}"
+        end
+      end
+
+      class List < Command
+        DEFAULT_BASE_DIRECTORY = Dir.pwd.dup.freeze
+        private_constant :DEFAULT_BASE_DIRECTORY
+
+        DEFAULT_CODEOWNERS_PATH = ::File.join(".github", "CODEOWNERS").freeze
+        private_constant :DEFAULT_CODEOWNERS_PATH
+
+        desc "List code owners for a file, if any"
+
+        argument :file, required: true, desc: "File to check"
+
+        option :base_directory, type: :string, default: DEFAULT_BASE_DIRECTORY,  desc: "Base directory"
+        option :codeowners,     type: :string, default: DEFAULT_CODEOWNERS_PATH, desc: "Path to CODEOWNERS file"
+
+        def call(file:, base_directory:, codeowners:, **)
+          result = Codeowners::ListOwners.new(base_directory, codeowners).call(file)
+          exit(1) unless result.successful?
+
+          out.puts result.to_s
+        end
+      end
+
+      class Contributors < Command
+        DEFAULT_BASE_DIRECTORY = Dir.pwd.dup.freeze
+        private_constant :DEFAULT_BASE_DIRECTORY
+
+        DEFAULT_CODEOWNERS_PATH = ::File.join(".github", "CODEOWNERS").freeze
+        private_constant :DEFAULT_CODEOWNERS_PATH
+
+        desc "List code contributors for a file"
+
+        argument :file, required: true, desc: "File to check"
+
+        option :base_directory, type: :string, default: DEFAULT_BASE_DIRECTORY, desc: "Base directory"
+
+        def call(file:, base_directory:, **)
+          result = Codeowners::ListContributors.new(base_directory).call(file)
+          exit(1) unless result.successful?
+
+          out.puts result.to_s
+        end
+      end
+
+      register "version",      Version, aliases: ["v", "-v", "--version"]
+      register "list",         List
+      register "contributors", Contributors
+    end
+  end
+end

data/lib/codeowners/git.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "pathname"
+require "shellwords"
+
+module Codeowners
+  class Git
+    def initialize(base_directory)
+      @base_directory = Pathname.new(::File.expand_path(base_directory))
+    end
+
+    def contributors(file)
+      require "codeowners/git/contributors"
+      output = git(["log", "--max-count=500", "--shortstat", %(--pretty=format:"author:%aN email:%ae"), "--no-color", "--", escape(file)])
+
+      Contributors.call(file, output)
+    end
+
+    private
+
+    def git(command_and_args)
+      execute(["git", "--git-dir=#{git_directory}", "--work-tree=#{work_tree}", "-c", "'color.ui=false'"] + command_and_args)
+    end
+
+    def work_tree
+      escape(@base_directory.to_s)
+    end
+
+    def git_directory
+      escape(@base_directory.join(".git").to_s)
+    end
+
+    def escape(string)
+      Shellwords.shellescape(string)
+    end
+
+    def execute(command, env: {}, error: ->(err) { raise Codeowners::SystemCallError.new(err) })
+      require "open3"
+
+      Open3.popen3(env, command.join(" ")) do |_, stdout, stderr, wait_thr|
+        error.call(stderr.read) unless wait_thr.value.success?
+        return stdout.read
+      end
+    end
+  end
+end

data/lib/codeowners/git/contributor.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Codeowners
+  class Git
+    class Contributor
+      attr_reader :email, :name, :file, :insertions, :deletions
+
+      def initialize(email, name, file, insertions, deletions)
+        @email = email
+        @name = name
+        @file = file
+        @insertions = insertions
+        @deletions = deletions
+
+        freeze
+      end
+
+      def to_s
+        "#{name} <#{email}> / +#{insertions}, -#{deletions}"
+      end
+    end
+  end
+end

data/lib/codeowners/git/contributors.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require "English"
+require "codeowners/git/contributor"
+
+module Codeowners
+  class Git
+    class Contributors
+      # rubocop:disable Metrics/AbcSize
+      # rubocop:disable Metrics/MethodLength
+      def self.call(file, output)
+        lines = output.split($INPUT_RECORD_SEPARATOR)
+
+        result = {}
+        each_commit(lines) do |authors, insertions, deletions|
+          authors.each do |author|
+            author_email = author.fetch("email")
+            author_name  = author.fetch("name")
+
+            result[author_email] ||= {}
+            result[author_email]["name"] = author_name
+            result[author_email]["file"] = file
+            result[author_email]["insertions"] ||= 0
+            result[author_email]["deletions"] ||= 0
+            result[author_email]["insertions"] += insertions
+            result[author_email]["deletions"] += deletions
+          end
+        end
+
+        new(result)
+      end
+      # rubocop:enable Metrics/MethodLength
+      # rubocop:enable Metrics/AbcSize
+
+      def self.each_commit(lines)
+        while lines.any?
+          commit = lines.take_while { |line| line != "" }
+          yield parse(commit.dup) unless commit.empty?
+          lines -= commit
+          lines.shift
+        end
+      end
+
+      def self.parse(commit)
+        stats = commit.pop
+        stats = stats.split(", ")
+
+        _, insertions, deletions = *stats
+        insertions = insertions.to_i
+        deletions = deletions.to_i
+
+        authors = commit.map do |author|
+          {
+            "name" => author.scan(/author:(.*)email:/).flatten.first.chop,
+            "email" => author.scan(/email:(.*)/).flatten.first
+          }
+        end
+
+        [authors.uniq, insertions, deletions]
+      end
+
+      def initialize(data)
+        @contributors = data.map do |email, stats|
+          Contributor.new(email, *stats.values)
+        end
+      end
+
+      def each(&blk)
+        return enum_for(:each) unless block_given?
+
+        @contributors.each(&blk)
+      end
+
+      def empty?
+        @contributors.empty?
+      end
+    end
+  end
+end

data/lib/codeowners/list_contributors.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "codeowners/git"
+
+module Codeowners
+  class ListContributors
+    class Result < ::Codeowners::Result
+      def initialize(file = nil, contributors = [])
+        @file = file
+        @contributors = contributors
+      end
+
+      def successful?
+        !@file.nil?
+      end
+
+      def to_s
+        [@file, "", *@contributors.map(&:to_s)].join("\n")
+      end
+    end
+
+    def initialize(base_directory, git: Git.new(base_directory))
+      @git = git
+    end
+
+    def call(file)
+      contributors = @git.contributors(file)
+      return Result.new if contributors.empty?
+
+      contributors = contributors.each.lazy.sort_by { |c| -c.insertions }
+
+      Result.new(file, contributors)
+    end
+  end
+end

data/lib/codeowners/list_owners.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "pathname"
+
+module Codeowners
+  class ListOwners
+    def initialize(base_directory, codeowners)
+      @base_directory = Pathname.new(::File.expand_path(base_directory))
+      @codeowners = @base_directory.join(codeowners)
+    end
+
+    def call(file)
+      ::File.open(@codeowners, "r").each_line do |line|
+        line = line.chomp
+        next if line.empty? || line.match?(/[[:space:]]*#/)
+
+        pattern, *owners = line.split(/[[:space:]]+/)
+
+        return Result.new(pattern, owners) if File.fnmatch(pattern, file)
+      end
+
+      Result.new
+    end
+  end
+end

data/lib/codeowners/result.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Codeowners
+  class Result
+    def initialize(pattern = nil, owners = [])
+      @pattern = pattern
+      @owners = owners
+    end
+
+    def successful?
+      !@pattern.nil?
+    end
+
+    def to_s
+      "#{@pattern}\n\n#{@owners.join('\n')}"
+    end
+  end
+end

data/lib/codeowners/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Codeowners
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: codeowners
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Luca Guidi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-06-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-cli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Check GitHub Codeowners and guess which team should be assigned to a
+  file
+email:
+- me@lucaguidi.com
+executables:
+- codeowners
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- codeowners.gemspec
+- exe/codeowners
+- lib/codeowners.rb
+- lib/codeowners/cli.rb
+- lib/codeowners/git.rb
+- lib/codeowners/git/contributor.rb
+- lib/codeowners/git/contributors.rb
+- lib/codeowners/list_contributors.rb
+- lib/codeowners/list_owners.rb
+- lib/codeowners/result.rb
+- lib/codeowners/version.rb
+homepage: https://lucaguidi.com
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://lucaguidi.com
+  source_code_uri: https://github.com/jodosha/codeowners
+  changelog_uri: https://github.com/jodosha/codeowners/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.3
+signing_key: 
+specification_version: 4
+summary: GitHub Codeowners check and guess
+test_files: []