use_packwerk 0.55.0 → 0.56.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b5e32955dbb7051402503ee3aad2d5358deeb9261f9e54b2bc86f330cb6ec4c
-  data.tar.gz: 4089b2018b9cc9321e50895b47682583e6a09d6ec95b07bf57e8fe74a41c4cca
+  metadata.gz: 6f2315b30561bd988826f08430f4bcecade3056549d1c78069dcbd72cd8aa90b
+  data.tar.gz: 2d8cb765865b07158ffb0dd6e7e30765e66e93912b49ccb63ede8e0e6116b41c
 SHA512:
-  metadata.gz: 020a051dd86236ea68eaa469a49393ac4cd11432a110912f716ab12b2a6e048c859fa4ba45eb9e3f989bd135fa6c7b0d294b3eb003711a2c9c6c326004b3518a
-  data.tar.gz: 3556b96d07434dd28e511fb639250cf71bd1129b3ecabcb63403438c0aa55b1f94dcf18891862092deb2d36bba5d3a965f790f8abfa088a4126f368d8869dd13
+  metadata.gz: 03d1a533f3323bad78ddef6843a3bcf996cb6390f71feeafdc7844baed5af13ee18ebe558b98c5e4fea89240f0f7645732ca90d73a555e78630758e90d04424a
+  data.tar.gz: 1cada76edf9ec7c76b343946c8c6373d1eaeb665312b226a7a2fecc2facca855c42a0b18d08f847722663f16799aca20383da82ef0f866bc962260652183d373

data/lib/use_packwerk/cli.rb

@@ -6,13 +6,13 @@ module UsePackwerk
   class CLI < Thor
     extend T::Sig
 
-    desc "create packs/your_pack", "Create pack with name packs/your_pack"
+    desc 'create packs/your_pack', 'Create pack with name packs/your_pack'
     sig { params(pack_name: String).void }
     def create(pack_name)
       UsePackwerk.create_pack!(pack_name: pack_name)
     end
 
-    desc "add_dependency packs/from_pack packs/to_pack", "Add packs/to_pack to packs/from_pack/package.yml list of dependencies"
+    desc 'add_dependency packs/from_pack packs/to_pack', 'Add packs/to_pack to packs/from_pack/package.yml list of dependencies'
     long_desc <<~LONG_DESC
       Use this to add a dependency between packs.
 
@@ -29,7 +29,7 @@ module UsePackwerk
       )
     end
 
-    desc "list_top_dependency_violations packs/your_pack", "List the top dependency violations of packs/your_pack"
+    desc 'list_top_dependency_violations packs/your_pack', 'List the top dependency violations of packs/your_pack'
     option :limit, type: :numeric, default: 10, aliases: :l, banner: 'Specify the limit of constants to analyze'
     sig { params(pack_name: String).void }
     def list_top_dependency_violations(pack_name)
@@ -39,7 +39,7 @@ module UsePackwerk
       )
     end
 
-    desc "list_top_privacy_violations packs/your_pack", "List the top privacy violations of packs/your_pack"
+    desc 'list_top_privacy_violations packs/your_pack', 'List the top privacy violations of packs/your_pack'
     option :limit, type: :numeric, default: 10, aliases: :l, banner: 'Specify the limit of constants to analyze'
     sig { params(pack_name: String).void }
     def list_top_privacy_violations(pack_name)
@@ -49,32 +49,32 @@ module UsePackwerk
       )
     end
 
-    desc "make_public path/to/file.rb path/to/directory", "Pass in a space-separated list of file or directory paths to make public"
+    desc 'make_public path/to/file.rb path/to/directory', 'Pass in a space-separated list of file or directory paths to make public'
     sig { params(paths: String).void }
     def make_public(*paths)
       UsePackwerk.make_public!(
         paths_relative_to_root: paths,
-        per_file_processors: [UsePackwerk::RubocopPostProcessor.new, UsePackwerk::CodeOwnershipPostProcessor.new],
+        per_file_processors: [UsePackwerk::RubocopPostProcessor.new, UsePackwerk::CodeOwnershipPostProcessor.new]
       )
     end
 
-    desc "move packs/destination_pack path/to/file.rb path/to/directory", "Pass in a destination pack and a space-separated list of file or directory paths to move to the destination pack"
+    desc 'move packs/destination_pack path/to/file.rb path/to/directory', 'Pass in a destination pack and a space-separated list of file or directory paths to move to the destination pack'
     sig { params(pack_name: String, paths: String).void }
     def move(pack_name, *paths)
       UsePackwerk.move_to_pack!(
         pack_name: pack_name,
         paths_relative_to_root: paths,
-        per_file_processors: [UsePackwerk::RubocopPostProcessor.new, UsePackwerk::CodeOwnershipPostProcessor.new],
+        per_file_processors: [UsePackwerk::RubocopPostProcessor.new, UsePackwerk::CodeOwnershipPostProcessor.new]
       )
     end
 
-    desc "move_to_parent packs/parent_pack packs/child_pack", "Pass in a parent pack and another pack to be made as a child to the parent pack!"
+    desc 'move_to_parent packs/parent_pack packs/child_pack', 'Pass in a parent pack and another pack to be made as a child to the parent pack!'
     sig { params(parent_name: String, pack_name: String).void }
     def move_to_parent(parent_name, pack_name)
       UsePackwerk.move_to_parent!(
         parent_name: parent_name,
         pack_name: pack_name,
-        per_file_processors: [UsePackwerk::RubocopPostProcessor.new, UsePackwerk::CodeOwnershipPostProcessor.new],
+        per_file_processors: [UsePackwerk::RubocopPostProcessor.new, UsePackwerk::CodeOwnershipPostProcessor.new]
       )
     end
   end

data/lib/use_packwerk/code_ownership_post_processor.rb

@@ -22,7 +22,7 @@ module UsePackwerk
         UsePackwerk.replace_in_file(
           file: code_owners_allow_list_file.to_s,
           find: relative_path_to_origin,
-          replace_with: relative_path_to_destination,
+          replace_with: relative_path_to_destination
         )
       end
 
@@ -45,11 +45,11 @@ module UsePackwerk
       if @teams.any?
         Logging.section('Code Ownership') do
           Logging.print('This section contains info about the current ownership distribution of the moved files.')
-          @teams.group_by { |team| team }.sort_by { |team, instances| -instances.count }.each do |team, instances|
+          @teams.group_by { |team| team }.sort_by { |_team, instances| -instances.count }.each do |team, instances|
             Logging.print "  #{team} - #{instances.count} files"
           end
           if @did_move_files
-            Logging.print "Since the destination package has package-based ownership, file-annotations were removed from moved files."
+            Logging.print 'Since the destination package has package-based ownership, file-annotations were removed from moved files.'
           end
         end
       end

data/lib/use_packwerk/configuration.rb

@@ -1,5 +1,8 @@
 # typed: strict
 
+require 'use_packwerk/user_event_logger'
+require 'use_packwerk/default_user_event_logger'
+
 module UsePackwerk
   class Configuration
     extend T::Sig
@@ -7,28 +10,28 @@ module UsePackwerk
     sig { params(enforce_dependencies: T::Boolean).void }
     attr_writer :enforce_dependencies
 
-    sig { params(documentation_link: String).void }
-    attr_writer :documentation_link
+    sig { returns(UserEventLogger) }
+    attr_accessor :user_event_logger
 
     sig { void }
     def initialize
-      @enforce_dependencies = T.let(@enforce_dependencies, T.nilable(T::Boolean))
-      @documentation_link = T.let(documentation_link, T.nilable(String) )
+      @enforce_dependencies = T.let(default_enforce_dependencies, T::Boolean)
+      @user_event_logger = T.let(DefaultUserEventLogger.new, UserEventLogger)
     end
 
     sig { returns(T::Boolean) }
     def enforce_dependencies
-      if !@enforce_dependencies.nil?
-        @enforce_dependencies
-      else
-        true
-      end
+      @enforce_dependencies
     end
 
-    # Configure a link to show up for users who are looking for more info
-    sig { returns(String) }
-    def documentation_link
-      "https://go/packwerk"
+    sig { void }
+    def bust_cache!
+      @enforce_dependencies = default_enforce_dependencies
+    end
+
+    sig { returns(T::Boolean) }
+    def default_enforce_dependencies
+      true
     end
   end
 
@@ -37,12 +40,13 @@ module UsePackwerk
 
     sig { returns(Configuration) }
     def config
+      Private.load_client_configuration
       @config = T.let(@config, T.nilable(Configuration))
       @config ||= Configuration.new
     end
 
     sig { params(blk: T.proc.params(arg0: Configuration).void).void }
-    def configure(&blk) # rubocop:disable Lint/UnusedMethodArgument
+    def configure(&blk)
       yield(config)
     end
   end

data/lib/use_packwerk/default_user_event_logger.rb

@@ -0,0 +1,7 @@
+# typed: strict
+
+module UsePackwerk
+  class DefaultUserEventLogger
+    include UserEventLogger
+  end
+end

data/lib/use_packwerk/logging.rb

@@ -9,7 +9,7 @@ module UsePackwerk
     sig { params(title: String, block: T.proc.void).void }
     def self.section(title, &block)
       print_divider
-      out ColorizedString.new("#{title}").green.bold
+      out ColorizedString.new(title).green.bold
       out "\n"
       yield
     end
@@ -35,4 +35,3 @@ module UsePackwerk
     end
   end
 end
-

data/lib/use_packwerk/per_file_processor_interface.rb

@@ -8,8 +8,7 @@ module UsePackwerk
     abstract!
 
     sig { abstract.params(file_move_operation: Private::FileMoveOperation).void }
-    def before_move_file!(file_move_operation)
-    end
+    def before_move_file!(file_move_operation); end
 
     sig { void }
     def print_final_message!

data/lib/use_packwerk/private/file_move_operation.rb

@@ -18,7 +18,6 @@ module UsePackwerk
       def self.destination_pathname_for_package_move(origin_pathname, new_package_root)
         origin_pack = T.must(ParsePackwerk.package_from_path(origin_pathname))
 
-        new_implementation = nil
         if origin_pack.name == ParsePackwerk::ROOT_PACKAGE_NAME
           new_package_root.join(origin_pathname).cleanpath
         else
@@ -28,7 +27,6 @@ module UsePackwerk
 
       sig { params(origin_pathname: Pathname).returns(Pathname) }
       def self.destination_pathname_for_new_public_api(origin_pathname)
-
         origin_pack = T.must(ParsePackwerk.package_from_path(origin_pathname))
         if origin_pack.name == ParsePackwerk::ROOT_PACKAGE_NAME
           filepath_without_pack_name = origin_pathname.to_s
@@ -37,15 +35,15 @@ module UsePackwerk
         end
 
         # We join the pack name with the rest of the path...
-        path_parts = filepath_without_pack_name.split("/")
+        path_parts = filepath_without_pack_name.split('/')
         Pathname.new(origin_pack.name).join(
           # ... keeping the "app" or "spec"
           T.must(path_parts[0]),
           # ... substituting "controllers," "services," etc. with "public"
           'public',
           # ... then the rest is the same
-          T.must(path_parts[2..]).join("/")
-        # and we take the cleanpath so `./app/...` becomes `app/...`
+          T.must(path_parts[2..]).join('/')
+          # and we take the cleanpath so `./app/...` becomes `app/...`
         ).cleanpath
       end
 
@@ -54,16 +52,16 @@ module UsePackwerk
         # This could probably be implemented by some "strategy pattern" where different extension types are handled by different helpers
         # Such a thing could also include, for example, when moving a controller, moving its ERB view too.
         if origin_pathname.extname == '.rake'
-          new_origin_pathname = origin_pathname.sub('/lib/', '/spec/lib/').sub(/^lib\//, 'spec/lib/').sub('.rake', '_spec.rb')
-          new_destination_pathname = destination_pathname.sub('/lib/', '/spec/lib/').sub(/^lib\//, 'spec/lib/').sub('.rake', '_spec.rb')
+          new_origin_pathname = origin_pathname.sub('/lib/', '/spec/lib/').sub(%r{^lib/}, 'spec/lib/').sub('.rake', '_spec.rb')
+          new_destination_pathname = destination_pathname.sub('/lib/', '/spec/lib/').sub(%r{^lib/}, 'spec/lib/').sub('.rake', '_spec.rb')
         else
-          new_origin_pathname = origin_pathname.sub('/app/', '/spec/').sub(/^app\//, 'spec/').sub('.rb', '_spec.rb')
-          new_destination_pathname = destination_pathname.sub('/app/', '/spec/').sub(/^app\//, 'spec/').sub('.rb', '_spec.rb')
+          new_origin_pathname = origin_pathname.sub('/app/', '/spec/').sub(%r{^app/}, 'spec/').sub('.rb', '_spec.rb')
+          new_destination_pathname = destination_pathname.sub('/app/', '/spec/').sub(%r{^app/}, 'spec/').sub('.rb', '_spec.rb')
         end
         FileMoveOperation.new(
           origin_pathname: new_origin_pathname,
           destination_pathname: new_destination_pathname,
-          destination_pack: destination_pack,
+          destination_pack: destination_pack
         )
       end
 
@@ -74,7 +72,7 @@ module UsePackwerk
         FileMoveOperation.new(
           origin_pathname: origin_pathname.relative_path_from(path),
           destination_pathname: destination_pathname.relative_path_from(path),
-          destination_pack: destination_pack,
+          destination_pack: destination_pack
         )
       end
     end

data/lib/use_packwerk/private/pack_relationship_analyzer.rb

@@ -8,72 +8,28 @@ module UsePackwerk
       sig do
         params(
           pack_name: T.nilable(String),
-          limit: Integer,
+          limit: Integer
         ).void
       end
       def self.list_top_privacy_violations(pack_name, limit)
         all_packages = ParsePackwerk.all
-        if !pack_name.nil?
+        if pack_name.nil?
+          to_package_names = all_packages.map(&:name)
+        else
           pack_name = Private.clean_pack_name(pack_name)
-          package = all_packages.find { |package| package.name == pack_name }
+          package = all_packages.find { |p| p.name == pack_name }
           if package.nil?
-            raise StandardError.new("Can not find package with name #{pack_name}. Make sure the argument is of the form `packs/my_pack/`")
+            raise StandardError, "Can not find package with name #{pack_name}. Make sure the argument is of the form `packs/my_pack/`"
           end
 
-          pack_specific_content = <<~PACK_CONTENT
-            You are listing top #{limit} privacy violations for #{pack_name}. See #{UsePackwerk.config.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`
-
-            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.
-          PACK_CONTENT
-
           to_package_names = [pack_name]
-        else
-          pack_specific_content = <<~PACK_CONTENT
-            You are listing top #{limit} privacy violations for all packs. See #{UsePackwerk.config.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`
-
-            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.
-          PACK_CONTENT
-
-          to_package_names = all_packages.map(&:name)
         end
 
         violations_by_count = {}
         total_pack_violation_count = 0
 
         Logging.section('👋 Hi there') do
-          intro = <<~INTRO
-            #{pack_specific_content}
-
-            When using this script, ask yourself some questions like:
-            - What do I want to support?
-            - What do I *not* want to support?
-            - What is considered simply an implementation detail, and what is essential to the behavior of my pack?
-            - What is a simple, minimialistic API for clients to engage with the behavior of your pack?
-            - How do I ensure my public API is not coupled to specific client's use cases?
-
-            Looking at privacy violations can help guide the development of your public API, but it is just the beginning!
-
-            The script will output in the following format:
-
-            SomeConstant # This is the name of a class, constant, or module defined in your pack, outside of app/public
-              - Total Count: 5 # This is the total number of uses of this outside your pack
-              - By package: # This is a breakdown of the use of this constant by other packages
-                # This is the number of files in this pack that this constant is used.
-                # Check `packs/other_pack_a/deprecated_references.yml` under the '#{pack_name}'.'SomeConstant' key to see where this constant is used
-                - packs/other_pack_a: 3
-                - packs/other_pack_b: 2
-            SomeClass # This is the second most violated class, constant, or module defined in your pack
-              - Total Count: 2
-              - By package:
-                - 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.
-          INTRO
+          intro = UsePackwerk.config.user_event_logger.before_list_top_privacy_violations(pack_name, limit)
           Logging.print_bold_green(intro)
         end
 
@@ -81,10 +37,11 @@ module UsePackwerk
         all_packages.each do |client_package|
           PackageProtections::ProtectedPackage.from(client_package).violations.select(&:privacy?).each do |violation|
             next unless to_package_names.include?(violation.to_package_name)
+
             if pack_name.nil?
               violated_symbol = "#{violation.class_name} (#{violation.to_package_name})"
             else
-              violated_symbol = "#{violation.class_name}"
+              violated_symbol = violation.class_name
             end
             violations_by_count[violated_symbol] ||= {}
             violations_by_count[violated_symbol][:total_count] ||= 0
@@ -104,8 +61,8 @@ module UsePackwerk
           Logging.print(violated_symbol)
           Logging.print("  - Total Count: #{count_info[:total_count]} (#{percentage_of_total}% of total)")
 
-          Logging.print("  - By package:")
-          count_info[:by_package].sort_by{ |client_package_name, count| [-count, client_package_name] }.each do |client_package_name, count|
+          Logging.print('  - By package:')
+          count_info[:by_package].sort_by { |client_package_name, count| [-count, client_package_name] }.each do |client_package_name, count|
             Logging.print("    - #{client_package_name}: #{count}")
           end
         end
@@ -120,76 +77,35 @@ module UsePackwerk
       def self.list_top_dependency_violations(pack_name, limit)
         all_packages = ParsePackwerk.all
 
-        if !pack_name.nil?
+        if pack_name.nil?
+          to_package_names = all_packages.map(&:name)
+        else
           pack_name = Private.clean_pack_name(pack_name)
-          package = all_packages.find { |package| package.name == pack_name }
+          package = all_packages.find { |p| p.name == pack_name }
           if package.nil?
-            raise StandardError.new("Can not find package with name #{pack_name}. Make sure the argument is of the form `packs/my_pack/`")
+            raise StandardError, "Can not find package with name #{pack_name}. Make sure the argument is of the form `packs/my_pack/`"
           end
 
-          pack_specific_content = <<~PACK_CONTENT
-            You are listing top #{limit} dependency violations for #{pack_name}. See #{UsePackwerk.config.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`
-
-            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.
-          PACK_CONTENT
-
           to_package_names = [pack_name]
-        else
-          pack_specific_content = <<~PACK_CONTENT
-            You are listing top #{limit} dependency violations for all packs. See #{UsePackwerk.config.documentation_link} for other utilities!
-            Pass in a limit to display more or less, e.g. `use_packwerk 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.
-          PACK_CONTENT
-
-          to_package_names = all_packages.map(&:name)
         end
 
-        violations_by_count = {}
-        total_pack_violation_count = 0
-
         Logging.section('👋 Hi there') do
-          intro = <<~INTRO
-            #{pack_specific_content}
-
-            When using this script, ask yourself some questions like:
-            - What do I want to support?
-            - What do I *not* want to support?
-            - Which direction should a dependency go?
-            - What packs should depend on you, and what packs should not depend on you?
-            - Would it be simpler if other packs only depended on interfaces to your pack rather than implementation?
-
-            Looking at dependency violations can help guide the development of your public API, but it is just the beginning!
-
-            The script will output in the following format:
-
-            SomeConstant # This is the name of a class, constant, or module defined in your pack, outside of app/public
-              - Total Count: 5 # This is the total number of unstated uses of this outside your pack
-              - By package: # This is a breakdown of the use of this constant by other packages
-                # This is the number of files in this pack that this constant is used.
-                # Check `packs/other_pack_a/deprecated_references.yml` under the '#{pack_name}'.'SomeConstant' key to see where this constant is used
-                - packs/other_pack_a: 3
-                - packs/other_pack_b: 2
-            SomeClass # This is the second most violated class, constant, or module defined in your pack
-              - Total Count: 2
-              - By package:
-                - packs/other_pack_a: 1
-                - packs/other_pack_b: 1
-          INTRO
+          intro = UsePackwerk.config.user_event_logger.before_list_top_dependency_violations(pack_name, limit)
           Logging.print_bold_green(intro)
         end
 
+        violations_by_count = {}
+        total_pack_violation_count = 0
+
         # TODO: This is a copy of the implementation above. We may want to refactor out this implementation detail before making changes that apply to both.
         all_packages.each do |client_package|
           PackageProtections::ProtectedPackage.from(client_package).violations.select(&:dependency?).each do |violation|
             next unless to_package_names.include?(violation.to_package_name)
+
             if pack_name.nil?
               violated_symbol = "#{violation.class_name} (#{violation.to_package_name})"
             else
-              violated_symbol = "#{violation.class_name}"
+              violated_symbol = violation.class_name
             end
             violations_by_count[violated_symbol] ||= {}
             violations_by_count[violated_symbol][:total_count] ||= 0
@@ -208,8 +124,8 @@ module UsePackwerk
           percentage_of_total = (count_info[:total_count] * 100.0 / total_pack_violation_count).round(2)
           Logging.print(violated_symbol)
           Logging.print("  - Total Count: #{count_info[:total_count]} (#{percentage_of_total}% of total)")
-          Logging.print("  - By package:")
-          count_info[:by_package].sort_by{ |client_package_name, count| [-count, client_package_name] }.each do |client_package_name, count|
+          Logging.print('  - By package:')
+          count_info[:by_package].sort_by { |client_package_name, count| [-count, client_package_name] }.each do |client_package_name, count|
             Logging.print("    - #{client_package_name}: #{count}")
           end
         end