Add visibility arrows (#49)

* Clarify edge options

* For focus_pack use nil to indicate that no focus is happening

* Organize options object and cli

* Indentation

* Add visibility arrows (and option to hide them)

* Remove broader penwidth of nested arrow

* Bump gem version

Author: shageman

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    visualize_packs (0.5.16)
+    visualize_packs (0.5.17)
       packs-specification
       parse_packwerk (>= 0.20.0)
       sorbet-runtime

bin/visualize_packs

@@ -12,23 +12,23 @@ options = Options.new
 OptionParser.new do |opt|
   opt.on('--no-legend', "Don't show legend") { |o| options.show_legend = false }
 
+  opt.on('--no-dependency-arrows', "Don't show accepted dependency arrows") { |o| options.show_dependencies = false }
+  opt.on('--no-privacy-boxes', "Don't show privacy enforcement box on a pack") { |o| options.show_privacy = false }
   opt.on('--no-layers', "Don't show architectural layers") { |o| options.show_layers = false }
-
-  opt.on('--no-teams', "Don't show team colors") { |o| options.show_teams = false }
-  
-  opt.on('--no-dependency-arrows', "Don't show accepted dependencies") { |o| options.show_dependencies = false }
+  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('--no-privacy-boxes', "Don't show privacy enforcement box on a pack") { |o| options.show_privacy = false }
 
-  opt.on('--no-nesting-arrows', "Don't draw relationships between parents and nested packs") { |o| options.show_nested_relationships = false }
-  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-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('--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_tail("-h", "--help", "Show this message") do

diagram_examples.png

@@ -33,7 +33,7 @@ digraph package_diagram {
       <%- end -%>
       <%- grouped_packages[layer_name].each do |package| -%>
         "<%= package.name -%>" [
-            fontsize=<%= options.focus_pack.any? && options.focus_pack.any? {|p| File.fnmatch(p, package.name)} ? 18.0 : 12.0 -%>
+            fontsize=<%= options.focus_pack && options.focus_pack.any? {|p| File.fnmatch(p, package.name)} ? 18.0 : 12.0 -%>
             <%- if options.remote_base_url %>
               URL="<%= options.remote_base_url %>/<%= package.name == '.' ? '' : package.name -%>"
             <%- end %>
@@ -109,20 +109,32 @@ digraph package_diagram {
     <%- end -%>
   <%- end -%>
   <%- if options.show_nested_relationships -%>
-  <%- all_packages.each do |package| -%>
-    <%- all_packages.each do |nested_package| -%>
-      <%- if nested_package.name.include?("#{package.name}/") && !(nested_package.name == package.name) -%>
-        "<%= package.name -%>" -> "<%= nested_package.name -%>" [ color=purple penwidth=3 ]
+    <%- all_packages.each do |package| -%>
+      <%- all_packages.each do |nested_package| -%>
+        <%- if nested_package.name.include?("#{package.name}/") && !(nested_package.name == package.name) -%>
+          "<%= package.name -%>" -> "<%= nested_package.name -%>" [ color=purple ]
+        <%- end -%>
+      <%- end -%>
+    <%- end -%>
+  <%- end -%>
+  <%- if options.show_visibility -%>
+    <%- all_packages.each do |package| -%>
+      <%- (package.config['visible_to'] || []).each do |other_package_name|  -%>
+        "<%= package.name -%>" -> "<%= other_package_name -%>" [ color=blue constraint=false ]
       <%- end -%>
     <%- end -%>
   <%- end -%>
-<%- end -%>
   <%- 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"]
+      K [ fontsize=12 shape=box label="package"]
+      L [ fontsize=12 shape=box label="package"]
+      M [ fontsize=12 shape=box label="package"]
+      N [ 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"]
@@ -131,14 +143,15 @@ digraph package_diagram {
       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]
+      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]
-      K -> L [label="nested package" color=purple penwidth=3]
     }
   <%- end -%>
   <%- if options.show_teams && all_team_names != [] -%>

lib/graph.dot.erb

@@ -57,8 +57,8 @@ def self.code_owner(package)
   sig { params(options: Options, max_todo_count: T.nilable(Integer)).returns(String) }
   def self.diagram_title(options, max_todo_count)
     app_name = File.basename(Dir.pwd)
-    focus_edge_info = options.focus_pack.any? && 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.any? ? "Focus on #{limited_sentence(options.focus_pack)} (#{focus_edge_info})" : "All packs"
+    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"
     skipped_info = 
     [
       options.show_legend ? nil : "hiding legend",
@@ -68,6 +68,7 @@ def self.diagram_title(options, max_todo_count)
       EdgeTodoTypes.values.size == options.only_todo_types.size ? nil : "only #{limited_sentence(options.only_todo_types.map &:serialize)} todos",
       options.show_privacy ? nil : "hiding privacy",
       options.show_teams ? nil : "hiding teams",
+      options.show_visibility ? nil : "hiding visibility",
       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' : ''}: #{limited_sentence(options.exclude_packs)}",
@@ -173,7 +174,7 @@ def self.filtered(packages, options)
     focus_pack = options.focus_pack
     exclude_packs = options.exclude_packs
 
-    return packages unless focus_pack.any? || exclude_packs.any?
+    return packages unless focus_pack || exclude_packs.any?
 
     nested_packages = all_nested_packages(packages.map { |p| p.name })
 
@@ -185,7 +186,7 @@ def self.filtered(packages, options)
     result = T.let([], T::Array[T.nilable(String)])
     result = packages.map { |pack| pack.name }
 
-    if !focus_pack.empty?
+    if focus_pack && !focus_pack.empty?
       result = []
       result += packages.map { |pack| pack.name }.select { |p| match_packs?(p, focus_pack) }
       if options.show_dependencies
@@ -299,8 +300,8 @@ def self.remove_nested_packs(packages, options)
     morphed_packages.reject { |p| nested_packages.keys.include?(p.name) }
   end
 
-  sig { params(pack: String, packs_name_with_wildcards: T::Array[String]).returns(T::Boolean) }
+  sig { params(pack: String, packs_name_with_wildcards: T.nilable(T::Array[String])).returns(T::Boolean) }
   def self.match_packs?(pack, packs_name_with_wildcards)
-    packs_name_with_wildcards.any? {|p| File.fnmatch(p, pack)}
+    !packs_name_with_wildcards || packs_name_with_wildcards.any? {|p| File.fnmatch(p, pack)}
   end
 end

lib/visualize_packs.rb

@@ -12,32 +12,35 @@ class EdgeTodoTypes < T::Enum
 
 class FocusPackEdgeDirection < T::Enum
   enums do
-    None = new
-    All = new
-    In = new
-    Out = new
-    InOut = new
+    None = new # don't include non-focus packs and thus show no edges to/from them
+    All = new # include non-focus packs and show all edges between all visible nodes
+    In = new # include non-focus packs and show edges that go towards focus packs (and show all edges between focus packs)
+    Out = new # include non-focus packs and show edges that go away from focus packs (and show all edges between focus packs)
+    InOut = new # include non-focus packs and show edges that go towards or away from focus packs (and show all edges between focus packs)
   end
 end
 
 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_privacy, T::Boolean, default: true
+  prop :show_layers, T::Boolean, default: true
+  prop :show_visibility, T::Boolean, default: true
+
   prop :show_todos, T::Boolean, default: true
   prop :only_todo_types, T::Array[EdgeTodoTypes], default: EdgeTodoTypes.values
-  prop :show_privacy, T::Boolean, default: true
+
   prop :show_teams, T::Boolean, default: true
 
-  prop :focus_pack, T::Array[String], default: []
+  prop :focus_pack, T.nilable(T::Array[String]), default: nil
   prop :show_only_edges_to_focus_pack, FocusPackEdgeDirection, default: FocusPackEdgeDirection::All
+  prop :exclude_packs, T::Array[String], default: []
 
   prop :roll_nested_into_parent_packs, T::Boolean, default: false
   prop :show_nested_relationships, T::Boolean, default: true
 
-  prop :exclude_packs, T::Array[String], default: []
-
   prop :remote_base_url, T.nilable(String)
 end

lib/visualize_packs/options.rb

@@ -23,6 +23,7 @@ test_names+=("no_dependencies"); test_params[${test_names[-1]}]="--no-dependency
 test_names+=("no_todos"); test_params[${test_names[-1]}]="--no-todo-arrows"
 test_names+=("no_privacy"); test_params[${test_names[-1]}]="--no-privacy-boxes"
 test_names+=("no_nested"); test_params[${test_names[-1]}]="--no-nesting-arrows"
+test_names+=("no_visibility"); test_params[${test_names[-1]}]="--no-visibility-arrows"
 
 test_names+=("only_todo_types"); test_params[${test_names[-1]}]="--only-todo-types=architecture,visibility"
 test_names+=("roll_nested_into_parent_packs"); test_params[${test_names[-1]}]="--roll-nested-into-parent-packs"

spec/diagram_generation_helper.sh

@@ -1,7 +1,7 @@
 PATH
   remote: ../..
   specs:
-    visualize_packs (0.5.16)
+    visualize_packs (0.5.17)
       packs-specification
       parse_packwerk (>= 0.20.0)
       sorbet-runtime

spec/sample_app1/Gemfile.lock

@@ -1,7 +1,10 @@
 enforce_dependencies: true
 enforce_privacy: true
+enforce_visibility: true
 layer: app
 dependencies:
 - packs/utility
 - .
-owner: UI Team
+owner: UI Team
+visible_to:
+- packs/models

spec/sample_app1/packs/models/packs/model_a/package.yml

@@ -155,12 +155,18 @@ digraph package_diagram {
               # headlabel="visibility"
                 arrowhead=obox
               penwidth=3.25            ]
-        "packs/models" -> "packs/models/packs/model_a" [ color=purple penwidth=3 ]
+          "packs/models" -> "packs/models/packs/model_a" [ color=purple ]
+        "packs/models/packs/model_a" -> "packs/models" [ color=blue constraint=false ]
     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"]
+      K [ fontsize=12 shape=box label="package"]
+      L [ fontsize=12 shape=box label="package"]
+      M [ fontsize=12 shape=box label="package"]
+      N [ 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"]
@@ -169,14 +175,15 @@ digraph package_diagram {
       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]
+      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]
-      K -> L [label="nested package" color=purple penwidth=3]
     }
   subgraph cluster_teams_legend {
     fontsize=16