code_ownership 1.32.18 → 1.33.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f00d3f6cebe0c0c1a832fe6bd5487b39edb84a0cb316ecbcea33bbf2b090d9bd
-  data.tar.gz: 6092a31cf222e8b734f19338d612ac1b08c121c20dbc822b1271e97ab11980c0
+  metadata.gz: b47612a8dd5a036e2e0f12d5706a0f014884ca977ca0a3db9ee433b580330761
+  data.tar.gz: 769f104467ccfe6cf73f4eddf491064adbcafe09b9666136d1e3df79e26eb525
 SHA512:
-  metadata.gz: 054d5179ae0516d621f71e222308c28c769dfcfe1fd66595ddbe23f6f18126bbfc683ef9a6882a67e8599e88b5fd6800eb95c8f1b55e80c66a13bd8c13a245ba
-  data.tar.gz: a1bcaa5dce9cb34158ce59d73b17d7cdc1494502ca802aa01b5bc3f5af507fd8187b5561e8b26f24151ec1e72eeee24a12c4b314f853af4a0f9230530e6d500d
+  metadata.gz: 1f048953162a4d95d7c44df6fff4138f38b645d042db15bce56cb945eefa722cef616a92e2f9aeb7e1ab4fd76a6e335b6d8f67cc2ff013e076ddc16deb6e40d6
+  data.tar.gz: c0f981c11675470220d58e06b37c737c873482e9d4c83a19bdb3995e8ffd05a45a07528892acf405a324efc8e6687f5d2404740aa9c23de1ca6930115cbda238

data/README.md

@@ -21,6 +21,15 @@ metadata:
   owner: Team
 ```
 
+You can also define `owner` as a top-level key, e.g.
+```yml
+enforce_dependency: true
+enforce_privacy: true
+owner: Team
+```
+
+To do this, add `code_ownership` to the `require` key of your `packwerk.yml`. See https://github.com/Shopify/packwerk/blob/main/USAGE.md#loading-extensions for more information.
+
 ### Glob-Based Ownership
 In your team's configured YML (see [`code_teams`](https://github.com/rubyatscale/code_teams)), you can set `owned_globs` to be a glob of files your team owns. For example, in `my_team.yml`:
 ```yml

data/lib/code_ownership/private/codeowners_file.rb

@@ -53,7 +53,10 @@ module CodeOwnership
 
         cache.each do |mapper_description, ownership_map_cache|
           ownership_entries = []
-          ownership_map_cache.each do |path, code_team|
+          sorted_ownership_map_cache = ownership_map_cache.sort_by do |glob, team|
+            glob
+          end
+          sorted_ownership_map_cache.to_h.each do |path, code_team|
             team_mapping = github_team_map[code_team.name]
             next if team_mapping.nil?
 

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

@@ -56,7 +56,7 @@ module CodeOwnership
 
         sig { params(package: Packs::Pack).returns(T.nilable(CodeTeams::Team)) }
         def owner_for_package(package)
-          raw_owner_value = package.metadata['owner']
+          raw_owner_value = package.raw_hash['owner'] || package.metadata['owner']
           return nil if !raw_owner_value
 
           Private.find_team!(

data/lib/code_ownership/private/permit_pack_owner_top_level_key.rb

@@ -0,0 +1,24 @@
+
+# typed: strict
+# frozen_string_literal: true
+
+require 'packwerk'
+
+module CodeOwnership
+  module Private
+    class PackOwnershipValidator
+      extend T::Sig
+      include Packwerk::Validator
+
+      sig { override.params(package_set: Packwerk::PackageSet, configuration: Packwerk::Configuration).returns(Result) }
+      def call(package_set, configuration)
+        Result.new(ok: true)
+      end
+
+      sig { override.returns(T::Array[String]) }
+      def permitted_keys
+        %w[owner]
+      end
+    end
+  end
+end

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

@@ -14,10 +14,8 @@ module CodeOwnership
 
           actual_content_lines = CodeownersFile.actual_contents_lines
           expected_content_lines = CodeownersFile.expected_contents_lines
-          missing_lines = expected_content_lines - actual_content_lines
-          extra_lines = actual_content_lines - expected_content_lines
 
-          codeowners_up_to_date = !missing_lines.any? && !extra_lines.any?
+          codeowners_up_to_date = actual_content_lines == expected_content_lines
           errors = T.let([], T::Array[String])
 
           if !codeowners_up_to_date
@@ -26,8 +24,14 @@ module CodeOwnership
               if stage_changes
                 `git add #{CodeownersFile.path}`
               end
+            # If there is no current file or its empty, display a shorter message.
+            elsif actual_content_lines == [""]
+              errors << <<~CODEOWNERS_ERROR
+                CODEOWNERS out of date. Run `bin/codeownership validate` to update the CODEOWNERS file
+              CODEOWNERS_ERROR
             else
-              # If there is no current file or its empty, display a shorter message.
+              missing_lines = expected_content_lines - actual_content_lines
+              extra_lines = actual_content_lines - expected_content_lines
 
               missing_lines_text = if missing_lines.any?
                 <<~COMMENT
@@ -50,20 +54,19 @@ module CodeOwnership
               elsif extra_lines_text
                 extra_lines_text
               else
-                ""
+                <<~TEXT
+                  There may be extra lines, or lines are out of order.
+                  You can try to regenerate the CODEOWNERS file from scratch:
+                  1) `rm .github/CODEOWNERS`
+                  2) `bin/codeownership validate`
+                TEXT
               end
 
-              if actual_content_lines == [""]
-                errors << <<~CODEOWNERS_ERROR
-                  CODEOWNERS out of date. Run `bin/codeownership validate` to update the CODEOWNERS file
-                CODEOWNERS_ERROR
-              else
-                errors << <<~CODEOWNERS_ERROR
-                  CODEOWNERS out of date. Run `bin/codeownership validate` to update the CODEOWNERS file
+              errors << <<~CODEOWNERS_ERROR
+                CODEOWNERS out of date. Run `bin/codeownership validate` to update the CODEOWNERS file
 
-                  #{diff_text.chomp}
-                CODEOWNERS_ERROR
-              end
+                #{diff_text.chomp}
+              CODEOWNERS_ERROR
             end
           end
 

data/lib/code_ownership.rb

@@ -13,6 +13,10 @@ require 'code_ownership/private'
 require 'code_ownership/cli'
 require 'code_ownership/configuration'
 
+if defined?(Packwerk)
+  require 'code_ownership/private/permit_pack_owner_top_level_key'
+end
+
 module CodeOwnership
   extend self
   extend T::Sig

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: code_ownership
 version: !ruby/object:Gem::Version
-  version: 1.32.18
+  version: 1.33.0
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-12 00:00:00.000000000 Z
+date: 2023-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: code_teams
@@ -122,6 +122,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: packwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A gem to help engineering teams declare ownership of code
 email:
 - dev@gusto.com
@@ -146,6 +174,7 @@ files:
 - 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/permit_pack_owner_top_level_key.rb
 - lib/code_ownership/private/team_plugins/github.rb
 - lib/code_ownership/private/team_plugins/ownership.rb
 - lib/code_ownership/private/validations/files_have_owners.rb