code_ownership 1.37.0 → 1.38.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c854c774447149078df69925e183be064e8ac92ea464da9eea83cec2cfb10931
-  data.tar.gz: 5a42650db0cdc8f14fd8878a0c70587b21a722a284a45104051062464f73a4a7
+  metadata.gz: 8319ea8a2a73ecec20a28193627b25b877ae9983b206dae6ff9422d5be157625
+  data.tar.gz: 13228207fa0b9042fe5f87e53c80234e862a476ef4a3888bce7f4bbdfb64e970
 SHA512:
-  metadata.gz: 25025e91fa585614f864ab1f84d829037b5769cd491dcca93bf822e25ecb3222388d8d9315bf7dd3fe5a645645855c391028a9df01592199ce0857d47276656e
-  data.tar.gz: 8f8035f102b184ac7ea866df6bff7cee92f0bd2fe5337b49956c85e2ead483a5868c0969030392c63dda1575f9bf33ae085058c0114ef027140b3bf629a60895
+  metadata.gz: a80e615b1d6e7cc8ec795a7b2ffdb20f0ffb8b0e8027cd70e8361542ff5650f195fca4fdf4ece8e0f1331e987dcef9e2d1106c7125925a43d16403e6e9ed0a78
+  data.tar.gz: 8fabc79d074c2491c49a3cdc1b0caf24f009dbab3e81b7cdcb84ac4b6d563d6ac7e32c83ec6494a3df81d8293afa01c7674e87b0b05878515177e757a4df0fe3

data/lib/code_ownership/private/codeowners_file.rb

@@ -73,7 +73,26 @@ module CodeOwnership
 
           next if ownership_entries.none?
 
-          codeowners_file_lines += ['', "# #{mapper_description}", *ownership_entries.sort]
+          # When we have a special character at the beginning of a folder name, then this character
+          # may be prioritized over *. However, we want the most specific folder to be listed last
+          # in the CODEOWNERS file, so we should prioritize any character above an asterisk in the
+          # same position.
+          if mapper_description == OwnershipMappers::FileAnnotations::DESCRIPTION
+            # individually owned files definitely won't have globs so we don't need to do special sorting
+            sorted_ownership_entries = ownership_entries.sort
+          else
+            sorted_ownership_entries = ownership_entries.sort do |entry1, entry2|
+              if entry2.start_with?(entry1.split('**').first)
+                -1
+              elsif entry1.start_with?(entry2.split('**').first)
+                1
+              else
+                entry1 <=> entry2
+              end
+            end
+          end
+
+          codeowners_file_lines += ['', "# #{mapper_description}", *sorted_ownership_entries]
         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.37.0
+  version: 1.38.1
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-13 00:00:00.000000000 Z
+date: 2024-11-21 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