visualize_packs 0.5.19 → 0.5.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21c174ca9487c1d11560c585972f1da5ff9b8ddc53148537753af82d1fb66a25
-  data.tar.gz: 2b910b38ad69c3df0631a98b21ec4ca6651190ab973bfc4ba4692e0f1fb7d740
+  metadata.gz: 72b6b3b6121cd9e3a2f30a4b927882be78fab2bbff55d2168100552cdf5b8276
+  data.tar.gz: 2281e4d89e00c73e18ed025b8b636d2cbafef28addc4955ff4f82ea22ddc442d
 SHA512:
-  metadata.gz: 883ddfb826a9f9051b0431d289fd98b6a92d41c41a42f4e560c0fae89a9432e741c5d9fddd2802a9eae64c9c1a6073d541f26ca8269c40d7f27b946908881088
-  data.tar.gz: 6136452d922cefa21486b40c18b2df6fda1838f25030d66019edfd291101dcae503777f7ecc9581ccf07d0c894f5800adc44248a18b931359d2ab2e1eb65d727
+  metadata.gz: 3b9affb4f63a85e56125c00e412373d60c705f793c8da118d0e11899b1dcff0e143cade00d4d2562d23d075e3f2a58d9be594cc751e6ee67038a5d591e6c1c27
+  data.tar.gz: e99623cfaaa59016939a675a500f12357da8401d2fb3ac6e87c37b1a1f861c5976665e59e830f2fc44fe38c33e7cc6926721e264a9516e2dd57df20e1bff95dc

data/bin/visualize_packs

@@ -17,11 +17,12 @@ OptionParser.new do |opt|
   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-arrows', "Don't show pack todos") { |o| options.show_todos = false }
-  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-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) }
@@ -34,6 +35,13 @@ OptionParser.new do |opt|
 
   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

data/lib/graph.dot.erb

@@ -46,11 +46,18 @@ digraph package_diagram {
                   <table border='0' cellborder='1' cellspacing='0' cellpadding='4'>
                     <tr> <td port='private'> <%= package.name -%> </td> </tr>
                   </table>
-                </td></tr></table>
+                  </td></tr>
+                  <%- if options.show_node_todos && node_protection.(package.name) != "" -%>
+                  <tr><td CELLPADDING='1' ALIGN='RIGHT'><%= node_protection.(package.name) %></td></tr>
+                  <%- end -%>
+                  </table>
               >
             <%- else -%><
                 <table border='0' cellborder='1' cellspacing='0' cellpadding='4'>
                   <tr> <td align='left'> <%= package.name -%> </td> </tr>
+                  <%- if options.show_node_todos && node_protection.(package.name) != "" -%>
+                  <tr><td CELLPADDING='1' ALIGN='RIGHT'><%= node_protection.(package.name) %></td></tr>
+                  <%- end -%>
                 </table>
               >
             <%- end -%>
@@ -79,16 +86,16 @@ digraph package_diagram {
       <%- end -%>
     <%- end -%>
   <%- end -%>
-  <%- if options.show_todos -%>
+  <%- if options.show_relationship_todos -%>
     <%- all_packages.each do |package| -%>
-      <%- filtered_todos = package.violations.select { options.only_todo_types.include?(EdgeTodoTypes.deserialize(_1.type)) } -%>
+      <%- filtered_todos = package.violations.select { options.relationship_todo_types.include?(EdgeTodoTypes.deserialize(_1.type)) } -%>
       <%- todos_by_package = filtered_todos.group_by(&:to_package_name) -%>
       <%- todos_by_package.keys.each do |todos_to_package| -%>
         <%- todo_types = todos_by_package[todos_to_package].group_by(&:type) -%>
         <%- todo_types.keys.each do |todo_type| -%>
           <%- if show_edge.call(package.name, todos_to_package) -%>
             "<%= package.name -%>" -> "<%= todos_to_package -%>"<%= todo_type == 'privacy' ? ':private' : '' -%> [
-              <%- if !options.use_todos_for_layout -%>
+              <%- if !options.use_relationship_todos_for_layout -%>
                 constraint=false
               <%- end -%>
               # headlabel="<%= todo_type -%>"
@@ -143,23 +150,23 @@ digraph package_diagram {
       N [ fontsize=12 shape=box label="package"]
       M -> N [label="visibile to" <%= VisualizePacks::ArrowHead::ConfiguredVisibileTo.serialize %>]
       <%- end -%>
-      <%- if options.show_todos -%>
-        <%- if options.only_todo_types.include?(EdgeTodoTypes::Privacy) -%>
+      <%- if options.show_relationship_todos -%>
+        <%- if options.relationship_todo_types.include?(EdgeTodoTypes::Privacy) -%>
       C [ fontsize=12 shape=box label="package"]
       D [ fontsize=12 shape=box label="package"]
       C -> D [label="privacy todo" <%= VisualizePacks::ArrowHead::PrivacyTodo.serialize %>]
         <%- end -%>
-        <%- if options.only_todo_types.include?(EdgeTodoTypes::Architecture) -%>
+        <%- if options.relationship_todo_types.include?(EdgeTodoTypes::Architecture) -%>
       E [ fontsize=12 shape=box label="package"]
       F [ fontsize=12 shape=box label="package"]
       E -> F [label="architecture todo" <%= VisualizePacks::ArrowHead::ArchitectureTodo.serialize %>]
         <%- end -%>
-        <%- if options.only_todo_types.include?(EdgeTodoTypes::Visibility) -%>
+        <%- if options.relationship_todo_types.include?(EdgeTodoTypes::Visibility) -%>
       G [ fontsize=12 shape=box label="package"]
       H [ fontsize=12 shape=box label="package"]
       G -> H [label="visibility todo" <%= VisualizePacks::ArrowHead::VisibilityTodo.serialize %>]
         <%- end -%>
-        <%- if options.only_todo_types.include?(EdgeTodoTypes::Dependency) -%>
+        <%- if options.relationship_todo_types.include?(EdgeTodoTypes::Dependency) -%>
       I [ fontsize=12 shape=box label="package"]
       J [ fontsize=12 shape=box label="package"]
       I -> J [label="dependency todo" <%= VisualizePacks::ArrowHead::DependencyTodo.serialize %>]

data/lib/visualize_packs/options.rb

@@ -30,11 +30,12 @@ class Options < T::Struct
   prop :show_layers, T::Boolean, default: true
   prop :show_visibility, T::Boolean, default: true
 
-  prop :show_todos, T::Boolean, default: true
-  prop :only_todo_types, T::Array[EdgeTodoTypes], default: EdgeTodoTypes.values
-  prop :use_todos_for_layout, T::Boolean, default: false
+  prop :show_relationship_todos, T::Boolean, default: true
+  prop :relationship_todo_types, T::Array[EdgeTodoTypes], default: EdgeTodoTypes.values
+  prop :use_relationship_todos_for_layout, T::Boolean, default: false
 
   prop :show_teams, T::Boolean, default: true
+  prop :show_node_todos, T::Boolean, default: true
 
   prop :focus_pack, T.nilable(T::Array[String]), default: nil
   prop :show_only_edges_to_focus_pack, FocusPackEdgeDirection, default: FocusPackEdgeDirection::All

data/lib/visualize_packs.rb

@@ -31,6 +31,7 @@ module VisualizePacks
 
     show_edge = show_edge_builder(options, all_package_names)
     node_color = node_color_builder()
+    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)
@@ -70,26 +71,33 @@ module VisualizePacks
   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"
-    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",
-      EdgeTodoTypes.values.size == options.only_todo_types.size ? nil : "only #{limited_sentence(options.only_todo_types.map &:serialize)} todos",
-      options.show_privacy ? nil : "hiding privacy",
-      options.show_teams ? nil : "hiding teams",
-      options.show_visibility ? nil : "hiding visibility",
-      options.roll_nested_into_parent_packs ? "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' : ''}: #{limited_sentence(options.exclude_packs)}",
+    focus_info = if options.focus_pack
+      "Focus on #{limited_sentence(options.focus_pack)} (Edge mode: #{options.show_only_edges_to_focus_pack.serialize})"
+    else 
+      "All packs"
+    end
+
+    hidden_aspects = [
+      options.show_legend ? nil : "legend",
+      options.show_layers ? nil : "layers",
+      options.show_dependencies ? nil : "dependencies",
+      options.show_relationship_todos ? nil : "edge todos",
+      options.show_privacy ? nil : "privacy",
+      options.show_teams ? nil : "teams",
+      options.show_node_todos ? nil : "node todos",
+      options.show_visibility ? nil : "visibility",
+      options.roll_nested_into_parent_packs ? "nested packs" : nil,
+      options.show_nested_relationships ? nil : "nested relationships",
     ].compact.join(', ').strip
-    main_title = "#{app_name}: #{focus_info}#{skipped_info != '' ? ' - ' + skipped_info : ''}"
-    sub_title = ""
-    if options.show_todos && max_todo_count
+    hidden_aspects_title = hidden_aspects != '' ? "Hiding #{hidden_aspects}" : nil
+
+    todo_types = EdgeTodoTypes.values.size == options.relationship_todo_types.size ? nil : "Only #{options.relationship_todo_types.map &:serialize} todos",
+
+    exclusions = options.exclude_packs.empty? ? nil : "Excluding pack#{options.exclude_packs.size > 1 ? 's' : ''}: #{limited_sentence(options.exclude_packs)}",
+
+    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>"
     end
     "<<b>#{main_title}</b>#{sub_title}>"
@@ -115,6 +123,8 @@ module VisualizePacks
         case options.show_only_edges_to_focus_pack
         when FocusPackEdgeDirection::All then
           true
+        when FocusPackEdgeDirection::None then
+          match_packs?(start_node, options.focus_pack) && match_packs?(end_node, options.focus_pack)
         when FocusPackEdgeDirection::InOut then
           match_packs?(start_node, options.focus_pack) || match_packs?(end_node, options.focus_pack)
         when FocusPackEdgeDirection::In then
@@ -142,13 +152,13 @@ module VisualizePacks
   sig { params(all_packages: T::Array[ParsePackwerk::Package], show_edge: T.proc.params(arg0: String, arg1: String).returns(T::Boolean), options: Options).returns(T.nilable(Integer)) }
   def self.max_todo_count(all_packages, show_edge, options)
     todo_counts = {}
-    if options.show_todos
+    if options.show_relationship_todos
       all_packages.each do |package|
         todos_by_package = package.violations&.group_by(&:to_package_name)
         todos_by_package&.keys&.each do |todos_to_package|
           todo_types = todos_by_package&& todos_by_package[todos_to_package]&.group_by(&:type)
           todo_types&.keys&.each do |todo_type|
-            if options.only_todo_types.include?(EdgeTodoTypes.deserialize(todo_type))
+            if options.relationship_todo_types.include?(EdgeTodoTypes.deserialize(todo_type))
               if show_edge.call(package.name, todos_to_package)
                 key = "#{package.name}->#{todos_to_package}:#{todo_type}"
                 todo_counts[key] = todo_types && todo_types[todo_type]&.count
@@ -200,36 +210,32 @@ module VisualizePacks
     result = T.let([], T::Array[T.nilable(String)])
     result = packages.map { |pack| pack.name }
 
-    if focus_pack && !focus_pack.empty?
+    if focus_pack
       result = []
-      result += packages.map { |pack| pack.name }.select { |p| match_packs?(p, focus_pack) }
-      if options.show_dependencies
-        result += packages.select { |p| p.dependencies.any? { |d| match_packs?(d, focus_pack) }}.map { |pack| pack.name }
-      end
-      if options.show_todos && [FocusPackEdgeDirection::All, FocusPackEdgeDirection::In, FocusPackEdgeDirection::InOut].include?(options.show_only_edges_to_focus_pack)
-        result += packages.select do
-          |p| (p.violations || []).inject([]) do |res, todo|
-            res << todo.to_package_name if options.only_todo_types.include?(EdgeTodoTypes.deserialize(todo.type))
-            res
-          end.any? { |v| match_packs?(v, focus_pack) }
-        end.map { |pack| pack.name }
+      focus_pack_name = packages.map { |pack| pack.name }.select { |p| match_packs?(p, focus_pack) }
+      result += focus_pack_name
+
+      dependents = options.show_dependencies ? dependents_on(packages, focus_pack_name) : []
+      dependencies = options.show_dependencies ? dependencies_of(packages, focus_pack_name) : []
+      todos_out = options.show_relationship_todos ? todos_out(packages, focus_pack_name, options) : []
+      todos_in = options.show_relationship_todos ? todos_in(packages, focus_pack_name, options) : []
+
+      case options.show_only_edges_to_focus_pack
+      when FocusPackEdgeDirection::All, FocusPackEdgeDirection::InOut then
+        result += dependents + dependencies + todos_out + todos_in
+      when FocusPackEdgeDirection::In then
+        result += dependents + todos_in
+      when FocusPackEdgeDirection::Out then
+        result += dependencies + todos_out 
+      when FocusPackEdgeDirection::None then
+        # nothing to do
       end
-      packages.map { |pack| pack.name }.select { |p| match_packs?(p, focus_pack) }.each do |p|
-        if options.show_dependencies
-          result += packages_by_name[p].dependencies
-        end
-        if options.show_todos && [FocusPackEdgeDirection::All, FocusPackEdgeDirection::Out, FocusPackEdgeDirection::InOut].include?(options.show_only_edges_to_focus_pack)
-          result += (packages_by_name[p].violations || []).inject([]) do |res, todo|
-            res << todo.to_package_name if options.only_todo_types.include?(EdgeTodoTypes.deserialize(todo.type))
-            res
-          end
-        end
-      end
-      result = result.uniq
+
       parent_packs = result.inject([]) do |res, package_name|
         res << nested_packages[package_name]
         res
       end
+
       result = (result + parent_packs).uniq.compact
     end
 
@@ -318,4 +324,73 @@ module VisualizePacks
   def self.match_packs?(pack, packs_name_with_wildcards)
     !packs_name_with_wildcards || packs_name_with_wildcards.any? {|p| File.fnmatch(p, pack)}
   end
+
+  sig { params(all_packages: T::Array[ParsePackwerk::Package], focus_packs_names: T::Array[String]).returns(T::Array[String]) }
+  def self.dependencies_of(all_packages, focus_packs_names)
+    focus_packs = all_packages.select { focus_packs_names.include?(_1.name)}
+    
+    focus_packs.inject([]) do |result, pack|
+      result += pack.dependencies
+      result
+    end.uniq
+  end
+
+  sig { params(all_packages: T::Array[ParsePackwerk::Package], focus_packs_names: T::Array[String]).returns(T::Array[String]) }
+  def self.dependents_on(all_packages, focus_packs_names)
+    all_packages.select { |pack| pack.dependencies.any? { focus_packs_names.include?(_1) }}.map &:name
+  end
+
+  sig { params(all_packages: T::Array[ParsePackwerk::Package], focus_packs_names: T::Array[String], options: Options).returns(T::Array[String]) }
+  def self.todos_in(all_packages, focus_packs_names, options)
+    all_packages.select do |p|
+      (p.violations || []).inject([]) do |res, todo|
+        res << todo.to_package_name if options.relationship_todo_types.include?(EdgeTodoTypes.deserialize(todo.type))
+        res
+      end.any? { |v| focus_packs_names.include?(v) }
+    end.map { |pack| pack.name }
+  end
+
+  sig { params(all_packages: T::Array[ParsePackwerk::Package], focus_packs_names: T::Array[String], options: Options).returns(T::Array[String]) }
+  def self.todos_out(all_packages, focus_packs_names, options)
+    all_packages.inject([]) do |result, p|
+      focus_packs_names.include?(p.name) && (p.violations || []).each do |todo|
+        result << todo.to_package_name if options.relationship_todo_types.include?(EdgeTodoTypes.deserialize(todo.type))
+      end
+      result
+    end
+  end
+
+  sig { params(protection: String, package_name: String, rubocop_config: T.any(NilClass, T::Boolean, T::Hash[String, T.untyped]), rubocop_todo: T.any(NilClass, T::Boolean, T::Hash[String, T.untyped])).returns(T.nilable(Integer)) }
+  def self.package_based_todos_for(protection, package_name, rubocop_config,  rubocop_todo)
+    rubocop_config = {} if rubocop_config.is_a?(TrueClass) || rubocop_config.is_a?(FalseClass) || rubocop_config.is_a?(NilClass)
+    rubocop_todo = {} if rubocop_todo.is_a?(TrueClass) || rubocop_todo.is_a?(FalseClass) || rubocop_todo.is_a?(NilClass)
+
+    raise ArgumentError unless ['Packs/ClassMethodsAsPublicApis', 'Packs/DocumentedPublicApis', 'Packs/RootNamespaceIsPackName', 'Packs/TypedPublicApis'].include?(protection)
+    return nil unless (rubocop_config.dig(protection)&.dig('Enabled'))
+    
+    (rubocop_todo.dig(protection)&.dig('Exclude') || []).inject(0) do |result, todo|
+      result += 1 if todo.start_with?("#{package_name}/")
+      result
+    end
+  end
+
+  sig { returns(T.untyped) }
+  def self.package_based_todos_text_maker
+    ->(package_name) {
+      [
+        'Packs/ClassMethodsAsPublicApis', 
+        'Packs/DocumentedPublicApis', 
+        'Packs/RootNamespaceIsPackName', 
+        'Packs/TypedPublicApis'
+      ].map do |protection|
+        rubocop_config = File.exist?("#{package_name}/.rubocop.yml") ? YAML.load_file("#{package_name}/.rubocop.yml") : {}
+        rubocop_todo = File.exist?(".rubocop_todo.yml") ? YAML.load_file(".rubocop_todo.yml") : {}
+
+        todo_value = package_based_todos_for(protection, package_name, rubocop_config,  rubocop_todo)
+        abbreviation = T.must(protection.split('/')[1]).chars[0]
+        
+        "#{abbreviation}: #{todo_value}" if todo_value
+      end.compact.join(", ")
+    }
+  end
 end

metadata

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