code_ownership 1.34.2 → 1.36.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a67c504ef03f9010003b0c3fad3eb09aab223ed033d58a090c3a3efc3509a89
-  data.tar.gz: 30aef026b8487bc1c20aa94890a4eca64fdaa26dddd44f17b77f705317c9b038
+  metadata.gz: e34134e28ee70e58344ea6d3f90be157bbdd6945888eee07d73abf3db3ed873b
+  data.tar.gz: 1875f6d3131505551c163aa03413edefa86c6f279d2c3189d9663a74a9603758
 SHA512:
-  metadata.gz: '09d72749e78b49b14284c3360cba9f9f3dda4e20818305b3fe0a819bbaa2720be5107bb85d8612bedfbd5590a039010d42700510ac027b34bc1a6bdaadc7531f'
-  data.tar.gz: 4be38dfd55b95eadf9ee661cb160715cc0ee7f3936f9b9b19d8b7ce65d0ed19b62805f882b8b684863acbc2caa602cb676e58837a060da04fd142f1b89b1e744
+  metadata.gz: de217fe525521395f2b6ad647257aecd69c9e8f8895fa0d466051cf4d365c3fce2dcf08ea9c9bfbeeef0c75116f3188d6f350c72becb965f7f3d49a992a0b6fa
+  data.tar.gz: abf92fcca79c8311cfa9d82fabcb0b129fdd076c9cb7a3db31c0db983dabf1e6cb5810b501e38cdab9fbf028dc3a43ed6105928469015b6bf30a33e774b5a6b6

data/README.md

@@ -73,6 +73,12 @@ js_package_paths:
 
 This defaults `**/`, which makes it look for `package.json` files across your application.
 
+> [!NOTE]
+> Javscript package ownership does not respect `unowned_globs`. If you wish to disable usage of this feature you can set `js_package_paths` to an empty list.
+```yml
+js_package_paths: []
+```
+
 ### Custom Ownership
 To enable custom ownership, you can inject your own custom classes into `code_ownership`.
 To do this, first create a class that adheres to the `CodeOwnership::Mapper` and/or `CodeOwnership::Validator` interface.
@@ -155,7 +161,7 @@ unowned_globs:
   - app/services/some_file2.rb
   - frontend/javascripts/**/__generated__/**/*
 ```
-You can call the validation function with the Ruby API 
+You can call the validation function with the Ruby API
 ```ruby
 CodeOwnership.validate!
 ```

data/lib/code_ownership/configuration.rb

@@ -11,6 +11,7 @@ module CodeOwnership
     const :unbuilt_gems_path, T.nilable(String)
     const :skip_codeowners_validation, T::Boolean
     const :raw_hash, T::Hash[T.untyped, T.untyped]
+    const :require_github_teams, T::Boolean
 
     sig { returns(Configuration) }
     def self.fetch
@@ -27,7 +28,8 @@ module CodeOwnership
         unowned_globs: config_hash.fetch('unowned_globs', []),
         js_package_paths: js_package_paths(config_hash),
         skip_codeowners_validation: config_hash.fetch('skip_codeowners_validation', false),
-        raw_hash: config_hash
+        raw_hash: config_hash,
+        require_github_teams: config_hash.fetch('require_github_teams', false)
       )
     end
 

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

@@ -10,6 +10,8 @@ module CodeOwnership
         include Mapper
 
         CODEOWNERS_DIRECTORY_FILE_NAME = '.codeowner'
+        RELATIVE_ROOT = Pathname('.').freeze
+        ABSOLUTE_ROOT = Pathname('/').freeze
 
         @@directory_cache = T.let({}, T::Hash[String, T.nilable(CodeTeams::Team)]) # rubocop:disable Style/ClassVars
 
@@ -74,36 +76,46 @@ module CodeOwnership
           )
         end
 
-        # takes a file and finds the relevant `.codeowner` file by walking up the directory
+        # Takes a file and finds the relevant `.codeowner` file by walking up the directory
         # structure. Example, given `a/b/c.rb`, this looks for `a/b/.codeowner`, `a/.codeowner`,
         # and `.codeowner` in that order, stopping at the first file to actually exist.
-        # We do additional caching so that we don't have to check for file existence every time
+        # If the parovided file is a directory, it will look for `.codeowner` in that directory and then upwards.
+        # We do additional caching so that we don't have to check for file existence every time.
         sig { params(file: String).returns(T.nilable(CodeTeams::Team)) }
         def map_file_to_relevant_owner(file)
           file_path = Pathname.new(file)
-          path_components = file_path.each_filename.to_a.map { |path| Pathname.new(path) }
+          team = T.let(nil, T.nilable(CodeTeams::Team))
 
-          (path_components.length - 1).downto(0).each do |i|
-            potential_relative_path_name = T.must(path_components[0...i]).reduce(Pathname.new('')) { |built_path, path| built_path.join(path) }
-            potential_codeowners_file = potential_relative_path_name.join(CODEOWNERS_DIRECTORY_FILE_NAME)
+          if File.directory?(file)
+            team = get_team_from_codeowners_file_within_directory(file_path)
+          end
+
+          while team.nil? && file_path != RELATIVE_ROOT && file_path != ABSOLUTE_ROOT
+            file_path = file_path.parent
+            team = get_team_from_codeowners_file_within_directory(file_path)
+          end
+
+          team
+        end
 
-            potential_codeowners_file_name = potential_codeowners_file.to_s
+        sig { params(directory: Pathname).returns(T.nilable(CodeTeams::Team)) }
+        def get_team_from_codeowners_file_within_directory(directory)
+          potential_codeowners_file = directory.join(CODEOWNERS_DIRECTORY_FILE_NAME)
 
-            team = nil
-            if @@directory_cache.key?(potential_codeowners_file_name)
-              team = @@directory_cache[potential_codeowners_file_name]
-            elsif potential_codeowners_file.exist?
-              team = owner_for_codeowners_file(potential_codeowners_file)
+          potential_codeowners_file_name = potential_codeowners_file.to_s
 
-              @@directory_cache[potential_codeowners_file_name] = team
-            else
-              @@directory_cache[potential_codeowners_file_name] = nil
-            end
+          team = nil
+          if @@directory_cache.key?(potential_codeowners_file_name)
+            team = @@directory_cache[potential_codeowners_file_name]
+          elsif potential_codeowners_file.exist?
+            team = owner_for_codeowners_file(potential_codeowners_file)
 
-            return team unless team.nil?
+            @@directory_cache[potential_codeowners_file_name] = team
+          else
+            @@directory_cache[potential_codeowners_file_name] = nil
           end
 
-          nil
+          return team
         end
       end
     end

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

@@ -21,7 +21,7 @@ module CodeOwnership
 
         sig { override.params(teams: T::Array[CodeTeams::Team]).returns(T::Array[String]) }
         def self.validation_errors(teams)
-          all_github_teams = teams.flat_map { |team| self.for(team).github.team }
+          all_github_teams = teams.flat_map { |team| self.for(team).github.team }.compact
 
           teams_used_more_than_once = all_github_teams.tally.select do |_team, count|
             count > 1
@@ -29,6 +29,18 @@ module CodeOwnership
 
           errors = T.let([], T::Array[String])
 
+          if require_github_teams?
+            missing_github_teams = teams.select { |team| self.for(team).github.team.nil? }
+
+            if missing_github_teams.any?
+              errors << <<~ERROR
+                The following teams are missing `github.team` entries:
+
+                #{missing_github_teams.map(&:config_yml).join("\n")}
+              ERROR
+            end
+          end
+
           if teams_used_more_than_once.any?
             errors << <<~ERROR
               The following teams are specified multiple times:
@@ -40,6 +52,11 @@ module CodeOwnership
 
           errors
         end
+
+        sig { returns(T::Boolean) }
+        def self.require_github_teams?
+          CodeOwnership.configuration.require_github_teams
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: code_ownership
 version: !ruby/object:Gem::Version
-  version: 1.34.2
+  version: 1.36.0
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-09 00:00:00.000000000 Z
+date: 2023-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: code_teams