visualize_packs 0.5.18 → 0.5.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c493faea12dcf090c4823910d9ecdcfc7da5eca6e370732caa2e063a832a704
-  data.tar.gz: 80b1906deaf843d82c4b317f15234e0ec023fe5fc66efcb865bf94f519101c92
+  metadata.gz: b8efefa896a6d002c7333dad53f2a8fa0be10d8c0004895682239c7a7f6a1105
+  data.tar.gz: 0046a3a518c25de488b4b2e0d89c04ced6e45c1ff5d90e9e85d71d46b5256e89
 SHA512:
-  metadata.gz: dab454f3ae4f6dac67e0027417bd996640fc85ab6ac397690051fd77c8a66aeb86175b86c4df39f18027a55d516f1f0b12f587fe090f2788991e6d927511dce0
-  data.tar.gz: 9d1fbc976c03a3540dd6f385193d7cd95e0b97a3f1c2fa6261000204a78924f280718b63568d8f510afd76f33d96db29a63984faeb6255e3ad971905948b6f70
+  metadata.gz: 5282d8a1af4103a3d6c38675c378adee512029eb4320a29874b91463c2fc4aa7380a76165306f8dc2d8163b67e60875b2496aeacca209b40ebdb09217744888c
+  data.tar.gz: 99f84713ec95080f82668184bd69ce4e67dc30fbc739803f67efe8ebbe51728dbd4717d22eec946a2e24ce1128cd646d3cca47413a09a481718b76c029c47ae7

data/bin/visualize_packs

@@ -34,6 +34,13 @@ OptionParser.new do |opt|
 
   opt.on('--title=STRING', "Set a custom diagram title") { |o| options.title = o }
 
+  opt.on('-V', '--version', "Show version") do
+    spec_path = File.expand_path("../visualize_packs.gemspec", __dir__)
+    spec = Gem::Specification::load(spec_path)
+    puts "Version #{spec.version}"
+    exit
+  end
+
   opt.on_tail("-h", "--help", "Show this message") do
     puts opt
     exit

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 }
@@ -58,25 +70,31 @@ module VisualizePacks
   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"
-    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",
-      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)}",
+    focus_info = if options.focus_pack
+      "Focus on #{limited_sentence(options.focus_pack)} (Edge mode: #{options.show_only_edges_to_focus_pack.serialize})"
+    else 
+      "All packs"
+    end
+
+    hidden_aspects = [
+      options.show_legend ? nil : "legend",
+      options.show_layers ? nil : "layers",
+      options.show_dependencies ? nil : "dependencies",
+      options.show_todos ? nil : "todos",
+      options.show_privacy ? nil : "privacy",
+      options.show_teams ? nil : "teams",
+      options.show_visibility ? nil : "visibility",
+      options.roll_nested_into_parent_packs ? "nested packs" : nil,
+      options.show_nested_relationships ? nil : "nested relationships",
     ].compact.join(', ').strip
-    main_title = "#{app_name}: #{focus_info}#{skipped_info != '' ? ' - ' + skipped_info : ''}"
-    sub_title = ""
+    hidden_aspects_title = hidden_aspects != '' ? "Hiding #{hidden_aspects}" : nil
+
+    todo_types = EdgeTodoTypes.values.size == options.only_todo_types.size ? nil : "Only #{options.only_todo_types.map &:serialize} todos",
+
+    exclusions = options.exclude_packs.empty? ? nil : "Excluding pack#{options.exclude_packs.size > 1 ? 's' : ''}: #{limited_sentence(options.exclude_packs)}",
+
+    main_title = [focus_info, hidden_aspects_title, todo_types, exclusions].compact.join('. ')
+
     if options.show_todos && max_todo_count
       sub_title = "<br/><font point-size='12'>Widest todo edge is #{max_todo_count} todo#{max_todo_count > 1 ? 's' : ''}</font>"
     end
@@ -103,6 +121,8 @@ module VisualizePacks
         case options.show_only_edges_to_focus_pack
         when FocusPackEdgeDirection::All then
           true
+        when FocusPackEdgeDirection::None then
+          match_packs?(start_node, options.focus_pack) && match_packs?(end_node, options.focus_pack)
         when FocusPackEdgeDirection::InOut then
           match_packs?(start_node, options.focus_pack) || match_packs?(end_node, options.focus_pack)
         when FocusPackEdgeDirection::In then
@@ -188,36 +208,32 @@ module VisualizePacks
     result = T.let([], T::Array[T.nilable(String)])
     result = packages.map { |pack| pack.name }
 
-    if focus_pack && !focus_pack.empty?
+    if focus_pack
       result = []
-      result += packages.map { |pack| pack.name }.select { |p| match_packs?(p, focus_pack) }
-      if options.show_dependencies
-        result += packages.select { |p| p.dependencies.any? { |d| match_packs?(d, focus_pack) }}.map { |pack| pack.name }
-      end
-      if options.show_todos && [FocusPackEdgeDirection::All, FocusPackEdgeDirection::In, FocusPackEdgeDirection::InOut].include?(options.show_only_edges_to_focus_pack)
-        result += packages.select do
-          |p| (p.violations || []).inject([]) do |res, todo|
-            res << todo.to_package_name if options.only_todo_types.include?(EdgeTodoTypes.deserialize(todo.type))
-            res
-          end.any? { |v| match_packs?(v, focus_pack) }
-        end.map { |pack| pack.name }
+      focus_pack_name = packages.map { |pack| pack.name }.select { |p| match_packs?(p, focus_pack) }
+      result += focus_pack_name
+
+      dependents = options.show_dependencies ? dependents_on(packages, focus_pack_name) : []
+      dependencies = options.show_dependencies ? dependencies_of(packages, focus_pack_name) : []
+      todos_out = options.show_todos ? todos_out(packages, focus_pack_name, options) : []
+      todos_in = options.show_todos ? todos_in(packages, focus_pack_name, options) : []
+
+      case options.show_only_edges_to_focus_pack
+      when FocusPackEdgeDirection::All, FocusPackEdgeDirection::InOut then
+        result += dependents + dependencies + todos_out + todos_in
+      when FocusPackEdgeDirection::In then
+        result += dependents + todos_in
+      when FocusPackEdgeDirection::Out then
+        result += dependencies + todos_out 
+      when FocusPackEdgeDirection::None then
+        # nothing to do
       end
-      packages.map { |pack| pack.name }.select { |p| match_packs?(p, focus_pack) }.each do |p|
-        if options.show_dependencies
-          result += packages_by_name[p].dependencies
-        end
-        if options.show_todos && [FocusPackEdgeDirection::All, FocusPackEdgeDirection::Out, FocusPackEdgeDirection::InOut].include?(options.show_only_edges_to_focus_pack)
-          result += (packages_by_name[p].violations || []).inject([]) do |res, todo|
-            res << todo.to_package_name if options.only_todo_types.include?(EdgeTodoTypes.deserialize(todo.type))
-            res
-          end
-        end
-      end
-      result = result.uniq
+
       parent_packs = result.inject([]) do |res, package_name|
         res << nested_packages[package_name]
         res
       end
+
       result = (result + parent_packs).uniq.compact
     end
 
@@ -306,4 +322,39 @@ module VisualizePacks
   def self.match_packs?(pack, packs_name_with_wildcards)
     !packs_name_with_wildcards || packs_name_with_wildcards.any? {|p| File.fnmatch(p, pack)}
   end
+
+  sig { params(all_packages: T::Array[ParsePackwerk::Package], focus_packs_names: T::Array[String]).returns(T::Array[String]) }
+  def self.dependencies_of(all_packages, focus_packs_names)
+    focus_packs = all_packages.select { focus_packs_names.include?(_1.name)}
+    
+    focus_packs.inject([]) do |result, pack|
+      result += pack.dependencies
+      result
+    end.uniq
+  end
+
+  sig { params(all_packages: T::Array[ParsePackwerk::Package], focus_packs_names: T::Array[String]).returns(T::Array[String]) }
+  def self.dependents_on(all_packages, focus_packs_names)
+    all_packages.select { |pack| pack.dependencies.any? { focus_packs_names.include?(_1) }}.map &:name
+  end
+
+  sig { params(all_packages: T::Array[ParsePackwerk::Package], focus_packs_names: T::Array[String], options: Options).returns(T::Array[String]) }
+  def self.todos_in(all_packages, focus_packs_names, options)
+    all_packages.select do |p|
+      (p.violations || []).inject([]) do |res, todo|
+        res << todo.to_package_name if options.only_todo_types.include?(EdgeTodoTypes.deserialize(todo.type))
+        res
+      end.any? { |v| focus_packs_names.include?(v) }
+    end.map { |pack| pack.name }
+  end
+
+  sig { params(all_packages: T::Array[ParsePackwerk::Package], focus_packs_names: T::Array[String], options: Options).returns(T::Array[String]) }
+  def self.todos_out(all_packages, focus_packs_names, options)
+    all_packages.inject([]) do |result, p|
+      focus_packs_names.include?(p.name) && (p.violations || []).each do |todo|
+        result << todo.to_package_name if options.only_todo_types.include?(EdgeTodoTypes.deserialize(todo.type))
+      end
+      result
+    end
+  end
 end

metadata

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