use_packwerk 0.64.0 → 0.66.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6ef7e8cd0b3253daba5690f8c80ad930f5b5fd609bb18bd8760275d64717745
-  data.tar.gz: 946a5ac17ac9316d6ce4fff47c77e53f228bc94ce95b251813fb00a859e1522e
+  metadata.gz: 2c36d9aa08d6196fcfc0a96e3846d0a44f8637f5dc800ac6a0778b7deac637df
+  data.tar.gz: 07b0910be565a9df52b31c63982ad8e8b75808b80de5b77ad78120293a48c890
 SHA512:
-  metadata.gz: 25b021c870b03ab4ac3086d7620aa773490d1332c49a76e76ccea8f9605c9fc62687b86819bdd7175527dca69bb865374ed7149e3d1af2db3ca89dd434d75e6f
-  data.tar.gz: c28a6bf619db1a741716de8cfe93e0d634a8c8017e2ea74af3c2e4698b1a6b58de57e6a4b6c378c2dd1e16075e30b28d9dc9ec4b92e575faa8a5bba70cd2bb43
+  metadata.gz: 46635409558c2c7c0557fb6164a979988558c4d47d0b2467dd97728bd67a6b0c6b77c4614e2c25b49ac075b74de392d7b062b435e0b81b1f60cf2c0c4a044f05
+  data.tar.gz: 6ebd403c29e4a432d43e7ace961e68c84192e238f0ad3172ad6af8fc1800c6900684cf5e010eb2bd679870258e3ea7b8ddd0b6d9a87612d03c9809db303ccd39

data/README.md

@@ -4,26 +4,26 @@ UsePackwerk is a gem that helps in creating and maintaining packs. It exists to
 
 ## Usage
 ### General Help
-`bin/use_packwerk --help`
+`bin/packs --help` or just `bin/packs` to enter interactive mode.
 
 ### Pack Creation
-`bin/use_packwerk create packs/your_pack_name_here`
+`bin/packs create packs/your_pack_name_here`
 
 ### Moving files to packs
-`bin/use_packwerk move packs/your_pack_name_here path/to/file.rb path/to/directory`
+`bin/packs move packs/your_pack_name_here path/to/file.rb path/to/directory`
 This is used for moving files into a pack (the pack must already exist).
 Note this works for moving files to packs from the monolith or from other packs
 
 Make sure there are no spaces between the comma-separated list of paths of directories.
 
 ### Moving a file to public API
-`bin/use_packwerk make_public path/to/file.rb,path/to/directory`
+`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).
 
 Make sure there are no spaces between the comma-separated list of paths of directories.
 
 ### Listing top privacy violations
-`bin/use_packwerk list_top_privacy_violations packs/my_pack`
+`bin/packs list_top_privacy_violations packs/my_pack`
 Want to create interfaces? Not sure how your pack's code is being used?
 
 You can use this command to list the top privacy violations.
@@ -31,7 +31,7 @@ You can use this command to list the top privacy violations.
 If no pack name is passed in, this will list out violations across all packs.
 
 ### Listing top dependency violations
-`bin/use_packwerk list_top_dependency_violations packs/my_pack`
+`bin/packs list_top_dependency_violations packs/my_pack`
 Want to see who is depending on you? Not sure how your pack's code is being used in an unstated way
 
 You can use this command to list the top dependency violations.
@@ -39,7 +39,7 @@ You can use this command to list the top dependency violations.
 If no pack name is passed in, this will list out violations across all packs.
 
 ### Adding a dependency
-`bin/use_packwerk add_dependency packs/my_pack packs/dependency_pack_name`
+`bin/packs add_dependency packs/my_pack packs/dependency_pack_name`
 
 This can be used to quickly modify a `package.yml` file and add a dependency. It also cleans up the list of dependencies to sort the list and remove redundant entries.
 

data/bin/packs

@@ -2,4 +2,9 @@
 # typed: strict
 
 require_relative '../lib/use_packwerk'
-UsePackwerk.start_interactive_mode!
+
+if ARGV.empty?
+  UsePackwerk.start_interactive_mode!
+else
+  UsePackwerk::CLI.start(ARGV)
+end

data/lib/use_packwerk/cli.rb

@@ -16,7 +16,7 @@ module UsePackwerk
     long_desc <<~LONG_DESC
       Use this to add a dependency between packs.
 
-      When you use bin/use_packwerk add_dependency packs/from_pack packs/to_pack, this command will
+      When you use bin/packs add_dependency packs/from_pack packs/to_pack, this command will
       modify packs/from_pack/package.yml's list of dependencies and add packs/to_pack.
 
       This command will also sort the list and make it unique.
@@ -77,5 +77,11 @@ module UsePackwerk
         per_file_processors: [UsePackwerk::RubocopPostProcessor.new, UsePackwerk::CodeOwnershipPostProcessor.new]
       )
     end
+
+    desc 'lint_deprecated_references', 'Ensures `deprecated_references.yml` files are up to date'
+    sig { void }
+    def lint_deprecated_references
+      UsePackwerk.lint_deprecated_references!
+    end
   end
 end

data/lib/use_packwerk/configuration.rb

@@ -13,10 +13,18 @@ module UsePackwerk
     sig { returns(UserEventLogger) }
     attr_accessor :user_event_logger
 
+    OnDeprecatedReferencesLintFailure = T.type_alias do
+      T.proc.params(output: String).void
+    end
+
+    sig { returns(OnDeprecatedReferencesLintFailure) }
+    attr_accessor :on_deprecated_references_lint_failure
+
     sig { void }
     def initialize
       @enforce_dependencies = T.let(default_enforce_dependencies, T::Boolean)
       @user_event_logger = T.let(DefaultUserEventLogger.new, UserEventLogger)
+      @on_deprecated_references_lint_failure = T.let(->(output) {}, OnDeprecatedReferencesLintFailure)
     end
 
     sig { returns(T::Boolean) }

data/lib/use_packwerk/private/interactive_cli.rb

@@ -25,9 +25,9 @@ module UsePackwerk
     module InteractiveCli
       extend T::Sig
 
-      sig { void }
-      def self.start!
-        prompt = TTY::Prompt.new(interrupt: lambda {
+      sig { params(prompt: T.nilable(TTY::Prompt)).void }
+      def self.start!(prompt: nil)
+        prompt ||= TTY::Prompt.new(interrupt: lambda {
                                               puts "\n\nGoodbye! I hope you have a good day."
                                               exit 1 })
         help_text = '(Press ↑/↓ arrow to move, Enter to select and letters to filter)'

data/lib/use_packwerk/private.rb

@@ -389,6 +389,52 @@ module UsePackwerk
       # otherwise `PackageProtections.config` will attempt to reload the client configuratoin.
       @loaded_client_configuration = false
     end
+
+    sig { returns(T::Hash[String, String]) }
+    def self.get_deprecated_references_contents
+      deprecated_references = {}
+      ParsePackwerk.all.each do |package|
+        deprecated_references_yml = ParsePackwerk::DeprecatedReferences.for(package).pathname
+        if deprecated_references_yml.exist?
+          deprecated_references[deprecated_references_yml.to_s] = deprecated_references_yml.read
+        end
+      end
+
+      deprecated_references
+    end
+
+    DeprecatedReferencesFiles = T.type_alias do
+      T::Hash[String, T.nilable(String)]
+    end
+
+    sig { params(before: DeprecatedReferencesFiles, after: DeprecatedReferencesFiles).returns(String) }
+    def self.diff_deprecated_references_yml(before, after)
+      dir_containing_contents_before = Dir.mktmpdir
+      dir_containing_contents_after = Dir.mktmpdir
+      begin
+        write_deprecated_references_to_tmp_folder(before, dir_containing_contents_before)
+        write_deprecated_references_to_tmp_folder(after, dir_containing_contents_after)
+
+        diff = `diff -r #{dir_containing_contents_before}/ #{dir_containing_contents_after}/`
+        # For ease of reading, sub out the tmp directory from the diff
+        diff.gsub(dir_containing_contents_before, '').gsub(dir_containing_contents_after, '')
+      ensure
+        FileUtils.remove_entry dir_containing_contents_before
+        FileUtils.remove_entry dir_containing_contents_after
+      end
+    end
+
+    sig { params(deprecated_references_files: DeprecatedReferencesFiles, tmp_folder: String).void }
+    def self.write_deprecated_references_to_tmp_folder(deprecated_references_files, tmp_folder)
+      deprecated_references_files.each do |filename, contents|
+        next if contents.nil?
+
+        tmp_folder_pathname = Pathname.new(tmp_folder)
+        temp_deprecated_references_yml = tmp_folder_pathname.join(filename)
+        FileUtils.mkdir_p(temp_deprecated_references_yml.dirname)
+        temp_deprecated_references_yml.write(contents)
+      end
+    end
   end
 
   private_constant :Private

data/lib/use_packwerk/user_event_logger.rb

@@ -19,13 +19,13 @@ module UsePackwerk
       <<~MSG
         Your next steps might be:
 
-        1) Move files into your pack with `bin/use_packwerk move #{pack_name} path/to/file.rb`
+        1) Move files into your pack with `bin/packs move #{pack_name} path/to/file.rb`
 
         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
 
-        4) Expose public API in #{pack_name}/app/public. Try `bin/use_packwerk 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
       MSG
@@ -49,7 +49,7 @@ module UsePackwerk
 
         3) Touch base with each team who owns files involved in this move
 
-        4) Expose public API in #{pack_name}/app/public. Try `bin/use_packwerk 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
       MSG
@@ -125,10 +125,10 @@ module UsePackwerk
         You can prevent other packs from using private API by using packwerk.
 
         Want to find how your private API is being used today?
-        Try running: `bin/use_packwerk list_top_privacy_violations #{pack_name}`
+        Try running: `bin/packs list_top_privacy_violations #{pack_name}`
 
         Want to move something into this folder?
-        Try running: `bin/use_packwerk make_public #{pack_name}/path/to/file.rb`
+        Try running: `bin/packs make_public #{pack_name}/path/to/file.rb`
 
         One more thing -- feel free to delete this file and replace it with a README.md describing your package in the main package directory.
 
@@ -170,7 +170,7 @@ module UsePackwerk
       else
         pack_specific_content = <<~PACK_CONTENT
           You are listing top #{limit} dependency violations for #{pack_name}. See #{documentation_link} for other utilities!
-          Pass in a limit to display more or less, e.g. `bin/use_packwerk list_top_dependency_violations #{pack_name} -l 1000`
+          Pass in a limit to display more or less, e.g. `bin/packs list_top_dependency_violations #{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.
@@ -211,7 +211,7 @@ module UsePackwerk
       if pack_name.nil?
         pack_specific_content = <<~PACK_CONTENT
           You are listing top #{limit} privacy violations for all packs. See #{documentation_link} for other utilities!
-          Pass in a limit to display more or less, e.g. `bin/use_packwerk list_top_privacy_violations #{pack_name} -l 1000`
+          Pass in a limit to display more or less, e.g. `bin/packs list_top_privacy_violations #{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.
@@ -219,7 +219,7 @@ module UsePackwerk
       else
         pack_specific_content = <<~PACK_CONTENT
           You are listing top #{limit} privacy violations for #{pack_name}. See #{documentation_link} for other utilities!
-          Pass in a limit to display more or less, e.g. `bin/use_packwerk list_top_privacy_violations #{pack_name} -l 1000`
+          Pass in a limit to display more or less, e.g. `bin/packs list_top_privacy_violations #{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.
@@ -253,7 +253,7 @@ module UsePackwerk
             - packs/other_pack_a: 1
             - packs/other_pack_b: 1
 
-        Lastly, remember you can use `bin/use_packwerk make_public #{pack_name}/path/to/file.rb` to make your class, constant, or module public API.
+        Lastly, remember you can use `bin/packs make_public #{pack_name}/path/to/file.rb` to make your class, constant, or module public API.
       MSG
     end
 

data/lib/use_packwerk.rb

@@ -245,4 +245,40 @@ module UsePackwerk
     Private::PackwerkWrapper.packwerk_cli_execute_safely(argv, formatter)
     formatter.aggregated_offenses.compact
   end
+
+  sig { void }
+  def self.lint_deprecated_references!
+    contents_before = Private.get_deprecated_references_contents
+    UsePackwerk.execute(['update-deprecations'])
+    contents_after = Private.get_deprecated_references_contents
+    diff = Private.diff_deprecated_references_yml(contents_before, contents_after)
+
+    if diff == ''
+      # No diff generated by `update-deprecations`
+      exit 0
+    else
+      output = <<~OUTPUT
+        All `deprecated_references.yml` files must be up-to-date and that no diff is generated when running `bin/packwerk update-deprecations`.
+        This helps ensure a high quality signal in other engineers' PRs when inspecting new violations by ensuring there are no unrelated changes.
+
+        There are three main reasons there may be a diff:
+        1) Most likely, you may have stale violations, meaning there are old violations that no longer apply.
+        2) You may have some sort of auto-formatter set up somewhere (e.g. something that reformats YML files) that is, for example, changing double quotes to single quotes. Ensure this is turned off for these auto-generated files.
+        3) You may have edited these files manually. It's recommended to use the `bin/packwerk update-deprecations` command to make changes to `deprecated_references.yml` files.
+
+        In all cases, you can run `bin/packwerk update-deprecations` to update these files.
+
+        Here is the diff generated after running `update-deprecations`:
+        ```
+        #{diff}
+        ```
+
+      OUTPUT
+
+      puts output
+      UsePackwerk.config.on_deprecated_references_lint_failure.call(output)
+
+      exit 1
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: use_packwerk
 version: !ruby/object:Gem::Version
-  version: 0.64.0
+  version: 0.66.0
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-16 00:00:00.000000000 Z
+date: 2022-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: code_ownership
@@ -281,7 +281,6 @@ description: UsePackwerk is a gem that helps in creating and maintaining packwer
 email:
 - dev@gusto.com
 executables:
-- use_packwerk
 - packs
 extensions: []
 extra_rdoc_files: []
@@ -290,7 +289,6 @@ files:
 - bin/packs
 - bin/rubocop
 - bin/tapioca
-- bin/use_packwerk
 - lib/use_packwerk.rb
 - lib/use_packwerk/cli.rb
 - lib/use_packwerk/code_ownership_post_processor.rb

data/bin/use_packwerk

@@ -1,5 +0,0 @@
-#!/usr/bin/env ruby
-# typed: strict
-
-require_relative '../lib/use_packwerk'
-UsePackwerk::CLI.start(ARGV)