code_ownership 1.36.2 → 1.37.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b73797a7557aab4536aef1ae47614f8d43e4dc634ec3ab476913c38efec1ad42
-  data.tar.gz: 5d1724a6eadb02d5bd7f1e521177f760b9134575d34a9bea634f30d45765de2f
+  metadata.gz: c854c774447149078df69925e183be064e8ac92ea464da9eea83cec2cfb10931
+  data.tar.gz: 5a42650db0cdc8f14fd8878a0c70587b21a722a284a45104051062464f73a4a7
 SHA512:
-  metadata.gz: 404f36c3804c30f3eb0fb5fc3a18faf71667c5fe4eab25f0d4527491ce838ee51c39824f3fcacc608e5e1356e82272bbe1928f18e0bd9a65e1c1941df595e5de
-  data.tar.gz: 326d2644787ee2e9d8c054b38762495db9be3c15305519176e3045c979b96e655136f3fb1def6840b8e975e56ee693fbc72dea8d10c6f69a86f2126376f70746
+  metadata.gz: 25025e91fa585614f864ab1f84d829037b5769cd491dcca93bf822e25ecb3222388d8d9315bf7dd3fe5a645645855c391028a9df01592199ce0857d47276656e
+  data.tar.gz: 8f8035f102b184ac7ea866df6bff7cee92f0bd2fe5337b49956c85e2ead483a5868c0969030392c63dda1575f9bf33ae085058c0114ef027140b3bf629a60895

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/cli.rb

@@ -14,7 +14,7 @@ module CodeOwnership
         for_file(argv)
       elsif command == 'for_team'
         for_team(argv)
-      elsif [nil, "help"].include?(command)
+      elsif [nil, 'help'].include?(command)
         puts <<~USAGE
           Usage: bin/codeownership <subcommand>
 
@@ -27,7 +27,6 @@ module CodeOwnership
       else
         puts "'#{command}' is not a code_ownership command. See `bin/codeownership help`."
       end
-
     end
 
     def self.validate!(argv)
@@ -53,16 +52,16 @@ module CodeOwnership
           exit
         end
       end
-      args = parser.order!(argv) {}
+      args = parser.order!(argv)
       parser.parse!(args)
 
       files = if options[:diff]
-        ENV.fetch('CODEOWNERS_GIT_STAGED_FILES') { `git diff --staged --name-only` }.split("\n").select do |file|
-          File.exist?(file)
-        end
-      else
-        nil
-      end
+                ENV.fetch('CODEOWNERS_GIT_STAGED_FILES') { `git diff --staged --name-only` }.split("\n").select do |file|
+                  File.exist?(file)
+                end
+              else
+                nil
+              end
 
       CodeOwnership.validate!(
         files: files,
@@ -79,7 +78,7 @@ module CodeOwnership
       # Long-term, we probably want to use something like `thor` so we don't have to implement logic
       # like this. In the short-term, this is a simple way for us to use the built-in OptionParser
       # while having an ergonomic CLI.
-      files = argv.select { |arg| !arg.start_with?('--') }
+      files = argv.reject { |arg| arg.start_with?('--') }
 
       parser = OptionParser.new do |opts|
         opts.banner = 'Usage: bin/codeownership for_file [options]'
@@ -93,22 +92,22 @@ module CodeOwnership
           exit
         end
       end
-      args = parser.order!(argv) {}
+      args = parser.order!(argv)
       parser.parse!(args)
 
       if files.count != 1
-        raise "Please pass in one file. Use `bin/codeownership for_file --help` for more info"
+        raise 'Please pass in one file. Use `bin/codeownership for_file --help` for more info'
       end
-      
+
       team = CodeOwnership.for_file(files.first)
 
-      team_name = team&.name || "Unowned"
-      team_yml = team&.config_yml || "Unowned"
+      team_name = team&.name || 'Unowned'
+      team_yml = team&.config_yml || 'Unowned'
 
       if options[:json]
         json = {
           team_name: team_name,
-          team_yml: team_yml,
+          team_yml: team_yml
         }
 
         puts json.to_json
@@ -121,8 +120,6 @@ module CodeOwnership
     end
 
     def self.for_team(argv)
-      options = {}
-
       parser = OptionParser.new do |opts|
         opts.banner = 'Usage: bin/codeownership for_team \'Team Name\''
 
@@ -131,14 +128,14 @@ module CodeOwnership
           exit
         end
       end
-      teams = argv.select { |arg| !arg.start_with?('--') }
-      args = parser.order!(argv) {}
+      teams = argv.reject { |arg| arg.start_with?('--') }
+      args = parser.order!(argv)
       parser.parse!(args)
 
       if teams.count != 1
-        raise "Please pass in one team. Use `bin/codeownership for_team --help` for more info"
+        raise 'Please pass in one team. Use `bin/codeownership for_team --help` for more info'
       end
-      
+
       puts CodeOwnership.for_team(teams.first)
     end
 

data/lib/code_ownership/configuration.rb

@@ -17,8 +17,8 @@ module CodeOwnership
     def self.fetch
       config_hash = YAML.load_file('config/code_ownership.yml')
 
-      if config_hash.key?("require")
-        config_hash["require"].each do |require_directive|
+      if config_hash.key?('require')
+        config_hash['require'].each do |require_directive|
           Private::ExtensionLoader.load(require_directive)
         end
       end

data/lib/code_ownership/mapper.rb

@@ -29,21 +29,19 @@ module CodeOwnership
     # This should be fast when run with ONE file
     #
     sig do
-      abstract.params(file: String).
-        returns(T.nilable(::CodeTeams::Team))
-    end
-    def map_file_to_owner(file)
+      abstract.params(file: String)
+        .returns(T.nilable(::CodeTeams::Team))
     end
+    def map_file_to_owner(file); end
 
     #
     # This should be fast when run with MANY files
     #
     sig do
-      abstract.params(files: T::Array[String]).
-        returns(T::Hash[String, ::CodeTeams::Team])
-    end
-    def globs_to_owner(files)
+      abstract.params(files: T::Array[String])
+        .returns(T::Hash[String, ::CodeTeams::Team])
     end
+    def globs_to_owner(files); end
 
     #
     # This should be fast when run with MANY files
@@ -51,16 +49,13 @@ module CodeOwnership
     sig do
       abstract.params(cache: GlobsToOwningTeamMap, files: T::Array[String]).returns(GlobsToOwningTeamMap)
     end
-    def update_cache(cache, files)
-    end
+    def update_cache(cache, files); end
 
     sig { abstract.returns(String) }
-    def description
-    end
+    def description; end
 
     sig { abstract.void }
-    def bust_caches!
-    end
+    def bust_caches!; end
 
     sig { returns(Private::GlobCache) }
     def self.to_glob_cache
@@ -72,6 +67,7 @@ module CodeOwnership
 
         mapped_files.each do |glob, owner|
           next if owner.nil?
+
           glob_to_owner_map_by_mapper_description.fetch(mapper.description)[glob] = owner
         end
       end

data/lib/code_ownership/private/codeowners_file.rb

@@ -13,15 +13,15 @@ module CodeOwnership
 
       sig { returns(T::Array[String]) }
       def self.actual_contents_lines
-        if !path.exist?
-          [""]
-        else
+        if path.exist?
           content = path.read
           lines = path.read.split("\n")
           if content.end_with?("\n")
-            lines << ""
+            lines << ''
           end
           lines
+        else
+          ['']
         end
       end
 
@@ -53,7 +53,7 @@ module CodeOwnership
 
         cache.each do |mapper_description, ownership_map_cache|
           ownership_entries = []
-          sorted_ownership_map_cache = ownership_map_cache.sort_by do |glob, 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|
@@ -64,22 +64,23 @@ module CodeOwnership
             # 1) It allows the CODEOWNERS file to be used as a cache for validations
             # 2) It allows users to specifically see what their team will not be notified about.
             entry = if ignored_teams.include?(code_team.name)
-              "# /#{path} #{team_mapping}"
-            else
-              "/#{path} #{team_mapping}"
-            end
+                      "# /#{path} #{team_mapping}"
+                    else
+                      "/#{path} #{team_mapping}"
+                    end
             ownership_entries << entry
           end
 
           next if ownership_entries.none?
+
           codeowners_file_lines += ['', "# #{mapper_description}", *ownership_entries.sort]
         end
 
         [
           *header.split("\n"),
-          "", # For line between header and codeowners_file_lines
+          '', # For line between header and codeowners_file_lines
           *codeowners_file_lines,
-          "", # For end-of-file newline
+          '' # For end-of-file newline
         ]
       end
 
@@ -123,20 +124,22 @@ module CodeOwnership
         mapper_descriptions = Set.new(Mapper.all.map(&:description))
 
         path.readlines.each do |line|
-          line_with_no_comment = line.chomp.gsub("# ", "")
+          line_with_no_comment = line.chomp.gsub('# ', '')
           if mapper_descriptions.include?(line_with_no_comment)
             current_mapper = line_with_no_comment
           else
             next if current_mapper.nil?
-            next if line.chomp == ""
+            next if line.chomp == ''
+
             # The codeowners file stores paths relative to the root of directory
             # Since a `/` means root of the file system from the perspective of ruby,
             # we remove that beginning slash so we can correctly glob the files out.
-            normalized_line = line.gsub(/^# /, '').gsub(/^\//, '')
+            normalized_line = line.gsub(/^# /, '').gsub(%r{^/}, '')
             split_line = normalized_line.split
             # Most lines will be in the format: /path/to/file my-github-team
             # This will skip over lines that are not of the correct form
             next if split_line.count > 2
+
             entry, github_team = split_line
             code_team = github_team_to_code_team_map[T.must(github_team)]
             # If a GitHub team is changed and a user runs `bin/codeownership validate`, we won't be able to identify
@@ -144,6 +147,7 @@ module CodeOwnership
             # Therefore, if we can't determine the team, we just skip it.
             # This affects how complete the cache is, but that will still be caught by `bin/codeownership validate`.
             next if code_team.nil?
+
             raw_cache_contents[current_mapper] ||= {}
             raw_cache_contents.fetch(current_mapper)[T.must(entry)] = github_team_to_code_team_map.fetch(T.must(github_team))
           end

data/lib/code_ownership/private/extension_loader.rb

@@ -12,7 +12,7 @@ module CodeOwnership
         def load(require_directive)
           # We want to transform the require directive to behave differently
           # if it's a specific local file being required versus a gem
-          if require_directive.start_with?(".")
+          if require_directive.start_with?('.')
             require File.join(Pathname.pwd, require_directive)
           else
             require require_directive

data/lib/code_ownership/private/glob_cache.rb

@@ -34,14 +34,15 @@ module CodeOwnership
 
       sig { params(files: T::Array[String]).returns(FilesByMapper) }
       def mapper_descriptions_that_map_files(files)
-        if files.count > 100
-          # When looking at many files, expanding the cache out using Dir.glob and checking for intersections is faster
-          files_by_mappers = files.map{ |f| [f, Set.new([]) ]}.to_h
-          files_by_mappers.merge(files_by_mappers_via_expanded_cache)
-        else
-          # When looking at few files, using File.fnmatch is faster
-          files_by_mappers_via_file_fnmatch(files)
+        files_by_mappers = files.to_h { |f| [f, Set.new([])] }
+
+        files_by_mappers_via_expanded_cache.each do |file, mappers|
+          mappers.each do |mapper|
+            T.must(files_by_mappers[file]) << mapper if files_by_mappers[file]
+          end
         end
+
+        files_by_mappers
       end
 
       private
@@ -61,11 +62,11 @@ module CodeOwnership
 
       sig { returns(FilesByMapper) }
       def files_by_mappers_via_expanded_cache
-        @files_by_mappers ||= T.let(@files_by_mappers, T.nilable(FilesByMapper))
-        @files_by_mappers ||= begin
+        @files_by_mappers_via_expanded_cache ||= T.let(@files_by_mappers_via_expanded_cache, T.nilable(FilesByMapper))
+        @files_by_mappers_via_expanded_cache ||= begin
           files_by_mappers = T.let({}, FilesByMapper)
           expanded_cache.each do |mapper_description, file_by_owner|
-            file_by_owner.each do |file, owner|
+            file_by_owner.each_key do |file|
               files_by_mappers[file] ||= Set.new([])
               files_by_mappers.fetch(file) << mapper_description
             end
@@ -74,31 +75,6 @@ module CodeOwnership
           files_by_mappers
         end
       end
-
-      sig { params(files: T::Array[String]).returns(FilesByMapper) }
-      def files_by_mappers_via_file_fnmatch(files)
-        files_by_mappers = T.let({}, FilesByMapper)
-
-        files.each do |file|
-          files_by_mappers[file] ||= Set.new([])
-          @raw_cache_contents.each do |mapper_description, globs_by_owner|
-            # As much as I'd like to *not* special case the file annotations mapper, using File.fnmatch? on the thousands of files mapped by the
-            # file annotations mapper is a lot of unnecessary extra work.
-            # Therefore we can just check if the file is in the globs directly for file annotations, otherwise use File.fnmatch
-            if mapper_description == OwnershipMappers::FileAnnotations::DESCRIPTION
-              files_by_mappers.fetch(file) << mapper_description if globs_by_owner[file]
-            else
-              globs_by_owner.each do |glob, owner|
-                if File.fnmatch?(glob, file, File::FNM_PATHNAME | File::FNM_EXTGLOB)
-                  files_by_mappers.fetch(file) << mapper_description
-                end
-              end
-            end
-          end
-        end
-
-        files_by_mappers
-      end
     end
   end
 end

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

@@ -14,8 +14,8 @@ module CodeOwnership
         @@directory_cache = T.let({}, T::Hash[String, T.nilable(CodeTeams::Team)]) # rubocop:disable Style/ClassVars
 
         sig do
-          override.params(file: String).
-            returns(T.nilable(::CodeTeams::Team))
+          override.params(file: String)
+            .returns(T.nilable(::CodeTeams::Team))
         end
         def map_file_to_owner(file)
           map_file_to_relevant_owner(file)
@@ -37,8 +37,8 @@ module CodeOwnership
         # subset of files, but rather we want code ownership for all files.
         #
         sig do
-          override.params(files: T::Array[String]).
-            returns(T::Hash[String, ::CodeTeams::Team])
+          override.params(files: T::Array[String])
+            .returns(T::Hash[String, ::CodeTeams::Team])
         end
         def globs_to_owner(files)
           # The T.unsafe is because the upstream RBI is wrong for Pathname.glob
@@ -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)
@@ -97,7 +98,7 @@ module CodeOwnership
           (path_components.length - 1).downto(0).each do |i|
             team = get_team_from_codeowners_file_within_directory(
                Pathname.new(File.join(*T.unsafe(path_components[0...i])))
-            )
+             )
             return team unless team.nil?
           end
 
@@ -121,7 +122,27 @@ module CodeOwnership
             @@directory_cache[potential_codeowners_file_name] = nil
           end
 
-          return team
+          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

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

@@ -18,24 +18,24 @@ module CodeOwnership
         extend T::Sig
         include Mapper
 
-        TEAM_PATTERN = T.let(/\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
-          override.params(file: String).
-            returns(T.nilable(::CodeTeams::Team))
+          override.params(file: String)
+            .returns(T.nilable(::CodeTeams::Team))
         end
         def map_file_to_owner(file)
           file_annotation_based_owner(file)
         end
 
         sig do
-          override.
-            params(files: T::Array[String]).
-            returns(T::Hash[String, ::CodeTeams::Team])
+          override
+            .params(files: T::Array[String])
+            .returns(T::Hash[String, ::CodeTeams::Team])
         end
         def globs_to_owner(files)
-          files.each_with_object({}) do |filename_relative_to_root, mapping| # rubocop:disable Style/ClassVars
+          files.each_with_object({}) do |filename_relative_to_root, mapping|
             owner = file_annotation_based_owner(filename_relative_to_root)
             next unless owner
 
@@ -56,10 +56,10 @@ 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) ||
-            # 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 == []
-            (fileset.include?(file) && !updated_cache_for_files.key?(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 == []
+              (fileset.include?(file) && !updated_cache_for_files.key?(file))
           end
 
           invalid_files.each do |invalid_file|
@@ -83,14 +83,14 @@ module CodeOwnership
           # and if the annotation isn't in the first two lines we assume it
           # doesn't exist.
 
-          line_1 = File.foreach(filename).first
+          line1 = File.foreach(filename).first
 
-          return if !line_1
+          return if !line1
 
           begin
-            team = line_1[TEAM_PATTERN, :team]
-          rescue ArgumentError => ex
-            if ex.message.include?('invalid byte sequence')
+            team = line1[TEAM_PATTERN, :team]
+          rescue ArgumentError => e
+            if e.message.include?('invalid byte sequence')
               team = nil
             else
               raise
@@ -110,7 +110,7 @@ module CodeOwnership
           if file_annotation_based_owner(filename)
             filepath = Pathname.new(filename)
             lines = filepath.read.split("\n")
-            new_lines = lines.select { |line| !line[TEAM_PATTERN] }
+            new_lines = lines.reject { |line| line[TEAM_PATTERN] }
             # We explicitly add a final new line since splitting by new line when reading the file lines
             # ignores new lines at the ends of files
             # We also remove leading new lines, since there is after a new line after an annotation
@@ -125,8 +125,7 @@ module CodeOwnership
         end
 
         sig { override.void }
-        def bust_caches!
-        end
+        def bust_caches!; end
       end
     end
   end

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

@@ -12,8 +12,8 @@ module CodeOwnership
         @@package_json_cache = T.let({}, T::Hash[String, T.nilable(ParseJsPackages::Package)]) # rubocop:disable Style/ClassVars
 
         sig do
-          override.params(file: String).
-            returns(T.nilable(::CodeTeams::Team))
+          override.params(file: String)
+            .returns(T.nilable(::CodeTeams::Team))
         end
         def map_file_to_owner(file)
           package = map_file_to_relevant_package(file)
@@ -39,8 +39,8 @@ module CodeOwnership
         # subset of files, but rather we want code ownership for all files.
         #
         sig do
-          override.params(files: T::Array[String]).
-            returns(T::Hash[String, ::CodeTeams::Team])
+          override.params(files: T::Array[String])
+            .returns(T::Hash[String, ::CodeTeams::Team])
         end
         def globs_to_owner(files)
           ParseJsPackages.all.each_with_object({}) do |package, res|
@@ -85,8 +85,8 @@ module CodeOwnership
 
           (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_package_json_path = potential_relative_path_name.
-              join(ParseJsPackages::PACKAGE_JSON_NAME)
+            potential_package_json_path = potential_relative_path_name
+              .join(ParseJsPackages::PACKAGE_JSON_NAME)
 
             potential_package_json_string = potential_package_json_path.to_s
 

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

@@ -10,8 +10,8 @@ module CodeOwnership
         include Mapper
 
         sig do
-          override.params(file: String).
-            returns(T.nilable(::CodeTeams::Team))
+          override.params(file: String)
+            .returns(T.nilable(::CodeTeams::Team))
         end
         def map_file_to_owner(file)
           package = Packs.for_file(file)
@@ -30,8 +30,8 @@ module CodeOwnership
         # subset of files, but rather we want code ownership for all files.
         #
         sig do
-          override.params(files: T::Array[String]).
-            returns(T::Hash[String, ::CodeTeams::Team])
+          override.params(files: T::Array[String])
+            .returns(T::Hash[String, ::CodeTeams::Team])
         end
         def globs_to_owner(files)
           Packs.all.each_with_object({}) do |package, res|
@@ -66,8 +66,7 @@ module CodeOwnership
         end
 
         sig { override.void }
-        def bust_caches!
-        end
+        def bust_caches!; end
       end
     end
   end

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

@@ -14,11 +14,11 @@ module CodeOwnership
         @@map_files_to_owners = {} # rubocop:disable Style/ClassVars
 
         sig do
-          params(files: T::Array[String]).
-          returns(T::Hash[String, ::CodeTeams::Team])
+          params(files: T::Array[String])
+          .returns(T::Hash[String, ::CodeTeams::Team])
         end
-        def map_files_to_owners(files) # rubocop:disable Lint/UnusedMethodArgument
-          return @@map_files_to_owners if @@map_files_to_owners&.keys && @@map_files_to_owners.keys.count > 0
+        def map_files_to_owners(files)
+          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|
@@ -42,7 +42,7 @@ module CodeOwnership
           sig { returns(String) }
           def description
             # These are sorted only to prevent non-determinism in output between local and CI environments.
-            sorted_contexts = mapping_contexts.sort_by{|context| context.team.config_yml.to_s }
+            sorted_contexts = mapping_contexts.sort_by { |context| context.team.config_yml.to_s }
             description_args = sorted_contexts.map do |context|
               "`#{context.glob}` (from `#{context.team.config_yml}`)"
             end
@@ -56,7 +56,7 @@ 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| # rubocop:disable Style/ClassVars
+          CodeTeams.all.each_with_object({}) do |team, _map|
             TeamPlugins::Ownership.for(team).owned_globs.each do |glob|
               Dir.glob(glob).each do |filename|
                 mapped_files[filename] ||= []
@@ -66,24 +66,22 @@ module CodeOwnership
           end
 
           overlaps = T.let([], T::Array[GlobOverlap])
-          mapped_files.each do |filename, mapping_contexts|
+          mapped_files.each_value do |mapping_contexts|
             if mapping_contexts.count > 1
               overlaps << GlobOverlap.new(mapping_contexts: mapping_contexts)
             end
           end
 
-          deduplicated_overlaps = overlaps.uniq do |glob_overlap|
+          overlaps.uniq do |glob_overlap|
             glob_overlap.mapping_contexts.map do |context|
               [context.glob, context.team.name]
             end
           end
-
-          deduplicated_overlaps
         end
 
         sig do
-          override.params(file: String).
-            returns(T.nilable(::CodeTeams::Team))
+          override.params(file: String)
+            .returns(T.nilable(::CodeTeams::Team))
         end
         def map_file_to_owner(file)
           map_files_to_owners([file])[file]
@@ -97,11 +95,11 @@ module CodeOwnership
         end
 
         sig do
-          override.params(files: T::Array[String]).
-            returns(T::Hash[String, ::CodeTeams::Team])
+          override.params(files: T::Array[String])
+            .returns(T::Hash[String, ::CodeTeams::Team])
         end
         def globs_to_owner(files)
-          CodeTeams.all.each_with_object({}) do |team, map| # rubocop:disable Style/ClassVars
+          CodeTeams.all.each_with_object({}) do |team, map|
             TeamPlugins::Ownership.for(team).owned_globs.each do |owned_glob|
               map[owned_glob] = team
             end
@@ -128,7 +126,7 @@ module CodeOwnership
             errors << <<~MSG
               `owned_globs` cannot overlap between teams. The following globs overlap:
 
-              #{overlapping_globs.map { |overlap| "- #{overlap.description}"}.join("\n")}
+              #{overlapping_globs.map { |overlap| "- #{overlap.description}" }.join("\n")}
             MSG
           end
 

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

@@ -13,11 +13,11 @@ module CodeOwnership
         @@map_files_to_owners = {} # rubocop:disable Style/ClassVars
 
         sig do
-          params(files: T::Array[String]).
-          returns(T::Hash[String, ::CodeTeams::Team])
+          params(files: T::Array[String])
+          .returns(T::Hash[String, ::CodeTeams::Team])
         end
-        def map_files_to_owners(files) # rubocop:disable Lint/UnusedMethodArgument
-          return @@map_files_to_owners if @@map_files_to_owners&.keys && @@map_files_to_owners.keys.count > 0
+        def map_files_to_owners(files)
+          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
             map[team.config_yml] = team
@@ -25,19 +25,19 @@ module CodeOwnership
         end
 
         sig do
-          override.params(file: String).
-            returns(T.nilable(::CodeTeams::Team))
+          override.params(file: String)
+            .returns(T.nilable(::CodeTeams::Team))
         end
         def map_file_to_owner(file)
           map_files_to_owners([file])[file]
         end
 
         sig do
-          override.params(files: T::Array[String]).
-            returns(T::Hash[String, ::CodeTeams::Team])
+          override.params(files: T::Array[String])
+            .returns(T::Hash[String, ::CodeTeams::Team])
         end
         def globs_to_owner(files)
-          CodeTeams.all.each_with_object({}) do |team, map| # rubocop:disable Style/ClassVars
+          CodeTeams.all.each_with_object({}) do |team, map|
             map[team.config_yml] = team
           end
         end

data/lib/code_ownership/private/parse_js_packages.rb

@@ -23,10 +23,10 @@ module CodeOwnership
           package_loaded_json = JSON.parse(pathname.read)
 
           package_name = if pathname.dirname == Pathname.new('.')
-            ROOT_PACKAGE_NAME
-          else
-            pathname.dirname.cleanpath.to_s
-          end
+                           ROOT_PACKAGE_NAME
+                         else
+                           pathname.dirname.cleanpath.to_s
+                         end
 
           new(
             name: package_name,
@@ -41,7 +41,7 @@ module CodeOwnership
             Please either make the JSON in that file valid or specify `js_package_paths` in config/code_ownership.yml.
           MESSAGE
 
-          raise InvalidCodeOwnershipConfigurationError.new(error_message)
+          raise InvalidCodeOwnershipConfigurationError, error_message
         end
 
         sig { returns(Pathname) }

data/lib/code_ownership/private/permit_pack_owner_top_level_key.rb

@@ -1,4 +1,3 @@
-
 # typed: strict
 # frozen_string_literal: true
 

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

@@ -12,8 +12,8 @@ module CodeOwnership
         def validation_errors(files:, autocorrect: true, stage_changes: true)
           cache = Private.glob_cache
           file_mappings = cache.mapper_descriptions_that_map_files(files)
-          files_not_mapped_at_all = file_mappings.select do |file, mapper_descriptions|
-            mapper_descriptions.count == 0
+          files_not_mapped_at_all = file_mappings.select do |_file, mapper_descriptions|
+            mapper_descriptions.count.zero?
           end
 
           errors = T.let([], T::Array[String])
@@ -22,7 +22,7 @@ module CodeOwnership
             errors << <<~MSG
               Some files are missing ownership:
 
-              #{files_not_mapped_at_all.map { |file, mappers| "- #{file}" }.join("\n")}
+              #{files_not_mapped_at_all.map { |file, _mappers| "- #{file}" }.join("\n")}
             MSG
           end
 

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

@@ -12,7 +12,7 @@ module CodeOwnership
         def validation_errors(files:, autocorrect: true, stage_changes: true)
           cache = Private.glob_cache
           file_mappings = cache.mapper_descriptions_that_map_files(files)
-          files_mapped_by_multiple_mappers = file_mappings.select do |file, mapper_descriptions|
+          files_mapped_by_multiple_mappers = file_mappings.select do |_file, mapper_descriptions|
             mapper_descriptions.count > 1
           end
 

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

@@ -25,7 +25,7 @@ module CodeOwnership
                 `git add #{CodeownersFile.path}`
               end
             # If there is no current file or its empty, display a shorter message.
-            elsif actual_content_lines == [""]
+            elsif actual_content_lines == ['']
               errors << <<~CODEOWNERS_ERROR
                 CODEOWNERS out of date. Run `bin/codeownership validate` to update the CODEOWNERS file
               CODEOWNERS_ERROR
@@ -34,33 +34,33 @@ module CodeOwnership
               extra_lines = actual_content_lines - expected_content_lines
 
               missing_lines_text = if missing_lines.any?
-                <<~COMMENT
-                  CODEOWNERS should contain the following lines, but does not:
-                  #{(missing_lines).map { |line| "- \"#{line}\""}.join("\n")}
-                COMMENT
-              end
+                                     <<~COMMENT
+                                       CODEOWNERS should contain the following lines, but does not:
+                                       #{missing_lines.map { |line| "- \"#{line}\"" }.join("\n")}
+                                     COMMENT
+                                   end
 
               extra_lines_text = if extra_lines.any?
-                <<~COMMENT
-                  CODEOWNERS should not contain the following lines, but it does:
-                  #{(extra_lines).map { |line| "- \"#{line}\""}.join("\n")}
-                COMMENT
-              end
+                                   <<~COMMENT
+                                     CODEOWNERS should not contain the following lines, but it does:
+                                     #{extra_lines.map { |line| "- \"#{line}\"" }.join("\n")}
+                                   COMMENT
+                                 end
 
               diff_text = if missing_lines_text && extra_lines_text
-                 "#{missing_lines_text}\n#{extra_lines_text}".chomp
-              elsif missing_lines_text
-                missing_lines_text
-              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
+                            "#{missing_lines_text}\n#{extra_lines_text}".chomp
+                          elsif missing_lines_text
+                            missing_lines_text
+                          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
 
               errors << <<~CODEOWNERS_ERROR
                 CODEOWNERS out of date. Run `bin/codeownership validate` to update the CODEOWNERS file

data/lib/code_ownership/private.rb

@@ -92,7 +92,7 @@ module CodeOwnership
       # However, globbing out can take 5 or more seconds on a large repository, dramatically slowing down
       # invocations to `bin/codeownership validate --diff`.
       # Using `File.fnmatch?` is a lot faster!
-      in_owned_globs = configuration.owned_globs.all? do |owned_glob|
+      in_owned_globs = configuration.owned_globs.any? do |owned_glob|
         File.fnmatch?(owned_glob, file, File::FNM_PATHNAME | File::FNM_EXTGLOB)
       end
 
@@ -115,13 +115,11 @@ module CodeOwnership
     sig { returns(GlobCache) }
     def self.glob_cache
       @glob_cache ||= T.let(@glob_cache, T.nilable(GlobCache))
-      @glob_cache ||= begin
-        if CodeownersFile.use_codeowners_cache?
-          CodeownersFile.to_glob_cache
-        else
-          Mapper.to_glob_cache
-        end
-      end
+      @glob_cache ||= if CodeownersFile.use_codeowners_cache?
+                        CodeownersFile.to_glob_cache
+                      else
+                        Mapper.to_glob_cache
+                      end
     end
   end
 

data/lib/code_ownership/validator.rb

@@ -8,8 +8,7 @@ module CodeOwnership
     interface!
 
     sig { abstract.params(files: T::Array[String], autocorrect: T::Boolean, stage_changes: T::Boolean).returns(T::Array[String]) }
-    def validation_errors(files:, autocorrect: true, stage_changes: true)
-    end
+    def validation_errors(files:, autocorrect: true, stage_changes: true); end
 
     class << self
       extend T::Sig

data/lib/code_ownership.rb

@@ -18,7 +18,8 @@ if defined?(Packwerk)
 end
 
 module CodeOwnership
-  extend self
+  module_function
+
   extend T::Sig
   extend T::Helpers
 
@@ -39,7 +40,7 @@ module CodeOwnership
 
     Mapper.all.each do |mapper|
       owner = mapper.map_file_to_owner(file)
-      break if owner
+      break if owner # TODO: what if there are multiple owners? Should we respond with an error instead of the first match?
     end
 
     @for_file[file] = owner
@@ -57,6 +58,7 @@ module CodeOwnership
       ownership_for_mapper = []
       glob_to_owning_team_map.each do |glob, owning_team|
         next if owning_team != team
+
         ownership_for_mapper << "- #{glob}"
       end
 
@@ -66,7 +68,7 @@ module CodeOwnership
         ownership_information += ownership_for_mapper.sort
       end
 
-      ownership_information << ""
+      ownership_information << ''
     end
 
     ownership_information.join("\n")
@@ -84,7 +86,7 @@ module CodeOwnership
     params(
       autocorrect: T::Boolean,
       stage_changes: T::Boolean,
-      files: T.nilable(T::Array[String]),
+      files: T.nilable(T::Array[String])
     ).void
   end
   def validate!(
@@ -95,10 +97,10 @@ module CodeOwnership
     Private.load_configuration!
 
     tracked_file_subset = if files
-      files.select{|f| Private.file_tracked?(f)}
-    else
-      Private.tracked_files
-    end
+                            files.select { |f| Private.file_tracked?(f) }
+                          else
+                            Private.tracked_files
+                          end
 
     Private.validate!(files: tracked_file_subset, autocorrect: autocorrect, stage_changes: stage_changes)
   end
@@ -150,7 +152,7 @@ module CodeOwnership
 
       [
         CodeOwnership.for_file(file),
-        file,
+        file
       ]
     end
   end
@@ -161,15 +163,15 @@ module CodeOwnership
     @memoized_values ||= T.let(@memoized_values, T.nilable(T::Hash[String, T.nilable(::CodeTeams::Team)]))
     @memoized_values ||= {}
     # We use key because the memoized value could be `nil`
-    if !@memoized_values.key?(klass.to_s)
+    if @memoized_values.key?(klass.to_s)
+      @memoized_values[klass.to_s]
+    else
       path = Private.path_from_klass(klass)
       return nil if path.nil?
 
       value_to_memoize = for_file(path)
       @memoized_values[klass.to_s] = value_to_memoize
       value_to_memoize
-    else
-      @memoized_values[klass.to_s]
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: code_ownership
 version: !ruby/object:Gem::Version
-  version: 1.36.2
+  version: 1.37.0
 platform: ruby
 authors:
 - Gusto Engineers
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-16 00:00:00.000000000 Z
+date: 2024-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: code_teams
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: packwerk
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,21 +81,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: sorbet
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +109,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: tapioca
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -123,7 +137,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: packwerk
+  name: sorbet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -137,7 +151,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: railties
+  name: tapioca
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -191,7 +205,7 @@ metadata:
   source_code_uri: https://github.com/rubyatscale/code_ownership
   changelog_uri: https://github.com/rubyatscale/code_ownership/releases
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -199,15 +213,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.5.11
+signing_key:
 specification_version: 4
 summary: A gem to help engineering teams declare ownership of code
 test_files: []