use_packwerk 0.55.0 → 0.57.0

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

@@ -0,0 +1,51 @@
+# typed: strict
+
+module UsePackwerk
+  module Private
+    module InteractiveCli
+      module UseCases
+        #
+        # We have not yet pulled QueryPackwerk into open source, so we cannot include it in this CLI yet
+        #
+        class Query
+          extend T::Sig
+          extend T::Helpers
+          include Interface
+
+          sig { override.returns(String) }
+          def user_facing_name
+            'Query violations about a pack'
+          end
+
+          sig { override.params(prompt: TTY::Prompt).void }
+          def perform!(prompt)
+            selection = prompt.select('For one pack or all packs?', ['One pack', 'All packs'])
+            if selection == 'All packs'
+              # Probably should just make `list_top_dependency_violations` take in an array of things
+              # Better yet we might just want to replace these functions with `QueryPackwerk`
+              selected_pack = nil
+            else
+              selected_pack = PackSelector.single_pack_select(prompt).name
+            end
+
+            limit = prompt.ask('Specify the limit of constants to analyze', default: 10, convert: :integer)
+
+            selection = prompt.select('Are you interested in dependency or privacy violations?', %w[Dependency Privacy], default: 'Privacy')
+
+            if selection == 'Dependency'
+              UsePackwerk.list_top_dependency_violations(
+                pack_name: selected_pack,
+                limit: limit
+              )
+            else
+              UsePackwerk.list_top_privacy_violations(
+                pack_name: selected_pack,
+                limit: limit
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# typed: strict
+
+module UsePackwerk
+  module Private
+    module InteractiveCli
+      module UseCases
+        class Rename
+          extend T::Sig
+          extend T::Helpers
+          include Interface
+
+          sig { override.returns(String) }
+          def user_facing_name
+            'Rename a pack'
+          end
+
+          sig { override.params(prompt: TTY::Prompt).void }
+          def perform!(prompt)
+            prompt.warn(<<~WARNING)
+              We do not yet have an automated API for this.
+
+              Follow these steps:
+              1. Rename the `packs/your_pack` directory to the name of the new pack, `packs/new_pack_name
+              2. Replace references to `- packs/your_pack` in `package.yml` files with `- packs/new_pack_name`
+              3. Rerun `bin/packwerk update-deprecations` to update violations
+              4. Run `bin/codeownership validate` to update ownership information
+              5. Please let us know if anything is missing.
+            WARNING
+          end
+        end
+      end
+    end
+  end
+end

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

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

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

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

data/lib/use_packwerk/private/interactive_cli.rb

@@ -0,0 +1,48 @@
+# typed: strict
+
+# https://github.com/piotrmurach/tty-prompt
+require 'tty-prompt'
+
+require 'use_packwerk/private/interactive_cli/team_selector'
+require 'use_packwerk/private/interactive_cli/pack_selector'
+require 'use_packwerk/private/interactive_cli/use_cases/interface'
+require 'use_packwerk/private/interactive_cli/use_cases/create'
+require 'use_packwerk/private/interactive_cli/use_cases/move'
+require 'use_packwerk/private/interactive_cli/use_cases/add_dependency'
+require 'use_packwerk/private/interactive_cli/use_cases/get_info'
+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/update_deprecations'
+require 'use_packwerk/private/interactive_cli/use_cases/validate'
+
+module UsePackwerk
+  module Private
+    module InteractiveCli
+      extend T::Sig
+
+      sig { void }
+      def self.start!
+        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)'
+        choice = prompt.select('Hello! What would you like to do?',
+          cycle: true,
+          filter: true,
+          help: help_text,
+          show_help: :always,
+          per_page: 15) do |menu|
+          menu.enum '.'
+
+          UseCases::Interface.all.each do |use_case|
+            menu.choice use_case.user_facing_name, use_case
+          end
+        end
+
+        choice.perform!(prompt)
+      end
+    end
+  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