packs 0.0.5 → 0.0.22

data/lib/packs/private/interactive_cli/pack_selector.rb

@@ -0,0 +1,55 @@
+# typed: strict
+
+module Packs
+  module Private
+    module InteractiveCli
+      class PackSelector
+        extend T::Sig
+
+        sig { params(prompt: TTY::Prompt, question_text: String).returns(Packs::Pack) }
+        def self.single_pack_select(prompt, question_text: 'Please use space to select a pack')
+          packs = Packs.all.to_h { |t| [t.name, t] }
+
+          pack_selection = T.let(prompt.select(
+            question_text,
+            packs,
+            filter: true,
+            per_page: 10,
+            show_help: :always
+          ), T.nilable(Packs::Pack))
+
+          while pack_selection.nil?
+            prompt.error(
+              'No packs were selected, please select a pack using the space key before pressing enter.'
+            )
+
+            pack_selection = single_pack_select(prompt, question_text: question_text)
+          end
+
+          pack_selection
+        end
+
+        sig { params(prompt: TTY::Prompt, question_text: String).returns(T::Array[Packs::Pack]) }
+        def self.single_or_all_pack_multi_select(prompt, question_text: 'Please use space to select one or more packs')
+          pack_selection = T.let(prompt.multi_select(
+            question_text,
+            Packs.all.to_h { |t| [t.name, t] },
+            filter: true,
+            per_page: 10,
+            show_help: :always
+          ), T::Array[Packs::Pack])
+
+          while pack_selection.empty?
+            prompt.error(
+              'No packs were selected, please select one or more packs using the space key before pressing enter.'
+            )
+
+            pack_selection = single_or_all_pack_multi_select(prompt, question_text: question_text)
+          end
+
+          pack_selection
+        end
+      end
+    end
+  end
+end

data/lib/packs/private/interactive_cli/team_selector.rb

@@ -0,0 +1,58 @@
+# typed: strict
+
+module Packs
+  module Private
+    module InteractiveCli
+      class TeamSelector
+        extend T::Sig
+
+        sig { params(prompt: TTY::Prompt, question_text: String).returns(T.nilable(CodeTeams::Team)) }
+        def self.single_select(prompt, question_text: 'Please use space to select a team owner')
+          teams = CodeTeams.all.sort_by(&:name).to_h { |t| [t.name, t] }
+          return nil if teams.count == 0
+
+          team_selection = T.let(prompt.select(
+            question_text,
+            teams,
+            filter: true,
+            per_page: 10,
+            show_help: :always
+          ), T.nilable(CodeTeams::Team))
+
+          while team_selection.nil?
+            prompt.error(
+              'No owners were selected, please select an owner using the space key before pressing enter.'
+            )
+
+            team_selection = single_select(prompt, question_text: question_text)
+          end
+
+          team_selection
+        end
+
+        sig { params(prompt: TTY::Prompt, question_text: String).returns(T::Array[CodeTeams::Team]) }
+        def self.multi_select(prompt, question_text: 'Please use space to select team owners')
+          teams = CodeTeams.all.to_h { |t| [t.name, t] }
+
+          team_selection = T.let(prompt.multi_select(
+            question_text,
+            teams,
+            filter: true,
+            per_page: 10,
+            show_help: :always
+          ), T::Array[CodeTeams::Team])
+
+          while team_selection.empty?
+            prompt.error(
+              'No owners were selected, please select one or more owners using the space key before pressing enter.'
+            )
+
+            team_selection = multi_select(prompt, question_text: question_text)
+          end
+
+          team_selection
+        end
+      end
+    end
+  end
+end

data/lib/packs/private/interactive_cli/use_cases/add_dependency.rb

@@ -0,0 +1,30 @@
+# typed: strict
+
+module Packs
+  module Private
+    module InteractiveCli
+      module UseCases
+        class AddDependency
+          extend T::Sig
+          extend T::Helpers
+          include Interface
+
+          sig { override.params(prompt: TTY::Prompt).void }
+          def perform!(prompt)
+            dependent_pack = PackSelector.single_pack_select(prompt, question_text: 'Please select the pack you are adding a dependency to.')
+            dependency_pack = PackSelector.single_pack_select(prompt, question_text: "Please select the pack that #{dependent_pack.name} should depend on.")
+            Packs.add_dependency!(
+              pack_name: dependent_pack.name,
+              dependency_name: dependency_pack.name
+            )
+          end
+
+          sig { override.returns(String) }
+          def user_facing_name
+            'Add a dependency'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/packs/private/interactive_cli/use_cases/check.rb

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

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

@@ -0,0 +1,27 @@
+# typed: strict
+
+module Packs
+  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)
+            Packs.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/packs/private/interactive_cli/use_cases/get_info.rb

@@ -0,0 +1,37 @@
+# typed: strict
+
+module Packs
+  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 = Packs.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
+
+            puts "You've selected #{selected_packs.count} packs. Wow! Here's all the info."
+
+            Private.get_info(packs: selected_packs)
+          end
+        end
+      end
+    end
+  end
+end

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

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

@@ -0,0 +1,25 @@
+# typed: strict
+
+module Packs
+  module Private
+    module InteractiveCli
+      module UseCases
+        class LintPackageYmlTodoFiles
+          extend T::Sig
+          extend T::Helpers
+          include Interface
+
+          sig { override.params(prompt: TTY::Prompt).void }
+          def perform!(prompt)
+            Private.lint_package_todo_yml_files!
+          end
+
+          sig { override.returns(String) }
+          def user_facing_name
+            'Lint .package_todo.yml files'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/packs/private/interactive_cli/use_cases/lint_package_yml_files.rb

@@ -0,0 +1,26 @@
+# typed: strict
+
+module Packs
+  module Private
+    module InteractiveCli
+      module UseCases
+        class LintPackageYmlFiles
+          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')
+            Packs.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/packs/private/interactive_cli/use_cases/make_public.rb

@@ -0,0 +1,30 @@
+# typed: strict
+
+module Packs
+  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)
+            paths_relative_to_root = FileSelector.select(prompt)
+
+            Packs.make_public!(
+              paths_relative_to_root: paths_relative_to_root,
+              per_file_processors: [Packs::RubocopPostProcessor.new, Packs::CodeOwnershipPostProcessor.new]
+            )
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# typed: strict
+
+module Packs
+  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')
+            paths_relative_to_root = FileSelector.select(prompt)
+
+            Packs.move_to_pack!(
+              pack_name: pack.name,
+              paths_relative_to_root: paths_relative_to_root,
+              per_file_processors: [Packs::RubocopPostProcessor.new, Packs::CodeOwnershipPostProcessor.new]
+            )
+          end
+
+          sig { override.returns(String) }
+          def user_facing_name
+            'Move files'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/packs/private/interactive_cli/use_cases/move_to_parent.rb

@@ -0,0 +1,31 @@
+# typed: strict
+
+module Packs
+  module Private
+    module InteractiveCli
+      module UseCases
+        class MoveToParent
+          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 child pack that will be nested')
+            parent_pack = PackSelector.single_pack_select(prompt, question_text: 'Please select the pack that will be the parent')
+            Packs.move_to_parent!(
+              parent_name: parent_pack.name,
+              pack_name: child_pack.name,
+              per_file_processors: [Packs::RubocopPostProcessor.new, Packs::CodeOwnershipPostProcessor.new]
+            )
+          end
+
+          sig { override.returns(String) }
+          def user_facing_name
+            'Move a child pack to be nested under a parent pack'
+          end
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,25 @@
+# typed: strict
+
+module Packs
+  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(Private.rename_pack)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/packs/private/interactive_cli/use_cases/update.rb

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

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

@@ -0,0 +1,25 @@
+# typed: strict
+
+module Packs
+  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/packs/private/interactive_cli/use_cases/visualize.rb

@@ -0,0 +1,44 @@
+# typed: strict
+
+require 'visualize_packs'
+
+module Packs
+  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)
+              VisualizePacks.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 = Packs.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
+
+              Private.visualize(packs: selected_packs)
+            end
+          end
+
+          sig { override.returns(String) }
+          def user_facing_name
+            'Visualize pack relationships'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/packs/private/interactive_cli.rb

@@ -0,0 +1,52 @@
+# typed: strict
+
+# https://github.com/piotrmurach/tty-prompt
+require 'tty-prompt'
+
+require 'packs/private/interactive_cli/team_selector'
+require 'packs/private/interactive_cli/pack_selector'
+require 'packs/private/interactive_cli/file_selector'
+require 'packs/private/interactive_cli/use_cases/interface'
+require 'packs/private/interactive_cli/use_cases/create'
+require 'packs/private/interactive_cli/use_cases/move'
+require 'packs/private/interactive_cli/use_cases/add_dependency'
+require 'packs/private/interactive_cli/use_cases/get_info'
+require 'packs/private/interactive_cli/use_cases/query'
+require 'packs/private/interactive_cli/use_cases/make_public'
+require 'packs/private/interactive_cli/use_cases/move_to_parent'
+require 'packs/private/interactive_cli/use_cases/rename'
+require 'packs/private/interactive_cli/use_cases/check'
+require 'packs/private/interactive_cli/use_cases/update'
+require 'packs/private/interactive_cli/use_cases/validate'
+require 'packs/private/interactive_cli/use_cases/lint_package_yml_files'
+require 'packs/private/interactive_cli/use_cases/visualize'
+
+module Packs
+  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