code_ownership 1.29.1 → 1.29.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd3be735f88cd50d9ba9d9e3d73d6adbf58ebcb20aaa4bceaf3955deedaa497c
-  data.tar.gz: 6a9ca2b07221580d8926218ab912ff418d7c24631a13b04767108e715f19ce57
+  metadata.gz: 0ea243e473ae151a2775f8e1e47d0eb9dacb27f3d2d594db63d3004f5c611109
+  data.tar.gz: eb77703d34e6c40ee734d3e487fd58ba0f124555a681ff267326a4a3f4aeb03e
 SHA512:
-  metadata.gz: 4931c183eb23c08d0ca13bd1d6455c09aa69c9a5fce4f6b7387a3d4da4034c817c341bd74e38efe5bb958ec191f021d749fbb939bc03d9b956836d52e400b312
-  data.tar.gz: a102028da11aefab9899f6eb194b4078846747f6afd2fea76d4e9aa78c66dfecb7c18f8f7482a02a5d43b8d8c4452b7d4492b2704aa3d07ebcdc238a89f363eb
+  metadata.gz: 8464d15022cc9a5f9e6019c0633b8941a3a5f1984f5d55f676c6377b94c335efb0b5722c4289f40b32da5f01453e806911c829c7fa0f11643f2d90c3327db3f3
+  data.tar.gz: 84c95502b0457b848d705b71b675c0d9b8654ed940cd3ba37bc1503c0d8c3cfe7b53dfa28340610ccfde17527e69facc14e7abb106843b21456b3fb17b3bc41d

data/README.md

@@ -36,7 +36,7 @@ File annotations are a last resort if there is no clear home for your code. File
 ```
 
 ### Javascript Package Ownership
-Javascript package based ownership allows you to specify an owenrship key in a `package.json`. To use this, configure your `package.json` like this:
+Javascript package based ownership allows you to specify an ownership key in a `package.json`. To use this, configure your `package.json` like this:
 
 ```json
 {

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

@@ -9,14 +9,14 @@ module CodeOwnership
         extend T::Sig
         include Interface
 
-        @@package_yml_cache = T.let({}, T::Hash[String, T.nilable(ParsePackwerk::Package)]) # rubocop:disable Style/ClassVars
+        @@package_yml_cache = T.let({}, T::Hash[String, T.nilable(Packs::Pack)]) # rubocop:disable Style/ClassVars
 
         sig do
           override.params(file: String).
             returns(T.nilable(::CodeTeams::Team))
         end
         def map_file_to_owner(file)
-          package = ParsePackwerk.package_from_path(file)
+          package = Packs.for_file(file)
 
           return nil if package.nil?
 
@@ -29,11 +29,11 @@ module CodeOwnership
             returns(T::Hash[String, T.nilable(::CodeTeams::Team)])
         end
         def map_files_to_owners(files) # rubocop:disable Lint/UnusedMethodArgument
-          ParsePackwerk.all.each_with_object({}) do |package, res|
+          Packs.all.each_with_object({}) do |package, res|
             owner = owner_for_package(package)
             next if owner.nil?
 
-            glob = package.directory.join('**/**').to_s
+            glob = package.relative_path.join('**/**').to_s
             Dir.glob(glob).each do |path|
               res[path] = owner
             end
@@ -52,11 +52,11 @@ module CodeOwnership
           override.returns(T::Hash[String, T.nilable(::CodeTeams::Team)])
         end
         def codeowners_lines_to_owners
-          ParsePackwerk.all.each_with_object({}) do |package, res|
+          Packs.all.each_with_object({}) do |package, res|
             owner = owner_for_package(package)
             next if owner.nil?
 
-            res[package.directory.join('**/**').to_s] = owner
+            res[package.relative_path.join('**/**').to_s] = owner
           end
         end
 
@@ -65,7 +65,7 @@ module CodeOwnership
           'Owner metadata key in package.yml'
         end
 
-        sig { params(package: ParsePackwerk::Package).returns(T.nilable(CodeTeams::Team)) }
+        sig { params(package: Packs::Pack).returns(T.nilable(CodeTeams::Team)) }
         def owner_for_package(package)
           raw_owner_value = package.metadata['owner']
           return nil if !raw_owner_value

data/lib/code_ownership.rb

@@ -6,7 +6,7 @@ require 'set'
 require 'code_teams'
 require 'sorbet-runtime'
 require 'json'
-require 'parse_packwerk'
+require 'packs'
 require 'code_ownership/cli'
 require 'code_ownership/private'
 
@@ -58,7 +58,6 @@ module CodeOwnership
         ownership_information += ownership_for_mapper
       end
 
-      
       ownership_information << ""
     end
 
@@ -93,7 +92,25 @@ module CodeOwnership
   # first line that corresponds to a file with assigned ownership
   sig { params(backtrace: T.nilable(T::Array[String]), excluded_teams: T::Array[::CodeTeams::Team]).returns(T.nilable(::CodeTeams::Team)) }
   def for_backtrace(backtrace, excluded_teams: [])
-    return unless backtrace
+    first_owned_file_for_backtrace(backtrace, excluded_teams: excluded_teams)&.first
+  end
+
+  # Given a backtrace from either `Exception#backtrace` or `caller`, find the
+  # first owned file in it, useful for figuring out which file is being blamed.
+  sig { params(backtrace: T.nilable(T::Array[String]), excluded_teams: T::Array[::CodeTeams::Team]).returns(T.nilable([::CodeTeams::Team, String])) }
+  def first_owned_file_for_backtrace(backtrace, excluded_teams: [])
+    backtrace_with_ownership(backtrace).each do |(team, file)|
+      if team && !excluded_teams.include?(team)
+        return [team, file]
+      end
+    end
+
+    nil
+  end
+
+  sig { params(backtrace: T.nilable(T::Array[String])).returns(T::Enumerable[[T.nilable(::CodeTeams::Team), String]]) }
+  def backtrace_with_ownership(backtrace)
+    return [] unless backtrace
 
     # The pattern for a backtrace hasn't changed in forever and is considered
     # stable: https://github.com/ruby/ruby/blob/trunk/vm_backtrace.c#L303-L317
@@ -110,18 +127,19 @@ module CodeOwnership
         `(?<function>.*)' # Matches "`block (3 levels) in create'"
       \z}x
 
-    backtrace.each do |line|
+    backtrace.lazy.filter_map do |line|
       match = line.match(backtrace_line)
+      next unless match
 
-      if match
-        team = CodeOwnership.for_file(T.must(match[:file]))
-        if team && !excluded_teams.include?(team)
-          return team
-        end
-      end
+      file = T.must(match[:file])
+
+      [
+        CodeOwnership.for_file(file),
+        file,
+      ]
     end
-    nil
   end
+  private_class_method(:backtrace_with_ownership)
 
   sig { params(klass: T.nilable(T.any(Class, Module))).returns(T.nilable(::CodeTeams::Team)) }
   def for_class(klass)
@@ -140,7 +158,7 @@ module CodeOwnership
     end
   end
 
-  sig { params(package: ParsePackwerk::Package).returns(T.nilable(::CodeTeams::Team)) }
+  sig { params(package: Packs::Pack).returns(T.nilable(::CodeTeams::Team)) }
   def for_package(package)
     Private::OwnershipMappers::PackageOwnership.new.owner_for_package(package)
   end

data/sorbet/rbi/gems/packs@0.0.2.rbi

@@ -0,0 +1,80 @@
+# typed: true
+
+# DO NOT EDIT MANUALLY
+# This is an autogenerated file for types exported from the `packs` gem.
+# Please instead update this file by running `bin/tapioca gem packs`.
+
+module Packs
+  class << self
+    sig { returns(T::Array[::Packs::Pack]) }
+    def all; end
+
+    sig { void }
+    def bust_cache!; end
+
+    sig { returns(::Packs::Configuration) }
+    def config; end
+
+    sig { params(blk: T.proc.params(arg0: ::Packs::Configuration).void).void }
+    def configure(&blk); end
+
+    sig { params(name: ::String).returns(T.nilable(::Packs::Pack)) }
+    def find(name); end
+
+    sig { params(file_path: T.any(::Pathname, ::String)).returns(T.nilable(::Packs::Pack)) }
+    def for_file(file_path); end
+
+    private
+
+    sig { returns(T::Array[::Pathname]) }
+    def package_glob_patterns; end
+
+    sig { returns(T::Hash[::String, ::Packs::Pack]) }
+    def packs_by_name; end
+  end
+end
+
+class Packs::Configuration
+  sig { void }
+  def initialize; end
+
+  sig { returns(T::Array[::Pathname]) }
+  def roots; end
+
+  sig { params(roots: T::Array[::String]).void }
+  def roots=(roots); end
+end
+
+Packs::PACKAGE_FILE = T.let(T.unsafe(nil), String)
+
+class Packs::Pack < ::T::Struct
+  const :name, ::String
+  const :path, ::Pathname
+  const :raw_hash, T::Hash[T.untyped, T.untyped]
+  const :relative_path, ::Pathname
+
+  sig { returns(::String) }
+  def last_name; end
+
+  sig { returns(T::Hash[T.untyped, T.untyped]) }
+  def metadata; end
+
+  sig { returns(::Pathname) }
+  def yml; end
+
+  class << self
+    sig { params(package_yml_absolute_path: ::Pathname).returns(::Packs::Pack) }
+    def from(package_yml_absolute_path); end
+
+    def inherited(s); end
+  end
+end
+
+module Packs::Private
+  class << self
+    sig { returns(::Pathname) }
+    def root; end
+  end
+end
+
+Packs::ROOTS = T.let(T.unsafe(nil), Array)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: code_ownership
 version: !ruby/object:Gem::Version
-  version: 1.29.1
+  version: 1.29.3
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-30 00:00:00.000000000 Z
+date: 2023-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: code_teams
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: parse_packwerk
+  name: packs
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -150,7 +150,7 @@ files:
 - lib/code_ownership/private/validations/interface.rb
 - sorbet/config
 - sorbet/rbi/gems/code_teams@1.0.0.rbi
-- sorbet/rbi/gems/parse_packwerk@0.12.0.rbi
+- sorbet/rbi/gems/packs@0.0.2.rbi
 - sorbet/rbi/manual.rbi
 - sorbet/rbi/todo.rbi
 homepage: https://github.com/rubyatscale/code_ownership

data/sorbet/rbi/gems/parse_packwerk@0.12.0.rbi

@@ -1,146 +0,0 @@
-# typed: true
-
-# DO NOT EDIT MANUALLY
-# This is an autogenerated file for types exported from the `parse_packwerk` gem.
-# Please instead update this file by running `bin/tapioca gem parse_packwerk`.
-
-module ParsePackwerk
-  class << self
-    sig { returns(T::Array[::ParsePackwerk::Package]) }
-    def all; end
-
-    sig { void }
-    def bust_cache!; end
-
-    sig { params(name: ::String).returns(T.nilable(::ParsePackwerk::Package)) }
-    def find(name); end
-
-    sig { params(file_path: T.any(::Pathname, ::String)).returns(T.nilable(::ParsePackwerk::Package)) }
-    def package_from_path(file_path); end
-
-    sig { params(package: ::ParsePackwerk::Package).void }
-    def write_package_yml!(package); end
-
-    sig { returns(::ParsePackwerk::Configuration) }
-    def yml; end
-
-    private
-
-    sig { returns(T::Hash[::String, ::ParsePackwerk::Package]) }
-    def packages_by_name; end
-  end
-end
-
-class ParsePackwerk::Configuration < ::T::Struct
-  const :exclude, T::Array[::String]
-  const :package_paths, T::Array[::String]
-
-  class << self
-    sig { params(config_hash: T::Hash[T.untyped, T.untyped]).returns(T::Array[::String]) }
-    def excludes(config_hash); end
-
-    sig { returns(::ParsePackwerk::Configuration) }
-    def fetch; end
-
-    def inherited(s); end
-
-    sig { params(config_hash: T::Hash[T.untyped, T.untyped]).returns(T::Array[::String]) }
-    def package_paths(config_hash); end
-  end
-end
-
-ParsePackwerk::DEFAULT_EXCLUDE_GLOBS = T.let(T.unsafe(nil), Array)
-ParsePackwerk::DEFAULT_PACKAGE_PATHS = T.let(T.unsafe(nil), Array)
-ParsePackwerk::DEPENDENCIES = T.let(T.unsafe(nil), String)
-ParsePackwerk::DEPRECATED_REFERENCES_YML_NAME = T.let(T.unsafe(nil), String)
-
-class ParsePackwerk::DeprecatedReferences < ::T::Struct
-  const :pathname, ::Pathname
-  const :violations, T::Array[::ParsePackwerk::Violation]
-
-  class << self
-    sig { params(package: ::ParsePackwerk::Package).returns(::ParsePackwerk::DeprecatedReferences) }
-    def for(package); end
-
-    sig { params(pathname: ::Pathname).returns(::ParsePackwerk::DeprecatedReferences) }
-    def from(pathname); end
-
-    def inherited(s); end
-  end
-end
-
-ParsePackwerk::ENFORCE_DEPENDENCIES = T.let(T.unsafe(nil), String)
-ParsePackwerk::ENFORCE_PRIVACY = T.let(T.unsafe(nil), String)
-ParsePackwerk::METADATA = T.let(T.unsafe(nil), String)
-ParsePackwerk::MetadataYmlType = T.type_alias { T::Hash[T.untyped, T.untyped] }
-
-class ParsePackwerk::MissingConfiguration < ::StandardError
-  sig { params(packwerk_file_name: ::Pathname).void }
-  def initialize(packwerk_file_name); end
-end
-
-ParsePackwerk::PACKAGE_YML_NAME = T.let(T.unsafe(nil), String)
-ParsePackwerk::PACKWERK_YML_NAME = T.let(T.unsafe(nil), String)
-
-class ParsePackwerk::Package < ::T::Struct
-  const :dependencies, T::Array[::String]
-  const :enforce_dependencies, T::Boolean
-  const :enforce_privacy, T::Boolean
-  const :metadata, T::Hash[T.untyped, T.untyped]
-  const :name, ::String
-
-  sig { returns(::Pathname) }
-  def directory; end
-
-  sig { returns(T::Boolean) }
-  def enforces_dependencies?; end
-
-  sig { returns(T::Boolean) }
-  def enforces_privacy?; end
-
-  sig { returns(::Pathname) }
-  def yml; end
-
-  class << self
-    sig { params(pathname: ::Pathname).returns(::ParsePackwerk::Package) }
-    def from(pathname); end
-
-    def inherited(s); end
-  end
-end
-
-class ParsePackwerk::PackageSet
-  class << self
-    sig do
-      params(
-        package_pathspec: T::Array[::String],
-        exclude_pathspec: T::Array[::String]
-      ).returns(T::Array[::ParsePackwerk::Package])
-    end
-    def from(package_pathspec:, exclude_pathspec:); end
-
-    private
-
-    sig { params(globs: T::Array[::String], path: ::Pathname).returns(T::Boolean) }
-    def exclude_path?(globs, path); end
-  end
-end
-
-ParsePackwerk::ROOT_PACKAGE_NAME = T.let(T.unsafe(nil), String)
-
-class ParsePackwerk::Violation < ::T::Struct
-  const :class_name, ::String
-  const :files, T::Array[::String]
-  const :to_package_name, ::String
-  const :type, ::String
-
-  sig { returns(T::Boolean) }
-  def dependency?; end
-
-  sig { returns(T::Boolean) }
-  def privacy?; end
-
-  class << self
-    def inherited(s); end
-  end
-end