use_packwerk 0.66.0 → 0.68.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c36d9aa08d6196fcfc0a96e3846d0a44f8637f5dc800ac6a0778b7deac637df
-  data.tar.gz: 07b0910be565a9df52b31c63982ad8e8b75808b80de5b77ad78120293a48c890
+  metadata.gz: 277da7b20ce7c61ddaca0c55a9db85d83ced70f6ead305861a91dba3b3a85316
+  data.tar.gz: 9841971587ea4f7bb9f18fc61bb48293e485594a738eff3825156ac36ec24775
 SHA512:
-  metadata.gz: 46635409558c2c7c0557fb6164a979988558c4d47d0b2467dd97728bd67a6b0c6b77c4614e2c25b49ac075b74de392d7b062b435e0b81b1f60cf2c0c4a044f05
-  data.tar.gz: 6ebd403c29e4a432d43e7ace961e68c84192e238f0ad3172ad6af8fc1800c6900684cf5e010eb2bd679870258e3ea7b8ddd0b6d9a87612d03c9809db303ccd39
+  metadata.gz: 1e0c11e3f4fec41cb8c585f1c533ef06015b4f129c3dc8423d5bdaf1bed7ce2f334042325f81aca8a660d63648005f1a3eba36677c7ae26d7a897aa7197448ce
+  data.tar.gz: f735885b3a452f5969219fe7e7949678b2e91e304fd603e442dcf78ce37bb0202ddf8fc8822c8afb8135d683303324448b869640a62d3de28a5369c0744c7c0d

data/lib/use_packwerk/cli.rb

@@ -78,10 +78,32 @@ module UsePackwerk
       )
     end
 
-    desc 'lint_deprecated_references', 'Ensures `deprecated_references.yml` files are up to date'
+    desc 'lint_deprecated_references_yml_files', 'Ensures `deprecated_references.yml` files are up to date'
     sig { void }
-    def lint_deprecated_references
-      UsePackwerk.lint_deprecated_references!
+    def lint_deprecated_references_yml_files
+      UsePackwerk.lint_deprecated_references_yml_files!
+    end
+
+    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)
+      UsePackwerk.lint_package_yml_files!(parse_pack_names(pack_names))
+    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/lint_package_yml.rb

@@ -12,16 +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 lint package.yml files for')
-            packs.each do |p|
-              new_package = ParsePackwerk::Package.new(
-                name: p.name,
-                enforce_privacy: p.enforce_privacy,
-                enforce_dependencies: p.enforce_dependencies,
-                dependencies: p.dependencies.uniq.sort,
-                metadata: p.metadata
-              )
-              ParsePackwerk.write_package_yml!(new_package)
-            end
+            UsePackwerk.lint_package_yml_files!(packs)
           end
 
           sig { override.returns(String) }

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/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
 

data/lib/use_packwerk.rb

@@ -247,7 +247,7 @@ module UsePackwerk
   end
 
   sig { void }
-  def self.lint_deprecated_references!
+  def self.lint_deprecated_references_yml_files!
     contents_before = Private.get_deprecated_references_contents
     UsePackwerk.execute(['update-deprecations'])
     contents_after = Private.get_deprecated_references_contents
@@ -281,4 +281,18 @@ module UsePackwerk
       exit 1
     end
   end
+
+  sig { params(packs: T::Array[ParsePackwerk::Package]).void }
+  def self.lint_package_yml_files!(packs)
+    packs.each do |p|
+      new_package = ParsePackwerk::Package.new(
+        name: p.name,
+        enforce_privacy: p.enforce_privacy,
+        enforce_dependencies: p.enforce_dependencies,
+        dependencies: p.dependencies.uniq.sort,
+        metadata: p.metadata
+      )
+      ParsePackwerk.write_package_yml!(new_package)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: use_packwerk
 version: !ruby/object:Gem::Version
-  version: 0.66.0
+  version: 0.68.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