codeowners-checker 1.0.0

data/lib/codeowners/cli/main.rb

@@ -0,0 +1,183 @@
+# frozen_string_literal: true
+
+require 'fuzzy_match'
+
+require_relative '../checker'
+require_relative 'base'
+require_relative 'config'
+require_relative 'filter'
+
+module Codeowners
+  module Cli
+    # Command Line Interface used by bin/codeowners-checker.
+    class Main < Base
+      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'
+      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?')
+      end
+
+      desc 'filter <by-owner>', 'List owners of changed files'
+      subcommand 'filter', Codeowners::Cli::Filter
+
+      desc 'config', 'Checks config is consistent or configure it'
+      subcommand 'config', Codeowners::Cli::Config
+
+      private
+
+      def setup_checker
+        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)
+      end
+
+      def write_codeowners
+        @checker.codeowners.persist!
+      end
+
+      def suggest_add_to_codeowners(file)
+        return unless yes?("File added: #{file.inspect}. Add owner to the CODEOWNERS file?")
+
+        owner = ask('File owner(s): ')
+        new_line = create_new_pattern(file, owner)
+
+        unless new_line.pattern?
+          puts "#{owner.inspect} is not a valid owner name."
+          return
+        end
+
+        subgroups = @checker.main_group.subgroups_owned_by(new_line.owner)
+        add_pattern(new_line, subgroups)
+
+        @codeowners_changed = true
+      end
+
+      def create_new_pattern(file, owner)
+        line = "#{file} #{owner}"
+        Codeowners::Checker::Group::Line.build(line)
+      end
+
+      def add_pattern(pattern, subgroups)
+        unless subgroups.empty?
+          return if insert_pattern_into_subgroup(pattern, subgroups) == true
+        end
+
+        @checker.main_group.add(pattern) if yes?('Add to the end of the CODEOWNERS file?')
+      end
+
+      def insert_pattern_into_subgroup(pattern, subgroups)
+        subgroup = suggest_subgroups_for_pattern(subgroups).to_i - 1
+        return unless subgroup >= 0 && subgroup < subgroups.length
+
+        subgroups[subgroup].insert(pattern)
+        true
+      end
+
+      def suggest_subgroups_for_pattern(subgroups)
+        puts 'Possible groups to which the pattern belongs: '
+        subgroups.each_with_index { |group, i| puts "#{i + 1} - #{group.title}" }
+        ask('Choose group: ')
+      end
+
+      def suggest_fix_for(line)
+        search = FuzzyMatch.new(line.suggest_files_for_pattern)
+        suggestion = search.find(line.pattern)
+
+        puts "Pattern #{line.pattern.inspect} doesn't match."
+
+        # TODO: Handle duplicate patterns.
+        if suggestion
+          apply_suggestion(line, suggestion)
+        else
+          pattern_fix(line)
+        end
+
+        @codeowners_changed = true
+      end
+
+      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!
+        end
+      end
+
+      def make_suggestion(suggestion)
+        ask(<<~QUESTION, limited_to: %w[y i e d])
+          Replace with: #{suggestion.inspect}?
+          (y) yes
+          (i) ignore
+          (e) edit the pattern
+          (d) delete the pattern
+        QUESTION
+      end
+
+      def pattern_fix(line)
+        case pattern_suggest_fixing
+        when 'e' then pattern_change(line)
+        when 'i' then nil
+        when 'd' then line.remove!
+        end
+      end
+
+      def pattern_suggest_fixing
+        ask(<<~QUESTION, limited_to: %w[i e d])
+          (e) edit the pattern
+          (d) delete the pattern
+          (i) ignore
+        QUESTION
+      end
+
+      def pattern_change(line)
+        new_pattern = ask("Replace pattern #{line.pattern.inspect} with: ")
+        return if new_pattern.empty?
+
+        line.pattern = new_pattern
+      end
+
+      def unrecognized_line(line)
+        return line unless line.is_a?(Codeowners::Checker::Group::UnrecognizedLine)
+
+        case unrecognized_line_suggest_fixing(line)
+        when 'i' then line
+        when 'y' then unrecognized_line_new_line
+        when 'd' then nil
+        end
+      end
+
+      def unrecognized_line_suggest_fixing(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 unrecognized_line_new_line
+        line = nil
+        begin
+          new_line_string = ask('New line: ')
+          line = Codeowners::Checker::Group::Line.build(new_line_string)
+        end while line.is_a?(Codeowners::Checker::Group::UnrecognizedLine)
+        line
+      end
+    end
+  end
+end

data/lib/codeowners/config.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+Git::Lib.class_eval do
+  def config_set(name, value)
+    command('config',  [name, value])
+  rescue Git::GitExecuteError
+    command('config',  ['--add', name, value])
+  end
+
+  def config_get(name)
+    do_get = proc do |_path|
+      command('config', ['--get', name])
+    end
+
+    if @git_dir
+      Dir.chdir(@git_dir, &do_get)
+    else
+      do_get.call
+    end
+  end
+end
+
+module Codeowners
+  class AnonymousGit
+    include Git
+  end
+
+  # Connfigure and manage the git config file.
+  class Config
+    def initialize(git = AnonymousGit.new)
+      @git = git
+    end
+
+    def default_owner
+      @git.config('user.owner')
+    end
+
+    def default_owner=(name)
+      @git.config('user.owner', name)
+    end
+
+    def to_h
+      {
+        default_owner: default_owner
+      }
+    end
+  end
+end

metadata

@@ -0,0 +1,239 @@
+--- !ruby/object:Gem::Specification
+name: codeowners-checker
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jônatas Davi Paganini
+- Eva Kadlecová
+- Michal Papis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fuzzy_match
+  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: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rb-readline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.5
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.61.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.61.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.30'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.30'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+description: 
+email:
+- open-source@toptal.com
+executables:
+- codeowners-checker
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".projections.json"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/codeowners-checker
+- bin/console
+- bin/setup
+- codeowners-checker.gemspec
+- demos/missing_reference.svg
+- demos/useless_pattern.svg
+- lib/codeowners/checker.rb
+- lib/codeowners/checker/array.rb
+- lib/codeowners/checker/code_owners.rb
+- lib/codeowners/checker/file_as_array.rb
+- lib/codeowners/checker/group.rb
+- lib/codeowners/checker/group/comment.rb
+- lib/codeowners/checker/group/empty.rb
+- lib/codeowners/checker/group/group_begin_comment.rb
+- lib/codeowners/checker/group/group_end_comment.rb
+- lib/codeowners/checker/group/line.rb
+- lib/codeowners/checker/group/pattern.rb
+- lib/codeowners/checker/group/unrecognized_line.rb
+- lib/codeowners/checker/line_grouper.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/main.rb
+- lib/codeowners/config.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Check consistency of Github CODEOWNERS and git changes.
+test_files: []