visualize_packs 0.5.15 → 0.5.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a1fb5d4a88ec1f052663cae4ae4b356fddc90ad34ffef47e241a1b35d13da66
-  data.tar.gz: bbc12cc3b7a7fb6bbf015569f38fa7f2ba6928b0c07f6dfbe5d80551674507c8
+  metadata.gz: a3844051eddac8142057acc5912277e386450da923f96714d7ab2f4b664d75ee
+  data.tar.gz: 646315741ca5d8706de1a8397948e231b04295b6513bd4a0cf69d943a546c41b
 SHA512:
-  metadata.gz: 3124d697f0ecedc3dfc8c0d82cf5125c9886dc7691eff89ca75ba2c61ea8af05aa6ee16efe6c4b6e38c927b762cb99d7b8ae00db1f19d55fcfd94d40ede16f8b
-  data.tar.gz: 83a3ee2ca08dc704642a48bdf00b05e6b96f108e9c8e9034e6aa46ceb5d2a8dbda757980a65cec3cc3fa041b16fa6742a7ec3cb3034b1e18d0847388c8f1f96d
+  metadata.gz: 5d8a1125327c319356a386ef1dfa5efe5fadb94a848d36e465d0a3bebd356f4597bc3db2e67ae35c2c54c7668f968e793dcb11457a1e1fd8f4b7b50bc12d39a8
+  data.tar.gz: 0f066a5bf9897d8a5a495ee6f9f6bcc1aacb1ea0e6c00e5422cc8470c6308c5fe9d0b665847c67b0a1d1d8b453362777917cded5395173b812e34638de7526db

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-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-dependency-arrows', "Don't show accepted dependencies") { |o| options.show_dependencies = 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-privacy-boxes', "Don't show privacy enforcement box on a pack") { |o| options.show_privacy = 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('--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('--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('--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=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

@@ -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) -%>

data/lib/visualize_packs/options.rb

@@ -1,8 +1,19 @@
 # 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
+    None = new
+    All = new
     In = new
     Out = new
     InOut = new
@@ -16,19 +27,17 @@ class Options < T::Struct
   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 :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_folder, T.nilable(String)
   prop :focus_pack, T::Array[String], default: []
-  prop :show_only_edges_to_focus_pack, T.nilable(FocusPackEdgeDirection), default: nil
+  prop :show_only_edges_to_focus_pack, FocusPackEdgeDirection, default: FocusPackEdgeDirection::All
 
   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,19 @@ 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.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"
     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.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 +94,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 +133,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 +166,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.any? || exclude_packs.any?
 
     nested_packages = all_nested_packages(packages.map { |p| p.name })
 
@@ -200,10 +191,10 @@ module VisualizePacks
       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 +203,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 +218,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

metadata

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