visualize_packs 0.5.4 → 0.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01f6c9f4bc79fee9a854283bdae4b57d12fa2a29fc53c1610765ef137f69dd68
-  data.tar.gz: bfb38e97af2696a7ee295341782905340a1458cc62004cd58b077a3caeb1d514
+  metadata.gz: b4ade528fc794c71afb2470d457f31d72b2456b85a484f2b328ca1c73e7fc2cf
+  data.tar.gz: 239feaba7ced4136ac77625e6ed1632a031492e86ca6d1c0d025976b23e31300
 SHA512:
-  metadata.gz: 39ee40c6a79f5c883ee1f14ebe9c964fedb65281aadf7ee43163f07a3f9e8f1401379baaf4efd0ccaedb7593d7ab18e28ff8d743e076da6a0028844b2180bb47
-  data.tar.gz: '0997b1cdf11c0095cb2a0bc00ba0dcd04b9ce58a1aff50b9fd106181806d0be3f36df316111946a2c1719014899043c173216dea0f4bd3301f99fdb5d1d6f368'
+  metadata.gz: 18a67a3b983c99f4d273a8e32e390a63bb0fa0398c7da51d4552fee73eedda0e77debfe45a3e196cae5b8d0e370124f7eeb82d202f4daba7b68bb90fb5b15708
+  data.tar.gz: 60e06eaacba3c796ee9045223d47203f63b19e83664c58b9db69696c591f68169f217bc8172287fcb9cc61befaa2008c4a337e486febd0477b6a0b8d14100520

data/bin/visualize_packs

@@ -10,11 +10,25 @@ require_relative '../lib/options'
 
 options = Options.new
 
+supported_todo_types = %w[
+  privacy
+  architecture
+  visibility
+  dependency
+].sort.freeze
+
+def validated_list(o, valid_arguments)
+  list = o.to_s.split(",").uniq
+  raise OptionParser::InvalidArgument, o unless (list - valid_arguments).empty?
+  list
+end
+
 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('--only-todo-types=privacy,architecture,etc', "Show only these types of todos (supported types: #{supported_todo_types.join(', ')})") { |o| options.only_todo_types = validated_list(o, supported_todo_types) }
   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 }
 

data/lib/graph.dot.erb

@@ -81,10 +81,14 @@ digraph package_diagram {
   <%- end -%>
   <%- if options.show_todos -%>
     <%- all_packages.each do |package| -%>
-      <%- violations_by_package = package.violations.group_by(&:to_package_name) -%>
+      <%- filtered_violations = package.violations -%>
+      <%- if options.only_todo_types.any? -%>
+        <%- filtered_violations = filtered_violations.select { options.only_todo_types.include?(_1.type) } -%>
+      <%- end -%>
+      <%- violations_by_package = filtered_violations.group_by(&:to_package_name) -%>
       <%- violations_by_package.keys.each do |violations_to_package| -%>
-        <%- violation_types = violations_by_package[violations_to_package].group_by(&:type) -%>
-        <%- violation_types.keys.each do |violation_type| -%>
+        <%- todo_types = violations_by_package[violations_to_package].group_by(&:type) -%>
+        <%- todo_types.keys.each do |violation_type| -%>
           <%- if show_edge.call(package.name, violations_to_package) -%>
             "<%= package.name -%>" -> "<%= violations_to_package -%>"<%= violation_type == 'privacy' ? ':private' : '' -%> [ color=darkred style=dashed
               constraint=false
@@ -100,7 +104,7 @@ digraph package_diagram {
               <%- end -%>
               <%-
                 max_edge_width = 10
-                edge_width = (violation_types[violation_type].count / max_violation_count.to_f * max_edge_width).to_i
+                edge_width = (todo_types[violation_type].count / max_violation_count.to_f * max_edge_width).to_i
               -%>
               penwidth=<%= edge_width -%>
             ]

data/lib/options.rb

@@ -8,6 +8,7 @@ class Options < T::Struct
   prop :show_layers, T::Boolean, default: true
   prop :show_dependencies, T::Boolean, default: true
   prop :show_todos, T::Boolean, default: true
+  prop :only_todo_types, T::Array[String], default: []
   prop :show_privacy, T::Boolean, default: true
   prop :show_teams, T::Boolean, default: true
 

data/lib/visualize_packs.rb

@@ -62,11 +62,12 @@ module VisualizePacks
       options.show_layers ? nil : "hiding layers",
       options.show_dependencies ? nil : "hiding dependencies",
       options.show_todos ? nil : "hiding todos",
+      options.only_todo_types.empty? ? nil : "only #{limited_sentence(options.only_todo_types)} todos",
       options.show_privacy ? nil : "hiding privacy",
       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)}",
+      options.exclude_packs.empty? ? nil : "excluding pack#{options.exclude_packs.size > 1 ? 's' : ''}: #{limited_sentence(options.exclude_packs)}",
     ].compact.join(', ').strip
     main_title = "#{app_name}: #{focus_info}#{skipped_info != '' ? ' - ' + skipped_info : ''}"
     sub_title = ""
@@ -76,14 +77,11 @@ 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 ")
+  def self.limited_sentence(list)
+    if list.size <= 2
+      list.join(" and ")
     else
-      "#{exclude_packs[0, 2].join(", ")}, and #{exclude_packs.size - 2} more."
+      "#{list[0, 2].join(", ")}, and #{list.size - 2} more"
     end
   end
 
@@ -120,11 +118,11 @@ module VisualizePacks
     all_packages.each do |package|
       violations_by_package = package.violations.group_by(&:to_package_name)
       violations_by_package.keys.each do |violations_to_package|
-        violation_types = violations_by_package[violations_to_package].group_by(&:type)
-        violation_types.keys.each do |violation_type|
+        todo_types = violations_by_package[violations_to_package].group_by(&:type)
+        todo_types.keys.each do |violation_type|
           if show_edge.call(package.name, violations_to_package)
             key = "#{package.name}->#{violations_to_package}:#{violation_type}"
-            violation_counts[key] = violation_types[violation_type].count
+            violation_counts[key] = todo_types[violation_type].count
             # violation_counts[key] += 1
           end
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: visualize_packs
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.5.5
 platform: ruby
 authors:
 - Gusto Engineers