code_ownership 1.29.3 → 1.31.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ea243e473ae151a2775f8e1e47d0eb9dacb27f3d2d594db63d3004f5c611109
-  data.tar.gz: eb77703d34e6c40ee734d3e487fd58ba0f124555a681ff267326a4a3f4aeb03e
+  metadata.gz: 292664613750d5a5413984bac92ade17caa9a7f1796123455d16dd6f76ae6410
+  data.tar.gz: 306f65f710f7462acc3b001232e73e3561a63faa260153b7f759adc3dbf0a28e
 SHA512:
-  metadata.gz: 8464d15022cc9a5f9e6019c0633b8941a3a5f1984f5d55f676c6377b94c335efb0b5722c4289f40b32da5f01453e806911c829c7fa0f11643f2d90c3327db3f3
-  data.tar.gz: 84c95502b0457b848d705b71b675c0d9b8654ed940cd3ba37bc1503c0d8c3cfe7b53dfa28340610ccfde17527e69facc14e7abb106843b21456b3fb17b3bc41d
+  metadata.gz: 196be6927310bda4e577f94ea9553d832abf85f2dbc65e2d2efc0c55016001a9d8b6d6c64674aeb846ae41f1500bd0f5254c6e486017653cb03c620be9be0865
+  data.tar.gz: bdf65c513ab30773eed96cb934d1212d4599e0f54f0f0fcc1729b54bd6a007aefc6edc7dd647c2348c3020c2afe04d79017b84013d51cb1b6fb3284577653a5f

data/lib/code_ownership/private/ownership_mappers/team_globs.rb

@@ -31,6 +31,58 @@ module CodeOwnership
           end
         end
 
+        class MappingContext < T::Struct
+          const :glob, String
+          const :team, CodeTeams::Team
+        end
+
+        class GlobOverlap < T::Struct
+          extend T::Sig
+
+          const :mapping_contexts, T::Array[MappingContext]
+
+          sig { returns(String) }
+          def description
+            # These are sorted only to prevent non-determinism in output between local and CI environments.
+            sorted_contexts = mapping_contexts.sort_by{|context| context.team.config_yml.to_s }
+            description_args = sorted_contexts.map do |context|
+              "`#{context.glob}` (from `#{context.team.config_yml}`)"
+            end
+
+            description_args.join(', ')
+          end
+        end
+
+        sig do
+          returns(T::Array[GlobOverlap])
+        end
+        def find_overlapping_globs
+          mapped_files = T.let({}, T::Hash[String, T::Array[MappingContext]])
+          CodeTeams.all.each_with_object({}) do |team, map| # rubocop:disable Style/ClassVars
+            TeamPlugins::Ownership.for(team).owned_globs.each do |glob|
+              Dir.glob(glob).each do |filename|
+                mapped_files[filename] ||= []
+                T.must(mapped_files[filename]) << MappingContext.new(glob: glob, team: team)
+              end
+            end
+          end
+
+          overlaps = T.let([], T::Array[GlobOverlap])
+          mapped_files.each do |filename, mapping_contexts|
+            if mapping_contexts.count > 1
+              overlaps << GlobOverlap.new(mapping_contexts: mapping_contexts)
+            end
+          end
+
+          deduplicated_overlaps = overlaps.uniq do |glob_overlap|
+            glob_overlap.mapping_contexts.map do |context|
+              [context.glob, context.team.name]
+            end
+          end
+
+          deduplicated_overlaps
+        end
+
         sig do
           override.params(file: String).
             returns(T.nilable(::CodeTeams::Team))

data/lib/code_ownership/private/ownership_mappers/team_yml_ownership.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+# typed: true
+
+module CodeOwnership
+  module Private
+    module OwnershipMappers
+      class TeamYmlOwnership
+        extend T::Sig
+        include Interface
+
+        @@map_files_to_owners = T.let(@map_files_to_owners, T.nilable(T::Hash[String, T.nilable(::CodeTeams::Team)])) # rubocop:disable Style/ClassVars
+        @@map_files_to_owners = {} # rubocop:disable Style/ClassVars
+        @@codeowners_lines_to_owners = T.let(@codeowners_lines_to_owners, T.nilable(T::Hash[String, T.nilable(::CodeTeams::Team)])) # rubocop:disable Style/ClassVars
+        @@codeowners_lines_to_owners = {} # rubocop:disable Style/ClassVars
+
+        sig do
+          override.
+            params(files: T::Array[String]).
+            returns(T::Hash[String, T.nilable(::CodeTeams::Team)])
+        end
+        def map_files_to_owners(files) # rubocop:disable Lint/UnusedMethodArgument
+          return @@map_files_to_owners if @@map_files_to_owners&.keys && @@map_files_to_owners.keys.count > 0
+
+          @@map_files_to_owners = CodeTeams.all.each_with_object({}) do |team, map| # rubocop:disable Style/ClassVars
+            map[team.config_yml] = team
+          end
+        end
+
+        sig do
+          override.params(file: String).
+            returns(T.nilable(::CodeTeams::Team))
+        end
+        def map_file_to_owner(file)
+          map_files_to_owners([file])[file]
+        end
+
+        sig do
+          override.returns(T::Hash[String, T.nilable(::CodeTeams::Team)])
+        end
+        def codeowners_lines_to_owners
+          return @@codeowners_lines_to_owners if @@codeowners_lines_to_owners&.keys && @@codeowners_lines_to_owners.keys.count > 0
+
+          @@codeowners_lines_to_owners = CodeTeams.all.each_with_object({}) do |team, map| # rubocop:disable Style/ClassVars
+            map[team.config_yml] = team
+          end
+        end
+
+        sig { override.void }
+        def bust_caches!
+          @@codeowners_lines_to_owners = {} # rubocop:disable Style/ClassVars
+          @@map_files_to_owners = {} # rubocop:disable Style/ClassVars
+        end
+
+        sig { override.returns(String) }
+        def description
+          'Team YML ownership'
+        end
+      end
+    end
+  end
+end

data/lib/code_ownership/private/validations/no_overlapping_globs.rb

@@ -0,0 +1,30 @@
+# typed: strict
+
+module CodeOwnership
+  module Private
+    module Validations
+      class NoOverlappingGlobs
+        extend T::Sig
+        extend T::Helpers
+        include Interface
+
+        sig { override.params(files: T::Array[String], autocorrect: T::Boolean, stage_changes: T::Boolean).returns(T::Array[String]) }
+        def validation_errors(files:, autocorrect: true, stage_changes: true)
+          overlapping_globs = OwnershipMappers::TeamGlobs.new.find_overlapping_globs
+
+          errors = T.let([], T::Array[String])
+
+          if overlapping_globs.any?
+            errors << <<~MSG
+              `owned_globs` cannot overlap between teams. The following globs overlap:
+
+              #{overlapping_globs.map { |overlap| "- #{overlap.description}"}.join("\n")}
+            MSG
+          end
+
+          errors
+        end
+      end
+    end
+  end
+end

data/lib/code_ownership/private.rb

@@ -10,11 +10,13 @@ require 'code_ownership/private/validations/interface'
 require 'code_ownership/private/validations/files_have_owners'
 require 'code_ownership/private/validations/github_codeowners_up_to_date'
 require 'code_ownership/private/validations/files_have_unique_owners'
+require 'code_ownership/private/validations/no_overlapping_globs'
 require 'code_ownership/private/ownership_mappers/interface'
 require 'code_ownership/private/ownership_mappers/file_annotations'
 require 'code_ownership/private/ownership_mappers/team_globs'
 require 'code_ownership/private/ownership_mappers/package_ownership'
 require 'code_ownership/private/ownership_mappers/js_package_ownership'
+require 'code_ownership/private/ownership_mappers/team_yml_ownership'
 
 module CodeOwnership
   module Private
@@ -39,6 +41,7 @@ module CodeOwnership
         Validations::FilesHaveOwners.new,
         Validations::FilesHaveUniqueOwners.new,
         Validations::GithubCodeownersUpToDate.new,
+        Validations::NoOverlappingGlobs.new,
       ]
 
       errors = validators.flat_map do |validator|
@@ -62,6 +65,7 @@ module CodeOwnership
         Private::OwnershipMappers::TeamGlobs.new,
         Private::OwnershipMappers::PackageOwnership.new,
         Private::OwnershipMappers::JsPackageOwnership.new,
+        Private::OwnershipMappers::TeamYmlOwnership.new,
       ]
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: code_ownership
 version: !ruby/object:Gem::Version
-  version: 1.29.3
+  version: 1.31.0
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-02-02 00:00:00.000000000 Z
+date: 2023-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: code_teams
@@ -141,6 +141,7 @@ files:
 - lib/code_ownership/private/ownership_mappers/js_package_ownership.rb
 - lib/code_ownership/private/ownership_mappers/package_ownership.rb
 - lib/code_ownership/private/ownership_mappers/team_globs.rb
+- lib/code_ownership/private/ownership_mappers/team_yml_ownership.rb
 - lib/code_ownership/private/parse_js_packages.rb
 - lib/code_ownership/private/team_plugins/github.rb
 - lib/code_ownership/private/team_plugins/ownership.rb
@@ -148,6 +149,7 @@ files:
 - lib/code_ownership/private/validations/files_have_unique_owners.rb
 - lib/code_ownership/private/validations/github_codeowners_up_to_date.rb
 - lib/code_ownership/private/validations/interface.rb
+- lib/code_ownership/private/validations/no_overlapping_globs.rb
 - sorbet/config
 - sorbet/rbi/gems/code_teams@1.0.0.rbi
 - sorbet/rbi/gems/packs@0.0.2.rbi