packs 0.0.30 → 0.0.32

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b82c7108ae3ca6db3f119837248bedbef6aa33481f51e40bb025e0a5f71d939
-  data.tar.gz: cce06aa5315648c21fa26f55955b7aa49dfc0f04a0662fc9336b2131926ec98c
+  metadata.gz: e95bfe90d9d998317f46782be71a54dce569df90c9aa14d4c27fe8fe5fe39e4f
+  data.tar.gz: 39eeba5a2b20decbb502c3eeb113391e9834a8d4f646c659c7230f667e8ae921
 SHA512:
-  metadata.gz: 3e5553c2866632b9d64bdff514ca2f301e96b22db903b3227909eb9c5e3232140a5566d1f878197794bf51d9fc0a268db17a4b47ad7fa1e420bac011394d0592
-  data.tar.gz: 3b9867217baf53cf7f3e8fc6d99e1c17c6d1a1f6cbba6ddab6535a9de1c2eaafb2b1fcb06ba2e43d1772c95954f61b6f9c372c94838c699c3bfaa324324d4060
+  metadata.gz: bd00632afab57dcd9bac60e5afab1b50a606e87f2f53bdc9ab6c0a1f8da26ca01565c6a363449f3bb5314449cf570087868de34368d74d6bba37293f49a47c7e
+  data.tar.gz: c45e3640db3a3251b04b54f14ce41347bf0d9ed03f3090efca62a3d68ab621631faab3c7d4d1d208cf0840781e6b4228635f2a24313921aa26cf48c3a3cbd924

data/lib/packs/cli.rb

@@ -74,10 +74,7 @@ module Packs
     LONG_DESC
     sig { params(paths: String).void }
     def make_public(*paths)
-      Packs.make_public!(
-        paths_relative_to_root: paths,
-        per_file_processors: [Packs::RubocopPostProcessor.new, Packs::CodeOwnershipPostProcessor.new]
-      )
+      Packs.make_public!(paths_relative_to_root: paths)
       exit_successfully
     end
 
@@ -92,8 +89,7 @@ module Packs
     def move(pack_name, *paths)
       Packs.move_to_pack!(
         pack_name: pack_name,
-        paths_relative_to_root: paths,
-        per_file_processors: [Packs::RubocopPostProcessor.new, Packs::CodeOwnershipPostProcessor.new]
+        paths_relative_to_root: paths
       )
       exit_successfully
     end
@@ -129,9 +125,21 @@ module Packs
     end
 
     desc 'get_info [ packs/my_pack packs/my_other_pack ]', 'Get info about size and violations for packs'
+    option :include_date, type: :boolean, default: false, aliases: :d, banner: "Include today's date as part of the data (useful to take snapshots over time)"
+    option :format, type: :string, default: 'detail', aliases: :f, banner: 'Specify the output format (detail, csv)'
+    option :types, type: :string, default: 'privacy,dependency', aliases: :t, banner: 'List of validation types to include (privacy,dependency,architecture)'
     sig { params(pack_names: String).void }
     def get_info(*pack_names)
-      Private.get_info(packs: parse_pack_names(pack_names))
+      selected_types = options[:types].to_s.downcase.split(',')
+      invalid_types = selected_types - POSIBLE_TYPES
+      raise StandardError, "Invalid type(s): #{invalid_types.join(', ')}. Possible types are: #{POSIBLE_TYPES.join(', ')}" unless invalid_types.empty?
+
+      Private.get_info(
+        packs: parse_pack_names(pack_names),
+        format: options[:format].to_sym,
+        types: selected_types.map(&:to_sym),
+        include_date: options[:include_date]
+      )
       exit_successfully
     end
 
@@ -147,8 +155,7 @@ module Packs
     def move_to_parent(child_pack_name, parent_pack_name)
       Packs.move_to_parent!(
         parent_name: parent_pack_name,
-        pack_name: child_pack_name,
-        per_file_processors: [Packs::RubocopPostProcessor.new, Packs::CodeOwnershipPostProcessor.new]
+        pack_name: child_pack_name
       )
       exit_successfully
     end

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

@@ -26,9 +26,23 @@ module Packs
               selected_packs = PackSelector.single_or_all_pack_multi_select(prompt, question_text: 'What pack(s) would you like info on?')
             end
 
+            format = prompt.select('What output format do you want?', %w[Detail CSV])
+
+            types = prompt.multi_select(
+              'What violation types do you want stats for?',
+              %w[Privacy Dependency Architecture]
+            )
+
+            include_date = !prompt.no?('Should the current date be included in the report?')
+
             puts "You've selected #{selected_packs.count} packs. Wow! Here's all the info."
 
-            Private.get_info(packs: selected_packs)
+            Private.get_info(
+              packs: selected_packs,
+              format: format.downcase.to_sym,
+              types: types.map(&:downcase).map(&:to_sym),
+              include_date: include_date
+            )
           end
         end
       end

data/lib/packs/private.rb

@@ -10,6 +10,8 @@ require 'packs/private/file_move_operation'
 require 'packs/private/pack_relationship_analyzer'
 require 'packs/private/interactive_cli'
 
+require 'date'
+
 module Packs
   module Private
     extend T::Sig
@@ -84,7 +86,6 @@ module Packs
       end
 
       add_public_directory(package) if package.enforce_privacy
-      add_readme_todo(package)
       package_location = package.directory
 
       file_move_operations = T.let([], T::Array[Private::FileMoveOperation])
@@ -132,6 +133,8 @@ module Packs
         end
       end
 
+      add_readme_todo(package)
+
       per_file_processors.each do |processor|
         processor.after_move_files!(file_move_operations)
       end
@@ -196,13 +199,20 @@ module Packs
           new_dependencies += [new_package_name]
         end
 
+        new_config = other_package.config.dup
+        if new_config['ignored_dependencies']
+          new_config['ignored_dependencies'] = new_config['ignored_dependencies'].map do |d|
+            d == pack_name ? new_package_name : d
+          end
+        end
+
         new_other_package = ParsePackwerk::Package.new(
           name: other_package.name,
           enforce_privacy: other_package.enforce_privacy,
           enforce_dependencies: other_package.enforce_dependencies,
           dependencies: new_dependencies.uniq.sort,
           metadata: other_package.metadata,
-          config: other_package.config
+          config: new_config
         )
 
         ParsePackwerk.write_package_yml!(new_other_package)
@@ -478,45 +488,97 @@ module Packs
       Packs.find(package.name)
     end
 
-    sig { params(packs: T::Array[Packs::Pack]).void }
-    def self.get_info(packs: Packs.all)
-      inbound_violations = {}
-      outbound_violations = {}
+    sig do
+      params(
+        packs: T::Array[Packs::Pack],
+        format: Symbol,
+        types: T::Array[Symbol],
+        include_date: T::Boolean
+      ).void
+    end
+    def self.get_info(packs: Packs.all, format: :detail, types: %i[privacy dependency architecture], include_date: false)
+      require 'csv' if format == :csv
+
+      today = Date.today.iso8601
+      violations = {
+        inbound: {},
+        outbound: {}
+      }
+
       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
+          violations[:outbound][p.name] ||= []
+          violations[:outbound][p.name] << violation
+          violations[:inbound][violation.to_package_name] ||= []
+          violations[:inbound][violation.to_package_name] << violation
         end
       end
 
-      all_inbound = T.let([], T::Array[ParsePackwerk::Violation])
-      all_outbound = T.let([], T::Array[ParsePackwerk::Violation])
+      all = {
+        inbound: T.let([], T::Array[ParsePackwerk::Violation]),
+        outbound: T.let([], T::Array[ParsePackwerk::Violation])
+      }
       packs.each do |pack|
-        all_inbound += inbound_violations[pack.name] || []
-        all_outbound += outbound_violations[pack.name] || []
+        all[:inbound] += violations[:inbound][pack.name] || []
+        all[:outbound] += violations[:outbound][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"
+      case format
+      when :csv
+        headers = ['Date', 'Pack name', 'Owned by', 'Size', 'Public API']
+        headers.delete('Date') unless include_date
+        types.each do |type|
+          headers << "Inbound #{type} violations"
+          headers << "Outbound #{type} violations"
+        end
+        puts CSV.generate_line(headers)
+      else # :detail
+        puts "Date: #{today}" if include_date
+        types.each do |type|
+          inbound_count = all[:inbound].select { _1.type.to_sym == type }.sum { |v| v.files.count }
+          outbound_count = all[:outbound].select { _1.type.to_sym == type }.sum { |v| v.files.count }
+          puts "There are #{inbound_count} total inbound #{type} violations"
+          puts "There are #{outbound_count} total outbound #{type} violations"
+        end
+      end
 
       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"
+
+        row = {
+          date: today,
+          pack_name: pack.name,
+          owner: owner.nil? ? 'No one' : owner.name,
+          size: pack.relative_path.glob('**/*.rb').count,
+          public_api: pack.relative_path.join('app/public')
+        }
+
+        row.delete(:date) unless include_date
+
+        types.each do |type|
+          key = ['inbound', type, 'violations'].join('_').to_sym
+          row[key] = (violations[:inbound][pack.name] || []).select { _1.type.to_sym == type }.sum { |v| v.files.count }
+          key = ['outbound', type, 'violations'].join('_').to_sym
+          row[key] = (violations[:outbound][pack.name] || []).select { _1.type.to_sym == type }.sum { |v| v.files.count }
+        end
+
+        case format
+        when :csv
+          puts CSV.generate_line(row.values)
+        else # :detail
+          puts "\n=========== Info about: #{row[:pack_name]}"
+
+          puts "Date: #{row[:date]}" if include_date
+          puts "Owned by: #{row[:owner]}"
+          puts "Size: #{row[:size]} ruby files"
+          puts "Public API: #{row[:public_api]}"
+          types.each do |type|
+            key = ['inbound', type, 'violations'].join('_').to_sym
+            puts "There are #{row[key]} inbound #{type} violations"
+            key = ['outbound', type, 'violations'].join('_').to_sym
+            puts "There are #{row[key]} outbound #{type} violations"
+          end
+        end
       end
     end
 

data/lib/packs/user_event_logger.rb

@@ -99,7 +99,7 @@ module Packs
       <<~MSG
         Your next steps might be:
 
-        1) Delete the old pack when things look good: `rm -rf #{pack_name}`
+        1) Delete the old pack when things look good: `git rm -r #{pack_name}`
 
         2) Run `bin/packwerk update-todo` to update the violations. Make sure to run `spring stop` first.
       MSG

data/lib/packs.rb

@@ -82,7 +82,7 @@ module Packs
   def self.move_to_pack!(
     pack_name:,
     paths_relative_to_root: [],
-    per_file_processors: []
+    per_file_processors: [Packs::RubocopPostProcessor.new, Packs::CodeOwnershipPostProcessor.new]
   )
     Logging.section('👋 Hi!') do
       intro = Packs.config.user_event_logger.before_move_to_pack(pack_name)
@@ -109,7 +109,7 @@ module Packs
   end
   def self.make_public!(
     paths_relative_to_root: [],
-    per_file_processors: []
+    per_file_processors: [Packs::RubocopPostProcessor.new, Packs::CodeOwnershipPostProcessor.new]
   )
     Logging.section('Making files public') do
       intro = Packs.config.user_event_logger.before_make_public
@@ -163,7 +163,7 @@ module Packs
   def self.move_to_parent!(
     pack_name:,
     parent_name:,
-    per_file_processors: []
+    per_file_processors: [Packs::RubocopPostProcessor.new, Packs::CodeOwnershipPostProcessor.new]
   )
     Logging.section('👋 Hi!') do
       intro = Packs.config.user_event_logger.before_move_to_parent(pack_name)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: packs
 version: !ruby/object:Gem::Version
-  version: 0.0.30
+  version: 0.0.32
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-26 00:00:00.000000000 Z
+date: 2023-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: code_ownership