code_ownership 1.38.2 → 1.39.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b40aef85c83e70ad2c2a8ba45030b3e894b184ec71e897443d47b859343a8636
-  data.tar.gz: 27741ae85077282dca91f42f274325d66ee25b8ed01eaab733aab581f23e6e4e
+  metadata.gz: 4750c985a93873263fe3f86ee3acfa80b3bb9a234445b2cacfdb57dd657916e4
+  data.tar.gz: 4e672aeeeaa93addd346d0a01c0dc135dd576e4e196a91124e8f7e31f7045da1
 SHA512:
-  metadata.gz: 8d8c2765433571d6407ec67608554fb04dc9b14d84948ddf9b227874aca628e3fd4e927c6154a3d41ede65bdd8628f522e77c089fab9727ec6860339a03673e3
-  data.tar.gz: 0c8eeb737cbbcce93210c43f0f6c21d846761fa94daa97243796747db3343bf6fd40c033cd3337a628716dd91714354ed5d2af1a2eda1ea29ea716f9ef0687e7
+  metadata.gz: 39b311ddd4a120865344fea860189c452d7adb8b88d56ce3cd6add99a376bb8337cb27d4d741c1fc44fa473b4a15866a50c9e18d08f47f9ebb8bfb57106a9c7f
+  data.tar.gz: 1355b25ee4a54d09dd6722aca4f11ad410521414cca07fdf7ccafba299ccc7482cbfa97b58c0c198488eacdf12c479aa1777c1acfcee7305f5454d60441c44ad

data/README.md

@@ -164,6 +164,8 @@ bin/codeownership for_team 'My Team' > tmp/ownership_report.md
 
 A `CODEOWNERS` file defines who owns specific files or paths in a repository. When you run `bin/codeownership validate`, a `.github/CODEOWNERS` file will automatically be generated and updated.
 
+If `codeowners_path` is set in `code_ownership.yml` codeowners will use that path to generate the `CODEOWNERS` file. For example, `codeowners_path: docs` will generate `docs/CODEOWNERS`.
+
 ## Proper Configuration & Validation
 
 CodeOwnership comes with a validation function to ensure the following things are true:

data/lib/code_ownership/configuration.rb

@@ -12,6 +12,7 @@ module CodeOwnership
     const :skip_codeowners_validation, T::Boolean
     const :raw_hash, T::Hash[T.untyped, T.untyped]
     const :require_github_teams, T::Boolean
+    const :codeowners_path, String
 
     sig { returns(Configuration) }
     def self.fetch
@@ -29,7 +30,8 @@ module CodeOwnership
         js_package_paths: js_package_paths(config_hash),
         skip_codeowners_validation: config_hash.fetch('skip_codeowners_validation', false),
         raw_hash: config_hash,
-        require_github_teams: config_hash.fetch('require_github_teams', false)
+        require_github_teams: config_hash.fetch('require_github_teams', false),
+        codeowners_path: config_hash.fetch('codeowners_path', '.github'),
       )
     end
 

data/lib/code_ownership/private/codeowners_file.rb

@@ -111,7 +111,10 @@ module CodeOwnership
 
       sig { returns(Pathname) }
       def self.path
-        Pathname.pwd.join('.github/CODEOWNERS')
+        Pathname.pwd.join(
+          CodeOwnership.configuration.codeowners_path,
+          'CODEOWNERS'
+        )
       end
 
       sig { params(files: T::Array[String]).void }

data/lib/code_ownership/private/owner_assigner.rb

@@ -12,7 +12,7 @@ module CodeOwnership
           # addresses the case where a directory name includes regex characters
           # such as `app/services/[test]/some_other_file.ts`
           mapping[glob] = owner if File.exist?(glob)
-          Dir.glob(glob).each do |file|
+          Dir.glob(glob) do |file|
             mapping[file] ||= owner
           end
         end

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

@@ -18,7 +18,7 @@ module CodeOwnership
         extend T::Sig
         include Mapper
 
-        TEAM_PATTERN = T.let(%r{\A(?:#|//) @team (?<team>.*)\Z}.freeze, Regexp)
+        TEAM_PATTERN = T.let(%r{\A(?:#|//|-#) @team (?<team>.*)\Z}.freeze, Regexp)
         DESCRIPTION = 'Annotations at the top of file'
 
         sig do
@@ -73,19 +73,20 @@ module CodeOwnership
 
         sig { params(filename: String).returns(T.nilable(CodeTeams::Team)) }
         def file_annotation_based_owner(filename)
-          # If for a directory is named with an ownable extension, we need to skip
-          # so File.foreach doesn't blow up below. This was needed because Cypress
-          # screenshots are saved to a folder with the test suite filename.
-          return if File.directory?(filename)
-          return unless File.file?(filename)
-
           # The annotation should be on line 1 but as of this comment
           # there's no linter installed to enforce that. We therefore check the
           # first line (the Ruby VM makes a single `read(1)` call for 8KB),
           # and if the annotation isn't in the first two lines we assume it
           # doesn't exist.
 
-          line1 = File.foreach(filename).first
+          begin
+            line1 = File.foreach(filename).first
+          rescue Errno::EISDIR, Errno::ENOENT
+            # Ignore files that fail to read to avoid intermittent bugs.
+            # Ignoring directories is needed because, e.g., Cypress screenshots
+            # are saved to a folder with the test suite filename.
+            return
+          end
 
           return if !line1
 

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

@@ -14,17 +14,16 @@ module CodeOwnership
         @@map_files_to_owners = {} # rubocop:disable Style/ClassVars
 
         sig do
-          params(files: T::Array[String])
-          .returns(T::Hash[String, ::CodeTeams::Team])
+          returns(T::Hash[String, ::CodeTeams::Team])
         end
-        def map_files_to_owners(files)
+        def map_files_to_owners
           return @@map_files_to_owners if @@map_files_to_owners&.keys && @@map_files_to_owners.keys.count.positive?
 
           @@map_files_to_owners = 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|
-                map[filename] = team
-              end
+            code_team = TeamPlugins::Ownership.for(team)
+
+            (Dir.glob(code_team.owned_globs) - Dir.glob(code_team.unowned_globs)).each do |filename|
+              map[filename] = team
             end
           end
         end
@@ -56,13 +55,20 @@ module CodeOwnership
         end
         def find_overlapping_globs
           mapped_files = T.let({}, T::Hash[String, T::Array[MappingContext]])
-          CodeTeams.all.each_with_object({}) do |team, _map|
-            TeamPlugins::Ownership.for(team).owned_globs.each do |glob|
-              Dir.glob(glob).each do |filename|
+          CodeTeams.all.each do |team|
+            code_team = TeamPlugins::Ownership.for(team)
+
+            code_team.owned_globs.each do |glob|
+              Dir.glob(glob) do |filename|
                 mapped_files[filename] ||= []
                 T.must(mapped_files[filename]) << MappingContext.new(glob: glob, team: team)
               end
             end
+
+            # Remove anything that is unowned, globbing them all at once
+            Dir.glob(code_team.unowned_globs) do |filename|
+              mapped_files.reject! { |key, value| key == filename && value.any? { |context| context.team == team } }
+            end
           end
 
           overlaps = T.let([], T::Array[GlobOverlap])
@@ -81,10 +87,10 @@ module CodeOwnership
 
         sig do
           override.params(file: String)
-            .returns(T.nilable(::CodeTeams::Team))
+                  .returns(T.nilable(::CodeTeams::Team))
         end
         def map_file_to_owner(file)
-          map_files_to_owners([file])[file]
+          map_files_to_owners[file]
         end
 
         sig do
@@ -96,7 +102,7 @@ module CodeOwnership
 
         sig do
           override.params(files: T::Array[String])
-            .returns(T::Hash[String, ::CodeTeams::Team])
+                  .returns(T::Hash[String, ::CodeTeams::Team])
         end
         def globs_to_owner(files)
           CodeTeams.all.each_with_object({}) do |team, map|

data/lib/code_ownership/private/team_plugins/ownership.rb

@@ -11,6 +11,11 @@ module CodeOwnership
         def owned_globs
           @team.raw_hash['owned_globs'] || []
         end
+
+        sig { returns(T::Array[String]) }
+        def unowned_globs
+          @team.raw_hash['unowned_globs'] || []
+        end
       end
     end
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: code_ownership
 version: !ruby/object:Gem::Version
-  version: 1.38.2
+  version: 1.39.0
 platform: ruby
 authors:
 - Gusto Engineers
 bindir: bin
 cert_chain: []
-date: 2025-01-16 00:00:00.000000000 Z
+date: 2025-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: code_teams