codeowners 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66eab678e31ae2c7c45bf32e8b8a92163bb3cef3147475a95775ece36081dce2
-  data.tar.gz: e188c85670d6cc4d1a0bb1d2f2fb6aee9085f1ad3b3ef978027d55ec4afc311d
+  metadata.gz: 790787fbbbface03dca93e7ee9fb70818d736b55b5b46feba832bb5d1d1cacde
+  data.tar.gz: 5cf3d0d5b9612527ac8e3d5416442dcb0442e1d69180b85df1b25752871e9d9e
 SHA512:
-  metadata.gz: 0c4e4381b4cdd046065ec83a785d742b058768d9b27cb78b765ecfe230e76e4a1cc608a3f395496196be051601ae7e9f22a3050f64e97e70a0f3761db481a204
-  data.tar.gz: 4037d4d9ba417ffe5ae65c3e50051f245c111f80e3880366b1bde609d936f15cef994a38a1438c64842447dbb2bb2f5685a6fd0c46268a065187699357541b9a
+  metadata.gz: 9728df04569e092a74db19feec631cb0f4031da24ab1bf7e127b6a728206c21026fc7a2988ff0c81f66b894a895350521a9f956236859e682eaa8be2f79194a3
+  data.tar.gz: 594590f13fe02ea9c8e7f5831e2d716a48779e7309f063caeb194c884a42d69037fed8ca64b6703ad88db7765f25258fa58d9d45e12b3eabb00875a016b1fb3a

data/.gitignore

@@ -8,3 +8,4 @@
 /tmp/
 Gemfile.lock
 .rubocop-*
+codeowners.json

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 # Codeowners
 Simple CLI to interact with GitHub CODEOWNERS
 
+## v0.0.3 - 2020-07-22
+### Added
+- [Luca Guidi] Added `codeowners guess`
+- [Luca Guidi] Added `codeowners import org`
+
 ## v0.0.2 - 2020-06-27
 ### Added
 - [Luca Guidi] Added pattern support to `codeowners contributors`

data/codeowners.gemspec

@@ -27,6 +27,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency "dry-cli", "~> 0.6"
+  spec.add_runtime_dependency "excon", "~> 0.75"
   spec.add_development_dependency "rubocop"
   spec.add_development_dependency "byebug"
 end

data/lib/codeowners.rb

@@ -3,8 +3,12 @@
 module Codeowners
   require "codeowners/version"
   require "codeowners/result"
+  require "codeowners/storage"
   require "codeowners/list_owners"
   require "codeowners/list_contributors"
+  require "codeowners/guess"
+  require "codeowners/import/client"
+  require "codeowners/import/organization"
 
   class Error < StandardError
   end

data/lib/codeowners/cli.rb

@@ -95,9 +95,104 @@ module Codeowners
         end
       end
 
+      class Guess < 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
+
+        FORMAT_MAPPING = { "string" => "to_s", "csv" => "to_csv" }.freeze
+        private_constant :FORMAT_MAPPING
+
+        FORMAT_VALUES = FORMAT_MAPPING.keys.freeze
+        private_constant :FORMAT_VALUES
+
+        DEFAULT_FORMAT = FORMAT_VALUES.first
+        private_constant :DEFAULT_FORMAT
+
+        DEFAULT_STORAGE_PATH = ::File.join(Dir.pwd, "codeowners.json").freeze
+        private_constant :DEFAULT_STORAGE_PATH
+
+        DEFAULT_DEBUG = false
+        private_constant :DEFAULT_DEBUG
+
+        desc "Check CODEOWNERS for a file (or a pattern), if missing, it tries to guess, by looking at the git commit history"
+
+        argument :file, required: true, desc: "File (or pattern) 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"
+        option :storage, type: :string, default: DEFAULT_STORAGE_PATH, desc: "Storage path (default: #{DEFAULT_STORAGE_PATH})"
+
+        option :format, type: :string, default: DEFAULT_FORMAT, values: FORMAT_VALUES, desc: "Output format"
+        option :debug, type: :boolean, default: DEFAULT_DEBUG, desc: "Print debug information to stdout"
+
+        example [
+          "path/to/file.rb # file",
+          "'path/to/**/*.rb' # pattern"
+        ]
+
+        def call(file:, base_directory:, codeowners:, storage:, format:, debug:, **)
+          owners = Codeowners::ListOwners.new(base_directory, codeowners)
+          contributors = Codeowners::ListContributors.new(base_directory)
+          storage = Codeowners::Storage.new(storage)
+
+          result = Codeowners::Guess.new(owners, contributors, storage, base_directory, out).call(file, debug)
+          # exit(1) unless result.successful?
+
+          out.puts output(result, format)
+        end
+
+        private
+
+        def output(result, format)
+          # method_name = FORMAT_MAPPING.fetch(format)
+          return unless format == "csv"
+
+          result.map do |file, data|
+            "#{file},#{data.fetch(:teams).join('/')},#{data.fetch(:codeowners)}"
+          end.join("\n")
+        end
+      end
+
+      module Import
+        class Org < Command
+          DEFAULT_STORAGE_PATH = ::File.join(Dir.pwd, "codeowners.json").freeze
+          private_constant :DEFAULT_STORAGE_PATH
+
+          DEFAULT_DEBUG = false
+          private_constant :DEFAULT_DEBUG
+
+          desc "Import teams and members for a GitHub organization"
+
+          argument :org, required: true, desc: "GitHub organization login"
+          argument :token, required: true, desc: "GitHub APIv3 token"
+
+          option :storage, type: :string, default: DEFAULT_STORAGE_PATH, desc: "Storage path (default: #{DEFAULT_STORAGE_PATH})"
+          option :debug, type: :boolean, default: DEFAULT_DEBUG, desc: "Print debug information to stdout"
+
+          example [
+            "hanami s3cr374p1t0k3n"
+          ]
+
+          def call(org:, token:, storage:, debug:, **)
+            client = Codeowners::Import::Client.new(token, out)
+            storage = Codeowners::Storage.new(storage)
+
+            Codeowners::Import::Organization.new(client, storage).call(org, debug)
+          end
+        end
+      end
+
       register "version",      Version, aliases: ["v", "-v", "--version"]
       register "list",         List
       register "contributors", Contributors
+      register "guess",        Guess
+
+      register "import" do |prefix|
+        prefix.register "org", Import::Org
+      end
     end
   end
 end

data/lib/codeowners/guess.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Codeowners
+  class Guess
+    def initialize(owners, contributors, storage, base_directory, out)
+      @owners = owners
+      @contributors = contributors
+      @storage = storage
+      @base_directory = ::File.expand_path(base_directory)
+      @out = out
+    end
+
+    def call(file, debug)
+      result = {}
+
+      Dir.chdir(base_directory) do
+        Dir.glob(file).sort.each do |f|
+          *teams, codeowners = list_code_owners(f, debug)
+          *teams, codeowners = guess_code_owners(f, debug) unless codeowners
+          teams ||= []
+
+          result[f] = { teams: teams, codeowners: codeowners }
+        end
+      end
+
+      result
+    end
+
+    private
+
+    attr_reader :owners
+    attr_reader :contributors
+    attr_reader :storage
+    attr_reader :base_directory
+    attr_reader :out
+
+    def list_code_owners(file, _debug)
+      result = owners.call(file)
+
+      if result.successful?
+        teams = result.to_a.find_all do |team|
+          storage.team_exist?(team) &&
+            !storage.blacklisted_team?(team)
+        end
+
+        return [result, true] if teams.any?
+      end
+
+      [nil, false]
+    end
+
+    def guess_code_owners(file, debug)
+      result = contributors.call(file, debug)
+      return [nil, false] unless result.successful?
+
+      contributors = result.to_a
+      result = contributors.each_with_object({}) do |contributor, memo|
+        teams = storage.teams_for(contributor)
+        teams.each do |team|
+          slug = team.fetch("slug")
+
+          memo[slug] ||= {}
+          memo[slug][:insertions] ||= 0
+          memo[slug][:deletions] ||= 0
+          memo[slug][:insertions] += contributor.insertions
+          memo[slug][:deletions] += contributor.deletions
+        end
+      end
+
+      team = result.sort do |a, b|
+        -a.last.fetch(:insertions) <=> -b.last.fetch(:insertions)
+      end&.first&.first
+
+      [team, false]
+    end
+  end
+end

data/lib/codeowners/import/client.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+require "json"
+require "excon"
+
+module Codeowners
+  module Import
+    class Client
+      BASE_URL = "https://api.github.com"
+      private_constant :BASE_URL
+
+      USER_AGENT = "codeowners v#{Codeowners::VERSION}"
+      private_constant :USER_AGENT
+
+      def initialize(token, out, base_url = BASE_URL, user_agent = USER_AGENT, client = Excon, sleep_time: 3)
+        @base_url = base_url
+        @user_agent = user_agent
+        @token = token
+        @client = client
+        @out = out
+        @sleep_time = sleep_time
+      end
+
+      def org(login, debug = false)
+        result = get("/orgs/#{login}", debug: debug)
+
+        {
+          id: result.fetch("id"),
+          login: result.fetch("login")
+        }
+      end
+
+      def org_members(org, debug = false)
+        result = get_paginated("/orgs/#{org.fetch(:login)}/members", debug: debug)
+        result.map do |user|
+          {
+            id: user.fetch("id"),
+            login: user.fetch("login")
+          }
+        end
+      end
+
+      def teams(org, debug = false)
+        result = get_paginated("/orgs/#{org.fetch(:login)}/teams", debug: debug)
+        result.map do |team|
+          {
+            id: team.fetch("id"),
+            org_id: org.fetch(:id),
+            name: team.fetch("name"),
+            slug: team.fetch("slug")
+          }
+        end
+      end
+
+      def team_members(org, teams, debug = false)
+        teams.each_with_object([]) do |team, memo|
+          result = get_paginated("/orgs/#{org.fetch(:login)}/teams/#{team.fetch(:slug)}/members", debug: debug)
+          result.each do |member|
+            team_id = team.fetch(:id)
+            user_id = member.fetch("id")
+
+            memo << {
+              id: [team_id, user_id],
+              team_id: team_id,
+              user_id: user_id
+            }
+          end
+
+          sleep_for_a_while
+        end
+      end
+
+      def users(users, debug)
+        users.each do |user|
+          remote_user = get("/users/#{user.fetch(:login)}", debug: debug)
+          user.merge!(
+            name: remote_user.fetch("name"),
+            email: remote_user.fetch("email")
+          )
+
+          sleep_for_a_while
+        end
+      end
+
+      private
+
+      attr_reader :base_url
+      attr_reader :user_agent
+      attr_reader :token
+      attr_reader :client
+      attr_reader :out
+      attr_reader :sleep_time
+
+      def get(path, debug: false)
+        out.puts "requesting GET #{path}" if debug
+
+        response = client.get(base_url + path, query: query, headers: headers)
+        return {} unless response.status == 200
+
+        JSON.parse(response.body)
+      end
+
+      def get_paginated(path, result = [], debug: false, page: 1)
+        out.puts "requesting GET #{path}, page: #{page}" if debug
+
+        response = client.get(base_url + path, query: query(page: page), headers: headers)
+        return [] unless response.status == 200
+
+        parsed = JSON.parse(response.body)
+        result.push(parsed)
+
+        if parsed.any?
+          sleep_for_a_while
+          get_paginated(path, result, debug: debug, page: page + 1)
+        else
+          result.flatten
+        end
+      end
+
+      def query(options = {})
+        { page: 1, per_page: 100 }.merge(options)
+      end
+
+      def headers
+        {
+          "Authorization" => "token #{token}",
+          "User-Agent" => user_agent
+        }
+      end
+
+      def sleep_for_a_while
+        sleep(sleep_time)
+      end
+    end
+  end
+end

data/lib/codeowners/import/organization.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Codeowners
+  module Import
+    class Organization
+      def initialize(client, storage)
+        @client = client
+        @storage = storage
+      end
+
+      def call(org, debug)
+        org = client.org(org, debug)
+        users = client.org_members(org, debug)
+        users = client.users(users, debug)
+        teams = client.teams(org, debug)
+        memberships = client.team_members(org, teams, debug)
+
+        storage.transaction do |db|
+          db[:orgs].upsert(org)
+          db[:users].upsert(users)
+          db[:teams].upsert(teams)
+          db[:memberships].upsert(memberships)
+        end
+      end
+
+      private
+
+      attr_reader :client
+      attr_reader :storage
+    end
+  end
+end

data/lib/codeowners/list_contributors.rb

@@ -18,6 +18,10 @@ module Codeowners
         [@file, "", *@contributors.map(&:to_s)].join("\n")
       end
 
+      def to_a
+        @contributors.dup
+      end
+
       def to_csv
         @contributors.map(&:to_csv).join("\n")
       end

data/lib/codeowners/result.rb

@@ -16,5 +16,9 @@ module Codeowners
     def to_s
       "#{@pattern}\n\n#{@owners.join('\n')}"
     end
+
+    def to_a
+      @owners.dup.flatten
+    end
   end
 end

data/lib/codeowners/storage.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require "json"
+require "tempfile"
+require "fileutils"
+
+module Codeowners
+  class Storage
+    require "codeowners/storage/data"
+
+    def initialize(path)
+      @path = path
+      @data = Data.new(load_data)
+      @mutex = Mutex.new
+    end
+
+    def transaction
+      @mutex.synchronize do
+        tmp_data = data.dup
+        yield tmp_data
+
+        Tempfile.open("codeowners-storage") do |tmp|
+          tmp.binmode
+          tmp.write(JSON.generate(data.dump))
+          tmp.close
+
+          FileUtils.mv(tmp.path, path, force: true)
+        end
+      end
+    end
+
+    def team_exist?(team)
+      data[:teams].find do |record|
+        record.fetch("slug") == team
+      end
+    end
+
+    def blacklisted_team?(team)
+      data[:teams].find do |record|
+        record.fetch("slug") == team &&
+          record.fetch("blacklisted")
+      end
+    end
+
+    def teams_for(user)
+      found = data[:users].find do |record|
+        record.fetch("email") == user.email ||
+          record.fetch("name") == user.name
+      end
+
+      return [] unless found
+
+      memberships = data[:memberships].find_all do |record|
+        record.fetch("user_id") == found.fetch("id")
+      end
+      memberships.map! { |hash| hash.fetch("team_id") }
+
+      return [] if memberships.empty?
+
+      teams = data[:teams].find_all do |record|
+        !record.fetch("blacklisted") &&
+          memberships.include?(record.fetch("id"))
+      end.flatten
+
+      teams
+    end
+
+    private
+
+    attr_reader :path
+    attr_reader :data
+
+    def load_data
+      return {} unless File.exist?(path)
+
+      JSON.parse(File.read(path))
+    end
+  end
+end

data/lib/codeowners/storage/collection.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Codeowners
+  class Storage
+    class Collection
+      def initialize(collection)
+        @collection = collection.each_with_object({}) do |record, memo|
+          memo[record.fetch("id")] = record
+        end
+      end
+
+      def find(&blk)
+        collection.values.find(&blk)
+      end
+
+      def find_all(&blk)
+        collection.values.find_all(&blk)
+      end
+
+      def upsert(*records)
+        records = Array(records).flatten
+
+        records.each do |record|
+          collection[record.fetch(:id)] = record
+        end
+      end
+
+      def dump
+        collection.values.dup
+      end
+
+      private
+
+      attr_reader :collection
+    end
+  end
+end

data/lib/codeowners/storage/data.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "codeowners/storage/collection"
+
+module Codeowners
+  class Storage
+    class Data
+      COLLECTIONS = %w[orgs users teams memberships].freeze
+      private_constant :COLLECTIONS
+
+      def initialize(data, collections: COLLECTIONS)
+        @data = collections.each_with_object({}) do |name, memo|
+          memo[name] = Collection.new(data.fetch(name, []))
+        end
+      end
+
+      def [](name)
+        data.fetch(name.to_s)
+      end
+
+      def dump
+        data.transform_values(&:dump)
+      end
+
+      private
+
+      attr_reader :data
+    end
+  end
+end

data/lib/codeowners/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: codeowners
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Luca Guidi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-27 00:00:00.000000000 Z
+date: 2020-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-cli
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: excon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.75'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.75'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -76,9 +90,15 @@ files:
 - lib/codeowners/git.rb
 - lib/codeowners/git/contributor.rb
 - lib/codeowners/git/contributors.rb
+- lib/codeowners/guess.rb
+- lib/codeowners/import/client.rb
+- lib/codeowners/import/organization.rb
 - lib/codeowners/list_contributors.rb
 - lib/codeowners/list_owners.rb
 - lib/codeowners/result.rb
+- lib/codeowners/storage.rb
+- lib/codeowners/storage/collection.rb
+- lib/codeowners/storage/data.rb
 - lib/codeowners/version.rb
 homepage: https://lucaguidi.com
 licenses: []