codeowner_validator 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 624518c4812a8172b2b08fb3afc5f5c67f862333bcf46e4ded910962d8219d8c
-  data.tar.gz: af12af2b285d3e7232e00933b8a594b4d2798d1bdc7fb79aec4177b93fa2cbdb
+  metadata.gz: ac6b80b200b35f8995987761579322d31d1755d571d66bdb8216b4b83acdb28b
+  data.tar.gz: 7898cbea2c42cf3406575622c4acca6541e9233ad9da9be67b15081010972088
 SHA512:
-  metadata.gz: ebebb11fdb1788a4599c8e691f1752bb0e6bd259e4130bc388407566312e0825aa0f46181ac1f021158cbbc2091b1d38eb39773ce052adba753e0117e9dc5532
-  data.tar.gz: 03d6770e812e540f641e8ddc2c193c3ded2a07a37eea2e75c4b8beb991f773501ce8911cde8e474eebe39944c69eeec5b48bf4acf389006df339e023c0e7d821
+  metadata.gz: 7cbbcb4882fd2b3348dfdd4adcfd6c5ae6babc7ee9d375869a682377ee0a37bf27eccccff0c8cba3ea0bb96464aeb95e84cb8b8a871126fcaf6cd0fa55b91623
+  data.tar.gz: '090ceb4dc06a0eb4f793928dd691fdb27c28c8f9674a0efb902f0c96fa4cd9a3898a060f9d291c9d0d46757a8ab95ba55c5afe63d6f3560552460d3247746d20'

data/CHANGELOG.md

@@ -11,4 +11,7 @@
 - Update to support ruby 3.2 ([#9](https://github.com/cerner/codeowner_validator/pull/9))
 
 # 0.3.1
-- Back version of ruby to be in RVM supported set ([#10](https://github.com/cerner/codeowner_validator/pull/10))
+- Back version of ruby to be in RVM supported set ([#10](https://github.com/cerner/codeowner_validator/pull/10))
+
+# 0.4.0
+- Remove usage of codeowner-checker from project and pulled in required classes ([#11](https://github.com/cerner/codeowner_validator/pull/11))

data/codeowner_validator.gemspec

@@ -33,12 +33,12 @@ Gem::Specification.new do |spec|
   # rubocop:enable Gemspec/RequiredRubyVersion
 
   spec.add_dependency 'rainbow', '>= 2.0', '< 4.0.0'
-  spec.add_dependency 'thor', '>= 0.19'
+  spec.add_dependency 'thor', '>= 1.0'
 
   spec.add_dependency 'tty-prompt', '~> 0.12'
   spec.add_dependency 'tty-spinner', '~> 0.4'
   spec.add_dependency 'tty-table', '~> 0.8'
 
-  spec.add_dependency 'codeowners-checker', '~> 1.1'
   spec.add_dependency 'git', '~> 1.0'
+  spec.add_dependency 'pathspec', '>= 0.2'
 end

data/lib/codeowner_validator/code_owners.rb

@@ -3,8 +3,7 @@
 require 'pathname'
 require_relative 'helpers/utility_helper'
 require 'codeowner_validator/lists/whitelist'
-require 'codeowners/checker/group'
-require_relative '../codeowners/checker/group/line'
+require_relative '../codeowners/checker/group'
 
 # rubocop:disable Style/ImplicitRuntimeError
 module CodeownerValidator

data/lib/codeowner_validator/helpers/utility_helper.rb

@@ -13,7 +13,14 @@ module CodeownerValidator
     def in_folder(folder)
       raise "The folder location '#{folder}' does not exists" unless File.directory?(folder)
 
-      with_clean_env do
+      if defined?(Bundler)
+        method = Bundler.respond_to?(:with_unbundled_env) ? :with_unbundled_env : :with_clean_env
+        Bundler.send(method) do
+          Dir.chdir folder do
+            yield
+          end
+        end
+      else
         Dir.chdir folder do
           yield
         end

data/lib/codeowner_validator/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module CodeownerValidator
-  VERSION = '0.3.1'
+  VERSION = '0.4.0'
 
   # version module
   module Version

data/lib/codeowner_validator.rb

@@ -1,10 +1,8 @@
 # frozen_string_literal: true
 
 require 'thor'
-require 'codeowners/checker'
-# pull in monkeypatch for codeowners-checker
-require_relative 'codeowners/checker/group/line'
 Dir.glob(File.join(File.dirname(__FILE__), 'codeowner_validator', '**/*.rb'), &method(:require))
+Dir.glob(File.join(File.dirname(__FILE__), 'codeowners', '**/*.rb'), &method(:require))
 
 # Public: The code owner validator space is utilized for validations against
 # the code owner file for a given repository.

data/lib/codeowners/checker/array.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Codeowners
+  class Checker
+    # Array.delete in contrary to Ruby documentation uses == instead of equal? for comparison.
+    # safe_delete removes an object from an array comparing objects by equal? method.
+    module Array
+      def safe_delete(object)
+        delete_at(index { |item| item.equal?(object) })
+      end
+    end
+  end
+end
+
+Array.prepend(Codeowners::Checker::Array)

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative 'line'
+
+module Codeowners
+  class Checker
+    class Group
+      # Define and manage comment line.
+      class Comment < Line
+        # Matches if the line is a comment.
+        # @return [Boolean] if the line start with `#`
+        def self.match?(line)
+          line.start_with?('#')
+        end
+
+        # Return the comment level if the comment works like a markdown
+        # headers.
+        # @return [Integer] with the heading level.
+        #
+        # @example
+        #   Comment.new('# First level').level # => 1
+        #   Comment.new('## Second').level # => 2
+        def level
+          (@line[/^#+/] || '').size
+        end
+      end
+    end
+  end
+end
+
+require_relative 'group_begin_comment'
+require_relative 'group_end_comment'

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative 'line'
+
+module Codeowners
+  class Checker
+    class Group
+      # Define line type empty line.
+      class Empty < Line
+        def self.match?(line)
+          line.empty?
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative 'comment'
+
+module Codeowners
+  class Checker
+    class Group
+      # Define line type GroupBeginComment which is used for defining the beggining
+      # of a group.
+      class GroupBeginComment < Comment
+        def self.match?(line)
+          line.lstrip =~ /^#+ BEGIN/
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative 'comment'
+
+module Codeowners
+  class Checker
+    class Group
+      # Define line type GroupEndComment which is used for defining the end
+      # of a group.
+      class GroupEndComment < Comment
+        def self.match?(line)
+          line.lstrip =~ /^#+ END/
+        end
+      end
+    end
+  end
+end

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

@@ -1,12 +1,69 @@
 # frozen_string_literal: true
 
-# monkeypatch class to include line number
+require 'pathname'
 module Codeowners
   class Checker
     class Group
+      # It sorts lines from CODEOWNERS file to different line types and holds
+      # shared methods for all lines.
       class Line
-        attr_accessor :line_number
+        attr_accessor :parent, :line_number
+
+        def self.build(line)
+          subclasses.each do |klass|
+            return klass.new(line) if klass.match?(line)
+          end
+          UnrecognizedLine.new(line)
+        end
+
+        def self.subclasses
+          [Empty, GroupBeginComment, GroupEndComment, Comment, Pattern]
+        end
+
+        def initialize(line)
+          @line = line
+        end
+
+        def to_s
+          @line
+        end
+
+        def to_content
+          to_s
+        end
+
+        def to_file
+          to_s
+        end
+
+        def pattern?
+          is_a?(Pattern)
+        end
+
+        def to_tree(indentation)
+          indentation + to_s
+        end
+
+        def remove!
+          parent&.remove(self)
+          self.parent = nil
+        end
+
+        def ==(other)
+          return false unless other.is_a?(self.class)
+
+          other.to_s == to_s
+        end
+
+        def <=>(other)
+          to_s <=> other.to_s
+        end
       end
     end
   end
 end
+
+require_relative 'empty'
+require_relative 'comment'
+require_relative 'pattern'
+require_relative 'unrecognized_line'

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

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require_relative 'line'
+require_relative '../owner'
+require 'pathspec'
+
+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 :owners, :whitespace
+        attr_reader :pattern, :spec
+
+        def self.match?(line)
+          _pattern, *owners = line.split(/\s+/)
+          Owner.valid?(*owners)
+        end
+
+        def initialize(line)
+          super
+          parse(line)
+        end
+
+        def owner
+          owners.first
+        end
+
+        def rename_owner(owner, new_owner)
+          owners.delete(owner)
+          owners << new_owner unless owners.include?(new_owner)
+        end
+
+        # Parse the line counting whitespaces between pattern and owners.
+        def parse(line)
+          @pattern, *@owners = line.split(/\s+/)
+          @whitespace = line.split('@').first.count(' ') - 1
+          @spec = parse_spec(@pattern)
+        end
+
+        def match_file?(file)
+          spec.match file
+        end
+
+        def pattern=(new_pattern)
+          @whitespace += @pattern.size - new_pattern.size
+          @whitespace = 1 if @whitespace < 1
+
+          @spec = parse_spec(new_pattern)
+          @pattern = new_pattern
+        end
+
+        # @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 to_s
+          to_file(preserve_whitespaces: false)
+        end
+
+        def parse_spec(pattern)
+          PathSpec.from_lines(pattern)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative 'line'
+
+module Codeowners
+  class Checker
+    class Group
+      # Hold lines which are not defined in other line classes.
+      class UnrecognizedLine < Line
+      end
+    end
+  end
+end

data/lib/codeowners/checker/group.rb

@@ -0,0 +1,158 @@
+# frozen_string_literal: true
+
+require_relative 'line_grouper'
+require_relative 'group/line'
+require_relative 'array'
+
+module Codeowners
+  class Checker
+    # Manage the groups content and handle operations on the groups.
+    class Group
+      include Enumerable
+
+      attr_accessor :parent
+
+      def self.parse(lines)
+        new.parse(lines)
+      end
+
+      def initialize
+        @list = []
+      end
+
+      def each(&block)
+        @list.each do |object|
+          if object.is_a?(Group)
+            object.each(&block)
+          else
+            yield(object)
+          end
+        end
+      end
+
+      def parse(lines)
+        LineGrouper.call(self, lines)
+      end
+
+      def to_content
+        @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.
+      def to_tree(indentation = '')
+        @list.each_with_index.flat_map do |item, index|
+          if indentation.empty?
+            item.to_tree(indentation + ' ')
+          elsif index.zero?
+            item.to_tree(indentation + '+ ')
+          elsif index == @list.length - 1
+            item.to_tree(indentation + '\\ ')
+          else
+            item.to_tree(indentation + '| ')
+          end
+        end
+      end
+      # rubocop:enable Metrics/MethodLength
+      # rubocop:enable Metrics/AbcSize
+
+      def owner
+        owners.first
+      end
+
+      # Owners are ordered by the amount of occurrences
+      def owners
+        all_owners.group_by(&:itself).sort_by do |_owner, occurrences|
+          -occurrences.count
+        end.map(&:first)
+      end
+
+      def subgroups_owned_by(owner)
+        @list.flat_map do |item|
+          next unless item.is_a?(Group)
+
+          a = []
+          a << item if item.owner == owner
+          a += item.subgroups_owned_by(owner)
+          a
+        end.compact
+      end
+
+      def title
+        @list.first.to_s
+      end
+
+      def create_subgroup
+        group = self.class.new
+        group.parent = self
+        @list << group
+        group
+      end
+
+      def add(line)
+        line.parent = self
+        @list << line
+      end
+
+      def insert(line)
+        line.parent = self
+        index = insert_at_index(line)
+        @list.insert(index, line)
+      end
+
+      def remove(line)
+        @list.safe_delete(line)
+        remove! unless any? { |object| object.is_a? Pattern }
+      end
+
+      def remove!
+        @list.clear
+        parent&.remove(self)
+        self.parent = nil
+      end
+
+      def ==(other)
+        other.is_a?(Group) && other.list == list
+      end
+
+      protected
+
+      attr_accessor :list
+
+      private
+
+      def all_owners
+        flat_map do |item|
+          item.owners if item.pattern?
+        end.compact
+      end
+
+      # rubocop:disable Metrics/AbcSize
+      def insert_at_index(line)
+        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|
+          return index unless item.is_a?(Comment)
+        end
+        0
+      end
+    end
+  end
+end

data/lib/codeowners/checker/line_grouper.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+module Codeowners
+  class Checker
+    # Create groups and subgroups structure for the lines in the CODEOWNERS file.
+    class LineGrouper
+      def self.call(group, lines)
+        new(group, lines).call
+      end
+
+      def initialize(group, lines)
+        @group_buffer = [group]
+        @lines = lines
+      end
+
+      def call
+        lines.each_with_index do |line, index|
+          case line
+          when Codeowners::Checker::Group::Empty
+            ensure_groups_structure
+          when Codeowners::Checker::Group::GroupBeginComment
+            trim_groups(line.level)
+            create_groups_structure(line.level)
+          when Codeowners::Checker::Group::GroupEndComment
+            trim_subgroups(line.level)
+            create_groups_structure(line.level)
+          when Codeowners::Checker::Group::Comment
+            if previous_line_empty?(index)
+              trim_groups(line.level)
+            else
+              trim_subgroups(line.level)
+            end
+            create_groups_structure(line.level)
+          when Codeowners::Checker::Group::Pattern
+            if new_owner?(line, index)
+              trim_groups(current_level)
+              new_group
+            end
+            ensure_groups_structure
+          when Codeowners::Checker::Group::UnrecognizedLine
+            ensure_groups_structure
+          else
+            raise StandardError, "Do not know how to handle line: #{line.inspect}"
+          end
+          current_group.add(line)
+        end
+        group_buffer.first
+      end
+      # rubocop:enable Metrics/AbcSize
+      # rubocop:enable Metrics/CyclomaticComplexity
+      # rubocop:enable Metrics/MethodLength
+
+      private
+
+      attr_reader :group_buffer, :lines
+
+      def previous_line_empty?(index)
+        index.positive? && lines[index - 1].is_a?(Codeowners::Checker::Group::Empty)
+      end
+
+      def new_owner?(line, index) # rubocop:disable Metrics/MethodLength
+        if previous_line_empty?(index)
+          offset = 2
+          while (index - offset).positive?
+            case lines[index - offset]
+            when Codeowners::Checker::Group::GroupEndComment
+              nil
+            when Codeowners::Checker::Group::Comment
+              return false
+            when Codeowners::Checker::Group::Pattern
+              return line.owner != lines[index - offset].owner
+            end
+            offset += 1
+          end
+        end
+        false
+      end
+
+      def current_group
+        group_buffer.last
+      end
+
+      def current_level
+        group_buffer.length - 1
+      end
+
+      def new_group
+        group = current_group.create_subgroup
+        group_buffer << group
+      end
+
+      def ensure_groups_structure
+        new_group if current_level.zero?
+      end
+
+      def create_groups_structure(level)
+        new_group while current_level < level
+      end
+
+      def trim_groups(level)
+        group_buffer.slice!(level..-1)
+      end
+
+      def trim_subgroups(level)
+        trim_groups(level + 1)
+      end
+    end
+  end
+end

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: codeowner_validator
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Greg Howdeshell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-06 00:00:00.000000000 Z
+date: 2023-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow
@@ -36,14 +36,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.19'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.19'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: tty-prompt
   requirement: !ruby/object:Gem::Requirement
@@ -87,33 +87,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.8'
 - !ruby/object:Gem::Dependency
-  name: codeowners-checker
+  name: git
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: git
+  name: pathspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0.2'
 description: 'GitHub CODEOWNERS validator
 
   '
@@ -178,7 +178,17 @@ files:
 - lib/codeowner_validator/tasks/syntax_checker.rb
 - lib/codeowner_validator/validator.rb
 - lib/codeowner_validator/version.rb
+- lib/codeowners/checker/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/owner.rb
 homepage: https://github.com/cerner/codeowner_validator
 licenses:
 - Apache-2.0