use_packs 0.0.1

data/lib/use_packs/private/interactive_cli/use_cases/create.rb

@@ -0,0 +1,27 @@
+# typed: strict
+
+module UsePacks
+  module Private
+    module InteractiveCli
+      module UseCases
+        class Create
+          extend T::Sig
+          extend T::Helpers
+          include Interface
+
+          sig { override.params(prompt: TTY::Prompt).void }
+          def perform!(prompt)
+            pack_name = prompt.ask('What should the name of your pack be?', value: 'packs/')
+            team = TeamSelector.single_select(prompt)
+            UsePacks.create_pack!(pack_name: pack_name, team: team)
+          end
+
+          sig { override.returns(String) }
+          def user_facing_name
+            'Create a new pack'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/use_packs/private/interactive_cli/use_cases/get_info.rb

@@ -0,0 +1,74 @@
+# typed: strict
+
+module UsePacks
+  module Private
+    module InteractiveCli
+      module UseCases
+        class GetInfo
+          extend T::Sig
+          extend T::Helpers
+          include Interface
+
+          sig { override.returns(String) }
+          def user_facing_name
+            'Get info on one or more packs'
+          end
+
+          sig { override.params(prompt: TTY::Prompt).void }
+          def perform!(prompt)
+            team_or_pack = prompt.select('Do you want info by team or by pack?', ['By team', 'By pack'])
+
+            if team_or_pack == 'By team'
+              teams = TeamSelector.multi_select(prompt)
+              selected_packs = ParsePackwerk.all.select do |p|
+                teams.map(&:name).include?(CodeOwnership.for_package(p)&.name)
+              end
+            else
+              selected_packs = PackSelector.single_or_all_pack_multi_select(prompt, question_text: 'What pack(s) would you like info on?')
+            end
+
+            inbound_violations = {}
+            outbound_violations = {}
+            ParsePackwerk.all.each do |p|
+              violations_for_pack = ParsePackwerk::DeprecatedReferences.for(p).violations
+              violations_for_pack.each do |violation|
+                outbound_violations[p.name] ||= []
+                outbound_violations[p.name] << violation
+                inbound_violations[violation.to_package_name] ||= []
+                inbound_violations[violation.to_package_name] << violation
+              end
+            end
+
+            puts "You've selected #{selected_packs.count} packs. Wow! Here's all the info."
+            all_inbound = T.let([], T::Array[ParsePackwerk::Violation])
+            all_outbound = T.let([], T::Array[ParsePackwerk::Violation])
+            selected_packs.each do |pack|
+              all_inbound += inbound_violations[pack.name] || []
+              all_outbound += outbound_violations[pack.name] || []
+            end
+
+            puts "There are #{all_inbound.select(&:privacy?).sum { |v| v.files.count }} total inbound privacy violations"
+            puts "There are #{all_inbound.select(&:dependency?).sum { |v| v.files.count }} total inbound dependency violations"
+            puts "There are #{all_outbound.select(&:privacy?).sum { |v| v.files.count }} total outbound privacy violations"
+            puts "There are #{all_outbound.select(&:dependency?).sum { |v| v.files.count }} total outbound dependency violations"
+
+            selected_packs.sort_by { |p| -p.directory.glob('**/*.rb').count }.each do |pack|
+              puts "\n=========== Info about: #{pack.name}"
+              owner = CodeOwnership.for_package(pack)
+              puts "Owned by: #{owner.nil? ? 'No one' : owner.name}"
+              puts "Size: #{pack.directory.glob('**/*.rb').count} ruby files"
+              puts "Public API: #{pack.directory.join('app/public')}"
+
+              inbound_for_pack = inbound_violations[pack.name] || []
+              outbound_for_pack = outbound_violations[pack.name] || []
+              puts "There are #{inbound_for_pack.select(&:privacy?).sum { |v| v.files.count }} inbound privacy violations"
+              puts "There are #{inbound_for_pack.flatten.select(&:dependency?).sum { |v| v.files.count }} inbound dependency violations"
+              puts "There are #{outbound_for_pack.select(&:privacy?).sum { |v| v.files.count }} outbound privacy violations"
+              puts "There are #{outbound_for_pack.flatten.select(&:dependency?).sum { |v| v.files.count }} outbound dependency violations"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/use_packs/private/interactive_cli/use_cases/interface.rb

@@ -0,0 +1,34 @@
+# typed: strict
+
+module UsePacks
+  module Private
+    module InteractiveCli
+      module UseCases
+        module Interface
+          extend T::Sig
+          extend T::Helpers
+
+          interface!
+
+          sig { params(base: Class).void }
+          def self.included(base)
+            @use_cases ||= T.let(@use_cases, T.nilable(T::Array[Class]))
+            @use_cases ||= []
+            @use_cases << base
+          end
+
+          sig { returns(T::Array[Interface]) }
+          def self.all
+            T.unsafe(@use_cases).map(&:new)
+          end
+
+          sig { abstract.params(prompt: TTY::Prompt).void }
+          def perform!(prompt); end
+
+          sig { abstract.returns(String) }
+          def user_facing_name; end
+        end
+      end
+    end
+  end
+end

data/lib/use_packs/private/interactive_cli/use_cases/lint_package_yml.rb

@@ -0,0 +1,26 @@
+# typed: strict
+
+module UsePacks
+  module Private
+    module InteractiveCli
+      module UseCases
+        class LintPackageYml
+          extend T::Sig
+          extend T::Helpers
+          include Interface
+
+          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')
+            UsePacks.lint_package_yml_files!(packs)
+          end
+
+          sig { override.returns(String) }
+          def user_facing_name
+            'Lint packs/*/package.yml for one or more packs'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/use_packs/private/interactive_cli/use_cases/make_public.rb

@@ -0,0 +1,34 @@
+# typed: strict
+
+module UsePacks
+  module Private
+    module InteractiveCli
+      module UseCases
+        class MakePublic
+          extend T::Sig
+          extend T::Helpers
+          include Interface
+
+          sig { override.returns(String) }
+          def user_facing_name
+            'Make files or directories public'
+          end
+
+          sig { override.params(prompt: TTY::Prompt).void }
+          def perform!(prompt)
+            raw_paths_relative_to_root = prompt.multiline('Please copy in a space or new line separated list of files or directories to make public')
+            paths_relative_to_root = T.let([], T::Array[String])
+            raw_paths_relative_to_root.each do |path|
+              paths_relative_to_root += path.chomp.split
+            end
+
+            UsePacks.make_public!(
+              paths_relative_to_root: paths_relative_to_root,
+              per_file_processors: [UsePacks::RubocopPostProcessor.new, UsePacks::CodeOwnershipPostProcessor.new]
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/use_packs/private/interactive_cli/use_cases/move.rb

@@ -0,0 +1,36 @@
+# typed: strict
+
+module UsePacks
+  module Private
+    module InteractiveCli
+      module UseCases
+        class Move
+          extend T::Sig
+          extend T::Helpers
+          include Interface
+
+          sig { override.params(prompt: TTY::Prompt).void }
+          def perform!(prompt)
+            pack = PackSelector.single_pack_select(prompt, question_text: 'Please select a destination pack')
+            raw_paths_relative_to_root = prompt.multiline('Please copy in a space or new line separated list of files or directories')
+            paths_relative_to_root = T.let([], T::Array[String])
+            raw_paths_relative_to_root.each do |path|
+              paths_relative_to_root += path.chomp.split
+            end
+
+            UsePacks.move_to_pack!(
+              pack_name: pack.name,
+              paths_relative_to_root: paths_relative_to_root,
+              per_file_processors: [UsePacks::RubocopPostProcessor.new, UsePacks::CodeOwnershipPostProcessor.new]
+            )
+          end
+
+          sig { override.returns(String) }
+          def user_facing_name
+            'Move files'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/use_packs/private/interactive_cli/use_cases/nest.rb

@@ -0,0 +1,31 @@
+# typed: strict
+
+module UsePacks
+  module Private
+    module InteractiveCli
+      module UseCases
+        class Nest
+          extend T::Sig
+          extend T::Helpers
+          include Interface
+
+          sig { override.params(prompt: TTY::Prompt).void }
+          def perform!(prompt)
+            child_pack = PackSelector.single_pack_select(prompt, question_text: 'Please select the pack that will be nested')
+            parent_pack = PackSelector.single_pack_select(prompt, question_text: 'Please select the pack that will be the parent')
+            UsePacks.move_to_parent!(
+              parent_name: parent_pack.name,
+              pack_name: child_pack.name,
+              per_file_processors: [UsePacks::RubocopPostProcessor.new, UsePacks::CodeOwnershipPostProcessor.new]
+            )
+          end
+
+          sig { override.returns(String) }
+          def user_facing_name
+            'Nest one pack under another'
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# typed: strict
+
+module UsePacks
+  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'
+              UsePacks.list_top_dependency_violations(
+                pack_name: selected_pack,
+                limit: limit
+              )
+            else
+              UsePacks.list_top_privacy_violations(
+                pack_name: selected_pack,
+                limit: limit
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# typed: strict
+
+module UsePacks
+  module Private
+    module InteractiveCli
+      module UseCases
+        class RegenerateRubocopTodo
+          extend T::Sig
+          extend T::Helpers
+          include Interface
+
+          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.regenerate_todo(packs: packs)
+          end
+
+          sig { override.returns(String) }
+          def user_facing_name
+            "Regenerate packs/*/#{RuboCop::Packs::PACK_LEVEL_RUBOCOP_TODO_YML} for one or more packs"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# typed: strict
+
+module UsePacks
+  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_packs/private/interactive_cli/use_cases/update_deprecations.rb

@@ -0,0 +1,25 @@
+# typed: strict
+
+module UsePacks
+  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)
+            system('bin/packwerk update-deprecations')
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# typed: strict
+
+module UsePacks
+  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)
+            system('bin/packwerk validate')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/use_packs/private/interactive_cli/use_cases/visualize.rb

@@ -0,0 +1,44 @@
+# typed: strict
+
+require 'visualize_packwerk'
+
+module UsePacks
+  module Private
+    module InteractiveCli
+      module UseCases
+        class Visualize
+          extend T::Sig
+          extend T::Helpers
+          include Interface
+
+          sig { override.params(prompt: TTY::Prompt).void }
+          def perform!(prompt)
+            teams_or_packs = prompt.select('Do you want the graph nodes to be teams or packs?', %w[Teams Packs])
+
+            if teams_or_packs == 'Teams'
+              teams = TeamSelector.multi_select(prompt)
+              VisualizePackwerk.team_graph!(teams)
+            else
+              by_name_or_by_owner = prompt.select('Do you select packs by name or by owner?', ['By name', 'By owner'])
+              if by_name_or_by_owner == 'By owner'
+                teams = TeamSelector.multi_select(prompt)
+                selected_packs = ParsePackwerk.all.select do |p|
+                  teams.map(&:name).include?(CodeOwnership.for_package(p)&.name)
+                end
+              else
+                selected_packs = PackSelector.single_or_all_pack_multi_select(prompt)
+              end
+
+              VisualizePackwerk.package_graph!(selected_packs)
+            end
+          end
+
+          sig { override.returns(String) }
+          def user_facing_name
+            'Visualize pack relationships'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/use_packs/private/interactive_cli.rb

@@ -0,0 +1,52 @@
+# typed: strict
+
+# https://github.com/piotrmurach/tty-prompt
+require 'tty-prompt'
+
+require 'use_packs/private/interactive_cli/team_selector'
+require 'use_packs/private/interactive_cli/pack_selector'
+require 'use_packs/private/interactive_cli/use_cases/interface'
+require 'use_packs/private/interactive_cli/use_cases/create'
+require 'use_packs/private/interactive_cli/use_cases/move'
+require 'use_packs/private/interactive_cli/use_cases/add_dependency'
+require 'use_packs/private/interactive_cli/use_cases/get_info'
+require 'use_packs/private/interactive_cli/use_cases/query'
+require 'use_packs/private/interactive_cli/use_cases/make_public'
+require 'use_packs/private/interactive_cli/use_cases/nest'
+require 'use_packs/private/interactive_cli/use_cases/rename'
+require 'use_packs/private/interactive_cli/use_cases/check'
+require 'use_packs/private/interactive_cli/use_cases/update_deprecations'
+require 'use_packs/private/interactive_cli/use_cases/validate'
+require 'use_packs/private/interactive_cli/use_cases/regenerate_rubocop_todo'
+require 'use_packs/private/interactive_cli/use_cases/lint_package_yml'
+require 'use_packs/private/interactive_cli/use_cases/visualize'
+
+module UsePacks
+  module Private
+    module InteractiveCli
+      extend T::Sig
+
+      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)'
+        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_packs/private/pack_relationship_analyzer.rb

@@ -0,0 +1,135 @@
+# typed: strict
+
+module UsePacks
+  module Private
+    module PackRelationshipAnalyzer
+      extend T::Sig
+
+      sig do
+        params(
+          pack_name: T.nilable(String),
+          limit: Integer
+        ).void
+      end
+      def self.list_top_privacy_violations(pack_name, limit)
+        all_packages = ParsePackwerk.all
+        if pack_name.nil?
+          to_package_names = all_packages.map(&:name)
+        else
+          pack_name = Private.clean_pack_name(pack_name)
+          package = all_packages.find { |p| p.name == pack_name }
+          if package.nil?
+            raise StandardError, "Can not find package with name #{pack_name}. Make sure the argument is of the form `packs/my_pack/`"
+          end
+
+          to_package_names = [pack_name]
+        end
+
+        violations_by_count = {}
+        total_pack_violation_count = 0
+
+        Logging.section('👋 Hi there') do
+          intro = UsePacks.config.user_event_logger.before_list_top_privacy_violations(pack_name, limit)
+          Logging.print_bold_green(intro)
+        end
+
+        # TODO: This is a copy of the implementation below. We may want to refactor out this implementation detail before making changes that apply to both.
+        all_packages.each do |client_package|
+          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
+            end
+            violations_by_count[violated_symbol] ||= {}
+            violations_by_count[violated_symbol][:total_count] ||= 0
+            violations_by_count[violated_symbol][:by_package] ||= {}
+            violations_by_count[violated_symbol][:by_package][client_package.name] ||= 0
+            violations_by_count[violated_symbol][:total_count] += violation.files.count
+            violations_by_count[violated_symbol][:by_package][client_package.name] += violation.files.count
+            total_pack_violation_count += violation.files.count
+          end
+        end
+
+        Logging.print("Total Count: #{total_pack_violation_count}")
+
+        sorted_violations = violations_by_count.sort_by { |violated_symbol, count_info| [-count_info[:total_count], violated_symbol] }
+        sorted_violations.first(limit).each do |violated_symbol, count_info|
+          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("    - #{client_package_name}: #{count}")
+          end
+        end
+      end
+
+      sig do
+        params(
+          pack_name: T.nilable(String),
+          limit: Integer
+        ).void
+      end
+      def self.list_top_dependency_violations(pack_name, limit)
+        all_packages = ParsePackwerk.all
+
+        if pack_name.nil?
+          to_package_names = all_packages.map(&:name)
+        else
+          pack_name = Private.clean_pack_name(pack_name)
+          package = all_packages.find { |p| p.name == pack_name }
+          if package.nil?
+            raise StandardError, "Can not find package with name #{pack_name}. Make sure the argument is of the form `packs/my_pack/`"
+          end
+
+          to_package_names = [pack_name]
+        end
+
+        Logging.section('👋 Hi there') do
+          intro = UsePacks.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|
+          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
+            end
+            violations_by_count[violated_symbol] ||= {}
+            violations_by_count[violated_symbol][:total_count] ||= 0
+            violations_by_count[violated_symbol][:by_package] ||= {}
+            violations_by_count[violated_symbol][:by_package][client_package.name] ||= 0
+            violations_by_count[violated_symbol][:total_count] += violation.files.count
+            violations_by_count[violated_symbol][:by_package][client_package.name] += violation.files.count
+            total_pack_violation_count += violation.files.count
+          end
+        end
+
+        Logging.print("Total Count: #{total_pack_violation_count}")
+
+        sorted_violations = violations_by_count.sort_by { |violated_symbol, count_info| [-count_info[:total_count], violated_symbol] }
+        sorted_violations.first(limit).each do |violated_symbol, count_info|
+          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("    - #{client_package_name}: #{count}")
+          end
+        end
+      end
+    end
+  end
+end