visualize_packs 0.5.18 → 0.5.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c493faea12dcf090c4823910d9ecdcfc7da5eca6e370732caa2e063a832a704
-  data.tar.gz: 80b1906deaf843d82c4b317f15234e0ec023fe5fc66efcb865bf94f519101c92
+  metadata.gz: 21c174ca9487c1d11560c585972f1da5ff9b8ddc53148537753af82d1fb66a25
+  data.tar.gz: 2b910b38ad69c3df0631a98b21ec4ca6651190ab973bfc4ba4692e0f1fb7d740
 SHA512:
-  metadata.gz: dab454f3ae4f6dac67e0027417bd996640fc85ab6ac397690051fd77c8a66aeb86175b86c4df39f18027a55d516f1f0b12f587fe090f2788991e6d927511dce0
-  data.tar.gz: 9d1fbc976c03a3540dd6f385193d7cd95e0b97a3f1c2fa6261000204a78924f280718b63568d8f510afd76f33d96db29a63984faeb6255e3ad971905948b6f70
+  metadata.gz: 883ddfb826a9f9051b0431d289fd98b6a92d41c41a42f4e560c0fae89a9432e741c5d9fddd2802a9eae64c9c1a6073d541f26ca8269c40d7f27b946908881088
+  data.tar.gz: 6136452d922cefa21486b40c18b2df6fda1838f25030d66019edfd291101dcae503777f7ecc9581ccf07d0c894f5800adc44248a18b931359d2ab2e1eb65d727

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
+            "<%= 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.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 }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: visualize_packs
 version: !ruby/object:Gem::Version
-  version: 0.5.18
+  version: 0.5.19
 platform: ruby
 authors:
 - Gusto Engineers