Folder visibility added (#58)

* Less is more for integration tests

* Fix “no to all” integration test

* Move optionsparser into its own class

* Always output all parameters

* Handle nested_visibility

* Better violation distribution in sample app

* When showing custom title, don’t show command line params

* FolderVisibility as new name

* Updated diagrams

* Bump version

* Update diagram

Author: shageman

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    visualize_packs (0.5.21)
+    visualize_packs (0.5.22)
       packs-specification
       parse_packwerk (>= 0.20.0)
       sorbet-runtime

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) }
 )

diagram_examples.png

@@ -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="visibile to" <%= VisualizePacks::ArrowHead::ConfiguredVisibileTo.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 ]

lib/graph.dot.erb

@@ -7,6 +7,7 @@
 require 'digest/md5'
 
 require 'visualize_packs/options'
+require 'visualize_packs/options_parser'
 
 module VisualizePacks
   extend T::Sig
@@ -17,14 +18,17 @@ class ArrowHead < T::Enum
       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')
       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 @@ def self.package_graph!(options, raw_config, packages)
     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 @@ def self.code_owner(package)
     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 @@ def self.diagram_title(options, max_todo_count)
     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)) }

lib/visualize_packs.rb

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

lib/visualize_packs/options.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
+

lib/visualize_packs/options_parser.rb

@@ -13,22 +13,10 @@ URL="--remote-base-url=https://github.com/rubyatscale/visualize_packwerk/tree/ma
 declare -a test_names # To keep the list of tests in the defined order
 declare -A test_params # To map test names to command parameters
 
-test_names+=("plain"); test_params[${test_names[-1]}]=""
-
-test_names+=("no_legend"); test_params[${test_names[-1]}]="--no-legend"
-test_names+=("no_layers"); test_params[${test_names[-1]}]="--no-layers"
-test_names+=("no_teams"); test_params[${test_names[-1]}]="--no-teams"
-
-test_names+=("no_dependencies"); test_params[${test_names[-1]}]="--no-dependency-arrows --use-edge-todos-for-layout"
-test_names+=("no_todos"); test_params[${test_names[-1]}]="--no-todo-edges"
-test_names+=("no_privacy"); test_params[${test_names[-1]}]="--no-privacy-boxes --no-node-todos"
-test_names+=("no_nested"); test_params[${test_names[-1]}]="--no-nesting-arrows"
-test_names+=("no_visibility"); test_params[${test_names[-1]}]="--no-visibility-arrows"
-
-test_names+=("relationship_todo_types"); test_params[${test_names[-1]}]="--edge-todo-types=architecture,visibility"
+test_names+=("plain"); test_params[${test_names[-1]}]="--title='custom title: Without options'"
+test_names+=("no_to_all"); test_params[${test_names[-1]}]="--title='custom title: Hide everything' --no-node-todos --no-legend --no-layers --no-visibility --no-dependency-arrows --no-todo-edges --no-privacy-boxes --no-teams --no-nesting-arrows"
+test_names+=("relationship_todo_types"); test_params[${test_names[-1]}]="--title='Show only architecture and visibility todos' --edge-todo-types=architecture,visibility"
 test_names+=("roll_nested_into_parent_packs"); test_params[${test_names[-1]}]="--roll-nested-into-parent-packs"
-test_names+=("only_layers"); test_params[${test_names[-1]}]="--no-dependency-arrows --no-todo-edges --no-privacy-boxes --no-teams --no-nesting-arrows"
-test_names+=("no_to_all"); test_params[${test_names[-1]}]="--title='Hide everything' --no-layers --no-visibility --no-dependency-arrows --no-todo-edges --no-privacy-boxes --no-teams --no-nesting-arrows"
 test_names+=("focussed_on_packs_ui"); test_params[${test_names[-1]}]="--focus-pack=packs/ui"
 test_names+=("focussed_on_packs_ui_focus_edges"); test_params[${test_names[-1]}]="--focus-pack=packs/ui --focus-pack-edge-mode=inout"
 test_names+=("focussed_on_packs_ui_focus_edges_in"); test_params[${test_names[-1]}]="--focus-pack=packs/ui --focus-pack-edge-mode=in"

spec/diagram_generation_helper.sh

@@ -1,7 +1,7 @@
 PATH
   remote: ../..
   specs:
-    visualize_packs (0.5.21)
+    visualize_packs (0.5.22)
       packs-specification
       parse_packwerk (>= 0.20.0)
       sorbet-runtime

spec/sample_app1/Gemfile.lock

@@ -0,0 +1,20 @@
+# This file contains a list of dependencies that are not part of the long term plan for the
+# '.' package.
+# We should generally work to reduce this list over time.
+#
+# You can regenerate this file using the following command:
+#
+# bin/packwerk update-todo
+---
+packs/ui:
+  "::SomeClass1":
+    violations:
+    - dependency
+    files:
+    - file_b
+packs/models/packs/model_a:
+  "::SomeClass1":
+    violations:
+    - dependency
+    files:
+    - file_b