codeowners-checker 1.0.4 → 1.0.5

data/lib/codeowners/cli/wizards/new_owner_wizard.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require_relative '../interactive_ops'
+
+module Codeowners
+  module Cli
+    module Wizards
+      # Attempt to find a name similar to one provided in the owners list.
+      # Suggest to add new owner to the owners list.
+      # Only return decision without applying any modifications.
+      class NewOwnerWizard
+        include InteractiveOps
+
+        DEFAULT_OPTIONS = {
+          'a' => '(a) add a new owner',
+          'r' => '(r) rename owner',
+          'i' => '(i) ignore owner in this session',
+          'q' => '(q) quit and save'
+        }.freeze
+
+        def initialize(owners_list)
+          @owners_list = owners_list
+        end
+
+        def suggest_fixing(line, new_owner)
+          suggested_owner = suggest_name_from_owners_list(new_owner)
+          case prompt(line, new_owner, suggested_owner)
+          when 'y' then [:rename, suggested_owner]
+          when 'a' then :add
+          when 'r' then [:rename, keep_asking_until_valid_owner]
+          when 'i' then :ignore
+          when 'q' then :quit
+          end
+        end
+
+        private
+
+        def suggest_name_from_owners_list(new_owner)
+          require 'fuzzy_match'
+          search = FuzzyMatch.new(@owners_list.owners)
+          (suggested_owner, dice, _lev) = search.find_with_score(new_owner)
+          return suggested_owner if dice && dice > 0.6
+        end
+
+        def prompt(line, new_owner, suggested_owner)
+          prompt_options = build_prompt_options(suggested_owner)
+          ask(<<~QUESTION, limited_to: prompt_options.keys)
+            #{question_body(line, new_owner, suggested_owner)}
+            #{question_options(prompt_options)}
+          QUESTION
+        end
+
+        def question_body(line, new_owner, suggested_owner)
+          prompt = "Unknown owner: #{new_owner} for pattern: #{line.pattern}."
+          if suggested_owner
+            prompt + " Did you mean #{suggested_owner}?"
+          else
+            prompt + ' Choose an option:'
+          end
+        end
+
+        def question_options(accepted_options)
+          accepted_options.values.join("\n")
+        end
+
+        def build_prompt_options(suggested_owner)
+          return DEFAULT_OPTIONS unless suggested_owner
+
+          { 'y' => "(y) correct to #{suggested_owner}" }.merge(DEFAULT_OPTIONS)
+        end
+
+        def keep_asking_until_valid_owner
+          loop do
+            owner = ask('New owner: ')
+            owner = '@' + owner unless owner[0] == '@'
+            return owner if @owners_list.valid_owner?(owner)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/codeowners/cli/wizards/unrecognized_line_wizard.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative '../interactive_ops'
+
+module Codeowners
+  module Cli
+    module Wizards
+      # Suggests to fix unrecognized lines in the codeowners file.
+      # Only returns decision without applying any modifications.
+      class UnrecognizedLineWizard
+        include InteractiveOps
+
+        def suggest_fixing(line)
+          case prompt(line)
+          when 'i' then :ignore
+          when 'y' then [:replace, keep_asking_until_valid_line]
+          when 'd' then :delete
+          end
+        end
+
+        private
+
+        def prompt(line)
+          ask(<<~QUESTION, limited_to: %w[y i d])
+            #{line.to_s.inspect} is in unrecognized format. Would you like to edit?
+            (y) yes
+            (i) ignore
+            (d) delete the line
+          QUESTION
+        end
+
+        def keep_asking_until_valid_line
+          line = nil
+          loop do
+            new_line_string = ask('New line: ')
+            line = Codeowners::Checker::Group::Line.build(new_line_string)
+            break unless line.is_a?(Codeowners::Checker::Group::UnrecognizedLine)
+          end
+          line
+        end
+      end
+    end
+  end
+end

data/lib/codeowners/cli/wizards/useless_pattern_wizard.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require_relative '../interactive_ops'
+
+module Codeowners
+  module Cli
+    module Wizards
+      # Suggests to fix useless patterns in the codeowners file.
+      # Only returns decision without applying any modifications.
+      class UselessPatternWizard
+        include InteractiveOps
+
+        def suggest_fixing(line)
+          puts "Pattern #{line.pattern.inspect} doesn't match."
+          suggestion = Codeowners::Cli::SuggestFileFromPattern.new(line.pattern).pick_suggestion
+
+          # TODO: Handle duplicate patterns.
+          if suggestion
+            apply_suggestion(line, suggestion)
+          else
+            pattern_fix(line)
+          end
+        end
+
+        private
+
+        def apply_suggestion(line, suggestion)
+          case make_suggestion(suggestion)
+          when 'i' then :ignore
+          when 'y' then [:replace, suggestion]
+          when 'e' then edit_pattern(line)
+          when 'd' then :delete
+          when 'q' then :quit
+          end
+        end
+
+        def make_suggestion(suggestion)
+          ask(<<~QUESTION, limited_to: %w[y i e d q])
+            Replace with: #{suggestion.inspect}?
+            (y) yes
+            (i) ignore
+            (e) edit the pattern
+            (d) delete the pattern
+            (q) quit and save
+          QUESTION
+        end
+
+        def pattern_fix(line)
+          case pattern_suggest_fixing
+          when 'e' then edit_pattern(line)
+          when 'i' then :ignore
+          when 'd' then :delete
+          when 'q' then :quit
+          end
+        end
+
+        def pattern_suggest_fixing
+          ask(<<~QUESTION, limited_to: %w[i e d q])
+            (e) edit the pattern
+            (d) delete the pattern
+            (i) ignore
+            (q) quit and save
+          QUESTION
+        end
+
+        def edit_pattern(line)
+          new_pattern = ask("Replace pattern #{line.pattern.inspect} with: ")
+          return :nop if new_pattern.empty?
+
+          [:replace, new_pattern]
+        end
+      end
+    end
+  end
+end

data/lib/codeowners/github_fetcher.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'rest-client'
+require 'json'
+
+module Codeowners
+  # Fetch teams and members from GitHub and return them in list
+  class GithubFetcher
+    class << self
+      GITHUB_URL = 'https://api.github.com'
+
+      # Fetch teams and members from GitHub.
+      # authorization_token is GitHub PAT with read:org scope
+      # @return <Array> with GitHub teams and individuals belonging to a given GitHub organization
+      def get_owners(github_org, authorization_token)
+        headers = get_headers(authorization_token)
+        base_url = GITHUB_URL + '/orgs/' + github_org
+        owners = []
+        list_entities(base_url + '/teams', headers) { |team| owners << "@#{github_org}/#{team['slug']}" }
+        list_entities(base_url + '/members', headers) { |member| owners << "@#{member['login']}" }
+        owners
+      end
+
+      private
+
+      # Helper method to get properly formatted HTTP headers
+      def get_headers(authorization_token)
+        {
+          Accept: 'application/vnd.github.v3+json',
+          Authorization: "token #{authorization_token}"
+        }
+      end
+
+      # Helper method that loops through all pages if GitHub returns a paged response
+      def list_entities(first_page, headers)
+        next_page = first_page
+        loop do
+          response = RestClient.get(next_page, headers)
+          response_json = JSON.parse(response.body)
+          response_json.each { |entity| yield entity }
+          next_page = get_next_page(response)
+          break unless next_page
+        end
+      end
+
+      # Helper method to parse and get URL of the next page from 'link' response header
+      def get_next_page(response)
+        return nil unless response.headers[:link]
+
+        matches = response.headers[:link].match('<([^>]+)>; rel="next"')
+        return matches[1] if matches
+      end
+    end
+  end
+end

data/lib/codeowners/reporter.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Codeowners
+  # This class is responsible for print the reports
+  class Reporter
+    LABELS = {
+      missing_ref: 'No owner defined',
+      useless_pattern: 'Useless patterns',
+      invalid_owner: 'Invalid owner',
+      unrecognized_line: 'Unrecognized line'
+    }.freeze
+
+    class << self
+      def print_delimiter_line(error_type)
+        raise ArgumentError, "unknown error type '#{error_type}'" unless LABELS.key?(error_type)
+
+        print('-' * 30, LABELS[error_type], '-' * 30)
+      end
+
+      def print_error(error_type, inconsistencies, meta)
+        case error_type
+        when :invalid_owner then print("#{inconsistencies} MISSING: #{meta.join(', ')}")
+        else print(inconsistencies.to_s)
+        end
+      end
+
+      def print(*args)
+        puts(*args)
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: codeowners-checker
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - Jônatas Davi Paganini
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-10 00:00:00.000000000 Z
+date: 2019-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fuzzy_match
@@ -40,6 +40,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -208,14 +236,25 @@ files:
 - lib/codeowners/checker/group/unrecognized_line.rb
 - lib/codeowners/checker/line_grouper.rb
 - lib/codeowners/checker/owner.rb
+- lib/codeowners/checker/owners_list.rb
 - lib/codeowners/checker/version.rb
 - lib/codeowners/cli/base.rb
-- lib/codeowners/cli/check.rb
 - lib/codeowners/cli/config.rb
 - lib/codeowners/cli/filter.rb
+- lib/codeowners/cli/interactive_ops.rb
+- lib/codeowners/cli/interactive_resolver.rb
+- lib/codeowners/cli/interactive_runner.rb
 - lib/codeowners/cli/main.rb
+- lib/codeowners/cli/owners_list_handler.rb
 - lib/codeowners/cli/suggest_file_from_pattern.rb
+- lib/codeowners/cli/wizards.rb
+- lib/codeowners/cli/wizards/new_file_wizard.rb
+- lib/codeowners/cli/wizards/new_owner_wizard.rb
+- lib/codeowners/cli/wizards/unrecognized_line_wizard.rb
+- lib/codeowners/cli/wizards/useless_pattern_wizard.rb
 - lib/codeowners/config.rb
+- lib/codeowners/github_fetcher.rb
+- lib/codeowners/reporter.rb
 homepage: https://github.com/toptal/codeowners-checker
 licenses:
 - MIT
@@ -235,8 +274,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Check consistency of Github CODEOWNERS and git changes.

data/lib/codeowners/cli/check.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-module Codeowners
-  module Cli
-    class Check < Base
-    end
-  end
-end