parse_packwerk 0.10.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00ce04288d8a8c4f46571bd181e8a3781d325116cd58e8078cdf142e9f74ffce
-  data.tar.gz: 23c1e53eab84fc472d116bf025c6ddb499f509da25246f47ffbdb857ec922f3f
+  metadata.gz: 573bc6231b6506545fa220a99d6ed0abf08362a72e44cabae50a333c209bcbb9
+  data.tar.gz: df64a2831b7d4cebc67597cebcfc2b71ee8cd0d33b1d124f8b6d152eb5e8f6a2
 SHA512:
-  metadata.gz: f24bf1e21e1800e35aa9c4fcdbf1c5e71efafd421d1ce7829461e620c30728a23dd78e099f91bd359fa69e0bca9cef71fabea4cc139598520520942afbcf9006
-  data.tar.gz: 6bd309198e121db0066178ec0fcddbef4b0187110a600bc716fe72d1ebbedab713767b25700d679bd219cafabd93ce6c0896cc0cf9cfa51c279c205105c30003
+  metadata.gz: 6cc08b66c764699ee9110f800fd13dd41deeacefeba958f5769b4d15d6dd1ed186612d846813d3d69670127036d24de51ec4a7dd599a435187b686dcc3693e0d
+  data.tar.gz: 64aacb8e7b976545a5974db6e480e5b0f4e01c164517ac8434f8e8f66dc6bf966f2cdb60aff357fc0dbb96af49f7aaa787e46af8868816f4fcc775209081e1f6

data/README.md

@@ -26,8 +26,8 @@ We generally recommend folks depend on `packwerk` rather than `parse_packwerk`.
 
 This gem exists for this toolchain for these reasons:
 
-(A) `packwerk` is lacking public APIs for the behavior we want. It's close with `PackageSet`, but we need to also be able to parse violations.
-(B) Certain critical, production runtime code-paths need to use this, and we want a simple, low-dependency, infrequently changing dependency for our production environment. One example of production usage is that `package.yml` files can store team ownership information, which is used when an error happens in production to route it to the right team.
-(C) `packwerk` has heavy duty dependencies like rails and lots of others, and it adds a degree of maintenance cost and complexity that isn’t necessary when all we want to do is read YML files
+- `packwerk` is lacking public APIs for the behavior we want. It's close with `PackageSet`, but we need to also be able to parse violations.
+- Certain critical, production runtime code-paths need to use this, and we want a simple, low-dependency, infrequently changing dependency for our production environment. One example of production usage is that `package.yml` files can store team ownership information, which is used when an error happens in production to route it to the right team.
+- `packwerk` has heavy duty dependencies like rails and lots of others, and it adds a degree of maintenance cost and complexity that isn’t necessary when all we want to do is read YML files
 
 Long-term, it might make sense for these reasons to extract out some of the parsing from `packwerk` into a separate gem similar to this so that we can leverage the ecosystem of tools associated with the idea of a “pack” in ways that are simple and safe for both development and production environments.

data/lib/parse_packwerk.rb

@@ -26,7 +26,7 @@ module ParsePackwerk
     returns(T::Array[Package])
   end
   def self.all
-    PackageSet.from(package_pathspec: yml.package_paths, exclude_pathspec: yml.exclude)
+    packages_by_name.values
   end
 
   sig { params(name: String).returns(T.nilable(Package)) }
@@ -39,6 +39,17 @@ module ParsePackwerk
     Configuration.fetch
   end
 
+  sig { params(file_path: T.any(Pathname, String)).returns(T.nilable(Package)) }
+  def self.package_from_path(file_path)
+    path_string = file_path.to_s
+    @package_from_path = T.let(@package_from_path, T.nilable(T::Hash[String, Package]))
+    @package_from_path ||= {}
+    @package_from_path[path_string] ||= T.must(begin
+      matching_package = all.find { |package| path_string.start_with?("#{package.name}/") || path_string == package.name }
+      matching_package || find(ROOT_PACKAGE_NAME)
+    end)
+  end
+
   sig { params(package: ParsePackwerk::Package).void }
   def self.write_package_yml!(package)
     FileUtils.mkdir_p(package.directory)
@@ -82,9 +93,19 @@ module ParsePackwerk
   def self.packages_by_name
     @packages_by_name = T.let(@packages_by_name, T.nilable(T::Hash[String, Package]))
     @packages_by_name ||= begin
-      all.map{|p| [p.name, p]}.to_h
+      all_packages = PackageSet.from(package_pathspec: yml.package_paths, exclude_pathspec: yml.exclude)
+      # We want to match more specific paths first
+      # Packwerk does this too and is necessary for package_from_path to work correctly.
+      sorted_packages = all_packages.sort_by { |package| -package.name.length }
+      sorted_packages.map{|p| [p.name, p]}.to_h
     end
   end
 
+  sig { void }
+  def self.bust_cache!
+    @packages_by_name = nil
+    @package_from_path = nil
+  end
+
   private_class_method :packages_by_name
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parse_packwerk
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-03 00:00:00.000000000 Z
+date: 2022-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
@@ -141,13 +141,13 @@ files:
 - sorbet/rbi/gems/hashdiff@1.0.1.rbi
 - sorbet/rbi/gems/rspec@3.10.0.rbi
 - sorbet/rbi/gems/rspec_override.rbi
-homepage: https://github.com/bigrails/parse_packwerk
+homepage: https://github.com/rubyatscale/parse_packwerk
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/bigrails/parse_packwerk
-  source_code_uri: https://github.com/bigrails/parse_packwerk
-  changelog_uri: https://github.com/bigrails/parse_packwerk/releases
+  homepage_uri: https://github.com/rubyatscale/parse_packwerk
+  source_code_uri: https://github.com/rubyatscale/parse_packwerk
+  changelog_uri: https://github.com/rubyatscale/parse_packwerk/releases
   allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []