visualize_packs 0.5.2 → 0.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b651191da33d76c72e2acaadb4a782e9435fbcd3b71029d85acec6cee1b2dc27
-  data.tar.gz: a2db3ab7593ef4b2b7dc158d03a11b7b16bb9cebdf389f3cc0d6b78877527b03
+  metadata.gz: 01f6c9f4bc79fee9a854283bdae4b57d12fa2a29fc53c1610765ef137f69dd68
+  data.tar.gz: bfb38e97af2696a7ee295341782905340a1458cc62004cd58b077a3caeb1d514
 SHA512:
-  metadata.gz: 3cb302b60a78824b60664e8f93792ff4e94e18243ea32a931d4859496227024150a2512911484fab3aa0b54f71cda4a0fc9ccf819b6aa15945e7feda3a2ef639
-  data.tar.gz: f2593b3863520c7ca7c5ed79b1ef24c8821c1aa04f60908f660c31a79045782236f50b5906353a8741415f7f82d8f128a0b48fbd6eaeee76ab7bb8775405b857
+  metadata.gz: 39ee40c6a79f5c883ee1f14ebe9c964fedb65281aadf7ee43163f07a3f9e8f1401379baaf4efd0ccaedb7593d7ab18e28ff8d743e076da6a0028844b2180bb47
+  data.tar.gz: '0997b1cdf11c0095cb2a0bc00ba0dcd04b9ce58a1aff50b9fd106181806d0be3f36df316111946a2c1719014899043c173216dea0f4bd3301f99fdb5d1d6f368'

data/README.md

@@ -31,17 +31,20 @@ bundle exec visualize_packs --help
 
 ## What outputs look like
 
-![Sample diagrams produced](https://github.com/shageman/visualize_packs/blob/main/diagram_examples.png?raw=true)
+![Sample diagrams produced](https://github.com/rubyatscale/visualize_packs/blob/main/diagram_examples.png?raw=true)
 
 ## Contributing
 
-To contribute, install graphviz (and the `dot` command). You must also have Ruby 3.2.2 and bundler installed. Then
+To contribute, install graphviz (and the `dot` command) and imagemagick. You must also have Ruby 3.2.2 and bundler installed. Then
 
 ```
-cd spec
-./test.sh
+./spec/test.sh
 ```
 
-Then, in `spec/sample_app` visually compare all `X.png` to `X_new.png` to make sure you are happy with the changes. If you, are, run `./update_cassettes.sh` in the same folder and commit the new test files with your changes.
+At the end of the test run, a new window will open up showing you a comparison of the old graphs (on the left) and the new graphs (on the right). Compare the visuals to make sure you're getting the changes you were expecting.
 
-If you have imagemagick installed, you can then also run `./create_comparison.sh` to create one big image of all the before (left) and after (right) versions of the sample diagrams.
+Once you are ready, run the following and commit the new `diagram_examples.png` and the new dot files with your changes:
+
+```
+./spec/update_cassettes.sh
+```

data/bin/visualize_packs

@@ -11,19 +11,22 @@ require_relative '../lib/options'
 options = Options.new
 
 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('--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('--focus-on=PACKAGE', "Don't show privacy enforcement") { |o| options.focus_package = o }
+  opt.on('--focus-on=PACKAGE', "Focus on a specific package") { |o| options.focus_package = o }
   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('--roll_nested_todos_into_top_level', "Don't show nested packages (not counting root). Connect edges to top-level package instead") { |o| options.roll_nested_todos_into_top_level = true }
   opt.on('--focus_folder=FOLDER', "Draw package diagram only for packages in FOLDER") { |o| options.focus_folder = o }
   opt.on('--no_nested_relationships', "Don't draw nested package relationships") { |o| options.show_nested_relationships = false }
 
+  opt.on('--exclude-packs=pack1,pack2,etc', "Exclude these packs from diagram") { |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_tail("-h", "--help", "Show this message") do

data/lib/graph.dot.erb

@@ -118,28 +118,30 @@ digraph package_diagram {
     <%- end -%>
   <%- end -%>
 <%- end -%>
-  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"]
-    C [ fontsize=12 shape=box label="package"]
-    D [ fontsize=12 shape=box label="package"]
-    E [ fontsize=12 shape=box label="package"]
-    F [ fontsize=12 shape=box label="package"]
-    G [ fontsize=12 shape=box label="package"]
-    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]
-    C -> D [label="privac 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]
-  }
+  <%- 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"]
+      C [ fontsize=12 shape=box label="package"]
+      D [ fontsize=12 shape=box label="package"]
+      E [ fontsize=12 shape=box label="package"]
+      F [ fontsize=12 shape=box label="package"]
+      G [ fontsize=12 shape=box label="package"]
+      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]
+      C -> D [label="privac 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 != [] -%>
   subgraph cluster_teams_legend {
     fontsize=16
@@ -157,6 +159,8 @@ digraph package_diagram {
       <%- end %>
     <%- end -%>
   }
-  J -> "<%= all_team_names.last %><%= all_team_names.last %>" [style=invis]
+  <%- if options.show_legend -%>
+    J -> "<%= all_team_names.last %><%= all_team_names.last %>" [style=invis]
+  <%- end -%>
   <%- end -%>
 }

data/lib/options.rb

@@ -4,6 +4,7 @@
 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
@@ -17,5 +18,7 @@ class Options < T::Struct
   prop :focus_folder, T.nilable(String)
   prop :show_nested_relationships, T::Boolean, default: true
 
+  prop :exclude_packs, T::Array[String], default: []
+
   prop :remote_base_url, T.nilable(String)
 end

data/lib/visualize_packs.rb

@@ -11,7 +11,7 @@ module VisualizePacks
   def self.package_graph!(options, raw_config, packages)
     raise ArgumentError, "Package #{options.focus_package} does not exist. Found packages #{packages.map(&:name).join(", ")}" if options.focus_package && !packages.map(&:name).include?(options.focus_package)
 
-    all_packages = filtered(packages, options.focus_package, options.focus_folder).sort_by {|x| x.name }
+    all_packages = filtered(packages, options.focus_package, options.focus_folder, options.exclude_packs).sort_by {|x| x.name }
     all_package_names = all_packages.map &:name
 
     all_packages = remove_nested_packs(all_packages) if options.roll_nested_todos_into_top_level
@@ -58,6 +58,7 @@ module VisualizePacks
     focus_info = options.focus_package || options.focus_folder ? "Focus on #{[options.focus_package, options.focus_folder].compact.join(' and ')} (#{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",
@@ -65,6 +66,7 @@ module VisualizePacks
       options.show_teams ? nil : "hiding teams",
       options.roll_nested_todos_into_top_level ? "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' : ''}: #{exclude_packs_info(options.exclude_packs)}",
     ].compact.join(', ').strip
     main_title = "#{app_name}: #{focus_info}#{skipped_info != '' ? ' - ' + skipped_info : ''}"
     sub_title = ""
@@ -74,6 +76,17 @@ module VisualizePacks
     "<<b>#{main_title}</b>#{sub_title}>"
   end
 
+  def self.exclude_packs_info(exclude_packs)
+    case exclude_packs.size
+    when 1
+      exclude_packs.first
+    when 2
+      exclude_packs.join(" and ")
+    else
+      "#{exclude_packs[0, 2].join(", ")}, and #{exclude_packs.size - 2} more."
+    end
+  end
+
   def self.show_edge_builder(options, all_package_names)
     return lambda do |start_node, end_node|
       (
@@ -120,8 +133,8 @@ module VisualizePacks
     violation_counts.values.max
   end
 
-  def self.filtered(packages, filter_package, filter_folder)
-    return packages unless filter_package || filter_folder
+  def self.filtered(packages, filter_package, filter_folder, exclude_packs)
+    return packages unless filter_package || filter_folder || exclude_packs.any?
 
     result = packages.map { |pack| pack.name }
 
@@ -138,6 +151,10 @@ module VisualizePacks
       result = result.select { |p| p.include? filter_folder }
     end
 
+    if exclude_packs.any?
+      result = result.reject { |p| exclude_packs.include? p }
+    end
+
     result.map { |pack_name| ParsePackwerk.find(pack_name) }
   end
 

metadata

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