packs 0.0.35 → 0.0.37

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29b2c810b50fb84aee08f79e49a7d6710b7bf74f8421efd2ce36a12c61bb5cb5
-  data.tar.gz: a183ed44f957f94de6736e0272193e873da6ca7d177a6cbad491682fc73596a8
+  metadata.gz: 61faca4f667524b1ad3ac80486441315601f3ceda6ff04c413a1412b943e7df4
+  data.tar.gz: 347f3a70a95fb188497f7056f88925a5c9ecc409fc0b9561d35ce8fbe13ca191
 SHA512:
-  metadata.gz: 5587b5c11a6ffcc20213ddf8c7fc5fd1efe2d82f6d461e70d38c82fa55151956225388f45313cd2a6cda88bc839a6350ee821a3afdb942929f130ef2b5c5165a
-  data.tar.gz: 3c789067155a3ff7a76eade07734f3acf884fecacea1472a1755afcba7f833bef370dd4f359b2761eeceb907615c2cbbf728bdfc0aa61056b17e9f2cb39593e0
+  metadata.gz: 11de5f83297dce2506a151ceb9f6e18d2a7bdfdfb0086f3ac05b2136f2530b638817d5eea079342265102e2e652c6264f6b31df9fd58e9a1bc61a15f0d47eae9
+  data.tar.gz: ab4bd4f5e89f880ada5f0d9bf7d4a25119a8e3b9ca1158be241cb3b9530b6470ddf6cf817d3c2930afd53b2c0ddd17821d0ee9b42a61547d0578402f581ce87e

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.
 
@@ -111,7 +111,10 @@ Make sure there are no spaces between the comma-separated list of paths of direc
 `bin/packs rename`
 
 ## Set packs/child_pack as a child of packs/parent_pack
-`bin/packs move_to_parent packs/child_pack packs/parent_pack `
+`bin/packs move_to_parent packs/child_pack packs/parent_pack`
+
+## Move packs/foo to the some/directory folder, where some/directory does not contain a package.yml file
+`bin/packs move_to_folder packs/foo some/directory`
 
 
 ## Releasing

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
@@ -150,7 +150,7 @@ module Packs
       exit_successfully
     end
 
-    desc 'move_to_parent packs/child_pack packs/parent_pack ', 'Set packs/child_pack as a child of packs/parent_pack'
+    desc 'move_to_parent packs/child_pack packs/parent_pack', 'Set packs/child_pack as a child of packs/parent_pack'
     sig { params(child_pack_name: String, parent_pack_name: String).void }
     def move_to_parent(child_pack_name, parent_pack_name)
       Packs.move_to_parent!(
@@ -160,6 +160,16 @@ module Packs
       exit_successfully
     end
 
+    desc 'move_to_folder packs/foo some/directory', 'Move packs/foo to the some/directory folder, where some/directory does not contain a package.yml file'
+    sig { params(pack_name: String, destination: String).void }
+    def move_to_folder(pack_name, destination)
+      Packs.move_to_folder!(
+        pack_name: pack_name,
+        destination: destination
+      )
+      exit_successfully
+    end
+
     private
 
     # This is used by thor to know that these private methods are not intended to be CLI commands

data/lib/packs/private.rb

@@ -140,6 +140,83 @@ module Packs
       end
     end
 
+    sig do
+      params(
+        pack_name: String,
+        destination: String,
+        per_file_processors: T::Array[PerFileProcessorInterface]
+      ).void
+    end
+    def self.move_to_folder!(pack_name:, destination:, per_file_processors: [Packs::RubocopPostProcessor.new, Packs::CodeOwnershipPostProcessor.new])
+      pack_name = Private.clean_pack_name(pack_name)
+      package = ParsePackwerk.all.find { |p| p.name == pack_name }
+      if package.nil?
+        raise StandardError, "Can not find package with name #{pack_name}. Make sure the argument is of the form `packs/my_pack/`"
+      end
+
+      # First we create a new pack that has the exact same properties of the old one!
+      package_last_name = package.directory.basename
+      new_package_name = File.join(destination, package_last_name)
+
+      new_package = ParsePackwerk::Package.new(
+        name: new_package_name,
+        enforce_privacy: package.enforce_privacy,
+        enforce_dependencies: package.enforce_dependencies,
+        dependencies: package.dependencies,
+        violations: package.violations,
+        metadata: package.metadata,
+        config: package.config
+      )
+      ParsePackwerk.write_package_yml!(new_package)
+      ParsePackwerk.bust_cache!
+
+      # Move everything from the old pack to the new one
+      move_to_pack!(
+        pack_name: new_package_name,
+        paths_relative_to_root: [package.directory.to_s],
+        per_file_processors: per_file_processors
+      )
+
+      # Then delete the old package.yml and package_todo.yml files
+      package.yml.delete
+      package_todo_file = ParsePackwerk::PackageTodo.for(package).pathname
+      package_todo_file.delete if package_todo_file.exist?
+
+      ParsePackwerk.bust_cache!
+
+      ParsePackwerk.all.each do |other_package|
+        new_dependencies = other_package.dependencies.map { |d| d == pack_name ? new_package_name : d }
+
+        new_config = other_package.config.dup
+        if new_config['ignored_dependencies']
+          new_config['ignored_dependencies'] = new_config['ignored_dependencies'].map do |d|
+            d == pack_name ? new_package_name : d
+          end
+        end
+
+        new_other_package = ParsePackwerk::Package.new(
+          name: other_package.name,
+          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
+        )
+
+        ParsePackwerk.write_package_yml!(new_other_package)
+      end
+
+      sorbet_config = Pathname.new('sorbet/config')
+      if sorbet_config.exist?
+        Packs.replace_in_file(
+          file: sorbet_config.to_s,
+          find: package.directory.join('spec'),
+          replace_with: new_package.directory.join('spec')
+        )
+      end
+    end
+
     sig do
       params(
         pack_name: String,
@@ -348,7 +425,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)
@@ -376,8 +453,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 }
@@ -512,7 +590,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
@@ -557,7 +638,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/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
@@ -105,6 +105,24 @@ module Packs
       MSG
     end
 
+    sig { params(pack_name: String).returns(String) }
+    def before_move_to_folder(pack_name)
+      <<~MSG
+        You are moving one pack to a new directory. Check out #{documentation_link} for more info!
+      MSG
+    end
+
+    sig { params(pack_name: String).returns(String) }
+    def after_move_to_folder(pack_name)
+      <<~MSG
+        Your next steps might be:
+
+        1) Delete the old pack when things look good: `git rm -r #{pack_name}`
+
+        2) Run `bin/packwerk update-todo` to update the violations. Make sure to run `spring stop` first.
+      MSG
+    end
+
     sig { params(pack_name: String).returns(String) }
     def on_create_public_directory_todo(pack_name)
       <<~MSG
@@ -136,7 +154,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 +175,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 +183,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

@@ -25,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!
@@ -184,6 +178,36 @@ module Packs
     end
   end
 
+  sig do
+    params(
+      pack_name: String,
+      destination: String,
+      per_file_processors: T::Array[PerFileProcessorInterface]
+    ).void
+  end
+  def self.move_to_folder!(
+    pack_name:,
+    destination:,
+    per_file_processors: [Packs::RubocopPostProcessor.new, Packs::CodeOwnershipPostProcessor.new]
+  )
+    Logging.section('👋 Hi!') do
+      intro = Packs.config.user_event_logger.before_move_to_folder(pack_name)
+      Logging.print_bold_green(intro)
+    end
+
+    Private.move_to_folder!(
+      pack_name: pack_name,
+      destination: destination,
+      per_file_processors: per_file_processors
+    )
+
+    Logging.section('Next steps') do
+      next_steps = Packs.config.user_event_logger.after_move_to_folder(pack_name)
+
+      Logging.print_bold_green(next_steps)
+    end
+  end
+
   sig do
     params(
       type: String,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: packs
 version: !ruby/object:Gem::Version
-  version: 0.0.35
+  version: 0.0.37
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-24 00:00:00.000000000 Z
+date: 2023-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: code_ownership