use_packwerk 0.67.0 → 0.69.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3044a336515f7443c6cfcf3814d066d8b2cfdf812de19214cfacddc49dbfcb8d
-  data.tar.gz: c249aea974522df11a037f8b1e46b956d27d2f06ad2dfab9d8076e5399031a15
+  metadata.gz: fb9fada6d2dddd8ab4f85d7133c16fb28557c191ebd10e4e4e98e95d2bc3bb43
+  data.tar.gz: d6c81594392166bb4ca6e849bb5c3366276f1643fdb41243187edb3413d4bce3
 SHA512:
-  metadata.gz: fb2a5a22e390444fcb14f9ef039dfaaa2678c018cbe478794c8fba1ec40ccbcb713ab996611bbbdb6ed2f13a39c773e5a3d080ff1d35276ba0b0e24bd755c516
-  data.tar.gz: 806f18afe7e10d280dcd179539401a12dc3078d79b60d44731c3bb608e639f1a10986e077dcaec578b5a6f2d706de746d39e495ff075f03cf1442f141ec48ece
+  metadata.gz: d24503a5e649108ef31d5632e8f42b688684d95772aff2802c76cc08e45955cc360006ca51682506cac20bc85c3bfc65f31e4d64b4da9d30112da5a64742f165
+  data.tar.gz: c77c2e8e436e6c0a116746998a064fbc5551ac78f8f5dc3896a54d06faf09c66481f59c5efe72641f6d91a4cb0c12cd9b9c896ed213d3de3f7e3ba7a8bb4ce13

data/lib/use_packwerk/cli.rb

@@ -87,8 +87,41 @@ module UsePackwerk
     desc 'lint_package_yml_files [ packs/my_pack packs/my_other_pack ]', 'Lint `package.yml` files'
     sig { params(pack_names: String).void }
     def lint_package_yml_files(*pack_names)
-      packages = pack_names.empty? ? ParsePackwerk.all : pack_names.map { |p| ParsePackwerk.find(p.gsub(%r{/$}, '')) }.compact
-      UsePackwerk.lint_package_yml_files!(packages)
+      UsePackwerk.lint_package_yml_files!(parse_pack_names(pack_names))
+    end
+
+    desc 'validate', 'Run bin/packwerk validate (detects cycles)'
+    sig { void }
+    def validate
+      system('bin/packwerk validate')
+    end
+
+    desc 'check [ packs/my_pack ]', 'Run bin/packwerk check'
+    sig { params(paths: String).void }
+    def check(*paths)
+      system("bin/packwerk check #{paths.join(' ')}")
+    end
+
+    desc 'update [ packs/my_pack ]', 'Run bin/packwerk update-deprecations'
+    sig { params(paths: String).void }
+    def update(*paths)
+      system("bin/packwerk update-deprecations #{paths.join(' ')}")
+    end
+
+    desc 'regenerate_rubocop_todo [ packs/my_pack packs/my_other_pack ]', "Regenerate packs/*/#{RuboCop::Packs::PACK_LEVEL_RUBOCOP_TODO_YML} for one or more packs"
+    sig { params(pack_names: String).void }
+    def regenerate_rubocop_todo(*pack_names)
+      RuboCop::Packs.regenerate_todo(packs: parse_pack_names(pack_names))
+    end
+
+    private
+
+    # This is used by thor to know that these private methods are not intended to be CLI commands
+    no_commands do
+      sig { params(pack_names: T::Array[String]).returns(T::Array[ParsePackwerk::Package]) }
+      def parse_pack_names(pack_names)
+        pack_names.empty? ? ParsePackwerk.all : pack_names.map { |p| ParsePackwerk.find(p.gsub(%r{/$}, '')) }.compact
+      end
     end
   end
 end

data/lib/use_packwerk/code_ownership_post_processor.rb

@@ -40,8 +40,8 @@ module UsePackwerk
       end
     end
 
-    sig { void }
-    def print_final_message!
+    sig { params(file_move_operations: T::Array[Private::FileMoveOperation]).void }
+    def after_move_files!(file_move_operations)
       if @teams.any?
         Logging.section('Code Ownership') do
           Logging.print('This section contains info about the current ownership distribution of the moved files.')

data/lib/use_packwerk/per_file_processor_interface.rb

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

data/lib/use_packwerk/private/interactive_cli/use_cases/check.rb

@@ -0,0 +1,25 @@
+# typed: strict
+
+module UsePackwerk
+  module Private
+    module InteractiveCli
+      module UseCases
+        class Check
+          extend T::Sig
+          extend T::Helpers
+          include Interface
+
+          sig { override.returns(String) }
+          def user_facing_name
+            'Run bin/packwerk check'
+          end
+
+          sig { override.params(prompt: TTY::Prompt).void }
+          def perform!(prompt)
+            system('bin/packwerk check')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/use_packwerk/private/interactive_cli/use_cases/regenerate_rubocop_todo.rb

@@ -12,7 +12,7 @@ module UsePackwerk
           sig { override.params(prompt: TTY::Prompt).void }
           def perform!(prompt)
             packs = PackSelector.single_or_all_pack_multi_select(prompt, question_text: "Please select the packs you want to regenerate `#{RuboCop::Packs::PACK_LEVEL_RUBOCOP_TODO_YML}` for")
-            RuboCop::Packs.auto_generate_rubocop_todo(packs: packs)
+            RuboCop::Packs.regenerate_todo(packs: packs)
           end
 
           sig { override.returns(String) }

data/lib/use_packwerk/private/interactive_cli.rb

@@ -14,6 +14,7 @@ require 'use_packwerk/private/interactive_cli/use_cases/query'
 require 'use_packwerk/private/interactive_cli/use_cases/make_public'
 require 'use_packwerk/private/interactive_cli/use_cases/nest'
 require 'use_packwerk/private/interactive_cli/use_cases/rename'
+require 'use_packwerk/private/interactive_cli/use_cases/check'
 require 'use_packwerk/private/interactive_cli/use_cases/update_deprecations'
 require 'use_packwerk/private/interactive_cli/use_cases/validate'
 require 'use_packwerk/private/interactive_cli/use_cases/regenerate_rubocop_todo'

data/lib/use_packwerk/private/packwerk_wrapper/offenses_aggregator_formatter.rb

@@ -4,7 +4,7 @@ module UsePackwerk
   module Private
     module PackwerkWrapper
       #
-      # This formatter simply collects offenses so we can feed them into PackageProtections
+      # This formatter simply collects offenses so we can feed them into other systems
       #
       class OffensesAggregatorFormatter
         extend T::Sig

data/lib/use_packwerk/private.rb

@@ -87,6 +87,8 @@ module UsePackwerk
       add_readme_todo(package)
       package_location = package.directory
 
+      file_move_operations = T.let([], T::Array[Private::FileMoveOperation])
+
       if paths_relative_to_root.any?
         Logging.section('File Operations') do
           file_paths = paths_relative_to_root.flat_map do |path|
@@ -113,21 +115,26 @@ module UsePackwerk
               origin_pathname
             end
           end
-          file_move_operations = file_paths.map do |origin_pathname|
-            FileMoveOperation.new(
+          file_move_operations = file_paths.flat_map do |origin_pathname|
+            file_move_operation = FileMoveOperation.new(
               origin_pathname: origin_pathname,
               destination_pathname: FileMoveOperation.destination_pathname_for_package_move(origin_pathname, package_location),
               destination_pack: package
             )
+            [
+              file_move_operation,
+              file_move_operation.spec_file_move_operation
+            ]
           end
           file_move_operations.each do |file_move_operation|
             Private.package_filepath(file_move_operation, per_file_processors)
-            Private.package_filepath_spec(file_move_operation, per_file_processors)
           end
         end
       end
 
-      per_file_processors.each(&:print_final_message!)
+      per_file_processors.each do |processor|
+        processor.after_move_files!(file_move_operations)
+      end
     end
 
     sig do
@@ -217,6 +224,8 @@ module UsePackwerk
     end
     def self.make_public!(paths_relative_to_root:, per_file_processors:)
       if paths_relative_to_root.any?
+        file_move_operations = T.let([], T::Array[Private::FileMoveOperation])
+
         Logging.section('File Operations') do
           file_paths = paths_relative_to_root.flat_map do |path|
             origin_pathname = Pathname.new(path).cleanpath
@@ -227,22 +236,30 @@ module UsePackwerk
             end
           end
 
-          file_move_operations = file_paths.map do |path|
+          file_move_operations = file_paths.flat_map do |path|
             package = ParsePackwerk.package_from_path(path)
             origin_pathname = Pathname.new(path).cleanpath
 
-            FileMoveOperation.new(
+            file_move_operation = FileMoveOperation.new(
               origin_pathname: origin_pathname,
               destination_pathname: FileMoveOperation.destination_pathname_for_new_public_api(origin_pathname),
               destination_pack: package
             )
+
+            [
+              file_move_operation,
+              file_move_operation.spec_file_move_operation
+            ]
           end
 
           file_move_operations.each do |file_move_operation|
             Private.package_filepath(file_move_operation, per_file_processors)
-            Private.package_filepath_spec(file_move_operation, per_file_processors)
           end
         end
+
+        per_file_processors.each do |processor|
+          processor.after_move_files!(file_move_operations)
+        end
       end
     end
 
@@ -290,11 +307,6 @@ module UsePackwerk
       idempotent_mv(origin, destination)
     end
 
-    sig { params(file_move_operation: FileMoveOperation, per_file_processors: T::Array[UsePackwerk::PerFileProcessorInterface]).void }
-    def self.package_filepath_spec(file_move_operation, per_file_processors)
-      package_filepath(file_move_operation.spec_file_move_operation, per_file_processors)
-    end
-
     sig { params(origin: Pathname, destination: Pathname).void }
     def self.idempotent_mv(origin, destination)
       if origin.exist? && destination.exist?
@@ -385,8 +397,8 @@ module UsePackwerk
     sig { void }
     def self.bust_cache!
       UsePackwerk.config.bust_cache!
-      # This comes explicitly after `PackageProtections.config.bust_cache!` because
-      # otherwise `PackageProtections.config` will attempt to reload the client configuratoin.
+      # This comes explicitly after `UsePackwerk.config.bust_cache!` because
+      # otherwise `UsePackwerk.config` will attempt to reload the client configuratoin.
       @loaded_client_configuration = false
     end
 

data/lib/use_packwerk/rubocop_post_processor.rb

@@ -21,6 +21,7 @@ module UsePackwerk
 
       if file_move_operation.origin_pack.name != ParsePackwerk::ROOT_PACKAGE_NAME && file_move_operation.destination_pack.name != ParsePackwerk::ROOT_PACKAGE_NAME
         origin_rubocop_todo = file_move_operation.origin_pack.directory.join(RuboCop::Packs::PACK_LEVEL_RUBOCOP_TODO_YML)
+        # If there were TODOs for this file in the origin pack's pack-based rubocop, we want to move it to the destination
         if origin_rubocop_todo.exist?
           loaded_origin_rubocop_todo = YAML.load_file(origin_rubocop_todo)
           new_origin_rubocop_todo = loaded_origin_rubocop_todo.dup
@@ -46,5 +47,21 @@ module UsePackwerk
         end
       end
     end
+
+    sig { params(file_move_operations: T::Array[Private::FileMoveOperation]).void }
+    def after_move_files!(file_move_operations)
+      # There could also be no TODOs for this file, but moving it produced TODOs. This could happen if:
+      # 1) The origin pack did not enforce a rubocop, such as typed public APIs
+      # 2) The file satisfied the cop in the origin pack, such as the Packs/RootNamespaceIsPackName, but the desired
+      # namespace changed once the file was moved to a different pack.
+      files = []
+      file_move_operations.each do |file_move_operation|
+        if file_move_operation.destination_pathname.exist?
+          files << file_move_operation.destination_pathname.to_s
+        end
+      end
+
+      RuboCop::Packs.regenerate_todo(files: files)
+    end
   end
 end

data/lib/use_packwerk/user_event_logger.rb

@@ -23,11 +23,9 @@ module UsePackwerk
 
         2) Run `bin/packwerk update-deprecations` 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) Update TODO lists for rubocop implemented protections. See #{documentation_link} for more info
+        3) Expose public API in #{pack_name}/app/public. Try `bin/packs make_public #{pack_name}/path/to/file.rb`
 
-        4) Expose public API in #{pack_name}/app/public. Try `bin/packs make_public #{pack_name}/path/to/file.rb`
-
-        5) Update your readme at #{pack_name}/README.md
+        4) Update your readme at #{pack_name}/README.md
       MSG
     end
 
@@ -45,13 +43,11 @@ module UsePackwerk
 
         1) Run `bin/packwerk update-deprecations` to update the violations. Make sure to run `spring stop` if you've added new load paths (new top-level directories) in your pack.
 
-        2) Update TODO lists for rubocop implemented protections. See #{documentation_link} for more info
-
-        3) Touch base with each team who owns files involved in this move
+        2) Touch base with each team who owns files involved in this move
 
-        4) 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}/app/public. Try `bin/packs make_public #{pack_name}/path/to/file.rb`
 
-        5) Update your readme at #{pack_name}/README.md
+        4) Update your readme at #{pack_name}/README.md
       MSG
     end
 
@@ -69,11 +65,9 @@ module UsePackwerk
 
         1) Run `bin/packwerk update-deprecations` to update the violations. Make sure to run `spring stop` if you've added new load paths (new top-level directories) in your pack.
 
-        2) Update TODO lists for rubocop implemented protections. See #{documentation_link} for more info
-
-        3) Work to migrate clients of private API to your new public API
+        2) Work to migrate clients of private API to your new public API
 
-        4) Update your README at packs/your_package_name/README.md
+        3) Update your README at packs/your_package_name/README.md
       MSG
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: use_packwerk
 version: !ruby/object:Gem::Version
-  version: 0.67.0
+  version: 0.69.0
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-18 00:00:00.000000000 Z
+date: 2022-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: code_ownership
@@ -302,6 +302,7 @@ files:
 - lib/use_packwerk/private/interactive_cli/pack_selector.rb
 - lib/use_packwerk/private/interactive_cli/team_selector.rb
 - lib/use_packwerk/private/interactive_cli/use_cases/add_dependency.rb
+- lib/use_packwerk/private/interactive_cli/use_cases/check.rb
 - lib/use_packwerk/private/interactive_cli/use_cases/create.rb
 - lib/use_packwerk/private/interactive_cli/use_cases/get_info.rb
 - lib/use_packwerk/private/interactive_cli/use_cases/interface.rb