packs 0.0.34 → 0.0.36

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a04a13a8a29914ee596b13b56398210d5758feb1b6765e00209f5e4c45e9bfe
-  data.tar.gz: 9d6bf62bb81a7787c0b100acb888496bbbf06f898fda036073e0e4d65bd01f15
+  metadata.gz: c0a49abad749c63c73c0bbb9cfa0ac4d75962af3c0f5b22cfb8173906f18310e
+  data.tar.gz: e9757c94ee7866e9ee7daaeec189166aa7a07b47baa18f93eff239552a5e94ab
 SHA512:
-  metadata.gz: f899dc6e201f15c8f256ae5ae6686d1954bce35e72558da615428fe1a43c55bd1aca42071983cf81e45ad091492add405b3094e62f2c66c7333d004e08dabdc3
-  data.tar.gz: 99c087232ca4f42199c55a2263daabcd8cc7f376e439ab8d258a0eb4b9a4b93d86150bb15d4498c53ac66c87a5226997a59b73a3d5cec5983f1d61f1f7010cb9
+  metadata.gz: a74621a2a3346a352256086cb534c1ef6038beac481af3559409682ce2198c4d90e16b4d276ebe271fc93d6a9d7a2260642bf0aa2b76de22cd8bd4d9f11054a1
+  data.tar.gz: 93dc9e6df47b7150fd1c2ef1ddd312931b154934d83ae8060307ef17a6a146858b98b33f6961863a3c23348b0aa398f0c188098e6bdf5dc5c6c70547b97fc843

data/README.md

@@ -21,7 +21,7 @@ The rest of the [rubyatscale](https://github.com/rubyatscale) ecosystem is inten
 Here are some example integrations with `packs`:
 - [`packs-specification`](https://github.com/rubyatscale/packs-specification) is a low-dependency gem that allows your production environment to query simple information about packs
 - [`packs-rails`](https://github.com/rubyatscale/packs-rails) can be used to integrate `packs` into your `rails` application
-- [`rubocop-packs`](https://github.com/rubyatscale/rubocop-packs) contains cops to improve boundaries around `packs` 
+- [`rubocop-packs`](https://github.com/rubyatscale/rubocop-packs) contains cops to improve boundaries around `packs`
 - [`packwerk`](https://github.com/Shopify/packwerk) and [`packwerk-extensions`](https://github.com/rubyatscale/packwerk-extensions) help you describe and constrain your package graph in terms of dependencies between packs and pack public API
 - [`code_ownership`](https://github.com/rubyatscale/code_ownership) gives your application the capability to determine the owner of a pack
 - [`pack_stats`](https://github.com/rubyatscale/pack_stats) makes it easy to send metrics about pack adoption and modularization to your favorite metrics provider, such as DataDog (which has built-in support).
@@ -77,7 +77,7 @@ If no pack name is passed in, this will list out violations across all packs.
 ## Make files or directories public API
 `bin/packs make_public path/to/file.rb path/to/directory`
 
-This moves a file or directory to public API (that is -- the `app/public` folder).
+This moves a file or directory to public API (either the `app/public` folder or the pack's specified public path).
 
 Make sure there are no spaces between the comma-separated list of paths of directories.
 

data/lib/packs/cli.rb

@@ -68,7 +68,7 @@ module Packs
 
     desc 'make_public path/to/file.rb path/to/directory', 'Make files or directories public API'
     long_desc <<~LONG_DESC
-      This moves a file or directory to public API (that is -- the `app/public` folder).
+      This moves a file or directory to public API (either the `#{ParsePackwerk::DEFAULT_PUBLIC_PATH}` folder or the pack's specified public path).
 
       Make sure there are no spaces between the comma-separated list of paths of directories.
     LONG_DESC

data/lib/packs/code_ownership_post_processor.rb

@@ -40,7 +40,7 @@ module Packs
       end
     end
 
-    sig { params(file_move_operations: T::Array[Private::FileMoveOperation]).void }
+    sig { override.params(file_move_operations: T::Array[Private::FileMoveOperation]).void }
     def after_move_files!(file_move_operations)
       if @teams.any?
         Logging.section('Code Ownership') do

data/lib/packs/per_file_processor_interface.rb

@@ -10,7 +10,7 @@ module Packs
     sig { abstract.params(file_move_operation: Private::FileMoveOperation).void }
     def before_move_file!(file_move_operation); end
 
-    sig { params(file_move_operations: T::Array[Private::FileMoveOperation]).void }
+    sig { overridable.params(file_move_operations: T::Array[Private::FileMoveOperation]).void }
     def after_move_files!(file_move_operations)
       nil
     end

data/lib/packs/private.rb

@@ -173,6 +173,7 @@ module Packs
         enforce_privacy: package.enforce_privacy,
         enforce_dependencies: package.enforce_dependencies,
         dependencies: package.dependencies,
+        violations: package.violations,
         metadata: package.metadata,
         config: package.config
       )
@@ -214,6 +215,7 @@ module Packs
           enforce_privacy: other_package.enforce_privacy,
           enforce_dependencies: other_package.enforce_dependencies,
           dependencies: new_dependencies.uniq.sort,
+          violations: other_package.violations,
           metadata: other_package.metadata,
           config: new_config
         )
@@ -304,6 +306,7 @@ module Packs
         dependencies: (package.dependencies + [dependency_name]).uniq.sort,
         enforce_privacy: package.enforce_privacy,
         enforce_dependencies: package.enforce_dependencies,
+        violations: package.violations,
         metadata: package.metadata,
         config: package.config
       )
@@ -345,7 +348,7 @@ module Packs
 
     sig { params(package: ParsePackwerk::Package).void }
     def self.add_public_directory(package)
-      public_directory = package.directory.join('app/public')
+      public_directory = package.directory.join(package.public_path)
 
       if public_directory.glob('**/**.rb').none?
         FileUtils.mkdir_p(public_directory)
@@ -373,8 +376,9 @@ module Packs
       ).returns(ParsePackwerk::Package)
     end
     def self.create_pack_if_not_exists!(pack_name:, enforce_privacy:, enforce_dependencies:, team: nil)
-      if PERMITTED_PACK_LOCATIONS.none? { |permitted_location| pack_name.start_with?(permitted_location) }
-        raise StandardError, "Packs only supports packages in the the following directories: #{PERMITTED_PACK_LOCATIONS.inspect}. Please make sure to pass in the name of the pack including the full directory path, e.g. `packs/my_pack`."
+      allowed_locations = Packs::Specification.config.pack_paths
+      if allowed_locations.none? { |location| File.fnmatch(location, pack_name) }
+        raise StandardError, "Packs only supports packages in the the following directories: #{allowed_locations}. Please make sure to pass in the name of the pack including the full directory path, e.g. `packs/my_pack`."
       end
 
       existing_package = ParsePackwerk.all.find { |p| p.name == pack_name }
@@ -395,6 +399,7 @@ module Packs
           enforce_dependencies: should_enforce_dependencies || false,
           enforce_privacy: enforce_privacy,
           dependencies: [],
+          violations: [],
           metadata: {},
           name: pack_name,
           config: config
@@ -508,7 +513,10 @@ module Packs
         outbound: {}
       }
 
+      package_by_name = {}
+
       ParsePackwerk.all.each do |p|
+        package_by_name[p.name] = p
         p.violations.each do |violation|
           violations[:outbound][p.name] ||= []
           violations[:outbound][p.name] << violation
@@ -553,7 +561,7 @@ module Packs
           pack_name: pack.name,
           owner: owner.nil? ? 'No one' : owner.name,
           size: pack.relative_path.glob('**/*.rb').count,
-          public_api: pack.relative_path.join('app/public')
+          public_api: pack.relative_path.join(package_by_name[pack.name].public_path)
         }
 
         row.delete(:date) unless include_date

data/lib/packs/update_references_post_processor.rb

@@ -0,0 +1,50 @@
+# typed: strict
+
+module Packs
+  class UpdateReferencesPostProcessor
+    include PerFileProcessorInterface
+
+    extend T::Sig
+
+    sig { override.params(file_move_operation: Private::FileMoveOperation).void }
+    def before_move_file!(file_move_operation)
+      nil
+    end
+
+    sig { override.params(file_move_operations: T::Array[Private::FileMoveOperation]).void }
+    def after_move_files!(file_move_operations)
+      return if file_move_operations.empty?
+
+      origin_pack = T.must(file_move_operations.first).origin_pack.name
+      destination_pack = T.must(file_move_operations.first).destination_pack.name
+
+      if self.class.ripgrep_enabled?
+        matching_files = `rg -l --hidden '#{origin_pack}' .`
+        matching_files.split("\n").each do |file_name|
+          substitute_references!(file_name, origin_pack, destination_pack)
+        end
+      else
+        Logging.print('For faster UpdateReferences install ripgrep: https://github.com/BurntSushi/ripgrep/tree/master')
+        Dir.glob('./**/*', File::FNM_DOTMATCH) do |file_name|
+          next if File.directory?(file_name)
+
+          substitute_references!(file_name, origin_pack, destination_pack)
+        end
+      end
+    end
+
+    sig { returns(T::Boolean) }
+    def self.ripgrep_enabled?
+      !!system('which', 'rg', out: File::NULL, err: :out)
+    end
+
+    private
+
+    sig { params(file_name: String, origin_pack: String, destination_pack: String).void }
+    def substitute_references!(file_name, origin_pack, destination_pack)
+      text = File.read(file_name)
+      replace = text.gsub(origin_pack, destination_pack)
+      File.open(file_name, 'w') { |file| file.puts replace }
+    end
+  end
+end

data/lib/packs/user_event_logger.rb

@@ -23,7 +23,7 @@ module Packs
 
         2) Run `bin/packwerk update-todo` to update the violations. Make sure to run `spring stop` if you've added new load paths (new top-level directories) in your pack.
 
-        3) Expose public API in #{pack_name}/app/public. Try `bin/packs make_public #{pack_name}/path/to/file.rb`
+        3) Expose public API in #{pack_name}/#{ParsePackwerk::DEFAULT_PUBLIC_PATH}. Try `bin/packs make_public #{pack_name}/path/to/file.rb`
 
         4) Update your readme at #{pack_name}/README.md
       MSG
@@ -45,7 +45,7 @@ module Packs
 
         2) Touch base with each team who owns files involved in this move
 
-        3) Expose public API in #{pack_name}/app/public. Try `bin/packs make_public #{pack_name}/path/to/file.rb`
+        3) Expose public API in #{pack_name}/#{ParsePackwerk::DEFAULT_PUBLIC_PATH}. Try `bin/packs make_public #{pack_name}/path/to/file.rb`
 
         4) Update your readme at #{pack_name}/README.md
       MSG
@@ -136,7 +136,7 @@ module Packs
         If you're the author, please consider replacing this file with a README.md, which may contain:
         - What your pack is and does
         - How you expect people to use your pack
-        - Example usage of your pack's public API (which lives in `#{pack_name}/app/public`)
+        - Example usage of your pack's public API (which lives in `#{pack_name}/#{ParsePackwerk::DEFAULT_PUBLIC_PATH}`)
         - Limitations, risks, and important considerations of usage
         - How to get in touch with eng and other stakeholders for questions or issues pertaining to this pack (note: it is recommended to add ownership in `#{pack_name}/package.yml` under the `owner` metadata key)
         - What SLAs/SLOs (service level agreements/objectives), if any, your package provides
@@ -157,7 +157,7 @@ module Packs
           Pass in a limit to display more or less, e.g. `bin/packs list_top_violations #{type} #{pack_name} -l 1000`
 
           This script is intended to help you find which of YOUR pack's private classes, constants, or modules other packs are using the most.
-          Anything not in pack_name/app/public is considered private API.
+          Anything not in pack_name/#{ParsePackwerk::DEFAULT_PUBLIC_PATH} is considered private API.
         PACK_CONTENT
       else
         <<~PACK_CONTENT
@@ -165,7 +165,7 @@ module Packs
           Pass in a limit to display more or less, e.g. `bin/packs list_top_violations #{type} #{pack_name} -l 1000`
 
           This script is intended to help you find which of YOUR pack's private classes, constants, or modules other packs are using the most.
-          Anything not in #{pack_name}/app/public is considered private API.
+          Anything not in #{pack_name}/#{ParsePackwerk::DEFAULT_PUBLIC_PATH} is considered private API.
         PACK_CONTENT
       end
     end

data/lib/packs.rb

@@ -16,6 +16,7 @@ require 'code_ownership'
 require 'packs/private'
 require 'packs/per_file_processor_interface'
 require 'packs/rubocop_post_processor'
+require 'packs/update_references_post_processor'
 require 'packs/code_ownership_post_processor'
 require 'packs/logging'
 require 'packs/configuration'
@@ -24,12 +25,6 @@ require 'packs/cli'
 module Packs
   extend T::Sig
 
-  PERMITTED_PACK_LOCATIONS = T.let(%w[
-                                     gems
-                                     components
-                                     packs
-                                   ], T::Array[String])
-
   sig { void }
   def self.start_interactive_mode!
     Private::InteractiveCli.start!

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: packs
 version: !ruby/object:Gem::Version
-  version: 0.0.34
+  version: 0.0.36
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-16 00:00:00.000000000 Z
+date: 2023-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: code_ownership
@@ -304,6 +304,7 @@ files:
 - lib/packs/private/pack_relationship_analyzer.rb
 - lib/packs/private/packwerk_wrapper/offenses_aggregator_formatter.rb
 - lib/packs/rubocop_post_processor.rb
+- lib/packs/update_references_post_processor.rb
 - lib/packs/user_event_logger.rb
 homepage: https://github.com/rubyatscale/packs
 licenses: