visualize_packs 0.5.15 → 0.5.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a1fb5d4a88ec1f052663cae4ae4b356fddc90ad34ffef47e241a1b35d13da66
-  data.tar.gz: bbc12cc3b7a7fb6bbf015569f38fa7f2ba6928b0c07f6dfbe5d80551674507c8
+  metadata.gz: 13042fc696d4570039e5edbb4b1ba1f9ea710b865be44cbf0054739137f21913
+  data.tar.gz: 660624c8afc17b6dabfefc7969c91af2dacd6858346997220c0a0bfac3382288
 SHA512:
-  metadata.gz: 3124d697f0ecedc3dfc8c0d82cf5125c9886dc7691eff89ca75ba2c61ea8af05aa6ee16efe6c4b6e38c927b762cb99d7b8ae00db1f19d55fcfd94d40ede16f8b
-  data.tar.gz: 83a3ee2ca08dc704642a48bdf00b05e6b96f108e9c8e9034e6aa46ceb5d2a8dbda757980a65cec3cc3fa041b16fa6742a7ec3cb3034b1e18d0847388c8f1f96d
+  metadata.gz: 7776c8d9a0aeee1aa2bc74e1fb071f1f2e76820883e30785a879b49dc86646701b12e82d9f4cdcfec1e6585f7509ab5a2ab81eb239a12bb1bc934f153ecfce99
+  data.tar.gz: 4a67c4ba2efbb24f5d084d8bf19e47d56a8d08b4faf5a02238eb939987c9fdc56b0055cff10049bd7257473f4015df1d5b8f4bc27ca77c998fa3de913b376395

data/README.md

@@ -19,7 +19,7 @@ find . -iname 'package.yml' | sed 's/\/package.yml//g' | sed 's/\.\///' | xargs
 If your app is large and has many packages and todos, the above graphs will likely be too big. Try this version to get only the edges to and from the focus package for each diagram:
 
 ```
-find . -iname 'package.yml' | sed 's/\/package.yml//g' | sed 's/\.\///' | xargs -I % sh -c "bundle exec visualize_packs --only=% --only-edges-to-focus > %/packs.dot && dot %/packs.dot -Tpng -o %/packs.png"
+find . -iname 'package.yml' | sed 's/\/package.yml//g' | sed 's/\.\///' | xargs -I % sh -c "bundle exec visualize_packs --only=% --focus-pack-edge-mode=inout > %/packs.dot && dot %/packs.dot -Tpng -o %/packs.png"
 ```
 
 

data/bin/visualize_packs

@@ -9,39 +9,27 @@ require_relative '../lib/visualize_packs'
 
 options = Options.new
 
-supported_todo_types = %w[
-  privacy
-  architecture
-  visibility
-  dependency
-].sort.freeze
-
-def validated_list(o, valid_arguments)
-  list = o.to_s.split(",").uniq
-  raise OptionParser::InvalidArgument, o unless (list - valid_arguments).empty?
-  list
-end
-
 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-dependencies', "Don't show accepted dependencies") { |o| options.show_dependencies = false }
-  opt.on('--no-todos', "Don't show package todos") { |o| options.show_todos = false }
-  opt.on('--only-todo-types=privacy,architecture,etc', "Show only these types of todos (supported types: #{supported_todo_types.join(', ')})") { |o| options.only_todo_types = validated_list(o, supported_todo_types) }
-  opt.on('--no-privacy', "Don't show privacy enforcement") { |o| options.show_privacy = false }
-  opt.on('--no-teams', "Don't show team colors") { |o| options.show_teams = false }
+  opt.on('--no-visibility-arrows', "Don't show visibility arrows") { |o| options.show_visibility = false }
 
-  opt.on('--focus-folder=FOLDER', "Draw package diagram only for packages in FOLDER. Matches with 'include' for partial matches") { |o| options.focus_folder = o.empty? ? nil : o }
-  opt.on('--focus-pack=pack1,pack2', "Focus on a specific package(s). Wildcards support: 'packs/*'") { |o| options.focus_pack = o.to_s.split(",") }
-  opt.on('--only-edges-to-focus=[in,out,inout]', "If focus-pack is set, this shows only the edges into / out of / in and out of the focus node instead of all edges in the focussed graph.") { |o| options.show_only_edges_to_focus_pack = FocusPackEdgeDirection.deserialize(o) }
+  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-teams', "Don't show team colors") { |o| options.show_teams = false }
 
-  opt.on('--roll-nested-into-parent-packs', "Don't show nested packages (not counting root). Connect edges to top-level package instead") { |o| options.roll_nested_into_parent_packs = true }
-  opt.on('--no-nested-relationships', "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('--exclude-packs=pack1,pack2,etc', "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('--include-packs=pack1,pack2,etc', "Include only listed packs in diagram. If used with exclude you will get all included that are not excluded. Wildcards support: 'packs/ignores/*'") { |o| options.include_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=PACKAGE', "Link package nodes to an 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_tail("-h", "--help", "Show this message") do
     puts opt
@@ -52,5 +40,5 @@ end.parse!
 puts VisualizePacks.package_graph!(
   options, 
   ParsePackwerk::Configuration.fetch.raw, 
-  Packs.all.map { |pack| ParsePackwerk.find(pack.name) }
+  Packs.all.map { ParsePackwerk.find(_1.name) }
 )

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 %>
@@ -81,10 +81,7 @@ digraph package_diagram {
   <%- end -%>
   <%- if options.show_todos -%>
     <%- all_packages.each do |package| -%>
-      <%- filtered_todos = package.violations -%>
-      <%- if options.only_todo_types.any? -%>
-        <%- filtered_todos = filtered_todos.select { options.only_todo_types.include?(_1.type) } -%>
-      <%- end -%>
+      <%- filtered_todos = package.violations.select { options.only_todo_types.include?(EdgeTodoTypes.deserialize(_1.type)) } -%>
       <%- todos_by_package = filtered_todos.group_by(&:to_package_name) -%>
       <%- todos_by_package.keys.each do |todos_to_package| -%>
         <%- todo_types = todos_by_package[todos_to_package].group_by(&:type) -%>
@@ -112,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"]
@@ -134,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

@@ -1,11 +1,22 @@
 # frozen_string_literal: true
 # typed: strict
 
+class EdgeTodoTypes < T::Enum
+  enums do
+    Dependency = new
+    Privacy = new
+    Architecture = new
+    Visibility = new
+  end
+end
+
 class FocusPackEdgeDirection < T::Enum
   enums do
-    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
 
@@ -13,22 +24,23 @@ 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_todos, T::Boolean, default: true
-  prop :only_todo_types, T::Array[String], default: []
   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_teams, T::Boolean, default: true
 
-  prop :focus_folder, T.nilable(String)
-  prop :focus_pack, T::Array[String], default: []
-  prop :show_only_edges_to_focus_pack, T.nilable(FocusPackEdgeDirection), default: nil
+  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 :include_packs, T.nilable(T::Array[String]), default: nil
-
   prop :remote_base_url, T.nilable(String)
 end

data/lib/visualize_packs.rb

@@ -57,20 +57,20 @@ module VisualizePacks
   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 ? "showing only edges to/from focus pack" : "showing all edges between visible packs"
-    focus_info = options.focus_pack.any? || options.focus_folder ? "Focus on #{[limited_sentence(options.focus_pack), options.focus_folder].compact.join(' and ')} (#{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",
       options.show_layers ? nil : "hiding layers",
       options.show_dependencies ? nil : "hiding dependencies",
       options.show_todos ? nil : "hiding todos",
-      options.only_todo_types.empty? ? nil : "only #{limited_sentence(options.only_todo_types)} 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.include_packs ? "including only: #{limited_sentence(options.include_packs)}" : nil,
       options.exclude_packs.empty? ? nil : "excluding pack#{options.exclude_packs.size > 1 ? 's' : ''}: #{limited_sentence(options.exclude_packs)}",
     ].compact.join(', ').strip
     main_title = "#{app_name}: #{focus_info}#{skipped_info != '' ? ' - ' + skipped_info : ''}"
@@ -95,25 +95,19 @@ module VisualizePacks
   sig { params(options: Options, all_package_names: T::Array[String]).returns(T.proc.params(arg0: String, arg1: String).returns(T::Boolean)) }
   def self.show_edge_builder(options, all_package_names)
     return lambda do |start_node, end_node|
+      all_package_names.include?(start_node) && 
+      all_package_names.include?(end_node) && 
       (
-        !options.show_only_edges_to_focus_pack && 
-        all_package_names.include?(start_node) && 
-        all_package_names.include?(end_node)
-      ) ||
-      (
-        options.show_only_edges_to_focus_pack && 
-        all_package_names.include?(start_node) && 
-        all_package_names.include?(end_node) && 
-        (
-          case options.show_only_edges_to_focus_pack
-          when FocusPackEdgeDirection::InOut then
-            match_packs?(start_node, options.focus_pack) || match_packs?(end_node, options.focus_pack)
-          when FocusPackEdgeDirection::In then
-            match_packs?(end_node, options.focus_pack)
-          when FocusPackEdgeDirection::Out then
-            match_packs?(start_node, options.focus_pack)
-          end
-        )
+        case options.show_only_edges_to_focus_pack
+        when FocusPackEdgeDirection::All then
+          true
+        when FocusPackEdgeDirection::InOut then
+          match_packs?(start_node, options.focus_pack) || match_packs?(end_node, options.focus_pack)
+        when FocusPackEdgeDirection::In then
+          match_packs?(end_node, options.focus_pack)
+        when FocusPackEdgeDirection::Out then
+          match_packs?(start_node, options.focus_pack)
+        end
       )
     end
   end
@@ -140,7 +134,7 @@ module VisualizePacks
         todos_by_package&.keys&.each do |todos_to_package|
           todo_types = todos_by_package&& todos_by_package[todos_to_package]&.group_by(&:type)
           todo_types&.keys&.each do |todo_type|
-            if options.only_todo_types.empty? || options.only_todo_types.include?(todo_type)
+            if options.only_todo_types.include?(EdgeTodoTypes.deserialize(todo_type))
               if show_edge.call(package.name, todos_to_package)
                 key = "#{package.name}->#{todos_to_package}:#{todo_type}"
                 todo_counts[key] = todo_types && todo_types[todo_type]&.count
@@ -173,16 +167,14 @@ module VisualizePacks
 
     edge_width = min_width + width_delta
     edge_width.round(2)
- end
+  end
 
- sig { params(packages: T::Array[ParsePackwerk::Package], options: Options).returns(T::Array[ParsePackwerk::Package]) }
- def self.filtered(packages, options)
+  sig { params(packages: T::Array[ParsePackwerk::Package], options: Options).returns(T::Array[ParsePackwerk::Package]) }
+  def self.filtered(packages, options)
     focus_pack = options.focus_pack
-    focus_folder = options.focus_folder 
-    include_packs = options.include_packs 
     exclude_packs = options.exclude_packs
 
-    return packages unless focus_pack.any? || focus_folder || include_packs || exclude_packs.any?
+    return packages unless focus_pack || exclude_packs.any?
 
     nested_packages = all_nested_packages(packages.map { |p| p.name })
 
@@ -194,16 +186,16 @@ 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
         result += packages.select { |p| p.dependencies.any? { |d| match_packs?(d, focus_pack) }}.map { |pack| pack.name }
       end
-      if options.show_todos && [nil, FocusPackEdgeDirection::In, FocusPackEdgeDirection::InOut].include?(options.show_only_edges_to_focus_pack)
+      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.empty? || options.only_todo_types.include?(todo.type)
+            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 }
@@ -212,9 +204,9 @@ module VisualizePacks
         if options.show_dependencies
           result += packages_by_name[p].dependencies
         end
-        if options.show_todos && [nil, FocusPackEdgeDirection::Out, FocusPackEdgeDirection::InOut].include?(options.show_only_edges_to_focus_pack)
+        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.empty? || options.only_todo_types.include?(todo.type)
+            res << todo.to_package_name if options.only_todo_types.include?(EdgeTodoTypes.deserialize(todo.type))
             res
           end
         end
@@ -227,14 +219,6 @@ module VisualizePacks
       result = (result + parent_packs).uniq.compact
     end
 
-    if focus_folder
-      result = result.select { |p| p.include? focus_folder }
-    end
-
-    if include_packs
-      result = result.select { |p| match_packs?(p, include_packs) }
-    end
-
     if exclude_packs.any?
       result = result.reject { |p| match_packs?(p, exclude_packs) }
     end
@@ -316,8 +300,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.15
+  version: 0.5.17
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-05 00:00:00.000000000 Z
+date: 2023-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler