visualize_packs 0.5.16 → 0.5.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3844051eddac8142057acc5912277e386450da923f96714d7ab2f4b664d75ee
-  data.tar.gz: 646315741ca5d8706de1a8397948e231b04295b6513bd4a0cf69d943a546c41b
+  metadata.gz: 3c493faea12dcf090c4823910d9ecdcfc7da5eca6e370732caa2e063a832a704
+  data.tar.gz: 80b1906deaf843d82c4b317f15234e0ec023fe5fc66efcb865bf94f519101c92
 SHA512:
-  metadata.gz: 5d8a1125327c319356a386ef1dfa5efe5fadb94a848d36e465d0a3bebd356f4597bc3db2e67ae35c2c54c7668f968e793dcb11457a1e1fd8f4b7b50bc12d39a8
-  data.tar.gz: 0f066a5bf9897d8a5a495ee6f9f6bcc1aacb1ea0e6c00e5422cc8470c6308c5fe9d0b665847c67b0a1d1d8b453362777917cded5395173b812e34638de7526db
+  metadata.gz: dab454f3ae4f6dac67e0027417bd996640fc85ab6ac397690051fd77c8a66aeb86175b86c4df39f18027a55d516f1f0b12f587fe090f2788991e6d927511dce0
+  data.tar.gz: 9d1fbc976c03a3540dd6f385193d7cd95e0b97a3f1c2fa6261000204a78924f280718b63568d8f510afd76f33d96db29a63984faeb6255e3ad971905948b6f70

data/bin/visualize_packs

@@ -12,24 +12,27 @@ 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-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=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('--no-dependency-arrows', "Don't show accepted dependencies") { |o| options.show_dependencies = 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('--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('--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-nesting-arrows', "Don't draw relationships between parents and nested packs") { |o| options.show_nested_relationships = 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('--remote-base-url=STRING', "Link pack packs to a URL (affects graphviz SVG generation)") { |o| options.remote_base_url = o }
 
-  opt.on('--remote-base-url=', "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

@@ -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 %>
@@ -88,7 +88,7 @@ digraph package_diagram {
         <%- 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 -%>
+              <%- if !options.use_todos_for_layout -%>
                 constraint=false
               <%- end -%>
               # headlabel="<%= todo_type -%>"
@@ -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 != [] -%>

data/lib/visualize_packs/options.rb

@@ -12,11 +12,11 @@ end
 
 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
 
@@ -24,20 +24,26 @@ 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 :use_todos_for_layout, T::Boolean, default: false
+
   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)
+
+  prop :title, T.nilable(String), default: nil
 end

data/lib/visualize_packs.rb

@@ -56,9 +56,11 @@ 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.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 +70,7 @@ module VisualizePacks
       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 +176,7 @@ module VisualizePacks
     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 +188,7 @@ module VisualizePacks
     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 +302,8 @@ module VisualizePacks
     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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: visualize_packs
 version: !ruby/object:Gem::Version
-  version: 0.5.16
+  version: 0.5.18
 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