codeowners-checker 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9768a17e8e26a830efa9f9808aec4a6e2fad800b1da0e7223fa68b8ee1a4c31c
-  data.tar.gz: 0e744a329069f56f24a1ba922c1c614eef6667816de05d6b042f2c77a883b559
+  metadata.gz: 94005a8b1e6eae5bf06a313f752d8adc3aa060d452487f20f22d8e1bef3dddb3
+  data.tar.gz: f02eab71b3bbb472c9ee3ca3d721dcecd611cd55b0a8ab5746f9606b8d6f4c4b
 SHA512:
-  metadata.gz: 02bcb19b84e96d42aedb93253baaedc4ead716c259dfc811f76d2bc75285c5a97ce69cffd4d88f82a9b5fa2891409337158fc0ba7fbef7090a55eaf9d722f41b
-  data.tar.gz: 2d63073791a7fa205e3aee026158fd37841217316c0a6bbbdad5c75f0ac73d9d9f3ab6858296c918cfc167654ca2d3778db4dc29822b1dbc98f16ebe21ea4c33
+  metadata.gz: 71ab0e69066731091f2ac51afb108a1ba67b17dc6e0d7693a4227ea9964c46d7833c9ab1e89cb822187d1f05fc70a39541aaa0a9e3d30c18bd2c2ee04d5431e8
+  data.tar.gz: 839ea4f56af40e7dfdc9ca452c6caddd1ea4ee0d6bc5884f5dd37f7ead3fc2a89739ac8ae01279c5e1518d95feba6df02a4209607648f5051bc5508d3d480ad2

data/README.md

@@ -9,7 +9,6 @@ between two git revisions.
 
 ## Usage
 
-
 ### Configure
 
     $  codeowners-checker config owner <@owner>
@@ -114,6 +113,9 @@ the comments defining the group are deleted as well as the pattern.
 
 ![Useless pattern example](demos/useless_pattern.svg)
 
+You can also use [fzf](https://github.com/junegunn/fzf) to pick better results
+and interactively choose the right file.
+
 Invalid patterns were fixed and the group `Security` was removed when deleting the only pattern
 in the group:
 ```

data/codeowners-checker.gemspec

@@ -3,19 +3,19 @@
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'codeowners/checker/version'
+require 'codeowners/cli/suggest_file_from_pattern'
 
 Gem::Specification.new do |spec|
   spec.name          = 'codeowners-checker'
   spec.version       = Codeowners::Checker::VERSION
   spec.authors       = ['Jônatas Davi Paganini', 'Eva Kadlecová', 'Michal Papis']
   spec.email         = ['open-source@toptal.com']
+  spec.homepage      = 'https://github.com/toptal/codeowners-checker'
 
   spec.summary       = 'Check consistency of Github CODEOWNERS and git changes.'
   spec.license       = 'MIT'
 
-  spec.files = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
-  end
+  spec.files = Dir['codeowners-checker.gemspec', '*.{md,txt}', 'lib/**/*.rb']
   spec.bindir        = 'bin'
   spec.executables   = ['codeowners-checker']
   spec.require_paths = ['lib']
@@ -31,4 +31,12 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop', '~> 0.61.1'
   spec.add_development_dependency 'rubocop-rspec', '~> 1.30'
   spec.add_development_dependency 'simplecov', '~> 0.16.1'
+
+  unless ENV['TRAVIS']
+    unless Codeowners::Cli::SuggestFileFromPattern.installed_fzf?
+      spec.post_install_message = <<~MESSAGE
+        Please, install `fzf` for a better experience.
+      MESSAGE
+    end
+  end
 end

data/issues.md

@@ -0,0 +1,29 @@
+ problems
+
+ - linked lines groups serve to  attach or dettach specific info into a chunk of text
+ - linked lines belong to a group and group belong to file
+ 
+
+what we're trying to solve
+
+1. we have a file that have a tree structure without holding the tree
+  CodeOwners holds the flat structure
+
+2. we need to interpret and parse the tree structure from the file
+  Group holds the tree structure with LineGroupers and pure lines
+
+3. we need to iterate over the lines to verify the file consistency
+  Checker do that.
+
+3.1 we interact with user when find similar and duplicated lines
+
+4. we need to remove a line and remove a group if the line was the last pattern
+in the group.
+ - the Line knows how to remove them selves.
+
+5. we need to add or change lines
+ - the Group knows what file it belongs and allow to insert a pattern in the
+     middle or in the bottom of the file
+
+
+

data/lib/codeowners/checker.rb

@@ -34,11 +34,8 @@ module Codeowners
       changes_to_analyze.select { |_k, v| v == 'A' }.keys
     end
 
-    def check!
-      {
-        missing_ref: missing_reference,
-        useless_pattern: useless_pattern
-      }
+    def fix!
+      catch(:user_quit) { results }
     end
 
     def changes_for_patterns(patterns)
@@ -82,7 +79,7 @@ module Codeowners
     end
 
     def pattern_has_files(pattern)
-      @git.ls_files(pattern).any?
+      @git.ls_files(pattern.gsub(%r{^/}, '')).any?
     end
 
     def defined_owner?(file)
@@ -107,17 +104,29 @@ module Codeowners
       codeowners.main_group
     end
 
+    def consistent?
+      results.values.all?(&:empty?)
+    end
+
     def commit_changes!
       @git.add(codeowners_filename)
       @git.commit('Fix pattern :robot:')
     end
 
-    private
-
     def codeowners_filename
       directories = ['', '.github', 'docs', '.gitlab']
       paths = directories.map { |dir| File.join(@repo_dir, dir, 'CODEOWNERS') }
       Dir.glob(paths).first || paths.first
     end
+
+    private
+
+    def results
+      @results ||=
+        {
+          missing_ref: missing_reference,
+          useless_pattern: useless_pattern
+        }
+    end
   end
 end

data/lib/codeowners/checker/code_owners.rb

@@ -20,7 +20,7 @@ module Codeowners
       end
 
       def persist!
-        file_manager.content = to_content
+        file_manager.content = main_group.to_file
       end
 
       def main_group

data/lib/codeowners/checker/file_as_array.rb

@@ -9,12 +9,15 @@ module Codeowners
         @target_dir, = File.split(@file)
       end
 
+      # @return <Array> of lines chomped
       def content
         @content ||= File.readlines(@file).map(&:chomp)
       rescue Errno::ENOENT
         @content = []
       end
 
+      # Save content to the @file
+      # Creates the directory of the file if needed
       def content=(content)
         @content = content
 

data/lib/codeowners/checker/group.rb

@@ -25,7 +25,7 @@ module Codeowners
           if object.is_a?(Group)
             object.each(&block)
           else
-            block.call(object)
+            yield(object)
           end
         end
       end
@@ -38,8 +38,14 @@ module Codeowners
         @list.flat_map(&:to_content)
       end
 
+      def to_file
+        @list.flat_map(&:to_file)
+      end
+
       # Returns an array of strings representing the structure of the group.
       # It indent internal subgroups for readability and debugging purposes.
+      # rubocop:disable Metrics/MethodLength
+      # rubocop:disable Metrics/AbcSize
       def to_tree(indentation = '')
         @list.each_with_index.flat_map do |item, index|
           if indentation.empty?
@@ -53,6 +59,8 @@ module Codeowners
           end
         end
       end
+      # rubocop:enable Metrics/MethodLength
+      # rubocop:enable Metrics/AbcSize
 
       def owner
         owners.first
@@ -67,7 +75,7 @@ module Codeowners
 
       def subgroups_owned_by(owner)
         @list.flat_map do |item|
-          return [] unless item.is_a?(Group)
+          next unless item.is_a?(Group)
 
           a = []
           a << item if item.owner == owner
@@ -110,7 +118,7 @@ module Codeowners
       end
 
       def ==(other)
-        other.kind_of?(Group) && other.list == list
+        other.is_a?(Group) && other.list == list
       end
 
       protected
@@ -125,17 +133,21 @@ module Codeowners
         end.compact
       end
 
+      # rubocop:disable Metrics/AbcSize
       def insert_at_index(line)
-        patterns = @list.grep(Pattern)
-        new_patterns_sorted = patterns.dup.push(line).sort
-        new_pattern_index = new_patterns_sorted.index { |l| l.equal? line }
-
-        if new_pattern_index > 0 # rubocop:disable Style/NumericPredicate
-          new_pattern_index + 1
+        new_patterns_sorted = @list.grep(Pattern).dup.push(line).sort
+        previous_line_index = new_patterns_sorted.index { |l| l.equal? line } - 1
+        previous_line = new_patterns_sorted[previous_line_index]
+        padding = previous_line.pattern.size + previous_line.whitespace - line.pattern.size
+        line.whitespace = [1, padding].max
+
+        if previous_line_index >= 0
+          @list.index { |l| l.equal? previous_line } + 1
         else
           find_last_line_of_initial_comments
         end
       end
+      # rubocop:enable Metrics/AbcSize
 
       def find_last_line_of_initial_comments
         @list.each_with_index do |item, index|

data/lib/codeowners/checker/group/line.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'pathname'
 module Codeowners
   class Checker
     class Group
@@ -8,7 +9,7 @@ module Codeowners
       class Line
         attr_accessor :parent
 
-        def self.build(line, transform_line_procs: nil)
+        def self.build(line)
           subclasses.each do |klass|
             return klass.new(line) if klass.match?(line)
           end
@@ -31,6 +32,10 @@ module Codeowners
           to_s
         end
 
+        def to_file
+          to_s
+        end
+
         def pattern?
           is_a?(Pattern)
         end
@@ -41,7 +46,7 @@ module Codeowners
 
         def remove!
           parent&.remove(self)
-          parent = nil
+          self.parent = nil
         end
 
         def ==(other)
@@ -53,25 +58,6 @@ module Codeowners
         def <=>(other)
           to_s <=> other.to_s
         end
-
-        # Pick all files from parent folder of pattern.
-        # This is used to build a list of suggestions case the pattern is not
-        # matching.
-        # If the pattern use "*/*" it will consider "."
-        # If the pattern uses Static files, it tries to reach the parent.
-        # If the pattern revers to the root folder, pick all files from the
-        # current pattern dir.
-        def suggest_files_for_pattern
-          parent_folders = pattern.split('/')[0..-2]
-          parent_folders << '*' if parent_folders[-1] != '*'
-          files = Dir[File.join(*parent_folders)] || []
-          files.map(&method(:normalize_path))
-        end
-
-        def normalize_path(file)
-          Pathname.new(file)
-                  .relative_path_from(Pathname.new('.')).to_s
-        end
       end
     end
   end

data/lib/codeowners/checker/group/pattern.rb

@@ -1,17 +1,20 @@
 # frozen_string_literal: true
 
 require_relative 'line'
+require_relative '../owner'
 
 module Codeowners
   class Checker
     class Group
       # Defines and manages line type pattern.
+      # Parse the line into pattern, owners and whitespaces.
       class Pattern < Line
-        attr_accessor :pattern, :owners
+        attr_accessor :owners, :whitespace
+        attr_reader :pattern
 
         def self.match?(line)
           _pattern, *owners = line.split(/\s+/)
-          owners.any? && owners.all? { |owner| owner.include?('@') }
+          Owner.valid?(*owners)
         end
 
         def initialize(line)
@@ -23,22 +26,38 @@ module Codeowners
           owners.first
         end
 
+        # Parse the line counting whitespaces between pattern and owners.
         def parse(line)
           @pattern, *@owners = line.split(/\s+/)
+          @whitespace = line.split('@').first.count(' ') - 1
         end
 
         def match_file?(file)
-          regex.match(file)
+          if !pattern.include?('/') || pattern.include?('**')
+            File.fnmatch(pattern.gsub(%r{^/}, ''), file, File::FNM_DOTMATCH)
+          else
+            File.fnmatch(pattern.gsub(%r{^/}, ''), file, File::FNM_PATHNAME | File::FNM_DOTMATCH)
+          end
         end
 
-        def to_s
-          [@pattern, @owners].join(' ')
+        def pattern=(new_pattern)
+          @whitespace += @pattern.size - new_pattern.size
+          @whitespace = 1 if @whitespace < 1
+
+          @pattern = new_pattern
         end
 
-        private
+        # @return String with the pattern and owners
+        # Use @param preserve_whitespaces to keep the previous identation.
+        def to_file(preserve_whitespaces: true)
+          line = pattern
+          spaces = preserve_whitespaces ? whitespace : 0
+          line << ' ' * spaces
+          [line, *owners].join(' ')
+        end
 
-        def regex
-          Regexp.new(pattern.gsub(%r{/\*\*}, '(/[^/]+)+').gsub(/\*/, '[^/]+'))
+        def to_s
+          to_file(preserve_whitespaces: false)
         end
       end
     end

data/lib/codeowners/checker/line_grouper.rb

@@ -13,6 +13,9 @@ module Codeowners
         @lines = lines
       end
 
+      # rubocop:disable Metrics/AbcSize
+      # rubocop:disable Metrics/CyclomaticComplexity
+      # rubocop:disable Metrics/MethodLength
       def call
         lines.each_with_index do |line, index|
           case line
@@ -46,6 +49,9 @@ module Codeowners
         end
         group_buffer.first
       end
+      # rubocop:enable Metrics/AbcSize
+      # rubocop:enable Metrics/CyclomaticComplexity
+      # rubocop:enable Metrics/MethodLength
 
       private
 
@@ -55,7 +61,7 @@ module Codeowners
         index.positive? && lines[index - 1].is_a?(Codeowners::Checker::Group::Empty)
       end
 
-      def new_owner?(line, index)
+      def new_owner?(line, index) # rubocop:disable Metrics/MethodLength
         if previous_line_empty?(index)
           offset = 2
           while (index - offset).positive?

data/lib/codeowners/checker/owner.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Codeowners
+  class Checker
+    # Owner shared methods.
+    module Owner
+      def self.valid?(*owners)
+        owners.any? && owners.all? { |owner| owner.include?('@') }
+      end
+    end
+  end
+end

data/lib/codeowners/checker/version.rb

@@ -2,6 +2,6 @@
 
 module Codeowners
   class Checker
-    VERSION = '1.0.0'
+    VERSION = '1.0.1'
   end
 end

data/lib/codeowners/cli/main.rb

@@ -1,29 +1,32 @@
 # frozen_string_literal: true
 
-require 'fuzzy_match'
-
 require_relative '../checker'
 require_relative 'base'
 require_relative 'config'
 require_relative 'filter'
+require_relative 'suggest_file_from_pattern'
+require_relative '../checker/owner'
 
 module Codeowners
   module Cli
     # Command Line Interface used by bin/codeowners-checker.
-    class Main < Base
+    class Main < Base # rubocop:disable Metrics/ClassLength
       LABEL = { missing_ref: 'Missing references', useless_pattern: 'No files matching with the pattern' }.freeze
       option :from, default: 'origin/master'
       option :to, default: 'HEAD'
       option :interactive, default: true, type: :boolean, aliases: '-i'
+      option :autocommit, default: false, type: :boolean, aliases: '-c'
       desc 'check REPO', 'Checks .github/CODEOWNERS consistency'
       # for pre-commit: --from HEAD --to index
       def check(repo = '.')
         @codeowners_changed = false
         @repo = repo
         setup_checker
-        @checker.check!
-        write_codeowners if @codeowners_changed
-        @checker.commit_changes! if options[:interactive] && yes?('Commit changes?')
+        if options[:interactive]
+          interactive_mode
+        else
+          report_inconsistencies
+        end
       end
 
       desc 'filter <by-owner>', 'List owners of changed files'
@@ -34,12 +37,31 @@ module Codeowners
 
       private
 
-      def setup_checker
+      def interactive_mode
+        @checker.fix!
+        return unless @codeowners_changed
+
+        write_codeowners
+        @checker.commit_changes! if options[:autocommit] || yes?('Commit changes?')
+      end
+
+      def report_inconsistencies
+        if @checker.consistent?
+          puts '✅ File is consistent'
+          exit 0
+        else
+          puts "File #{@checker.codeowners_filename} is inconsistent:"
+          report_errors!
+          exit(-1)
+        end
+      end
+
+      def setup_checker # rubocop:disable Metrics/AbcSize
         to = options[:to] != 'index' ? options[:to] : nil
         @checker = Codeowners::Checker.new(@repo, options[:from], to)
         @checker.when_useless_pattern = method(:suggest_fix_for)
         @checker.when_new_file = method(:suggest_add_to_codeowners)
-        @checker.transformers << method(:unrecognized_line)
+        @checker.transformers << method(:unrecognized_line) if options[:interactive]
       end
 
       def write_codeowners
@@ -47,15 +69,24 @@ module Codeowners
       end
 
       def suggest_add_to_codeowners(file)
-        return unless yes?("File added: #{file.inspect}. Add owner to the CODEOWNERS file?")
+        case add_to_codeowners_dialog(file)
+        when 'y' then add_to_codeowners(file)
+        when 'i' then nil
+        when 'q' then throw :user_quit
+        end
+      end
 
-        owner = ask('File owner(s): ')
-        new_line = create_new_pattern(file, owner)
+      def add_to_codeowners_dialog(file)
+        ask(<<~QUESTION, limited_to: %w[y i q])
+          File added: #{file.inspect}. Add owner to the CODEOWNERS file?
+          (y) yes
+          (i) ignore
+          (q) quit and save
+        QUESTION
+      end
 
-        unless new_line.pattern?
-          puts "#{owner.inspect} is not a valid owner name."
-          return
-        end
+      def add_to_codeowners(file)
+        new_line = create_new_pattern(file)
 
         subgroups = @checker.main_group.subgroups_owned_by(new_line.owner)
         add_pattern(new_line, subgroups)
@@ -63,14 +94,42 @@ module Codeowners
         @codeowners_changed = true
       end
 
-      def create_new_pattern(file, owner)
-        line = "#{file} #{owner}"
-        Codeowners::Checker::Group::Line.build(line)
+      def create_new_pattern(file)
+        sorted_owners = @checker.main_group.owners.sort
+        list_owners(sorted_owners)
+        loop do
+          owner = new_owner(sorted_owners)
+
+          unless Codeowners::Checker::Owner.valid?(owner)
+            puts "#{owner.inspect} is not a valid owner name. Try again."
+            next
+          end
+
+          return Codeowners::Checker::Group::Pattern.new("#{file} #{owner}")
+        end
+      end
+
+      def list_owners(sorted_owners)
+        puts 'Owners:'
+        sorted_owners.each_with_index { |owner, i| puts "#{i + 1} - #{owner}" }
+        puts "Choose owner, add new one or leave empty to use #{@config.default_owner.inspect}."
+      end
+
+      def new_owner(sorted_owners)
+        owner = ask('New owner: ')
+
+        if owner.to_i.between?(1, sorted_owners.length)
+          sorted_owners[owner.to_i - 1]
+        elsif owner.empty?
+          @config.default_owner
+        else
+          owner
+        end
       end
 
       def add_pattern(pattern, subgroups)
         unless subgroups.empty?
-          return if insert_pattern_into_subgroup(pattern, subgroups) == true
+          return if insert_pattern_into_subgroup(pattern, subgroups)
         end
 
         @checker.main_group.add(pattern) if yes?('Add to the end of the CODEOWNERS file?')
@@ -91,10 +150,10 @@ module Codeowners
       end
 
       def suggest_fix_for(line)
-        search = FuzzyMatch.new(line.suggest_files_for_pattern)
-        suggestion = search.find(line.pattern)
+        return unless options[:interactive]
 
         puts "Pattern #{line.pattern.inspect} doesn't match."
+        suggestion = Codeowners::Cli::SuggestFileFromPattern.new(line.pattern).pick_suggestion
 
         # TODO: Handle duplicate patterns.
         if suggestion
@@ -109,22 +168,21 @@ module Codeowners
       def apply_suggestion(line, suggestion)
         case make_suggestion(suggestion)
         when 'i' then nil
-        when 'y'
-          line.pattern = suggestion
-        when 'e'
-          pattern_change(line)
-        when 'd'
-          line.remove!
+        when 'y' then line.pattern = suggestion
+        when 'e' then pattern_change(line)
+        when 'd' then line.remove!
+        when 'q' then throw :user_quit
         end
       end
 
       def make_suggestion(suggestion)
-        ask(<<~QUESTION, limited_to: %w[y i e d])
+        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
 
@@ -133,14 +191,16 @@ module Codeowners
         when 'e' then pattern_change(line)
         when 'i' then nil
         when 'd' then line.remove!
+        when 'q' then throw :user_quit
         end
       end
 
       def pattern_suggest_fixing
-        ask(<<~QUESTION, limited_to: %w[i e d])
+        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
 
@@ -172,12 +232,39 @@ module Codeowners
 
       def unrecognized_line_new_line
         line = nil
-        begin
+        loop do
           new_line_string = ask('New line: ')
           line = Codeowners::Checker::Group::Line.build(new_line_string)
-        end while line.is_a?(Codeowners::Checker::Group::UnrecognizedLine)
+          break unless line.is_a?(Codeowners::Checker::Group::UnrecognizedLine)
+        end
+        @codeowners_changed = true
         line
       end
+
+      def ask(message, *opts)
+        return unless options[:interactive]
+
+        super
+      end
+
+      def yes?(message, *opts)
+        return unless options[:interactive]
+
+        super
+      end
+
+      LABELS = {
+        missing_ref: 'No owner defined',
+        useless_pattern: 'Useless patterns'
+      }.freeze
+
+      def report_errors!
+        @checker.fix!.each do |error_type, inconsistencies|
+          next if inconsistencies.empty?
+
+          puts LABELS[error_type], '-' * 30, inconsistencies, '-' * 30
+        end
+      end
     end
   end
 end