visualize_packs 0.5.21 → 0.5.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72b6b3b6121cd9e3a2f30a4b927882be78fab2bbff55d2168100552cdf5b8276
-  data.tar.gz: 2281e4d89e00c73e18ed025b8b636d2cbafef28addc4955ff4f82ea22ddc442d
+  metadata.gz: 0e0cfe73d505dcc80ec3792514b251aa3320c5e7c9703c071202bf1c384ca77a
+  data.tar.gz: 0bff429e62083b1a193ddaeb15c443568363ac5400d22b06e5d220e38aea2b90
 SHA512:
-  metadata.gz: 3b9affb4f63a85e56125c00e412373d60c705f793c8da118d0e11899b1dcff0e143cade00d4d2562d23d075e3f2a58d9be594cc751e6ee67038a5d591e6c1c27
-  data.tar.gz: e99623cfaaa59016939a675a500f12357da8401d2fb3ac6e87c37b1a1f861c5976665e59e830f2fc44fe38c33e7cc6926721e264a9516e2dd57df20e1bff95dc
+  metadata.gz: cd23c6aa9d40fc57d4b0272af1046c7a289062a27c809b78ef121c239b53347f7dee5e3ccd7afbebca49d25697ee01da6de9b92864c83d0524f1f3a394b8f0f3
+  data.tar.gz: d394fdfb12da6cb44fa0401aa33f17e9fcfcb801b201a485c92683260f5bb17be66054d7361bc01c95dea5bcb82e136d1da1c09040a43bf053ddc403521e1738

data/README.md

@@ -1,9 +1,11 @@
 # visualize_packs
+
 Visualize_packs helps you visualize the structure, intended and actual, of your package-based Ruby application.
 
 This gem takes a minimal approach in that it only outputs a graph in the format of [graphviz](https://graphviz.org/)' [dot language](https://graphviz.org/doc/info/lang.html). Install graphviz and use one of the chains of commands from below to generate full or partial images of the graphs of your application.
 
 ## Visualize your entire application
+
 ```
 bundle exec visualize_packs > packs.dot && dot packs.dot -Tpng -o packs.png && open packs.png
 ```
@@ -13,16 +15,15 @@ bundle exec visualize_packs > packs.dot && dot packs.dot -Tpng -o packs.png && o
 This will generate a local dependency diagram for every pack in your app
 
 ```
-find . -iname 'package.yml' | sed 's/\/package.yml//g' | sed 's/\.\///' | xargs -I % sh -c "bundle exec visualize_packs --only=% > %/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 --focus-pack=% > %/packs.dot && dot %/packs.dot -Tpng -o %/packs.png"
 ```
 
 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=% --focus-pack-edge-mode=inout > %/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 --focus-pack=% --focus-pack-edge-mode=inout > %/packs.dot && dot %/packs.dot -Tpng -o %/packs.png"
 ```
 
-
 ## Get help
 
 ```
@@ -49,4 +50,4 @@ 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.
+Please check in a new `diagram_examples.png` only if there are actual visual changes.

data/bin/visualize_packs

@@ -1,55 +1,10 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require "pathname"
-require "optparse"
-require "ostruct"
-
 require_relative '../lib/visualize_packs'
 
-options = Options.new
-
-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-visibility-arrows', "Don't show visibility arrows") { |o| options.show_visibility = false }
-
-  opt.on('--no-todo-edges', "Don't show todos for package relationships") { |o| options.show_relationship_todos = false }
-  opt.on("--edge-todo-types=STRING", "Show only the selected types of relationship todos. Comma-separated list of #{EdgeTodoTypes.values.map &:serialize}") { |o| options.relationship_todo_types = o.to_s.split(",").uniq.map { EdgeTodoTypes.deserialize(_1) } }
-  opt.on("--use-edge-todos-for-layout", "Show only the selected types of relationship todos. Comma-separated list of #{EdgeTodoTypes.values.map &:serialize}") { |o| options.use_relationship_todos_for_layout = true }
-
-  opt.on('--no-teams', "Don't show team colors") { |o| options.show_teams = false }
-  opt.on('--no-node-todos', "Don't show package-based todos") { |o| options.show_node_todos = false }
-
-  opt.on('--focus-pack=STRING', "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=STRING', "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('--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=STRING', "Link pack packs to a URL (affects graphviz SVG generation)") { |o| options.remote_base_url = o }
-
-  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
-  end
-end.parse!
-
 puts VisualizePacks.package_graph!(
-  options, 
+  ARGV, 
   ParsePackwerk::Configuration.fetch.raw, 
   Packs.all.map { ParsePackwerk.find(_1.name) }
 )

data/lib/graph.dot.erb

@@ -105,6 +105,8 @@ digraph package_diagram {
                 <%= VisualizePacks::ArrowHead::ArchitectureTodo.serialize %>
               <%- elsif todo_type == 'visibility' -%>
                 <%= VisualizePacks::ArrowHead::VisibilityTodo.serialize %>
+              <%- elsif todo_type == 'folder_visibility' -%>
+                <%= VisualizePacks::ArrowHead::FolderVisibilityTodo.serialize %>
               <%- elsif todo_type == 'dependency' -%>
                 <%= VisualizePacks::ArrowHead::DependencyTodo.serialize %>
               <%- end -%>
@@ -141,14 +143,14 @@ digraph package_diagram {
       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 %>]
+      M -> N [label="nested package" <%= VisualizePacks::ArrowHead::ConfiguredNested.serialize %>]
+      <%- end -%>
+      <%- if options.show_visibility -%>
+      O [ fontsize=12 shape=box label="package"]
+      P [ fontsize=12 shape=box label="package"]
+      O -> P [label="visible to" <%= VisualizePacks::ArrowHead::ConfiguredVisibleTo.serialize %>]
       <%- end -%>
       <%- if options.show_relationship_todos -%>
         <%- if options.relationship_todo_types.include?(EdgeTodoTypes::Privacy) -%>
@@ -166,10 +168,15 @@ digraph package_diagram {
       H [ fontsize=12 shape=box label="package"]
       G -> H [label="visibility todo" <%= VisualizePacks::ArrowHead::VisibilityTodo.serialize %>]
         <%- end -%>
-        <%- if options.relationship_todo_types.include?(EdgeTodoTypes::Dependency) -%>
+        <%- if options.relationship_todo_types.include?(EdgeTodoTypes::Folder_Visibility) -%>
       I [ fontsize=12 shape=box label="package"]
       J [ fontsize=12 shape=box label="package"]
-      I -> J [label="dependency todo" <%= VisualizePacks::ArrowHead::DependencyTodo.serialize %>]
+      I -> J [label="folder visibility todo" <%= VisualizePacks::ArrowHead::FolderVisibilityTodo.serialize %>]
+        <%- end -%>
+        <%- if options.relationship_todo_types.include?(EdgeTodoTypes::Dependency) -%>
+      K [ fontsize=12 shape=box label="package"]
+      L [ fontsize=12 shape=box label="package"]
+      K -> L [label="dependency todo" <%= VisualizePacks::ArrowHead::DependencyTodo.serialize %>]
         <%- end -%>
       <%- end -%>
       LEGEND_NODE_1 [ label="" peripheries=0 height=0 width=0 style=invis ]
@@ -198,4 +205,4 @@ digraph package_diagram {
     LEGEND_NODE_2 -> "<%= all_team_names.last %><%= all_team_names.last %>" [style=invis]
   <%- end -%>
   <%- end -%>
-}
+}

data/lib/visualize_packs/options.rb

@@ -7,6 +7,7 @@ class EdgeTodoTypes < T::Enum
     Privacy = new
     Architecture = new
     Visibility = new
+    Folder_Visibility = new
   end
 end
 

data/lib/visualize_packs/options_parser.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+#typed: strict
+
+require "optparse"
+
+class OptionsParser
+  extend T::Sig
+
+  sig { params(args: T::Array[String]).returns(Options) }
+  def self.parse(args)
+    options = Options.new
+
+    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-visibility-arrows', "Don't show visibility arrows") { |o| options.show_visibility = false }
+
+      opt.on('--no-todo-edges', "Don't show todos for package relationships") { |o| options.show_relationship_todos = false }
+      opt.on("--edge-todo-types=STRING", "Show only the selected types of relationship todos. Comma-separated list of #{EdgeTodoTypes.values.map &:serialize}") { |o| options.relationship_todo_types = o.to_s.split(",").uniq.map { EdgeTodoTypes.deserialize(_1) } }
+      opt.on("--use-edge-todos-for-layout", "Show only the selected types of relationship todos. Comma-separated list of #{EdgeTodoTypes.values.map &:serialize}") { |o| options.use_relationship_todos_for_layout = true }
+
+      opt.on('--no-teams', "Don't show team colors") { |o| options.show_teams = false }
+      opt.on('--no-node-todos', "Don't show package-based todos") { |o| options.show_node_todos = false }
+
+      opt.on('--focus-pack=STRING', "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=STRING', "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('--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=STRING', "Link pack packs to a URL (affects graphviz SVG generation)") { |o| options.remote_base_url = o }
+
+      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
+      end
+    end.parse(args)
+
+    options
+  end
+end
+

data/lib/visualize_packs.rb

@@ -7,6 +7,7 @@ require 'parse_packwerk'
 require 'digest/md5'
 
 require 'visualize_packs/options'
+require 'visualize_packs/options_parser'
 
 module VisualizePacks
   extend T::Sig
@@ -17,14 +18,17 @@ module VisualizePacks
       PrivacyTodo = new('color=darkred style=dashed arrowhead=crow')
       ArchitectureTodo = new('color=darkred style=dashed arrowhead=obox')
       VisibilityTodo = new('color=darkred style=dashed arrowhead=tee')
+      FolderVisibilityTodo = new('color=darkred style=dashed arrowhead=odot')
       ConfiguredDependency = new('color=darkgreen')
-      ConfiguredVisibileTo = new('color=blue')
+      ConfiguredVisibleTo = 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)
+  sig { params(args: T::Array[String], raw_config: T::Hash[String, T.untyped], packages: T::Array[ParsePackwerk::Package]).returns(String) }
+  def self.package_graph!(args, raw_config, packages)
+    options = OptionsParser.parse(args)
+
     all_packages = filtered(packages, options).compact.sort_by {|x| x.name }
     all_packages = remove_nested_packs(all_packages, options)
     all_package_names = all_packages.map &:name
@@ -34,7 +38,7 @@ module VisualizePacks
     node_protection = package_based_todos_text_maker()
     max_todo_count = max_todo_count(all_packages, show_edge, options)
 
-    title = diagram_title(options, max_todo_count)
+    title = diagram_title(args, options, max_todo_count)
 
     architecture_layers = (raw_config['architecture_layers'] || []) + ["NotInLayer"]
     grouped_packages = architecture_layers.inject({}) do |result, key|
@@ -67,10 +71,24 @@ module VisualizePacks
     package.config.dig("metadata", "owner") || package.config["owner"]
   end
 
-  sig { params(options: Options, max_todo_count: T.nilable(Integer)).returns(String) }
-  def self.diagram_title(options, max_todo_count)
+  sig { params(args: T::Array[String], options: Options, max_todo_count: T.nilable(Integer)).returns(String) }
+  def self.diagram_title(args, options, max_todo_count)
     return "<<b>#{options.title}</b>>" if options.title
 
+    sub_title1_length = 0
+    options_to_display = args.inject('') do |result, item|
+      sub_title1_length += item.length
+      if sub_title1_length > 90
+        sub_title1_length = 0
+        result += "<br/>#{item}"
+      else
+        result += " #{item}"
+      end
+      result
+    end
+    sub_title1 = "<br/>#{options_to_display}"
+
+
     focus_info = if options.focus_pack
       "Focus on #{limited_sentence(options.focus_pack)} (Edge mode: #{options.show_only_edges_to_focus_pack.serialize})"
     else 
@@ -98,9 +116,9 @@ module VisualizePacks
     main_title = [focus_info, hidden_aspects_title, todo_types, exclusions].compact.join('. ')
 
     if options.show_relationship_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>"
+      sub_title2 = "<br/><font point-size='12'>Widest todo edge is #{max_todo_count} todo#{max_todo_count > 1 ? 's' : ''}</font>"
     end
-    "<<b>#{main_title}</b>#{sub_title}>"
+    "<<b>#{main_title}</b>#{sub_title1}#{sub_title2}>"
   end
 
   sig { params(list: T.nilable(T::Array[String])).returns(T.nilable(String)) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: visualize_packs
 version: !ruby/object:Gem::Version
-  version: 0.5.21
+  version: 0.5.23
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-27 00:00:00.000000000 Z
+date: 2023-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -122,6 +122,7 @@ files:
 - lib/graph.dot.erb
 - lib/visualize_packs.rb
 - lib/visualize_packs/options.rb
+- lib/visualize_packs/options_parser.rb
 homepage: https://github.com/rubyatscale/visualize_packs
 licenses:
 - MIT