visualize_packs 0.5.4 → 0.5.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01f6c9f4bc79fee9a854283bdae4b57d12fa2a29fc53c1610765ef137f69dd68
-  data.tar.gz: bfb38e97af2696a7ee295341782905340a1458cc62004cd58b077a3caeb1d514
+  metadata.gz: bd8d9c383e056e9ca083b753f77d14ff951d2f0245d3cccb8570eb4a6ac5cf72
+  data.tar.gz: 98edaf0dd58faabbfc57e3d42b24ca43c5f5ea65227627f519815811a03970a6
 SHA512:
-  metadata.gz: 39ee40c6a79f5c883ee1f14ebe9c964fedb65281aadf7ee43163f07a3f9e8f1401379baaf4efd0ccaedb7593d7ab18e28ff8d743e076da6a0028844b2180bb47
-  data.tar.gz: '0997b1cdf11c0095cb2a0bc00ba0dcd04b9ce58a1aff50b9fd106181806d0be3f36df316111946a2c1719014899043c173216dea0f4bd3301f99fdb5d1d6f368'
+  metadata.gz: 541e54ff0460769bccc2d7e8788a57a86c1fbb5929af3cc7b01bbcac36daf0f26bf7378745e89bf189c51fa63b3484c3b34d6493e85e1603cf976f1b6780945e
+  data.tar.gz: d0622a5d36ee4816b497f6fb2488be4ee1a86679729432f8304b27ce1120ff16e28fd1baefc790a1372b227932d9cd54ca5c13e7221f91271d33e717ff01f682

data/README.md

@@ -16,7 +16,7 @@ This will generate a local dependency diagram for every pack in your app
 find . -iname 'package.yml' | sed 's/\/package.yml//g' | sed 's/\.\///' | xargs -I % sh -c "bundle exec visualize_packs --only=% > %/packs.dot && dot %/packs.dot -Tpng -o %/packs.png"
 ```
 
-If your app is large and has many packages and violations, the above graphs will likely be too big. Try this version to get only the edges to and from the focus package for each diagram:
+If your app is large and has many packages and todos, the above graphs will likely be too big. Try this version to get only the edges to and from the focus package for each diagram:
 
 ```
 find . -iname 'package.yml' | sed 's/\/package.yml//g' | sed 's/\.\///' | xargs -I % sh -c "bundle exec visualize_packs --only=% --only-edges-to-focus > %/packs.dot && dot %/packs.dot -Tpng -o %/packs.png"

data/bin/visualize_packs

@@ -10,20 +10,34 @@ require_relative '../lib/options'
 
 options = Options.new
 
+supported_todo_types = %w[
+  privacy
+  architecture
+  visibility
+  dependency
+].sort.freeze
+
+def validated_list(o, valid_arguments)
+  list = o.to_s.split(",").uniq
+  raise OptionParser::InvalidArgument, o unless (list - valid_arguments).empty?
+  list
+end
+
 OptionParser.new do |opt|
   opt.on('--no-legend', "Don't show legend") { |o| options.show_legend = false }
   opt.on('--no-layers', "Don't show architectural layers") { |o| options.show_layers = false }
   opt.on('--no-dependencies', "Don't show accepted dependencies") { |o| options.show_dependencies = false }
   opt.on('--no-todos', "Don't show package todos") { |o| options.show_todos = false }
+  opt.on('--only-todo-types=privacy,architecture,etc', "Show only these types of todos (supported types: #{supported_todo_types.join(', ')})") { |o| options.only_todo_types = validated_list(o, supported_todo_types) }
   opt.on('--no-privacy', "Don't show privacy enforcement") { |o| options.show_privacy = false }
   opt.on('--no-teams', "Don't show team colors") { |o| options.show_teams = false }
 
   opt.on('--focus-on=PACKAGE', "Focus on a specific package") { |o| options.focus_package = o }
   opt.on('--only-edges-to-focus', "If focus is set, this shows only the edges to/from the focus node instead of all edges in the focussed graph. This only has effect when --focus-on is set.") { |o| options.show_only_edges_to_focus_package = true }
 
-  opt.on('--roll_nested_todos_into_top_level', "Don't show nested packages (not counting root). Connect edges to top-level package instead") { |o| options.roll_nested_todos_into_top_level = true }
+  opt.on('--roll-nested-into-parent-packs', "Don't show nested packages (not counting root). Connect edges to top-level package instead") { |o| options.roll_nested_into_parent_packs = true }
   opt.on('--focus_folder=FOLDER', "Draw package diagram only for packages in FOLDER") { |o| options.focus_folder = o }
-  opt.on('--no_nested_relationships', "Don't draw nested package relationships") { |o| options.show_nested_relationships = false }
+  opt.on('--no_nested_relationships', "Don't draw relationships between parents and nested packs") { |o| options.show_nested_relationships = false }
 
   opt.on('--exclude-packs=pack1,pack2,etc', "Exclude these packs from diagram") { |o| options.exclude_packs = o.to_s.split(",") }
 

data/lib/graph.dot.erb

@@ -81,26 +81,30 @@ digraph package_diagram {
   <%- end -%>
   <%- if options.show_todos -%>
     <%- all_packages.each do |package| -%>
-      <%- violations_by_package = package.violations.group_by(&:to_package_name) -%>
-      <%- violations_by_package.keys.each do |violations_to_package| -%>
-        <%- violation_types = violations_by_package[violations_to_package].group_by(&:type) -%>
-        <%- violation_types.keys.each do |violation_type| -%>
-          <%- if show_edge.call(package.name, violations_to_package) -%>
-            "<%= package.name -%>" -> "<%= violations_to_package -%>"<%= violation_type == 'privacy' ? ':private' : '' -%> [ color=darkred style=dashed
+      <%- filtered_todos = package.violations -%>
+      <%- if options.only_todo_types.any? -%>
+        <%- filtered_todos = filtered_todos.select { options.only_todo_types.include?(_1.type) } -%>
+      <%- end -%>
+      <%- todos_by_package = filtered_todos.group_by(&:to_package_name) -%>
+      <%- todos_by_package.keys.each do |todos_to_package| -%>
+        <%- todo_types = todos_by_package[todos_to_package].group_by(&:type) -%>
+        <%- todo_types.keys.each do |todo_type| -%>
+          <%- if show_edge.call(package.name, todos_to_package) -%>
+            "<%= package.name -%>" -> "<%= todos_to_package -%>"<%= todo_type == 'privacy' ? ':private' : '' -%> [ color=darkred style=dashed
               constraint=false
-              # headlabel="<%= violation_type -%>"
-              <%- if violation_type == 'privacy' -%>
+              # headlabel="<%= todo_type -%>"
+              <%- if todo_type == 'privacy' -%>
                 arrowhead=crow
-              <%- elsif violation_type == 'architecture' -%>
+              <%- elsif todo_type == 'architecture' -%>
                 arrowhead=invodot
-              <%- elsif violation_type == 'visibility' -%>
+              <%- elsif todo_type == 'visibility' -%>
                 arrowhead=obox
-              <%- elsif violation_type == 'dependency' -%>
+              <%- elsif todo_type == 'dependency' -%>
                 arrowhead=odot
               <%- end -%>
               <%-
                 max_edge_width = 10
-                edge_width = (violation_types[violation_type].count / max_violation_count.to_f * max_edge_width).to_i
+                edge_width = (todo_types[todo_type].count / max_todo_count.to_f * max_edge_width).to_i
               -%>
               penwidth=<%= edge_width -%>
             ]
@@ -135,7 +139,7 @@ digraph package_diagram {
       K [ fontsize=12 shape=box label="package"]
       L [ fontsize=12 shape=box label="package"]
       A -> B [label="accepted dependency" color=darkgreen]
-      C -> D [label="privac todo" color=darkred style=dashed arrowhead=crow]
+      C -> D [label="privacy todo" color=darkred style=dashed arrowhead=crow]
       E -> F [label="architecture todo" color=darkred style=dashed arrowhead=invodot]
       G -> H [label="visibility todo" color=darkred style=dashed arrowhead=obox]
       I -> J [label="dependency todo" color=darkred style=dashed arrowhead=odot]

data/lib/options.rb

@@ -8,13 +8,14 @@ class Options < T::Struct
   prop :show_layers, T::Boolean, default: true
   prop :show_dependencies, T::Boolean, default: true
   prop :show_todos, T::Boolean, default: true
+  prop :only_todo_types, T::Array[String], default: []
   prop :show_privacy, T::Boolean, default: true
   prop :show_teams, T::Boolean, default: true
 
   prop :focus_package, T.nilable(String)
   prop :show_only_edges_to_focus_package, T::Boolean, default: false
 
-  prop :roll_nested_todos_into_top_level, T::Boolean, default: false
+  prop :roll_nested_into_parent_packs, T::Boolean, default: false
   prop :focus_folder, T.nilable(String)
   prop :show_nested_relationships, T::Boolean, default: true
 

data/lib/visualize_packs.rb

@@ -14,13 +14,13 @@ module VisualizePacks
     all_packages = filtered(packages, options.focus_package, options.focus_folder, options.exclude_packs).sort_by {|x| x.name }
     all_package_names = all_packages.map &:name
 
-    all_packages = remove_nested_packs(all_packages) if options.roll_nested_todos_into_top_level
+    all_packages = remove_nested_packs(all_packages) if options.roll_nested_into_parent_packs
 
     show_edge = show_edge_builder(options, all_package_names)
     node_color = node_color_builder()
-    max_violation_count = max_violation_count(all_packages, show_edge)
+    max_todo_count = max_todo_count(all_packages, show_edge)
 
-    title = diagram_title(options, max_violation_count)
+    title = diagram_title(options, max_todo_count)
 
     architecture_layers = (raw_config['architecture_layers'] || []) + ["NotInLayer"]
     grouped_packages = architecture_layers.inject({}) do |result, key|
@@ -52,7 +52,7 @@ module VisualizePacks
     package.config.dig("metadata", "owner") || package.config["owner"]
   end
 
-  def self.diagram_title(options, max_violation_count)
+  def self.diagram_title(options, max_todo_count)
     app_name = File.basename(Dir.pwd)
     focus_edge_info = options.focus_package && options.show_only_edges_to_focus_package ? "showing only edges to/from focus pack" : "showing all edges between visible packs"
     focus_info = options.focus_package || options.focus_folder ? "Focus on #{[options.focus_package, options.focus_folder].compact.join(' and ')} (#{focus_edge_info})" : "All packs"
@@ -62,28 +62,26 @@ module VisualizePacks
       options.show_layers ? nil : "hiding layers",
       options.show_dependencies ? nil : "hiding dependencies",
       options.show_todos ? nil : "hiding todos",
+      options.only_todo_types.empty? ? nil : "only #{limited_sentence(options.only_todo_types)} todos",
       options.show_privacy ? nil : "hiding privacy",
       options.show_teams ? nil : "hiding teams",
-      options.roll_nested_todos_into_top_level ? "hiding nested packs" : nil,
+      options.roll_nested_into_parent_packs ? "hiding nested packs" : nil,
       options.show_nested_relationships ? nil : "hiding nested relationships",
-      options.exclude_packs.empty? ? nil : "excluding pack#{options.exclude_packs.size > 1 ? 's' : ''}: #{exclude_packs_info(options.exclude_packs)}",
+      options.exclude_packs.empty? ? nil : "excluding pack#{options.exclude_packs.size > 1 ? 's' : ''}: #{limited_sentence(options.exclude_packs)}",
     ].compact.join(', ').strip
     main_title = "#{app_name}: #{focus_info}#{skipped_info != '' ? ' - ' + skipped_info : ''}"
     sub_title = ""
-    if options.show_todos && max_violation_count
-      sub_title = "<br/><font point-size='12'>Widest todo edge is #{max_violation_count} violation#{max_violation_count > 1 ? 's' : ''}</font>"
+    if options.show_todos && max_todo_count
+      sub_title = "<br/><font point-size='12'>Widest todo edge is #{max_todo_count} todo#{max_todo_count > 1 ? 's' : ''}</font>"
     end
     "<<b>#{main_title}</b>#{sub_title}>"
   end
 
-  def self.exclude_packs_info(exclude_packs)
-    case exclude_packs.size
-    when 1
-      exclude_packs.first
-    when 2
-      exclude_packs.join(" and ")
+  def self.limited_sentence(list)
+    if list.size <= 2
+      list.join(" and ")
     else
-      "#{exclude_packs[0, 2].join(", ")}, and #{exclude_packs.size - 2} more."
+      "#{list[0, 2].join(", ")}, and #{list.size - 2} more"
     end
   end
 
@@ -115,22 +113,22 @@ module VisualizePacks
     end
   end
 
-  def self.max_violation_count(all_packages, show_edge)
-    violation_counts = {}
+  def self.max_todo_count(all_packages, show_edge)
+    todo_counts = {}
     all_packages.each do |package|
-      violations_by_package = package.violations.group_by(&:to_package_name)
-      violations_by_package.keys.each do |violations_to_package|
-        violation_types = violations_by_package[violations_to_package].group_by(&:type)
-        violation_types.keys.each do |violation_type|
-          if show_edge.call(package.name, violations_to_package)
-            key = "#{package.name}->#{violations_to_package}:#{violation_type}"
-            violation_counts[key] = violation_types[violation_type].count
-            # violation_counts[key] += 1
+      todos_by_package = package.violations.group_by(&:to_package_name)
+      todos_by_package.keys.each do |todos_to_package|
+        todo_types = todos_by_package[todos_to_package].group_by(&:type)
+        todo_types.keys.each do |todo_type|
+          if show_edge.call(package.name, todos_to_package)
+            key = "#{package.name}->#{todos_to_package}:#{todo_type}"
+            todo_counts[key] = todo_types[todo_type].count
+            # todo_counts[key] += 1
           end
         end
       end
     end
-    violation_counts.values.max
+    todo_counts.values.max
   end
 
   def self.filtered(packages, filter_package, filter_folder, exclude_packs)
@@ -161,13 +159,12 @@ module VisualizePacks
   def self.all_nested_packages(all_package_names)
     all_package_names.reject { |p| p == '.' }.inject({}) do |result, package|
       package_map_tally = all_package_names.map { |other_package| Pathname.new(package).parent.to_s.include?(other_package) }
-      if package_map_tally.tally[true].nil?
-        #nothing to do
-      elsif package_map_tally.tally[true] > 1
-        raise "Can't handle multiple levels of nesting atm"
-      elsif package_map_tally.tally[true] == 1
-        result[package] = all_package_names[package_map_tally.find_index(true)]
-      end
+
+      acc = []
+      all_package_names.each_with_index { |pack, idx| acc << pack if package_map_tally[idx] }
+      acc.sort_by(&:length)
+      result[package] = acc.first unless acc.empty?
+
       result
     end
   end
@@ -203,7 +200,7 @@ module VisualizePacks
           nested_packages[d] || d
         end.uniq.reject { |p| p == package.name }
 
-        morphed_violations = package.violations.map do |v|
+        morphed_todos = package.violations.map do |v|
           ParsePackwerk::Violation.new(
             type: v.type, 
             to_package_name: nested_packages[v.to_package_name] || v.to_package_name, 
@@ -221,10 +218,10 @@ module VisualizePacks
           metadata: package.metadata,
           dependencies: morphed_dependencies,
           config: package.config,
-          violations: morphed_violations
+          violations: morphed_todos
         )
         # add dependencies TO nested packages to top-level package
-        # add violations TO nested packages to top-level package
+        # add todos TO nested packages to top-level package
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: visualize_packs
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.5.6
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-25 00:00:00.000000000 Z
+date: 2023-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler