use_packs 0.0.13 → 0.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e860d861797457083f35ab124de8f1b2417ab092772f4bb094622dfacda64cef
-  data.tar.gz: 7349fe62972a5423fd14a99b367eaf8eede053085a3be7afe08ae2de8556e804
+  metadata.gz: 5450c6c78c1c7257449c5b3e9cd7e9301be0642af31a9324051cfd97cea5045f
+  data.tar.gz: 13028e1163d760e183bff5d9840b11e1148ca9718900652fe9a4246ae040ad23
 SHA512:
-  metadata.gz: 8a41d04d25654c0d31ef45ff37fc3a87ff9373e52d29f0b2848dc4cb0fcd55a4425d5a6de91bab60484258b0093ba1e463785cbba972435076756501ac0259e3
-  data.tar.gz: 0b285e3a349ee94ac6983e1546a17d09633ed6a49ac72e55b608cdc7d1a7f01a345ebaf1f8c0204922199c93abc9c4590b25a30745aa17995ef08b7902b29a2c
+  metadata.gz: cf4115115841e5242ca58aafbf105e6c0cd35acf1e945a20f67b71e8163866705e03ac58ae9a0dfe412342b95b1e7ffe60e9662e61a1ef0f3aa7e182e0b8bf8a
+  data.tar.gz: 9ae241757c61197ccda052f06263180ece2e907680125e69405a533d0063875eb43217ee078f22654f43e1a98c558db6ed29c0477964197946482b4bc417b16b

data/README.md

@@ -3,6 +3,8 @@
 UsePacks is a gem that helps in creating and maintaining packs. It exists to help perform some basic operations needed for pack setup and configuration. It provides a basic ruby file packager utility for [`packwerk`](https://github.com/Shopify/packwerk/). It assumes you are using [`stimpack`](https://github.com/rubyatscale/stimpack) to organize your packages.
 
 ## Usage
+Make sure to run `bundle binstub use_packs` to generate `bin/packs` within your application.
+
 ### General Help
 `bin/packs --help` or just `bin/packs` to enter interactive mode.
 
@@ -50,16 +52,16 @@ Releases happen automatically through github actions once a version update is co
 To keep things organized, here are some recommended homes:
 
 ### Issues:
-https://github.com/Gusto/use_packs/issues
+https://github.com/rubyatscale/use_packs/issues
 
 ### Questions:
-https://github.com/Gusto/use_packs/discussions/categories/q-a
+https://github.com/rubyatscale/use_packs/discussions/categories/q-a
 
 ### General discussions:
-https://github.com/Gusto/use_packs/discussions/categories/general
+https://github.com/rubyatscale/use_packs/discussions/categories/general
 
 ### Ideas, new features, requests for change:
-https://github.com/Gusto/use_packs/discussions/categories/ideas
+https://github.com/rubyatscale/use_packs/discussions/categories/ideas
 
 ### Showcasing your work:
-https://github.com/Gusto/use_packs/discussions/categories/show-and-tell
+https://github.com/rubyatscale/use_packs/discussions/categories/show-and-tell

data/lib/use_packs/cli.rb

@@ -68,16 +68,6 @@ module UsePacks
       )
     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!'
-    sig { params(parent_name: String, pack_name: String).void }
-    def move_to_parent(parent_name, pack_name)
-      UsePacks.move_to_parent!(
-        parent_name: parent_name,
-        pack_name: pack_name,
-        per_file_processors: [UsePacks::RubocopPostProcessor.new, UsePacks::CodeOwnershipPostProcessor.new]
-      )
-    end
-
     desc 'lint_package_todo_yml_files', 'Ensures `package_todo.yml` files are up to date'
     sig { void }
     def lint_package_todo_yml_files
@@ -114,6 +104,34 @@ module UsePacks
       RuboCop::Packs.regenerate_todo(packs: parse_pack_names(pack_names))
     end
 
+    desc 'get_info [ packs/my_pack packs/my_other_pack ]', 'Get info about size and violations for packs'
+    sig { params(pack_names: String).void }
+    def get_info(*pack_names)
+      Private.get_info(packs: parse_pack_names(pack_names))
+    end
+
+    desc 'visualize [ packs/my_pack packs/my_other_pack ]', 'Visualize packs'
+    sig { params(pack_names: String).void }
+    def visualize(*pack_names)
+      Private.visualize(packs: parse_pack_names(pack_names))
+    end
+
+    desc 'rename', 'Rename a pack'
+    sig { void }
+    def rename
+      puts Private.rename_pack
+    end
+
+    desc 'move_to_parent packs/child_pack packs/parent_pack ', 'Sets packs/child_pack as a child of packs/parent_pack'
+    sig { params(child_pack_name: String, parent_pack_name: String).void }
+    def move_to_parent(child_pack_name, parent_pack_name)
+      UsePacks.move_to_parent!(
+        parent_name: parent_pack_name,
+        pack_name: child_pack_name,
+        per_file_processors: [UsePacks::RubocopPostProcessor.new, UsePacks::CodeOwnershipPostProcessor.new]
+      )
+    end
+
     private
 
     # This is used by thor to know that these private methods are not intended to be CLI commands

data/lib/use_packs/code_ownership_post_processor.rb

@@ -17,14 +17,13 @@ module UsePacks
       relative_path_to_destination = file_move_operation.destination_pathname
 
       code_owners_allow_list_file = Pathname.new('config/code_ownership.yml')
+      return if !code_owners_allow_list_file.exist?
 
-      if code_owners_allow_list_file.exist?
-        UsePacks.replace_in_file(
-          file: code_owners_allow_list_file.to_s,
-          find: relative_path_to_origin,
-          replace_with: relative_path_to_destination
-        )
-      end
+      UsePacks.replace_in_file(
+        file: code_owners_allow_list_file.to_s,
+        find: relative_path_to_origin,
+        replace_with: relative_path_to_destination
+      )
 
       team = CodeOwnership.for_file(relative_path_to_origin.to_s)
 

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

@@ -6,9 +6,10 @@ module UsePacks
       class TeamSelector
         extend T::Sig
 
-        sig { params(prompt: TTY::Prompt, question_text: String).returns(CodeTeams::Team) }
+        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,

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

@@ -17,7 +17,6 @@ module UsePacks
           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|
@@ -27,45 +26,9 @@ module UsePacks
               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|
-              p.violations.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.relative_path.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.relative_path.glob('**/*.rb').count} ruby files"
-              puts "Public API: #{pack.relative_path.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
+            Private.get_info(packs: selected_packs)
           end
         end
       end

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

@@ -0,0 +1,25 @@
+# typed: strict
+
+module UsePacks
+  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/use_packs/private/interactive_cli/use_cases/{lint_package_yml.rb → lint_package_yml_files.rb}

@@ -4,7 +4,7 @@ module UsePacks
   module Private
     module InteractiveCli
       module UseCases
-        class LintPackageYml
+        class LintPackageYmlFiles
           extend T::Sig
           extend T::Helpers
           include Interface

data/lib/use_packs/private/interactive_cli/use_cases/{nest.rb → move_to_parent.rb}

@@ -4,14 +4,14 @@ module UsePacks
   module Private
     module InteractiveCli
       module UseCases
-        class Nest
+        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 pack that will be nested')
+            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')
             UsePacks.move_to_parent!(
               parent_name: parent_pack.name,
@@ -22,7 +22,7 @@ module UsePacks
 
           sig { override.returns(String) }
           def user_facing_name
-            'Nest one pack under another'
+            'Move a child pack to be nested under a parent pack'
           end
         end
       end

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

@@ -16,16 +16,7 @@ module UsePacks
 
           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-todo` to update violations
-              4. Run `bin/codeownership validate` to update ownership information
-              5. Please let us know if anything is missing.
-            WARNING
+            prompt.warn(Private.rename_pack)
           end
         end
       end

data/lib/use_packs/private/interactive_cli/use_cases/{update_todo.rb → update.rb}

@@ -4,19 +4,19 @@ module UsePacks
   module Private
     module InteractiveCli
       module UseCases
-        class UpdateTodo
+        class Update
           extend T::Sig
           extend T::Helpers
           include Interface
 
           sig { override.returns(String) }
           def user_facing_name
-            'Run bin/packwerk update-todo'
+            'Run bin/packwerk update'
           end
 
           sig { override.params(prompt: TTY::Prompt).void }
           def perform!(prompt)
-            system('bin/packwerk update-todo')
+            system('bin/packwerk update')
           end
         end
       end

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

@@ -29,10 +29,7 @@ module UsePacks
                 selected_packs = PackSelector.single_or_all_pack_multi_select(prompt)
               end
 
-              packwerk_packages = selected_packs.map do |pack|
-                T.must(ParsePackwerk.find(pack.name))
-              end
-              VisualizePackwerk.package_graph!(packwerk_packages)
+              Private.visualize(packs: selected_packs)
             end
           end
 

data/lib/use_packs/private/interactive_cli.rb

@@ -13,13 +13,13 @@ 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/move_to_parent'
 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_todo'
+require 'use_packs/private/interactive_cli/use_cases/update'
 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/lint_package_yml_files'
 require 'use_packs/private/interactive_cli/use_cases/visualize'
 
 module UsePacks

data/lib/use_packs/private.rb

@@ -366,13 +366,21 @@ module UsePacks
       if existing_package.nil?
         should_enforce_dependenceies = enforce_dependencies.nil? ? UsePacks.config.enforce_dependencies : enforce_dependencies
 
+        # TODO: This should probably be `if defined?(CodeOwnership) && CodeOwnership.configured?`
+        # but we'll need to add an API to CodeOwnership to do this
+        if Pathname.new('config/code_ownership.yml').exist?
+          metadata = {
+            'owner' => team.nil? ? 'MyTeam' : team.name
+          }
+        else
+          metadata = {}
+        end
+
         package = ParsePackwerk::Package.new(
           enforce_dependencies: should_enforce_dependenceies,
           enforce_privacy: enforce_privacy,
           dependencies: [],
-          metadata: {
-            'owner' => team.nil? ? 'MyTeam' : team.name
-          },
+          metadata: metadata,
           name: pack_name,
           config: {}
         )
@@ -469,6 +477,106 @@ module UsePacks
     def self.packwerk_package_to_pack(package)
       Packs.find(package.name)
     end
+
+    sig { params(packs: T::Array[Packs::Pack]).void }
+    def self.get_info(packs: Packs.all)
+      inbound_violations = {}
+      outbound_violations = {}
+      ParsePackwerk.all.each do |p|
+        p.violations.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
+
+      all_inbound = T.let([], T::Array[ParsePackwerk::Violation])
+      all_outbound = T.let([], T::Array[ParsePackwerk::Violation])
+      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"
+
+      packs.sort_by { |p| -p.relative_path.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.relative_path.glob('**/*.rb').count} ruby files"
+        puts "Public API: #{pack.relative_path.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
+
+    sig { void }
+    def self.lint_package_todo_yml_files!
+      contents_before = Private.get_package_todo_contents
+      UsePacks.execute(['update-todo'])
+      contents_after = Private.get_package_todo_contents
+      diff = Private.diff_package_todo_yml(contents_before, contents_after)
+
+      if diff == ''
+        # No diff generated by `update-todo`
+        exit 0
+      else
+        output = <<~OUTPUT
+          All `package_todo.yml` files must be up-to-date and that no diff is generated when running `bin/packwerk update-todo`.
+          This helps ensure a high quality signal in other engineers' PRs when inspecting new violations by ensuring there are no unrelated changes.
+
+          There are three main reasons there may be a diff:
+          1) Most likely, you may have stale violations, meaning there are old violations that no longer apply.
+          2) You may have some sort of auto-formatter set up somewhere (e.g. something that reformats YML files) that is, for example, changing double quotes to single quotes. Ensure this is turned off for these auto-generated files.
+          3) You may have edited these files manually. It's recommended to use the `bin/packwerk update-todo` command to make changes to `package_todo.yml` files.
+
+          In all cases, you can run `bin/packwerk update-todo` to update these files.
+
+          Here is the diff generated after running `update-todo`:
+          ```
+          #{diff}
+          ```
+
+        OUTPUT
+
+        puts output
+        UsePacks.config.on_package_todo_lint_failure.call(output)
+
+        exit 1
+      end
+    end
+
+    sig { params(packs: T::Array[Packs::Pack]).void }
+    def self.visualize(packs: Packs.all)
+      packwerk_packages = packs.map do |pack|
+        T.must(ParsePackwerk.find(pack.name))
+      end
+      VisualizePackwerk.package_graph!(packwerk_packages)
+    end
+
+    sig { returns(String) }
+    def self.rename_pack
+      <<~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-todo` to update violations
+        4. Run `bin/codeownership validate` to update ownership information
+        5. Please let us know if anything is missing.
+      WARNING
+    end
   end
 
   private_constant :Private

data/lib/use_packs.rb

@@ -248,38 +248,7 @@ module UsePacks
 
   sig { void }
   def self.lint_package_todo_yml_files!
-    contents_before = Private.get_package_todo_contents
-    UsePacks.execute(['update-todo'])
-    contents_after = Private.get_package_todo_contents
-    diff = Private.diff_package_todo_yml(contents_before, contents_after)
-
-    if diff == ''
-      # No diff generated by `update-todo`
-      exit 0
-    else
-      output = <<~OUTPUT
-        All `package_todo.yml` files must be up-to-date and that no diff is generated when running `bin/packwerk update-todo`.
-        This helps ensure a high quality signal in other engineers' PRs when inspecting new violations by ensuring there are no unrelated changes.
-
-        There are three main reasons there may be a diff:
-        1) Most likely, you may have stale violations, meaning there are old violations that no longer apply.
-        2) You may have some sort of auto-formatter set up somewhere (e.g. something that reformats YML files) that is, for example, changing double quotes to single quotes. Ensure this is turned off for these auto-generated files.
-        3) You may have edited these files manually. It's recommended to use the `bin/packwerk update-todo` command to make changes to `package_todo.yml` files.
-
-        In all cases, you can run `bin/packwerk update-todo` to update these files.
-
-        Here is the diff generated after running `update-todo`:
-        ```
-        #{diff}
-        ```
-
-      OUTPUT
-
-      puts output
-      UsePacks.config.on_package_todo_lint_failure.call(output)
-
-      exit 1
-    end
+    Private.lint_package_todo_yml_files!
   end
 
   sig { params(packs: T::Array[Packs::Pack]).void }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: use_packs
 version: !ruby/object:Gem::Version
-  version: 0.0.13
+  version: 0.0.15
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-29 00:00:00.000000000 Z
+date: 2023-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: code_ownership
@@ -320,14 +320,15 @@ files:
 - lib/use_packs/private/interactive_cli/use_cases/create.rb
 - lib/use_packs/private/interactive_cli/use_cases/get_info.rb
 - lib/use_packs/private/interactive_cli/use_cases/interface.rb
-- lib/use_packs/private/interactive_cli/use_cases/lint_package_yml.rb
+- lib/use_packs/private/interactive_cli/use_cases/lint_package_todo_yml_files.rb
+- lib/use_packs/private/interactive_cli/use_cases/lint_package_yml_files.rb
 - lib/use_packs/private/interactive_cli/use_cases/make_public.rb
 - lib/use_packs/private/interactive_cli/use_cases/move.rb
-- lib/use_packs/private/interactive_cli/use_cases/nest.rb
+- lib/use_packs/private/interactive_cli/use_cases/move_to_parent.rb
 - lib/use_packs/private/interactive_cli/use_cases/query.rb
 - lib/use_packs/private/interactive_cli/use_cases/regenerate_rubocop_todo.rb
 - lib/use_packs/private/interactive_cli/use_cases/rename.rb
-- lib/use_packs/private/interactive_cli/use_cases/update_todo.rb
+- lib/use_packs/private/interactive_cli/use_cases/update.rb
 - lib/use_packs/private/interactive_cli/use_cases/validate.rb
 - lib/use_packs/private/interactive_cli/use_cases/visualize.rb
 - lib/use_packs/private/pack_relationship_analyzer.rb