code_ownership 1.36.3 → 1.38.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb464ff5e39c0c9f2712a7af6498f30b3b42e3c456e7da52a5209d7f30467346
-  data.tar.gz: 5fd3f8974a041ff298fbdaceca0b3eccee027f4d9c94bdfaa344ae9b8ade72d5
+  metadata.gz: 7883f0d73587e099adf43101b91f0a2f296912cfa3e994e2f1c70472de918e4b
+  data.tar.gz: 1e11b8c1ce41986fa40325b3edf10369b00a7ed8a42f47e2ed4fe9694f565642
 SHA512:
-  metadata.gz: ef51049577f74ab3faed01b4a37df119eaf577465fa10f342b79c0fabf7bc89b59ed993f8c1d8f687c53a3957745dfe579430e081473b9eb63f9b3cbe1f8eb19
-  data.tar.gz: ba03e839b81e0dcdfd1c07356b99dbf850b9abddaa83049c2c74e458012c4b81bdfaead12ed6c59fc744848261e078d715f6512df876d1d1fa238362910bfcb9
+  metadata.gz: 5a381fc3a9867de019b70ada03aca768c427b05198449c4d6478f245f79fefd8e2bd56ab5df06fbe62577d12ce6f6bf80a6509f8347f65831ab8251075b1047f
+  data.tar.gz: 5ea28b28bbf41f5620fbf07d6d4083f8dcfea577648612fd8f05d4e128007ff73d6cec2e1a433ef84cf35a1e4b2c8b4a2d4fca0a8bbaeafedca948be293aaaba

data/README.md

@@ -8,6 +8,30 @@ Check out [`code_ownership_spec.rb`](https://github.com/rubyatscale/code_ownersh
 
 There is also a [companion VSCode Extension]([url](https://github.com/rubyatscale/code-ownership-vscode)) for this gem. Just search `Gusto.code-ownership-vscode` in the VSCode Extension Marketplace.
 
+## Getting started
+
+To get started there's a few things you should do.
+
+1) Create a `config/code_ownership.yml` file and declare where your files live. Here's a sample to start with:
+```yml
+owned_globs:
+  - '{app,components,config,frontend,lib,packs,spec}/**/*.{rb,rake,js,jsx,ts,tsx}'
+js_package_paths: []
+unowned_globs:
+  - db/**/*
+  - app/services/some_file1.rb
+  - app/services/some_file2.rb
+  - frontend/javascripts/**/__generated__/**/*
+```
+2) Declare some teams. Here's an example, that would live at `config/teams/operations.yml`:
+```yml
+name: Operations
+github:
+  team: '@my-org/operations-team'
+```
+3) Declare ownership. You can do this at a directory level or at a file level. All of the files within the `owned_globs` you declared in step 1 will need to have an owner assigned (or be opted out via `unowned_globs`). See the next section for more detail.
+4) Run validations when you commit, and/or in CI. If you run validations in CI, ensure that if your `.github/CODEOWNERS` file gets changed, that gets pushed to the PR.
+
 ## Usage: Declaring Ownership
 
 There are three ways to declare code ownership using this gem.

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

@@ -48,7 +48,8 @@ module CodeOwnership
             .map(&:cleanpath)
             .each_with_object({}) do |pathname, res|
             owner = owner_for_codeowners_file(pathname)
-            res[pathname.dirname.cleanpath.join('**/**').to_s] = owner
+            glob = glob_for_codeowners_file(pathname)
+            res[glob] = owner
           end
         end
 
@@ -77,7 +78,7 @@ module CodeOwnership
         # 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.
-        # If the parovided file is a directory, it will look for `.codeowner` in that directory and then upwards.
+        # If the provided 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)
@@ -123,6 +124,26 @@ module CodeOwnership
 
           team
         end
+
+        sig { params(codeowners_file: Pathname).returns(String) }
+        def glob_for_codeowners_file(codeowners_file)
+          unescaped = codeowners_file.dirname.cleanpath.join('**/**').to_s
+
+          # Globs can contain certain regex characters, like "[" and "]".
+          # However, when we are generating a glob from a .codeowner file, we
+          # need to escape bracket characters and interpret them literally.
+          # Otherwise the resulting glob will not actually match the directory
+          # containing the .codeowner file.
+          #
+          # Example
+          # file: "/some/[dir]/.codeowner"
+          # unescaped: "/some/[dir]/**/**"
+          # matches: "/some/d/file"
+          # matches: "/some/i/file"
+          # matches: "/some/r/file"
+          # does not match!: "/some/[dir]/file"
+          unescaped.gsub(/[\[\]]/) { |x| "\\#{x}" }
+        end
       end
     end
   end

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

@@ -39,7 +39,8 @@ module CodeOwnership
             owner = file_annotation_based_owner(filename_relative_to_root)
             next unless owner
 
-            mapping[filename_relative_to_root] = owner
+            escaped_filename = escaped_path_for_codeowners_file(filename_relative_to_root)
+            mapping[escaped_filename] = owner
           end
         end
 
@@ -55,7 +56,8 @@ module CodeOwnership
 
           invalid_files = cache.keys.select do |file|
             # If a file is not tracked, it should be removed from the cache
-            !Private.file_tracked?(file) ||
+            unescaped_file = unescaped_path_for_codeowners_file(file)
+            !Private.file_tracked?(unescaped_file) ||
               # If a file no longer has a file annotation (i.e. `globs_to_owner` doesn't map it)
               # it should be removed from the cache
               # We make sure to only apply this to the input files since otherwise `updated_cache_for_files.key?(file)` would always return `false` when files == []
@@ -126,6 +128,32 @@ module CodeOwnership
 
         sig { override.void }
         def bust_caches!; end
+
+        sig { params(filename: String).returns(String) }
+        def escaped_path_for_codeowners_file(filename)
+          # Globs can contain certain regex characters, like "[" and "]".
+          # However, when we are generating a glob from a file annotation, we
+          # need to escape bracket characters and interpret them literally.
+          # Otherwise the resulting glob will not actually match the directory
+          # containing the file.
+          #
+          # Example
+          # filename: "/some/[xId]/myfile.tsx"
+          # matches: "/some/1/file"
+          # matches: "/some/2/file"
+          # matches: "/some/3/file"
+          # does not match!: "/some/[xId]/myfile.tsx"
+          filename.gsub(/[\[\]]/) { |x| "\\#{x}" }
+        end
+
+        sig { params(filename: String).returns(String) }
+        def unescaped_path_for_codeowners_file(filename)
+          # Globs can contain certain regex characters, like "[" and "]".
+          # We escape bracket characters and interpret them literally for
+          # the CODEOWNERS file. However, we want to compare the unescaped
+          # glob to the actual file path when we check if the file was deleted.
+          filename.gsub(/\\([\[\]])/, '\1')
+        end
       end
     end
   end

data/lib/code_ownership/private.rb

@@ -99,6 +99,7 @@ module CodeOwnership
       in_unowned_globs = configuration.unowned_globs.any? do |unowned_glob|
         File.fnmatch?(unowned_glob, file, File::FNM_PATHNAME | File::FNM_EXTGLOB)
       end
+
       in_owned_globs && !in_unowned_globs && File.exist?(file)
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: code_ownership
 version: !ruby/object:Gem::Version
-  version: 1.36.3
+  version: 1.38.0
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-30 00:00:00.000000000 Z
+date: 2024-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: code_teams
@@ -220,7 +220,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: A gem to help engineering teams declare ownership of code