use_packs 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e12528c58342f14ac6b85143222c121a415baf025dbce4bf46349b60c5a1a726
-  data.tar.gz: e59faa92e2e6eab2e0967cd46cba1ba7bb1aade8957f55a40656571ea3431bbc
+  metadata.gz: 88815e86f43379f87b2d925c883562f0ad12211e519a9af6249dd77f3627ed1a
+  data.tar.gz: 50eb6e85903b56a79adc16e89af0a9610e79159e2be63ed7f21985cc23970023
 SHA512:
-  metadata.gz: 31f76e50ac922c3968066db9f7744922cb36f8fce69ace812d7b98b6af5488257c3efa5b9a12190854d88959a2b7ad6573c97847a3c364c5e4adc29740eb39c5
-  data.tar.gz: 2b3fce71ffb916a7c40392e8bbdcb2533819c3825245f0e29f1fa910e42cd5a2dc8fda16c8ddf4d5c6a6d69af22ef87176d7c5de5a715613b79b600664ea7d58
+  metadata.gz: 1e72a14e415236769db14069f22c6b54c1f89f0ef3a6299265cd9836d93c978ecb2aaa8316714364b4e9532df8c0c49693fce7c42bb5c20b7b4c058cf9488488
+  data.tar.gz: 446ff0e9ff57eac52c954a7a4c393ab4d42c1a13891d16909e51f76aa21b0de4a4d361d6791eb751e67d0698dacb31df60497ecdd2087313ced045b4d882c5ac

data/lib/use_packs/private/interactive_cli/file_selector.rb

@@ -0,0 +1,26 @@
+# typed: strict
+
+module UsePacks
+  module Private
+    module InteractiveCli
+      class FileSelector
+        extend T::Sig
+
+        sig { params(prompt: TTY::Prompt).returns(T::Array[String]) }
+        def self.select(prompt)
+          prompt.on(:keytab) do
+            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
+
+            return paths_relative_to_root
+          end
+
+          [prompt.ask('Please input a file or directory to move (press tab to enter multiline mode)')]
+        end
+      end
+    end
+  end
+end

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

@@ -7,26 +7,47 @@ module UsePacks
         extend T::Sig
 
         sig { params(prompt: TTY::Prompt, question_text: String).returns(ParsePackwerk::Package) }
-        def self.single_pack_select(prompt, question_text: 'Please select a pack')
+        def self.single_pack_select(prompt, question_text: 'Please use space to select a pack')
           packs = ParsePackwerk.all.to_h { |t| [t.name, t] }
-          prompt.select(
+
+          pack_selection = T.let(prompt.select(
             question_text,
             packs,
             filter: true,
             per_page: 10,
             show_help: :always
-          )
+          ), T.nilable(ParsePackwerk::Package))
+
+          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[ParsePackwerk::Package]) }
-        def self.single_or_all_pack_multi_select(prompt, question_text: 'Please select one or more packs')
-          prompt.multi_select(
+        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,
             ParsePackwerk.all.to_h { |t| [t.name, t] },
             filter: true,
             per_page: 10,
             show_help: :always
-          )
+          ), T::Array[ParsePackwerk::Package])
+
+          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

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

@@ -7,27 +7,49 @@ module UsePacks
         extend T::Sig
 
         sig { params(prompt: TTY::Prompt, question_text: String).returns(CodeTeams::Team) }
-        def self.single_select(prompt, question_text: 'Please select a team owner')
+        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] }
-          prompt.select(
+
+          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 select team owners')
+        def self.multi_select(prompt, question_text: 'Please use space to select team owners')
           teams = CodeTeams.all.to_h { |t| [t.name, t] }
-          prompt.multi_select(
+
+          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

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

@@ -16,11 +16,7 @@ module UsePacks
 
           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
+            paths_relative_to_root = FileSelector.select(prompt)
 
             UsePacks.make_public!(
               paths_relative_to_root: paths_relative_to_root,

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

@@ -12,11 +12,7 @@ module UsePacks
           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
+            paths_relative_to_root = FileSelector.select(prompt)
 
             UsePacks.move_to_pack!(
               pack_name: pack.name,

data/lib/use_packs/private/interactive_cli.rb

@@ -5,6 +5,7 @@ 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/file_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'

data/lib/use_packs/user_event_logger.rb

@@ -154,15 +154,15 @@ module UsePacks
     sig { params(pack_name: T.nilable(String), limit: Integer).returns(String) }
     def before_list_top_dependency_violations(pack_name, limit)
       if pack_name.nil?
-        pack_specific_content = <<~PACK_CONTENT
+        <<~PACK_CONTENT
           You are listing top #{limit} dependency violations for all packs. See #{documentation_link} for other utilities!
-          Pass in a limit to display more or less, e.g. `use_packs 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.
         PACK_CONTENT
       else
-        pack_specific_content = <<~PACK_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/packs list_top_dependency_violations #{pack_name} -l 1000`
 
@@ -170,40 +170,12 @@ module UsePacks
           Anything not in #{pack_name}/app/public is considered private API.
         PACK_CONTENT
       end
-
-      <<~MSG
-        #{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
-      MSG
     end
 
     sig { params(pack_name: T.nilable(String), limit: Integer).returns(String) }
     def before_list_top_privacy_violations(pack_name, limit)
       if pack_name.nil?
-        pack_specific_content = <<~PACK_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/packs list_top_privacy_violations #{pack_name} -l 1000`
 
@@ -211,7 +183,7 @@ module UsePacks
           Anything not in pack_name/app/public is considered private API.
         PACK_CONTENT
       else
-        pack_specific_content = <<~PACK_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/packs list_top_privacy_violations #{pack_name} -l 1000`
 
@@ -219,36 +191,6 @@ module UsePacks
           Anything not in #{pack_name}/app/public is considered private API.
         PACK_CONTENT
       end
-
-      <<~MSG
-        #{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/packs make_public #{pack_name}/path/to/file.rb` to make your class, constant, or module public API.
-      MSG
     end
 
     sig { returns(String) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: use_packs
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-09 00:00:00.000000000 Z
+date: 2022-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: code_ownership
@@ -298,6 +298,7 @@ files:
 - lib/use_packs/private.rb
 - lib/use_packs/private/file_move_operation.rb
 - lib/use_packs/private/interactive_cli.rb
+- lib/use_packs/private/interactive_cli/file_selector.rb
 - lib/use_packs/private/interactive_cli/pack_selector.rb
 - lib/use_packs/private/interactive_cli/team_selector.rb
 - lib/use_packs/private/interactive_cli/use_cases/add_dependency.rb