visualize_packs 0.5.11 → 0.5.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c97e3f2997e104fa0359775892adfb5e8cc40d22a85d886bf0f8a1d608398a8
-  data.tar.gz: 7b933103509243b81126bc29cd193daf9536a46860d36ad40f1d988df29d77b3
+  metadata.gz: fd8d04886b359c5fe0ee721ba30aa63a82cf15cbbd49f4f22aae9bb122d746da
+  data.tar.gz: f3e546e753e571226f782fe8aa2ae9cbee845c3629964cd8eedaf1527fc77f90
 SHA512:
-  metadata.gz: 0e0c1ca8ea26ee9cbd57b3e4066960868ea9362de4bae5fad1517481376ba8f3dd476ff8ad1f43c186d9b9c9d291a7332c203b877e37d5e9d6e07f4277d70899
-  data.tar.gz: 632e641dc9e1c45dd744bf9d09bff3cc9723138bc8eb27c1d6771afdc51ad3aef2de988801420b64a1c7f27155fb530fcbfe66cd3c4c65e7eb3b4c6de5e220e6
+  metadata.gz: 23b4d5aeb2ac339bb16a731d66733b47dd4d3583adbd099064a3bcd2c2cd77d56ded62cd64128cf7e992108227f91fa32667622e461e42ed49dcee60cf16fc7d
+  data.tar.gz: 3c07f47b89313c37d062550289ca28591a0d2a2023c7fb3f23f401a27710cad28eff6df42775108429af7193374088d0ad9c690599c64c2ad8b0352e921c076c

data/README.md

@@ -48,3 +48,5 @@ Once you are ready, run the following and commit the new `diagram_examples.png`
 ```
 ./spec/update_cassettes.sh
 ```
+
+Please check in a new `diagram_examples.png` only if there are actual visual changes.

data/bin/visualize_packs

@@ -33,8 +33,8 @@ OptionParser.new do |opt|
   opt.on('--no-teams', "Don't show team colors") { |o| options.show_teams = 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_package = o.to_s.split(",") }
-  opt.on('--only-edges-to-focus', "If focus is set, this shows only the edges to/from the focus node instead of all edges in the focussed graph. This only has effect when --focus-on is set.") { |o| options.show_only_edges_to_focus_package = true }
+  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('--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 }

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_package.any? && options.focus_package.any? {|p| File.fnmatch(p, package.name)} ? 18.0 : 12.0 -%>
+            fontsize=<%= options.focus_pack.any? && 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 %>

data/lib/options.rb

@@ -1,6 +1,14 @@
 # frozen_string_literal: true
 # typed: strict
 
+class FocusPackEdgeDirection < T::Enum
+  enums do
+    In = new
+    Out = new
+    InOut = new
+  end
+end
+
 class Options < T::Struct
   extend T::Sig
 
@@ -12,11 +20,11 @@ class Options < T::Struct
   prop :show_privacy, T::Boolean, default: true
   prop :show_teams, T::Boolean, default: true
 
-  prop :focus_package, T::Array[String], default: []
-  prop :show_only_edges_to_focus_package, T::Boolean, default: false
+  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 :roll_nested_into_parent_packs, T::Boolean, default: false
-  prop :focus_folder, T.nilable(String)
   prop :show_nested_relationships, T::Boolean, default: true
 
   prop :exclude_packs, T::Array[String], default: []

data/lib/visualize_packs.rb

@@ -12,13 +12,12 @@ module VisualizePacks
   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 }
-    all_package_names = all_packages.map &:name
-
     all_packages = remove_nested_packs(all_packages, options)
+    all_package_names = all_packages.map &:name
 
     show_edge = show_edge_builder(options, all_package_names)
     node_color = node_color_builder()
-    max_todo_count = max_todo_count(all_packages, show_edge)
+    max_todo_count = max_todo_count(all_packages, show_edge, options)
 
     title = diagram_title(options, max_todo_count)
 
@@ -56,8 +55,8 @@ 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_package.any? && options.show_only_edges_to_focus_package ? "showing only edges to/from focus pack" : "showing all edges between visible packs"
-    focus_info = options.focus_package.any? || options.focus_folder ? "Focus on #{[limited_sentence(options.focus_package), 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 ? "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"
     skipped_info = 
     [
       options.show_legend ? nil : "hiding legend",
@@ -95,17 +94,23 @@ module VisualizePacks
   def self.show_edge_builder(options, all_package_names)
     return lambda do |start_node, end_node|
       (
-        !options.show_only_edges_to_focus_package && 
+        !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_package && 
+        options.show_only_edges_to_focus_pack && 
         all_package_names.include?(start_node) && 
         all_package_names.include?(end_node) && 
         (
-          match_packs?(start_node, options.focus_package) ||
-          match_packs?(end_node, options.focus_package)
+          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
         )
       )
     end
@@ -124,17 +129,21 @@ module VisualizePacks
     end
   end
 
-  sig { params(all_packages: T::Array[ParsePackwerk::Package], show_edge: T.proc.params(arg0: String, arg1: String).returns(T::Boolean)).returns(T.nilable(Integer)) }
-  def self.max_todo_count(all_packages, show_edge)
+  sig { params(all_packages: T::Array[ParsePackwerk::Package], show_edge: T.proc.params(arg0: String, arg1: String).returns(T::Boolean), options: Options).returns(T.nilable(Integer)) }
+  def self.max_todo_count(all_packages, show_edge, options)
     todo_counts = {}
-    all_packages.each do |package|
-      todos_by_package = package.violations&.group_by(&:to_package_name)
-      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 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
+    if options.show_todos
+      all_packages.each do |package|
+        todos_by_package = package.violations&.group_by(&:to_package_name)
+        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 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
+              end
+            end
           end
         end
       end
@@ -164,12 +173,12 @@ module VisualizePacks
 
  sig { params(packages: T::Array[ParsePackwerk::Package], options: Options).returns(T::Array[ParsePackwerk::Package]) }
  def self.filtered(packages, options)
-    focus_package = options.focus_package
+    focus_pack = options.focus_pack
     focus_folder = options.focus_folder 
     include_packs = options.include_packs 
     exclude_packs = options.exclude_packs
 
-    return packages unless focus_package.any? || focus_folder || include_packs || exclude_packs.any?
+    return packages unless focus_pack.any? || focus_folder || include_packs || exclude_packs.any?
 
     nested_packages = all_nested_packages(packages.map { |p| p.name })
 
@@ -181,12 +190,12 @@ module VisualizePacks
     result = T.let([], T::Array[T.nilable(String)])
     result = packages.map { |pack| pack.name }
 
-    if !focus_package.empty?
+    if !focus_pack.empty?
       result = []
-      result += packages.map { |pack| pack.name }.select { |p| match_packs?(p, focus_package) }
-      result += packages.select{ |p| p.dependencies.any? { |d| match_packs?(d, focus_package) }}.map { |pack| pack.name }
-      result += packages.select{ |p| p.violations&.map(&:to_package_name)&.any? { |v| match_packs?(v, focus_package) }}.map { |pack| pack.name }
-      packages.map { |pack| pack.name }.select { |p| match_packs?(p, focus_package) }.each do |p|
+      result += packages.map { |pack| pack.name }.select { |p| match_packs?(p, focus_pack) }
+      result += packages.select{ |p| p.dependencies.any? { |d| match_packs?(d, focus_pack) }}.map { |pack| pack.name }
+      result += packages.select{ |p| p.violations&.map(&:to_package_name)&.any? { |v| match_packs?(v, focus_pack) }}.map { |pack| pack.name }
+      packages.map { |pack| pack.name }.select { |p| match_packs?(p, focus_pack) }.each do |p|
         result += packages_by_name[p].dependencies
         result += packages_by_name[p].violations.map(&:to_package_name)
       end

metadata

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