packs 0.0.25 → 0.0.28

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d0b7482840c04ba379ace0bb6b3af72257dee2c3538ed49212b11bc45821b53
-  data.tar.gz: a0b35ed0dd622f22000a1e472cffa1c3d2b5e87479af1fa2bef2686454203fa9
+  metadata.gz: a84d1cf9caf1c2e96c4331060015703cc1383177a3dc77252dfb4a54ec9637e0
+  data.tar.gz: 7c2f8e1b763d61dd2f0b1c43c759f857e9a89b1fb53dc1edd7a0fedbf8e3fd69
 SHA512:
-  metadata.gz: 4ef79ae43f292f79c70aa3324723a0f3ae3c307207f6f133a4ed3a7caea9b861a18d9dacb96b7c8603582e481f8193eadf71a6aa4d1e28a34fbd7ed20080f110
-  data.tar.gz: 5c7c2be4ba96f3c8b3bd0bab435735414299e27b1748f31f11427f829c7ee010a9a035872b25a0e6c38259dd5680353e3b1c57b626d5249350a1f63aa1dbff97
+  metadata.gz: 69140e0f68acb38d625f969cdd32488d73f25c7edbf05230743c7aae6b836d1f9802dbf4b542171dc596f1f076109e08d12507737f5ff0957fc9d05bf7aeffd6
+  data.tar.gz: 7db402b5c133d3a737e74bfa4cb95e4b964272f396015822f74fea7e374da63826da63b18897e82b40f99a96bdfdcdf2d2a86c0efd4da7299768c437e3f975a7

data/README.md

@@ -49,21 +49,16 @@ modify packs/from_pack/package.yml's list of dependencies and add packs/to_pack.
 
 This command will also sort the list and make it unique.
 
-## List the top dependency violations of packs/your_pack
-`bin/packs list_top_dependency_violations packs/your_pack`
+## List the top violations of a specific type for packs/your_pack.
+`bin/packs list_top_violations type [ packs/your_pack ]`
 
-Want to see who is depending on you? Not sure how your pack's code is being used in an unstated way
+Possible types are: dependency, privacy, architecture.
 
-You can use this command to list the top dependency violations.
+Want to see who is depending on you? Not sure how your pack's code is being used in an unstated way? You can use this command to list the top dependency violations.
 
-If no pack name is passed in, this will list out violations across all packs.
-
-## List the top privacy violations of packs/your_pack
-`bin/packs list_top_privacy_violations packs/your_pack`
+Want to create interfaces? Not sure how your pack's code is being used? You can use this command to list the top privacy violations.
 
-Want to create interfaces? Not sure how your pack's code is being used?
-
-You can use this command to list the top privacy violations.
+Want to focus on the big picture first? You can use this command to list the top architecture violations.
 
 If no pack name is passed in, this will list out violations across all packs.
 
@@ -100,9 +95,6 @@ Make sure there are no spaces between the comma-separated list of paths of direc
 ## Get info about size and violations for packs
 `bin/packs get_info [ packs/my_pack packs/my_other_pack ]`
 
-## Visualize packs
-`bin/packs visualize [ packs/my_pack packs/my_other_pack ]`
-
 ## Rename a pack
 `bin/packs rename`
 

data/lib/packs/cli.rb

@@ -31,36 +31,31 @@ module Packs
       exit_successfully
     end
 
-    desc 'list_top_dependency_violations packs/your_pack', 'List the top dependency violations of packs/your_pack'
+    POSIBLE_TYPES = T.let(%w[dependency privacy architecture], T::Array[String])
+    desc 'list_top_violations type [ packs/your_pack ]', 'List the top violations of a specific type for packs/your_pack.'
     long_desc <<~LONG_DESC
-      Want to see who is depending on you? Not sure how your pack's code is being used in an unstated way
+      Possible types are: #{POSIBLE_TYPES.join(', ')}.
 
-      You can use this command to list the top dependency violations.
+      Want to see who is depending on you? Not sure how your pack's code is being used in an unstated way? You can use this command to list the top dependency violations.
 
-      If no pack name is passed in, this will list out violations across all packs.
-    LONG_DESC
-    option :limit, type: :numeric, default: 10, aliases: :l, banner: 'Specify the limit of constants to analyze'
-    sig { params(pack_name: String).void }
-    def list_top_dependency_violations(pack_name)
-      Packs.list_top_dependency_violations(
-        pack_name: pack_name,
-        limit: options[:limit]
-      )
-      exit_successfully
-    end
+      Want to create interfaces? Not sure how your pack's code is being used? You can use this command to list the top privacy violations.
 
-    desc 'list_top_privacy_violations packs/your_pack', 'List the top privacy violations of packs/your_pack'
-    long_desc <<~LONG_DESC
-      Want to create interfaces? Not sure how your pack's code is being used?
-
-      You can use this command to list the top privacy violations.
+      Want to focus on the big picture first? You can use this command to list the top architecture violations.
 
       If no pack name is passed in, this will list out violations across all packs.
     LONG_DESC
     option :limit, type: :numeric, default: 10, aliases: :l, banner: 'Specify the limit of constants to analyze'
-    sig { params(pack_name: String).void }
-    def list_top_privacy_violations(pack_name)
-      Packs.list_top_privacy_violations(
+    sig do
+      params(
+        type: String,
+        pack_name: T.nilable(String)
+      ).void
+    end
+    def list_top_violations(type, pack_name = nil)
+      raise StandardError, "Invalid type #{type}. Possible types are: #{POSIBLE_TYPES.join(', ')}" unless POSIBLE_TYPES.include?(type)
+
+      Packs.list_top_violations(
+        type: type,
         pack_name: pack_name,
         limit: options[:limit]
       )
@@ -136,13 +131,6 @@ module Packs
       exit_successfully
     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))
-      exit_successfully
-    end
-
     desc 'rename', 'Rename a pack'
     sig { void }
     def rename

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

@@ -21,7 +21,7 @@ module Packs
           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
+              # Probably should just make `list_top_violations` take in an array of things
               # Better yet we might just want to replace these functions with `QueryPackwerk`
               selected_pack = nil
             else
@@ -30,19 +30,13 @@ module Packs
 
             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')
+            selection = prompt.select('Are you interested in dependency, or privacy violations?', %w[Dependency Privacy Architecture], 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
+            Packs.list_top_violations(
+              type: selection.downcase,
+              pack_name: selected_pack,
+              limit: limit
+            )
           end
         end
       end

data/lib/packs/private/interactive_cli.rb

@@ -19,7 +19,6 @@ 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

data/lib/packs/private/pack_relationship_analyzer.rb

@@ -7,74 +7,12 @@ module Packs
 
       sig do
         params(
+          type: String,
           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 = Packs.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)
+      def self.list_top_violations(type, pack_name, limit)
         all_packages = ParsePackwerk.all
 
         if pack_name.nil?
@@ -90,16 +28,15 @@ module Packs
         end
 
         Logging.section('👋 Hi there') do
-          intro = Packs.config.user_event_logger.before_list_top_dependency_violations(pack_name, limit)
+          intro = Packs.config.user_event_logger.before_list_top_violations(type, 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|
+          client_package.violations.select { _1.type == type }.each do |violation|
             next unless to_package_names.include?(violation.to_package_name)
 
             if pack_name.nil?

data/lib/packs/private.rb

@@ -587,11 +587,6 @@ module Packs
       config.to_a.sort_by { |key, _value| T.unsafe(sort_order).index(key) }.to_h
     end
 
-    sig { params(packs: T::Array[Packs::Pack]).void }
-    def self.visualize(packs: Packs.all)
-      VisualizePacks.package_graph!(packs)
-    end
-
     sig { returns(String) }
     def self.rename_pack
       <<~WARNING

data/lib/packs/user_event_logger.rb

@@ -117,7 +117,7 @@ module Packs
         You can prevent other packs from using private API by using packwerk.
 
         Want to find how your private API is being used today?
-        Try running: `bin/packs list_top_privacy_violations #{pack_name}`
+        Try running: `bin/packs list_top_violations privacy #{pack_name}`
 
         Want to move something into this folder?
         Try running: `bin/packs make_public #{pack_name}/path/to/file.rb`
@@ -149,41 +149,20 @@ module Packs
       MSG
     end
 
-    sig { params(pack_name: T.nilable(String), limit: Integer).returns(String) }
-    def before_list_top_dependency_violations(pack_name, limit)
+    sig { params(type: String, pack_name: T.nilable(String), limit: Integer).returns(String) }
+    def before_list_top_violations(type, pack_name, limit)
       if pack_name.nil?
         <<~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. `bin/packs list_top_dependency_violations #{pack_name} -l 1000`
+          You are listing top #{limit} #{type} 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_violations #{type} #{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_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`
-
-          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
-      end
-    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_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`
-
-          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_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`
+          You are listing top #{limit} #{type} 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_violations #{type} #{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.

data/lib/packs.rb

@@ -186,31 +186,18 @@ module Packs
 
   sig do
     params(
+      type: String,
       pack_name: T.nilable(String),
       limit: Integer
     ).void
   end
-  def self.list_top_privacy_violations(
+  def self.list_top_violations(
+    type:,
     pack_name:,
     limit:
   )
-    Private::PackRelationshipAnalyzer.list_top_privacy_violations(
-      pack_name,
-      limit
-    )
-  end
-
-  sig do
-    params(
-      pack_name: T.nilable(String),
-      limit: Integer
-    ).void
-  end
-  def self.list_top_dependency_violations(
-    pack_name:,
-    limit:
-  )
-    Private::PackRelationshipAnalyzer.list_top_dependency_violations(
+    Private::PackRelationshipAnalyzer.list_top_violations(
+      type,
       pack_name,
       limit
     )

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: packs
 version: !ruby/object:Gem::Version
-  version: 0.0.25
+  version: 0.0.28
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-23 00:00:00.000000000 Z
+date: 2023-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: code_ownership
@@ -136,20 +136,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: visualize_packs
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -343,7 +329,6 @@ files:
 - lib/packs/private/interactive_cli/use_cases/rename.rb
 - lib/packs/private/interactive_cli/use_cases/update.rb
 - lib/packs/private/interactive_cli/use_cases/validate.rb
-- lib/packs/private/interactive_cli/use_cases/visualize.rb
 - lib/packs/private/pack_relationship_analyzer.rb
 - lib/packs/private/packwerk_wrapper/offenses_aggregator_formatter.rb
 - lib/packs/rubocop_post_processor.rb

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

@@ -1,44 +0,0 @@
-# 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