visualize_packs 0.5.3 → 0.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a14f60b122081e11447ca15b17f75693f2797ed56f26ea7918f5eea7422ea8b
-  data.tar.gz: b09d7f7b1683ddb4422ae839f6a6d5d8af159e16a34cd7798ad9155dd713e46f
+  metadata.gz: b4ade528fc794c71afb2470d457f31d72b2456b85a484f2b328ca1c73e7fc2cf
+  data.tar.gz: 239feaba7ced4136ac77625e6ed1632a031492e86ca6d1c0d025976b23e31300
 SHA512:
-  metadata.gz: 07c3ae10e94edd11c917293de275b2c0fef42e2acc74139817adee33691f3d37dbfb1df6d643c4d2a302dc2eea28948b9316ba0cf5610fdf2f63a9c53293a70a
-  data.tar.gz: 1cd63442e74739d13a30638557f891c72809b121e938526542cc201bd621dc596b3352d16697d876f465992f874230fe65a70b0cf9f966c3c5b56d318711cc5e
+  metadata.gz: 18a67a3b983c99f4d273a8e32e390a63bb0fa0398c7da51d4552fee73eedda0e77debfe45a3e196cae5b8d0e370124f7eeb82d202f4daba7b68bb90fb5b15708
+  data.tar.gz: 60e06eaacba3c796ee9045223d47203f63b19e83664c58b9db69696c591f68169f217bc8172287fcb9cc61befaa2008c4a337e486febd0477b6a0b8d14100520

data/bin/visualize_packs

@@ -10,20 +10,37 @@ 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', "Don't show privacy enforcement") { |o| options.focus_package = o }
+  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('--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('--exclude-packs=pack1,pack2,etc', "Exclude these packs from diagram") { |o| options.exclude_packs = o.to_s.split(",") }
+
   opt.on('--remote-base-url=PACKAGE', "Link package nodes to an URL (affects graphviz SVG generation)") { |o| options.remote_base_url = o }
 
   opt.on_tail("-h", "--help", "Show this message") do

data/lib/graph.dot.erb

@@ -81,10 +81,14 @@ digraph package_diagram {
   <%- end -%>
   <%- if options.show_todos -%>
     <%- all_packages.each do |package| -%>
-      <%- violations_by_package = package.violations.group_by(&:to_package_name) -%>
+      <%- filtered_violations = package.violations -%>
+      <%- if options.only_todo_types.any? -%>
+        <%- filtered_violations = filtered_violations.select { options.only_todo_types.include?(_1.type) } -%>
+      <%- end -%>
+      <%- violations_by_package = filtered_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| -%>
+        <%- todo_types = violations_by_package[violations_to_package].group_by(&:type) -%>
+        <%- todo_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
               constraint=false
@@ -100,7 +104,7 @@ digraph package_diagram {
               <%- 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[violation_type].count / max_violation_count.to_f * max_edge_width).to_i
               -%>
               penwidth=<%= edge_width -%>
             ]
@@ -118,28 +122,30 @@ digraph package_diagram {
     <%- end -%>
   <%- end -%>
 <%- end -%>
-  subgraph cluster_legend {
-    fontsize=16
-    label="Edges Styles and Arrow Heads"
-    A [ fontsize=12 shape=box label="package"]
-    B [ fontsize=12 shape=box label="package"]
-    C [ fontsize=12 shape=box label="package"]
-    D [ fontsize=12 shape=box label="package"]
-    E [ fontsize=12 shape=box label="package"]
-    F [ fontsize=12 shape=box label="package"]
-    G [ fontsize=12 shape=box label="package"]
-    H [ fontsize=12 shape=box label="package"]
-    I [ fontsize=12 shape=box label="package"]
-    J [ fontsize=12 shape=box label="package"]
-    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]
-    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]
-    K -> L [label="nested package" color=purple penwidth=3]
-  }
+  <%- if options.show_legend -%>
+    subgraph cluster_legend {
+      fontsize=16
+      label="Edges Styles and Arrow Heads"
+      A [ fontsize=12 shape=box label="package"]
+      B [ fontsize=12 shape=box label="package"]
+      C [ fontsize=12 shape=box label="package"]
+      D [ fontsize=12 shape=box label="package"]
+      E [ fontsize=12 shape=box label="package"]
+      F [ fontsize=12 shape=box label="package"]
+      G [ fontsize=12 shape=box label="package"]
+      H [ fontsize=12 shape=box label="package"]
+      I [ fontsize=12 shape=box label="package"]
+      J [ fontsize=12 shape=box label="package"]
+      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]
+      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]
+      K -> L [label="nested package" color=purple penwidth=3]
+    }
+  <%- end -%>
   <%- if options.show_teams && all_team_names != [] -%>
   subgraph cluster_teams_legend {
     fontsize=16
@@ -157,6 +163,8 @@ digraph package_diagram {
       <%- end %>
     <%- end -%>
   }
-  J -> "<%= all_team_names.last %><%= all_team_names.last %>" [style=invis]
+  <%- if options.show_legend -%>
+    J -> "<%= all_team_names.last %><%= all_team_names.last %>" [style=invis]
+  <%- end -%>
   <%- end -%>
 }

data/lib/options.rb

@@ -4,9 +4,11 @@
 class Options < T::Struct
   extend T::Sig
 
+  prop :show_legend, T::Boolean, default: true
   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
 
@@ -17,5 +19,7 @@ class Options < T::Struct
   prop :focus_folder, T.nilable(String)
   prop :show_nested_relationships, T::Boolean, default: true
 
+  prop :exclude_packs, T::Array[String], default: []
+
   prop :remote_base_url, T.nilable(String)
 end

data/lib/visualize_packs.rb

@@ -11,7 +11,7 @@ module VisualizePacks
   def self.package_graph!(options, raw_config, packages)
     raise ArgumentError, "Package #{options.focus_package} does not exist. Found packages #{packages.map(&:name).join(", ")}" if options.focus_package && !packages.map(&:name).include?(options.focus_package)
 
-    all_packages = filtered(packages, options.focus_package, options.focus_folder).sort_by {|x| x.name }
+    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
@@ -58,13 +58,16 @@ module VisualizePacks
     focus_info = options.focus_package || options.focus_folder ? "Focus on #{[options.focus_package, options.focus_folder].compact.join(' and ')} (#{focus_edge_info})" : "All packs"
     skipped_info = 
     [
+      options.show_legend ? nil : "hiding legend",
       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.show_nested_relationships ? nil : "hiding nested relationships",
+      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 = ""
@@ -74,6 +77,14 @@ module VisualizePacks
     "<<b>#{main_title}</b>#{sub_title}>"
   end
 
+  def self.limited_sentence(list)
+    if list.size <= 2
+      list.join(" and ")
+    else
+      "#{list[0, 2].join(", ")}, and #{list.size - 2} more"
+    end
+  end
+
   def self.show_edge_builder(options, all_package_names)
     return lambda do |start_node, end_node|
       (
@@ -107,11 +118,11 @@ module VisualizePacks
     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|
+        todo_types = violations_by_package[violations_to_package].group_by(&:type)
+        todo_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] = todo_types[violation_type].count
             # violation_counts[key] += 1
           end
         end
@@ -120,8 +131,8 @@ module VisualizePacks
     violation_counts.values.max
   end
 
-  def self.filtered(packages, filter_package, filter_folder)
-    return packages unless filter_package || filter_folder
+  def self.filtered(packages, filter_package, filter_folder, exclude_packs)
+    return packages unless filter_package || filter_folder || exclude_packs.any?
 
     result = packages.map { |pack| pack.name }
 
@@ -138,6 +149,10 @@ module VisualizePacks
       result = result.select { |p| p.include? filter_folder }
     end
 
+    if exclude_packs.any?
+      result = result.reject { |p| exclude_packs.include? p }
+    end
+
     result.map { |pack_name| ParsePackwerk.find(pack_name) }
   end
 

metadata

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