code_ownership 1.32.3 → 1.32.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3bf52f1bcb70650a93514852fec13bc3e1f4f275643ed712bad37f8439b6ae17
-  data.tar.gz: ca47603f68d95683c4b948318532170a7156651ab24c2f0adcce292975b6076f
+  metadata.gz: 18268f7457aeb632f100ea698349530dc29a4be7ae62611f416fe43782705a5b
+  data.tar.gz: 937353d0f07b1ff21ddf813dff047e59d4029c8ff6b08a29f75f31db61e342bb
 SHA512:
-  metadata.gz: 037e1119a49812006add87fcef7c7a3d6de0505523c36dd7811e0583fbd654ccce450b79a7a6a4b298ef90e511a269ed11d076d823cd4025ceb693e3101c4316
-  data.tar.gz: 5c6ef23bf3554f1531bcebeb6daf49353503a251ee8e3a51ff0223375d3fbb7d4abb1d2f4b0ed99e9368e5279d9c0f623f58906f84b2bc09ed0fb8fecc7d5e33
+  metadata.gz: 33c6f36e7a037a8495a370b738715cc2eb557912d4cb2f14df9184b329a6cc18e2c8e0a3f56fc0afd86d028ea321c2737043b8f94a88e5b3ea7c3486ff026216
+  data.tar.gz: 1665092ef4a69c4eecd08039fa1315be6bca38aaec17ead77573ede1c408c4b1e4a9c5a1746505310abaebe07f14c95cb088b691d71ee66b35eaa84ef40db8bd

data/lib/code_ownership/mapper.rb

@@ -58,5 +58,21 @@ module CodeOwnership
     sig { abstract.void }
     def bust_caches!
     end
+
+    sig { returns(Private::GlobCache) }
+    def self.to_glob_cache
+      glob_to_owner_map_by_mapper_description = {}
+
+      Mapper.all.each do |mapper|
+        mapped_files = mapper.codeowners_lines_to_owners
+        mapped_files.each do |glob, owner|
+          next if owner.nil?
+          glob_to_owner_map_by_mapper_description[mapper.description] ||= {}
+          glob_to_owner_map_by_mapper_description.fetch(mapper.description)[glob] = owner
+        end
+      end
+
+      Private::GlobCache.new(glob_to_owner_map_by_mapper_description)
+    end
   end
 end

data/lib/code_ownership/private/codeowners_file.rb

@@ -0,0 +1,94 @@
+# typed: strict
+# frozen_string_literal: true
+
+module CodeOwnership
+  module Private
+    #
+    # This class is responsible for turning CodeOwnership directives (e.g. annotations, package owners)
+    # into a GitHub CODEOWNERS file, as specified here:
+    # https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
+    #
+    class CodeownersFile
+      extend T::Sig
+
+      sig { returns(T::Array[String]) }
+      def self.actual_contents_lines
+        if !path.exist?
+          [""]
+        else
+          content = path.read
+          lines = path.read.split("\n")
+          if content.end_with?("\n")
+            lines << ""
+          end
+          lines
+        end
+      end
+
+      sig { returns(T::Array[T.nilable(String)]) }
+      def self.expected_contents_lines
+        cache = Private.glob_cache.raw_cache_contents
+
+        header = <<~HEADER
+          # STOP! - DO NOT EDIT THIS FILE MANUALLY
+          # This file was automatically generated by "bin/codeownership validate".
+          #
+          # CODEOWNERS is used for GitHub to suggest code/file owners to various GitHub
+          # teams. This is useful when developers create Pull Requests since the
+          # code/file owner is notified. Reference GitHub docs for more details:
+          # https://help.github.com/en/articles/about-code-owners
+        HEADER
+        ignored_teams = T.let(Set.new, T::Set[String])
+
+        github_team_map = CodeTeams.all.each_with_object({}) do |team, map|
+          team_github = TeamPlugins::Github.for(team).github
+          if team_github.do_not_add_to_codeowners_file
+            ignored_teams << team.name
+          end
+
+          map[team.name] = team_github.team
+        end
+
+        codeowners_file_lines = T.let([], T::Array[String])
+
+        cache.each do |mapper_description, ownership_map_cache|
+          ownership_entries = []
+          ownership_map_cache.each do |path, code_team|
+            team_mapping = github_team_map[code_team.name]
+            next if team_mapping.nil?
+            next if ignored_teams.include?(code_team.name)
+            entry = "/#{path} #{team_mapping}"
+            # In order to use the codeowners file as a proper cache, we'll need to insert commented out entries for ignored teams
+            # entry = if ignored_teams.include?(code_team.name)
+            #   "# /#{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
+          *codeowners_file_lines,
+          "", # For end-of-file newline
+        ]
+      end
+
+      sig { void }
+      def self.write!
+        FileUtils.mkdir_p(path.dirname) if !path.dirname.exist?
+        path.write(expected_contents_lines.join("\n"))
+      end
+
+      sig { returns(Pathname) }
+      def self.path
+        Pathname.pwd.join('.github/CODEOWNERS')
+      end
+    end
+  end
+end

data/lib/code_ownership/private/glob_cache.rb

@@ -0,0 +1,72 @@
+# typed: strict
+# frozen_string_literal: true
+
+module CodeOwnership
+  module Private
+    class GlobCache
+      extend T::Sig
+
+      MapperDescription = T.type_alias { String }
+      GlobsByMapper = T.type_alias { T::Hash[String, CodeTeams::Team] }
+
+      CacheShape = T.type_alias do
+        T::Hash[
+          MapperDescription,
+          GlobsByMapper
+        ]
+      end
+
+      FilesByMapper = T.type_alias do
+        T::Hash[
+          String,
+          T::Array[MapperDescription]
+        ]
+      end
+
+      sig { params(raw_cache_contents: CacheShape).void }
+      def initialize(raw_cache_contents)
+        @raw_cache_contents = raw_cache_contents
+      end
+
+      sig { returns(CacheShape) }
+      def raw_cache_contents
+        @raw_cache_contents
+      end
+
+      sig { returns(CacheShape) }
+      def expanded_cache
+        @expanded_cache = T.let(@expanded_cache, T.nilable(CacheShape))
+
+        @expanded_cache ||= begin
+          expanded_cache = {}
+          @raw_cache_contents.each do |mapper_description, globs_by_owner|
+            expanded_cache[mapper_description] = {}
+            globs_by_owner.each do |glob, owner|
+              Dir.glob(glob).each do |file, owner|
+                expanded_cache[mapper_description][file] = owner
+              end
+            end
+          end
+          
+          expanded_cache
+        end
+      end
+
+      sig { returns(FilesByMapper) }
+      def files_by_mapper
+        @files_by_mapper ||= T.let(@files_by_mapper, T.nilable(FilesByMapper))
+        @files_by_mapper ||= begin
+          files_by_mapper = {}
+          expanded_cache.each do |mapper_description, file_by_owner|
+            file_by_owner.each do |file, owner|
+              files_by_mapper[file] ||= []
+              files_by_mapper[file] << mapper_description
+            end
+          end
+
+          files_by_mapper
+        end
+      end
+    end
+  end
+end

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

@@ -11,8 +11,11 @@ module CodeOwnership
         sig { override.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)
           allow_list = Dir.glob(Private.configuration.unowned_globs)
-          files_by_mapper = Private.files_by_mapper(files)
-          files_not_mapped_at_all = files_by_mapper.select { |_file, mapper_descriptions| mapper_descriptions.count == 0 }.keys
+          files_by_mapper = Private.glob_cache.files_by_mapper
+
+          files_not_mapped_at_all = files.select do |file|
+            files_by_mapper.fetch(file, []).count == 0
+          end
 
           files_without_owners = files_not_mapped_at_all - allow_list
 

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

@@ -10,9 +10,15 @@ module CodeOwnership
 
         sig { override.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)
-          files_by_mapper = Private.files_by_mapper(files)
+          files_by_mapper = Private.glob_cache.files_by_mapper
 
-          files_mapped_by_multiple_mappers = files_by_mapper.select { |_file, mapper_descriptions| mapper_descriptions.count > 1 }.to_h
+          files_mapped_by_multiple_mappers = {}
+          files.each do |file|
+            mappers = files_by_mapper.fetch(file, [])
+            if mappers.count > 1
+              files_mapped_by_multiple_mappers[file] = mappers
+            end
+          end
 
           errors = T.let([], T::Array[String])
 

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

@@ -12,55 +12,34 @@ module CodeOwnership
         def validation_errors(files:, autocorrect: true, stage_changes: true)
           return [] if Private.configuration.skip_codeowners_validation
 
-          codeowners_filepath = Pathname.pwd.join('.github/CODEOWNERS')
-          FileUtils.mkdir_p(codeowners_filepath.dirname) if !codeowners_filepath.dirname.exist?
-
-          header = <<~HEADER
-            # STOP! - DO NOT EDIT THIS FILE MANUALLY
-            # This file was automatically generated by "bin/codeownership validate".
-            #
-            # CODEOWNERS is used for GitHub to suggest code/file owners to various GitHub
-            # teams. This is useful when developers create Pull Requests since the
-            # code/file owner is notified. Reference GitHub docs for more details:
-            # https://help.github.com/en/articles/about-code-owners
-          HEADER
-
-          expected_content_lines = [
-            *header.split("\n"),
-            nil, # For line between header and codeowners_file_lines
-            *codeowners_file_lines,
-            nil, # For end-of-file newline
-          ]
-          
-          expected_contents = expected_content_lines.join("\n")
-          actual_contents = codeowners_filepath.exist? ? codeowners_filepath.read : ""
-          actual_content_lines = actual_contents.split("\n")
-
-          codeowners_up_to_date = actual_contents == expected_contents
+          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?
           errors = T.let([], T::Array[String])
 
           if !codeowners_up_to_date
             if autocorrect
-              codeowners_filepath.write(expected_contents)
+              CodeownersFile.write!
               if stage_changes
-                `git add #{codeowners_filepath}`
+                `git add #{CodeownersFile.path}`
               end
             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
                   CODEOWNERS should contain the following lines, but does not:
-                  #{(expected_content_lines - actual_content_lines).map { |line| "- \"#{line}\""}.join("\n")}
+                  #{(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:
-                  #{(actual_content_lines - expected_content_lines).map { |line| "- \"#{line}\""}.join("\n")}
+                  #{(extra_lines).map { |line| "- \"#{line}\""}.join("\n")}
                 COMMENT
               end
 
@@ -74,7 +53,7 @@ module CodeOwnership
                 ""
               end
 
-              if actual_contents == ""
+              if actual_content_lines == [""]
                 errors << <<~CODEOWNERS_ERROR
                   CODEOWNERS out of date. Run `bin/codeownership validate` to update the CODEOWNERS file
                 CODEOWNERS_ERROR
@@ -90,37 +69,6 @@ module CodeOwnership
 
           errors
         end
-
-        private
-
-        # Generate the contents of a CODEOWNERS file that GitHub can use to
-        # automatically assign reviewers
-        # https://help.github.com/articles/about-codeowners/
-        sig { returns(T::Array[String]) }
-        def codeowners_file_lines
-          github_team_map = CodeTeams.all.each_with_object({}) do |team, map|
-            team_github = TeamPlugins::Github.for(team).github
-            next if team_github.do_not_add_to_codeowners_file
-
-            map[team.name] = team_github.team
-          end
-
-          Mapper.all.flat_map do |mapper|
-            codeowners_lines = mapper.codeowners_lines_to_owners.filter_map do |line, team|
-              team_mapping = github_team_map[team&.name]
-              next unless team_mapping
-
-              "/#{line} #{team_mapping}"
-            end
-            next [] if codeowners_lines.empty?
-
-            [
-              '',
-              "# #{mapper.description}",
-              *codeowners_lines.sort,
-            ]
-          end
-        end
       end
     end
   end

data/lib/code_ownership/private.rb

@@ -5,7 +5,9 @@
 require 'code_ownership/private/extension_loader'
 require 'code_ownership/private/team_plugins/ownership'
 require 'code_ownership/private/team_plugins/github'
+require 'code_ownership/private/codeowners_file'
 require 'code_ownership/private/parse_js_packages'
+require 'code_ownership/private/glob_cache'
 require 'code_ownership/private/validations/files_have_owners'
 require 'code_ownership/private/validations/github_codeowners_up_to_date'
 require 'code_ownership/private/validations/files_have_unique_owners'
@@ -37,7 +39,7 @@ module CodeOwnership
     def self.bust_caches!
       @configuration = nil
       @tracked_files = nil
-      @files_by_mapper = nil
+      @glob_cache = nil
     end
 
     sig { params(files: T::Array[String], autocorrect: T::Boolean, stage_changes: T::Boolean).void }
@@ -87,21 +89,10 @@ module CodeOwnership
       end
     end
 
-    sig { params(files: T::Array[String]).returns(T::Hash[String, T::Array[String]]) }
-    def self.files_by_mapper(files)
-      @files_by_mapper ||= T.let(@files_by_mapper, T.nilable(T::Hash[String, T::Array[String]]))
-      @files_by_mapper ||= begin
-        files_by_mapper = files.map { |file| [file, []] }.to_h
-
-        Mapper.all.each do |mapper|
-          mapper.map_files_to_owners(files).each do |file, _team|
-            files_by_mapper[file] ||= []
-            T.must(files_by_mapper[file]) << mapper.description
-          end
-        end
-
-        files_by_mapper
-      end
+    sig { returns(GlobCache) }
+    def self.glob_cache
+      @glob_cache ||= T.let(@glob_cache, T.nilable(GlobCache))
+      @glob_cache ||= Mapper.to_glob_cache
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: code_ownership
 version: !ruby/object:Gem::Version
-  version: 1.32.3
+  version: 1.32.5
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-07 00:00:00.000000000 Z
+date: 2023-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: code_teams
@@ -137,7 +137,9 @@ files:
 - lib/code_ownership/configuration.rb
 - lib/code_ownership/mapper.rb
 - lib/code_ownership/private.rb
+- lib/code_ownership/private/codeowners_file.rb
 - lib/code_ownership/private/extension_loader.rb
+- lib/code_ownership/private/glob_cache.rb
 - lib/code_ownership/private/ownership_mappers/file_annotations.rb
 - lib/code_ownership/private/ownership_mappers/js_package_ownership.rb
 - lib/code_ownership/private/ownership_mappers/package_ownership.rb