Allow setting of custom title (#52)

* Make OptionParser enforce required parameter options

* Allow setting of custom title

* Bump gem version

Author: shageman

Gemfile.lock

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

bin/visualize_packs

@@ -18,19 +18,21 @@ OptionParser.new do |opt|
   opt.on('--no-visibility-arrows', "Don't show visibility arrows") { |o| options.show_visibility = false }
 
   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("--only-todo-types=STRING", "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("--use-todos-for-layout", "Show only the selected types of todos. Comma-separated list of #{EdgeTodoTypes.values.map &:serialize}") { |o| options.use_todos_for_layout = true }
 
   opt.on('--no-teams', "Don't show team colors") { |o| options.show_teams = false }
 
-  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('--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=', "Link pack packs to a URL (affects graphviz SVG generation)") { |o| options.remote_base_url = o }
+  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_tail("-h", "--help", "Show this message") do
     puts opt

diagram_examples.png

@@ -56,6 +56,8 @@ def self.code_owner(package)
 
   sig { params(options: Options, max_todo_count: T.nilable(Integer)).returns(String) }
   def self.diagram_title(options, max_todo_count)
+    return "<<b>#{options.title}</b>>" if options.title
+
     app_name = File.basename(Dir.pwd)
     focus_edge_info = options.focus_pack && 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 ? "Focus on #{limited_sentence(options.focus_pack)} (#{focus_edge_info})" : "All packs"

lib/visualize_packs.rb

@@ -44,4 +44,6 @@ class Options < T::Struct
   prop :show_nested_relationships, T::Boolean, default: true
 
   prop :remote_base_url, T.nilable(String)
+
+  prop :title, T.nilable(String), default: nil
 end

lib/visualize_packs/options.rb

@@ -28,7 +28,7 @@ test_names+=("no_visibility"); test_params[${test_names[-1]}]="--no-visibility-a
 test_names+=("only_todo_types"); test_params[${test_names[-1]}]="--only-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-arrows --no-privacy --no-teams --no-nesting-arrows"
-test_names+=("no_to_all"); test_params[${test_names[-1]}]="--no-layers --no-dependency-arrows --no-todo-arrows --no-privacy --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-arrows --no-privacy --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"
 
@@ -40,7 +40,7 @@ test_names+=("focussed_on_packs_ui_focus_edges"); test_params[${test_names[-1]}]
 for test in "${test_names[@]}"; do
   params=${test_params[$test]}
   echo "Testing $test: $params"
-  bundle exec visualize_packs $params $URL > test_output/$test$NEW.dot
+  bundle exec "visualize_packs ${params} $URL" > test_output/$test$NEW.dot
 done
 
 if [ "$GENERATE_PNGS" = "GENERATE_PNGS" ]; then

spec/diagram_generation_helper.sh

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

spec/sample_app1/Gemfile.lock

@@ -5,7 +5,7 @@ digraph package_diagram {
     fontname="Helvetica,Arial,sans-serif"
     dpi=100
     layout=dot
-    label=<<b>sample_app1: All packs - hiding layers, hiding dependencies, hiding todos, hiding privacy, hiding teams, hiding nested relationships</b>>
+    label=<<b>Hide everything</b>>
     fontsize=18
   ]
   node [
@@ -105,7 +105,6 @@ digraph package_diagram {
           ]
 
     }
-        "packs/models/packs/model_a" -> "packs/models" [ color=blue constraint=false ]
     subgraph cluster_legend {
       fontsize=16
       label="Edges Styles and Arrow Heads"

spec/sample_app1/test_output/no_to_all.dot

@@ -594,4 +594,57 @@
       end
     end
   end
+
+  describe '.diagram_title' do
+    context 'with a custom title from options' do
+      it "returns whatever is set" do
+        options = Options.new
+        options.title = "Some title"
+
+        expect(VisualizePacks.diagram_title(options, 42)).to eq("<<b>Some title</b>>")
+      end
+    end
+
+    context 'without a custom title from options' do
+      describe 'with basic options and nil max edge count' do
+        it "with " do
+          options = Options.new
+
+          expect(VisualizePacks.diagram_title(options, 0)).to eq(
+            "<<b>visualize_packs: All packs</b><br/><font point-size='12'>Widest todo edge is 0 todo</font>>"
+          )
+        end
+      end
+
+      describe 'with basic options and 0 max edge count' do
+        it "with " do
+          options = Options.new
+
+          expect(VisualizePacks.diagram_title(options, 0)).to eq(
+            "<<b>visualize_packs: All packs</b><br/><font point-size='12'>Widest todo edge is 0 todo</font>>"
+          )
+        end
+      end
+
+      describe 'with basic options and 1 max edge count' do
+        it "with " do
+          options = Options.new
+
+          expect(VisualizePacks.diagram_title(options, 1)).to eq(
+            "<<b>visualize_packs: All packs</b><br/><font point-size='12'>Widest todo edge is 1 todo</font>>"
+          )
+        end
+      end
+
+      describe 'with basic options and non-zero max edge count' do
+        it "with " do
+          options = Options.new
+
+          expect(VisualizePacks.diagram_title(options, 19)).to eq(
+            "<<b>visualize_packs: All packs</b><br/><font point-size='12'>Widest todo edge is 19 todos</font>>"
+          )
+        end
+      end
+    end
+  end
 end

spec/visualize_packs_spec.rb

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "visualize_packs"
-  spec.version       = '0.5.17'
+  spec.version       = '0.5.18'
   spec.authors       = ['Gusto Engineers']
   spec.email         = ['dev@gusto.com']
   spec.summary       = 'A gem to visualize connections in a Ruby app that uses packs'