code_ownership 1.31.1 → 1.32.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f18626234130fdbd4637847307299048bed10e57619e9fa695f94d05e22f398
-  data.tar.gz: 07a11ca7265a02ab547501072867cffc9f4d2b3e194de9f919deb829dc240ad5
+  metadata.gz: ebb581f1f5784bcac8ce0772d2350227c522f1d5096f2b9546a514b1d79fba1d
+  data.tar.gz: 4f2d525089ce8a67f1c0248bfa2bdb06db432dac677ae995e125c5997cdd97f1
 SHA512:
-  metadata.gz: d742401692975e16d26305c0fdd22671c34b9d67172da3ffc5b38846ec512761229dd6cc5f4a19c86e9b2c95cddd1e96b1a4452aebe571c4ae2f534ea834d2bf
-  data.tar.gz: c06b4fad39595de7d5e74492483a4d326358bfdc8604340abd54686ed0543283d570c34d3f051923f8a080b9a6b75fa037d75dcd9aed570df7ae6e9da60e42b6
+  metadata.gz: 2ccb639acea58cf8a882a06a1075146991781a8ee213251ec0dd8a5fdde19583df739a439246bd00548bf4b540e2904bd7c679f57ca470a3aecacfe1ee022e26
+  data.tar.gz: af0f3b0ee49dbdd0ce6f5a8b98aa6cf15cf290620d080ae1d791b273377b723ae5a31a4d48a667ece4072a24748dff2672d15cb38752ad8574b0e6bdd65fffd4

data/README.md

@@ -57,6 +57,17 @@ js_package_paths:
 
 This defaults `**/`, which makes it look for `package.json` files across your application.
 
+### Custom Ownership
+To enable custom ownership, you can inject your own custom classes into `code_ownership`.
+To do this, first create a class that adheres to the `CodeOwnership::Mapper` and/or `CodeOwnership::Validator` interface.
+Then, in `config/code_ownership.yml`, you can require that file:
+```yml
+require:
+  - ./lib/my_extension.rb
+```
+
+Now, `bin/codeownership validate` will automatically include your new mapper and/or validator. See [`spec/lib/code_ownership/private/extension_loader_spec.rb](spec/lib/code_ownership/private/extension_loader_spec.rb) for an example of what this looks like.
+
 ## Usage: Reading CodeOwnership
 ### `for_file`
 `CodeOwnership.for_file`, given a relative path to a file returns a `CodeTeams::Team` if there is a team that owns the file, `nil` otherwise.

data/lib/code_ownership/configuration.rb

@@ -0,0 +1,44 @@
+# typed: strict
+
+module CodeOwnership
+  class Configuration < T::Struct
+    extend T::Sig
+    DEFAULT_JS_PACKAGE_PATHS = T.let(['**/'], T::Array[String])
+
+    const :owned_globs, T::Array[String]
+    const :unowned_globs, T::Array[String]
+    const :js_package_paths, T::Array[String]
+    const :unbuilt_gems_path, T.nilable(String)
+    const :skip_codeowners_validation, T::Boolean
+    const :raw_hash, T::Hash[T.untyped, T.untyped]
+
+    sig { returns(Configuration) }
+    def self.fetch
+      config_hash = YAML.load_file('config/code_ownership.yml')
+
+      if config_hash.key?("require")
+        config_hash["require"].each do |require_directive|
+          Private::ExtensionLoader.load(require_directive)
+        end
+      end
+
+      new(
+        owned_globs: config_hash.fetch('owned_globs', []),
+        unowned_globs: config_hash.fetch('unowned_globs', []),
+        js_package_paths: js_package_paths(config_hash),
+        skip_codeowners_validation: config_hash.fetch('skip_codeowners_validation', false),
+        raw_hash: config_hash
+      )
+    end
+
+    sig { params(config_hash: T::Hash[T.untyped, T.untyped]).returns(T::Array[String]) }
+    def self.js_package_paths(config_hash)
+      specified_package_paths = config_hash['js_package_paths']
+      if specified_package_paths.nil?
+        DEFAULT_JS_PACKAGE_PATHS.dup
+      else
+        Array(specified_package_paths)
+      end
+    end
+  end
+end

data/lib/code_ownership/mapper.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+# typed: strict
+
+module CodeOwnership
+  module Mapper
+    extend T::Sig
+    extend T::Helpers
+
+    interface!
+
+    class << self
+      extend T::Sig
+
+      sig { params(base: Class).void }
+      def included(base)
+        @mappers ||= T.let(@mappers, T.nilable(T::Array[Class]))
+        @mappers ||= []
+        @mappers << base
+      end
+
+      sig { returns(T::Array[Mapper]) }
+      def all
+        T.unsafe(@mappers).map(&:new)
+      end
+    end
+
+    #
+    # 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)
+    end
+
+    #
+    # This should be fast when run with MANY files
+    #
+    sig do
+      abstract.params(files: T::Array[String]).
+        returns(T::Hash[String, T.nilable(::CodeTeams::Team)])
+    end
+    def map_files_to_owners(files)
+    end
+
+    sig do
+      abstract.returns(T::Hash[String, T.nilable(::CodeTeams::Team)])
+    end
+    def codeowners_lines_to_owners
+    end
+
+    sig { abstract.returns(String) }
+    def description
+    end
+
+    sig { abstract.void }
+    def bust_caches!
+    end
+  end
+end

data/lib/code_ownership/private/extension_loader.rb

@@ -0,0 +1,24 @@
+# typed: strict
+# frozen_string_literal: true
+
+module CodeOwnership
+  module Private
+    # This class handles loading extensions to code_ownership using the `require` directive
+    # in the `code_ownership.yml` configuration.
+    module ExtensionLoader
+      class << self
+        extend T::Sig
+        sig { params(require_directive: String).void }
+        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?(".")
+            require File.join(Pathname.pwd, require_directive)
+          else
+            require require_directive
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -16,7 +16,7 @@ module CodeOwnership
       #   }
       class FileAnnotations
         extend T::Sig
-        include Interface
+        include Mapper
 
         @@map_files_to_owners = T.let({}, T.nilable(T::Hash[String, T.nilable(::CodeTeams::Team)])) # rubocop:disable Style/ClassVars
 

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

@@ -7,7 +7,7 @@ module CodeOwnership
     module OwnershipMappers
       class JsPackageOwnership
         extend T::Sig
-        include Interface
+        include Mapper
 
         @@package_json_cache = T.let({}, T::Hash[String, T.nilable(ParseJsPackages::Package)]) # rubocop:disable Style/ClassVars
 

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

@@ -7,7 +7,7 @@ module CodeOwnership
     module OwnershipMappers
       class PackageOwnership
         extend T::Sig
-        include Interface
+        include Mapper
 
         @@package_yml_cache = T.let({}, T::Hash[String, T.nilable(Packs::Pack)]) # rubocop:disable Style/ClassVars
 

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

@@ -7,7 +7,8 @@ module CodeOwnership
     module OwnershipMappers
       class TeamGlobs
         extend T::Sig
-        include Interface
+        include Mapper
+        include Validator
 
         @@map_files_to_owners = T.let(@map_files_to_owners, T.nilable(T::Hash[String, T.nilable(::CodeTeams::Team)])) # rubocop:disable Style/ClassVars
         @@map_files_to_owners = {} # rubocop:disable Style/ClassVars
@@ -114,6 +115,23 @@ module CodeOwnership
         def description
           'Team-specific owned globs'
         end
+
+        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)
+          overlapping_globs = OwnershipMappers::TeamGlobs.new.find_overlapping_globs
+
+          errors = T.let([], T::Array[String])
+
+          if overlapping_globs.any?
+            errors << <<~MSG
+              `owned_globs` cannot overlap between teams. The following globs overlap:
+
+              #{overlapping_globs.map { |overlap| "- #{overlap.description}"}.join("\n")}
+            MSG
+          end
+
+          errors
+        end
       end
     end
   end

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

@@ -7,7 +7,7 @@ module CodeOwnership
     module OwnershipMappers
       class TeamYmlOwnership
         extend T::Sig
-        include Interface
+        include Mapper
 
         @@map_files_to_owners = T.let(@map_files_to_owners, T.nilable(T::Hash[String, T.nilable(::CodeTeams::Team)])) # rubocop:disable Style/ClassVars
         @@map_files_to_owners = {} # rubocop:disable Style/ClassVars

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

@@ -6,7 +6,7 @@ module CodeOwnership
       class FilesHaveOwners
         extend T::Sig
         extend T::Helpers
-        include Interface
+        include Validator
 
         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)

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

@@ -6,7 +6,7 @@ module CodeOwnership
       class FilesHaveUniqueOwners
         extend T::Sig
         extend T::Helpers
-        include Interface
+        include Validator
 
         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)

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

@@ -6,7 +6,7 @@ module CodeOwnership
       class GithubCodeownersUpToDate
         extend T::Sig
         extend T::Helpers
-        include Interface
+        include Validator
 
         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)
@@ -105,7 +105,7 @@ module CodeOwnership
             map[team.name] = team_github.team
           end
 
-          Private.mappers.flat_map do |mapper|
+          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

data/lib/code_ownership/private.rb

@@ -2,16 +2,13 @@
 
 # typed: strict
 
-require 'code_ownership/private/configuration'
+require 'code_ownership/private/extension_loader'
 require 'code_ownership/private/team_plugins/ownership'
 require 'code_ownership/private/team_plugins/github'
 require 'code_ownership/private/parse_js_packages'
-require 'code_ownership/private/validations/interface'
 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'
-require 'code_ownership/private/validations/no_overlapping_globs'
-require 'code_ownership/private/ownership_mappers/interface'
 require 'code_ownership/private/ownership_mappers/file_annotations'
 require 'code_ownership/private/ownership_mappers/team_globs'
 require 'code_ownership/private/ownership_mappers/package_ownership'
@@ -22,10 +19,18 @@ module CodeOwnership
   module Private
     extend T::Sig
 
-    sig { returns(Private::Configuration) }
+    sig { returns(Configuration) }
     def self.configuration
-      @configuration ||= T.let(@configuration, T.nilable(Private::Configuration))
-      @configuration ||= Private::Configuration.fetch
+      @configuration ||= T.let(@configuration, T.nilable(Configuration))
+      @configuration ||= Configuration.fetch
+    end
+
+    # This is just an alias for `configuration` that makes it more explicit what we're doing instead of just calling `configuration`.
+    # This is necessary because configuration may contain extensions of code ownership, so those extensions should be loaded prior to
+    # calling APIs that provide ownership information.
+    sig { returns(Configuration) }
+    def self.load_configuration!
+      configuration
     end
 
     sig { void }
@@ -37,14 +42,7 @@ module CodeOwnership
 
     sig { params(files: T::Array[String], autocorrect: T::Boolean, stage_changes: T::Boolean).void }
     def self.validate!(files:, autocorrect: true, stage_changes: true)
-      validators = [
-        Validations::FilesHaveOwners.new,
-        Validations::FilesHaveUniqueOwners.new,
-        Validations::GithubCodeownersUpToDate.new,
-        Validations::NoOverlappingGlobs.new,
-      ]
-
-      errors = validators.flat_map do |validator|
+      errors = Validator.all.flat_map do |validator|
         validator.validation_errors(
           files: files,
           autocorrect: autocorrect,
@@ -58,23 +56,6 @@ module CodeOwnership
       end
     end
 
-    sig { returns(T::Array[Private::OwnershipMappers::Interface]) }
-    def self.mappers
-      [
-        file_annotations_mapper,
-        Private::OwnershipMappers::TeamGlobs.new,
-        Private::OwnershipMappers::PackageOwnership.new,
-        Private::OwnershipMappers::JsPackageOwnership.new,
-        Private::OwnershipMappers::TeamYmlOwnership.new,
-      ]
-    end
-
-    sig { returns(Private::OwnershipMappers::FileAnnotations) }
-    def self.file_annotations_mapper
-      @file_annotations_mapper = T.let(@file_annotations_mapper, T.nilable(Private::OwnershipMappers::FileAnnotations))
-      @file_annotations_mapper ||= Private::OwnershipMappers::FileAnnotations.new
-    end
-
     # Returns a string version of the relative path to a Rails constant,
     # or nil if it can't find something
     sig { params(klass: T.nilable(T.any(Class, Module))).returns(T.nilable(String)) }
@@ -112,7 +93,7 @@ module CodeOwnership
       @files_by_mapper ||= begin
         files_by_mapper = files.map { |file| [file, []] }.to_h
 
-        Private.mappers.each do |mapper|
+        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

data/lib/code_ownership/validator.rb

@@ -0,0 +1,30 @@
+# typed: strict
+
+module CodeOwnership
+  module Validator
+    extend T::Sig
+    extend T::Helpers
+
+    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
+
+    class << self
+      extend T::Sig
+
+      sig { params(base: Class).void }
+      def included(base)
+        @validators ||= T.let(@validators, T.nilable(T::Array[Class]))
+        @validators ||= []
+        @validators << base
+      end
+
+      sig { returns(T::Array[Validator]) }
+      def all
+        T.unsafe(@validators).map(&:new)
+      end
+    end
+  end
+end

data/lib/code_ownership.rb

@@ -7,8 +7,11 @@ require 'code_teams'
 require 'sorbet-runtime'
 require 'json'
 require 'packs'
-require 'code_ownership/cli'
+require 'code_ownership/mapper'
+require 'code_ownership/validator'
 require 'code_ownership/private'
+require 'code_ownership/cli'
+require 'code_ownership/configuration'
 
 module CodeOwnership
   extend self
@@ -25,9 +28,11 @@ module CodeOwnership
     return nil if file.start_with?('./')
     return @for_file[file] if @for_file.key?(file)
 
+    Private.load_configuration!
+
     owner = T.let(nil, T.nilable(CodeTeams::Team))
 
-    Private.mappers.each do |mapper|
+    Mapper.all.each do |mapper|
       owner = mapper.map_file_to_owner(file)
       break if owner
     end
@@ -37,11 +42,13 @@ module CodeOwnership
 
   sig { params(team: T.any(CodeTeams::Team, String)).returns(String) }
   def for_team(team)
+    Private.load_configuration!
+
     team = T.must(CodeTeams.find(team)) if team.is_a?(String)
     ownership_information = T.let([], T::Array[String])
 
     ownership_information << "# Code Ownership Report for `#{team.name}` Team"
-    Private.mappers.each do |mapper|
+    Mapper.all.each do |mapper|
       ownership_information << "## #{mapper.description}"
       codeowners_lines = mapper.codeowners_lines_to_owners
       ownership_for_mapper = []
@@ -69,7 +76,7 @@ module CodeOwnership
 
   sig { params(filename: String).void }
   def self.remove_file_annotation!(filename)
-    Private.file_annotations_mapper.remove_file_annotation!(filename)
+    Private::OwnershipMappers::FileAnnotations.new.remove_file_annotation!(filename)
   end
 
   sig do
@@ -84,6 +91,7 @@ module CodeOwnership
     autocorrect: true,
     stage_changes: true
   )
+    Private.load_configuration!
     tracked_file_subset = Private.tracked_files & files
     Private.validate!(files: tracked_file_subset, autocorrect: autocorrect, stage_changes: stage_changes)
   end
@@ -172,6 +180,11 @@ module CodeOwnership
     @for_file = nil
     @memoized_values = nil
     Private.bust_caches!
-    Private.mappers.each(&:bust_caches!)
+    Mapper.all.each(&:bust_caches!)
+  end
+
+  sig { returns(Configuration) }
+  def self.configuration
+    Private.configuration
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: code_ownership
 version: !ruby/object:Gem::Version
-  version: 1.31.1
+  version: 1.32.1
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-06 00:00:00.000000000 Z
+date: 2023-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: code_teams
@@ -134,10 +134,11 @@ files:
 - bin/codeownership
 - lib/code_ownership.rb
 - lib/code_ownership/cli.rb
+- lib/code_ownership/configuration.rb
+- lib/code_ownership/mapper.rb
 - lib/code_ownership/private.rb
-- lib/code_ownership/private/configuration.rb
+- lib/code_ownership/private/extension_loader.rb
 - lib/code_ownership/private/ownership_mappers/file_annotations.rb
-- lib/code_ownership/private/ownership_mappers/interface.rb
 - lib/code_ownership/private/ownership_mappers/js_package_ownership.rb
 - lib/code_ownership/private/ownership_mappers/package_ownership.rb
 - lib/code_ownership/private/ownership_mappers/team_globs.rb
@@ -148,8 +149,7 @@ files:
 - lib/code_ownership/private/validations/files_have_owners.rb
 - lib/code_ownership/private/validations/files_have_unique_owners.rb
 - lib/code_ownership/private/validations/github_codeowners_up_to_date.rb
-- lib/code_ownership/private/validations/interface.rb
-- lib/code_ownership/private/validations/no_overlapping_globs.rb
+- lib/code_ownership/validator.rb
 homepage: https://github.com/rubyatscale/code_ownership
 licenses:
 - MIT

data/lib/code_ownership/private/configuration.rb

@@ -1,37 +0,0 @@
-# typed: strict
-
-module CodeOwnership
-  module Private
-    class Configuration < T::Struct
-      extend T::Sig
-      DEFAULT_JS_PACKAGE_PATHS = T.let(['**/'], T::Array[String])
-
-      const :owned_globs, T::Array[String]
-      const :unowned_globs, T::Array[String]
-      const :js_package_paths, T::Array[String]
-      const :skip_codeowners_validation, T::Boolean
-
-      sig { returns(Configuration) }
-      def self.fetch
-        config_hash = YAML.load_file('config/code_ownership.yml')
-
-        new(
-          owned_globs: config_hash.fetch('owned_globs', []),
-          unowned_globs: config_hash.fetch('unowned_globs', []),
-          js_package_paths: js_package_paths(config_hash),
-          skip_codeowners_validation: config_hash.fetch('skip_codeowners_validation', false)
-        )
-      end
-
-      sig { params(config_hash: T::Hash[T.untyped, T.untyped]).returns(T::Array[String]) }
-      def self.js_package_paths(config_hash)
-        specified_package_paths = config_hash['js_package_paths']
-        if specified_package_paths.nil?
-          DEFAULT_JS_PACKAGE_PATHS.dup
-        else
-          Array(specified_package_paths)
-        end
-      end
-    end
-  end
-end

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

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-# typed: strict
-
-module CodeOwnership
-  module Private
-    module OwnershipMappers
-      module Interface
-        extend T::Sig
-        extend T::Helpers
-
-        interface!
-
-        #
-        # 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)
-        end
-
-        #
-        # This should be fast when run with MANY files
-        #
-        sig do
-          abstract.params(files: T::Array[String]).
-            returns(T::Hash[String, T.nilable(::CodeTeams::Team)])
-        end
-        def map_files_to_owners(files)
-        end
-
-        sig do
-          abstract.returns(T::Hash[String, T.nilable(::CodeTeams::Team)])
-        end
-        def codeowners_lines_to_owners
-        end
-
-        sig { abstract.returns(String) }
-        def description
-        end
-
-        sig { abstract.void }
-        def bust_caches!
-        end
-      end
-    end
-  end
-end

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

@@ -1,18 +0,0 @@
-# typed: strict
-
-module CodeOwnership
-  module Private
-    module Validations
-      module Interface
-        extend T::Sig
-        extend T::Helpers
-
-        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
-      end
-    end
-  end
-end

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

@@ -1,30 +0,0 @@
-# typed: strict
-
-module CodeOwnership
-  module Private
-    module Validations
-      class NoOverlappingGlobs
-        extend T::Sig
-        extend T::Helpers
-        include Interface
-
-        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)
-          overlapping_globs = OwnershipMappers::TeamGlobs.new.find_overlapping_globs
-
-          errors = T.let([], T::Array[String])
-
-          if overlapping_globs.any?
-            errors << <<~MSG
-              `owned_globs` cannot overlap between teams. The following globs overlap:
-
-              #{overlapping_globs.map { |overlap| "- #{overlap.description}"}.join("\n")}
-            MSG
-          end
-
-          errors
-        end
-      end
-    end
-  end
-end