visualize_packs 0.5.17 → 0.5.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13042fc696d4570039e5edbb4b1ba1f9ea710b865be44cbf0054739137f21913
-  data.tar.gz: 660624c8afc17b6dabfefc7969c91af2dacd6858346997220c0a0bfac3382288
+  metadata.gz: 21c174ca9487c1d11560c585972f1da5ff9b8ddc53148537753af82d1fb66a25
+  data.tar.gz: 2b910b38ad69c3df0631a98b21ec4ca6651190ab973bfc4ba4692e0f1fb7d740
 SHA512:
-  metadata.gz: 7776c8d9a0aeee1aa2bc74e1fb071f1f2e76820883e30785a879b49dc86646701b12e82d9f4cdcfec1e6585f7509ab5a2ab81eb239a12bb1bc934f153ecfce99
-  data.tar.gz: 4a67c4ba2efbb24f5d084d8bf19e47d56a8d08b4faf5a02238eb939987c9fdc56b0055cff10049bd7257473f4015df1d5b8f4bc27ca77c998fa3de913b376395
+  metadata.gz: 883ddfb826a9f9051b0431d289fd98b6a92d41c41a42f4e560c0fae89a9432e741c5d9fddd2802a9eae64c9c1a6073d541f26ca8269c40d7f27b946908881088
+  data.tar.gz: 6136452d922cefa21486b40c18b2df6fda1838f25030d66019edfd291101dcae503777f7ecc9581ccf07d0c894f5800adc44248a18b931359d2ab2e1eb65d727

data/bin/visualize_packs

@@ -18,18 +18,21 @@ OptionParser.new do |opt|
   opt.on('--no-visibility-arrows', "Don't show visibility arrows") { |o| options.show_visibility = false }
 
   opt.on('--no-todo-arrows', "Don't show pack todos") { |o| options.show_todos = false }
-  opt.on("--only-todo-types=", "Show only the selected types of todos. Comma-separated list of #{EdgeTodoTypes.values.map &:serialize}") { |o| options.only_todo_types = o.to_s.split(",").uniq.map { EdgeTodoTypes.deserialize(_1) } }
+  opt.on("--only-todo-types=STRING", "Show only the selected types of todos. Comma-separated list of #{EdgeTodoTypes.values.map &:serialize}") { |o| options.only_todo_types = o.to_s.split(",").uniq.map { EdgeTodoTypes.deserialize(_1) } }
+  opt.on("--use-todos-for-layout", "Show only the selected types of todos. Comma-separated list of #{EdgeTodoTypes.values.map &:serialize}") { |o| options.use_todos_for_layout = true }
 
   opt.on('--no-teams', "Don't show team colors") { |o| options.show_teams = false }
 
-  opt.on('--focus-pack=', "Focus on a specific pack(s). Comma-separated list of packs. Wildcards supported: 'packs/*'") { |o| options.focus_pack = o.to_s.split(",") }
-  opt.on('--focus-pack-edge-mode=', "If focus-pack is set, this shows only between focussed packs (when set to none) or the edges into / out of / in and out of the focus packs to non-focus packs (which will be re-added to the graph). One of #{FocusPackEdgeDirection.values.map &:serialize}") { |o| options.show_only_edges_to_focus_pack = FocusPackEdgeDirection.deserialize(o) }
+  opt.on('--focus-pack=STRING', "Focus on a specific pack(s). Comma-separated list of packs. Wildcards supported: 'packs/*'") { |o| options.focus_pack = o.to_s.split(",") }
+  opt.on('--focus-pack-edge-mode=STRING', "If focus-pack is set, this shows only between focussed packs (when set to none) or the edges into / out of / in and out of the focus packs to non-focus packs (which will be re-added to the graph). One of #{FocusPackEdgeDirection.values.map &:serialize}") { |o| options.show_only_edges_to_focus_pack = FocusPackEdgeDirection.deserialize(o) }
   opt.on('--exclude-packs=', "Exclude listed packs from diagram. If used with include you will get all included that are not excluded. Wildcards support: 'packs/ignores/*'") { |o| options.exclude_packs = o.to_s.split(",") }
 
   opt.on('--roll-nested-into-parent-packs', "Don't show nested packs (not counting root). Connect edges to top-level pack instead") { |o| options.roll_nested_into_parent_packs = true }
   opt.on('--no-nesting-arrows', "Don't draw relationships between parents and nested packs") { |o| options.show_nested_relationships = false }
 
-  opt.on('--remote-base-url=', "Link pack packs to a URL (affects graphviz SVG generation)") { |o| options.remote_base_url = o }
+  opt.on('--remote-base-url=STRING', "Link pack packs to a URL (affects graphviz SVG generation)") { |o| options.remote_base_url = o }
+
+  opt.on('--title=STRING', "Set a custom diagram title") { |o| options.title = o }
 
   opt.on_tail("-h", "--help", "Show this message") do
     puts opt

data/lib/graph.dot.erb

@@ -87,19 +87,19 @@ digraph package_diagram {
         <%- 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
-              <%- if options.show_dependencies -%>
+            "<%= package.name -%>" -> "<%= todos_to_package -%>"<%= todo_type == 'privacy' ? ':private' : '' -%> [
+              <%- if !options.use_todos_for_layout -%>
                 constraint=false
               <%- end -%>
               # headlabel="<%= todo_type -%>"
               <%- if todo_type == 'privacy' -%>
-                arrowhead=crow
+                <%= VisualizePacks::ArrowHead::PrivacyTodo.serialize %>
               <%- elsif todo_type == 'architecture' -%>
-                arrowhead=invodot
+                <%= VisualizePacks::ArrowHead::ArchitectureTodo.serialize %>
               <%- elsif todo_type == 'visibility' -%>
-                arrowhead=obox
+                <%= VisualizePacks::ArrowHead::VisibilityTodo.serialize %>
               <%- elsif todo_type == 'dependency' -%>
-                arrowhead=odot
+                <%= VisualizePacks::ArrowHead::DependencyTodo.serialize %>
               <%- end -%>
               penwidth=<%= todo_edge_width(todo_types[todo_type].count, max_todo_count) -%>
             ]
@@ -128,30 +128,46 @@ digraph package_diagram {
     subgraph cluster_legend {
       fontsize=16
       label="Edges Styles and Arrow Heads"
+      <%- if options.show_dependencies -%>
       A [ fontsize=12 shape=box label="package"]
       B [ fontsize=12 shape=box label="package"]
+      A -> B [label="accepted dependency" <%= VisualizePacks::ArrowHead::ConfiguredDependency.serialize %>]
+      <%- end -%>
+      <%- if options.show_nested_relationships -%>
       K [ fontsize=12 shape=box label="package"]
       L [ fontsize=12 shape=box label="package"]
+      K -> L [label="nested package" <%= VisualizePacks::ArrowHead::ConfiguredNested.serialize %>]
+      <%- end -%>
+      <%- if options.show_visibility -%>
       M [ fontsize=12 shape=box label="package"]
       N [ fontsize=12 shape=box label="package"]
-
+      M -> N [label="visibile to" <%= VisualizePacks::ArrowHead::ConfiguredVisibileTo.serialize %>]
+      <%- end -%>
+      <%- if options.show_todos -%>
+        <%- if options.only_todo_types.include?(EdgeTodoTypes::Privacy) -%>
       C [ fontsize=12 shape=box label="package"]
       D [ fontsize=12 shape=box label="package"]
+      C -> D [label="privacy todo" <%= VisualizePacks::ArrowHead::PrivacyTodo.serialize %>]
+        <%- end -%>
+        <%- if options.only_todo_types.include?(EdgeTodoTypes::Architecture) -%>
       E [ fontsize=12 shape=box label="package"]
       F [ fontsize=12 shape=box label="package"]
+      E -> F [label="architecture todo" <%= VisualizePacks::ArrowHead::ArchitectureTodo.serialize %>]
+        <%- end -%>
+        <%- if options.only_todo_types.include?(EdgeTodoTypes::Visibility) -%>
       G [ fontsize=12 shape=box label="package"]
       H [ fontsize=12 shape=box label="package"]
+      G -> H [label="visibility todo" <%= VisualizePacks::ArrowHead::VisibilityTodo.serialize %>]
+        <%- end -%>
+        <%- if options.only_todo_types.include?(EdgeTodoTypes::Dependency) -%>
       I [ fontsize=12 shape=box label="package"]
       J [ fontsize=12 shape=box label="package"]
-
-      A -> B [label="accepted dependency" color=darkgreen]
-      K -> L [label="nested package" color=purple]
-      M -> N [label="visibile to" color=darkgreen]
-
-      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]
+      I -> J [label="dependency todo" <%= VisualizePacks::ArrowHead::DependencyTodo.serialize %>]
+        <%- end -%>
+      <%- end -%>
+      LEGEND_NODE_1 [ label="" peripheries=0 height=0 width=0 style=invis ]
+      LEGEND_NODE_2 [ label="" peripheries=0 height=0 width=0 style=invis ]
+      LEGEND_NODE_1 -> LEGEND_NODE_2 [ style=invis ]
     }
   <%- end -%>
   <%- if options.show_teams && all_team_names != [] -%>
@@ -172,7 +188,7 @@ digraph package_diagram {
     <%- end -%>
   }
   <%- if options.show_legend -%>
-    J -> "<%= all_team_names.last %><%= all_team_names.last %>" [style=invis]
+    LEGEND_NODE_2 -> "<%= all_team_names.last %><%= all_team_names.last %>" [style=invis]
   <%- end -%>
   <%- end -%>
 }

data/lib/visualize_packs/options.rb

@@ -32,6 +32,7 @@ class Options < T::Struct
 
   prop :show_todos, T::Boolean, default: true
   prop :only_todo_types, T::Array[EdgeTodoTypes], default: EdgeTodoTypes.values
+  prop :use_todos_for_layout, T::Boolean, default: false
 
   prop :show_teams, T::Boolean, default: true
 
@@ -43,4 +44,6 @@ class Options < T::Struct
   prop :show_nested_relationships, T::Boolean, default: true
 
   prop :remote_base_url, T.nilable(String)
+
+  prop :title, T.nilable(String), default: nil
 end

data/lib/visualize_packs.rb

@@ -11,6 +11,18 @@ require 'visualize_packs/options'
 module VisualizePacks
   extend T::Sig
 
+  class ArrowHead < T::Enum
+    enums do
+      DependencyTodo = new('color=darkred style=dashed arrowhead=odiamond')
+      PrivacyTodo = new('color=darkred style=dashed arrowhead=crow')
+      ArchitectureTodo = new('color=darkred style=dashed arrowhead=obox')
+      VisibilityTodo = new('color=darkred style=dashed arrowhead=tee')
+      ConfiguredDependency = new('color=darkgreen')
+      ConfiguredVisibileTo = new('color=blue')
+      ConfiguredNested = new('color=purple')
+    end
+  end
+
   sig { params(options: Options, raw_config: T::Hash[String, T.untyped], packages: T::Array[ParsePackwerk::Package]).returns(String) }
   def self.package_graph!(options, raw_config, packages)
     all_packages = filtered(packages, options).compact.sort_by {|x| x.name }
@@ -56,6 +68,8 @@ module VisualizePacks
 
   sig { params(options: Options, max_todo_count: T.nilable(Integer)).returns(String) }
   def self.diagram_title(options, max_todo_count)
+    return "<<b>#{options.title}</b>>" if options.title
+
     app_name = File.basename(Dir.pwd)
     focus_edge_info = options.focus_pack && options.show_only_edges_to_focus_pack != FocusPackEdgeDirection::All ? "showing only edges to/from focus pack" : "showing all edges between visible packs"
     focus_info = options.focus_pack ? "Focus on #{limited_sentence(options.focus_pack)} (#{focus_edge_info})" : "All packs"

metadata

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