visualize_packwerk 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dbd24c4c7be488fb37b173c00512196884dafe06e1788bbfb9fd3161988f395b
-  data.tar.gz: 0c4da79eef14eba7759074636a556d03f2e74a1b964b485bba0d7e090c83471b
+  metadata.gz: 4425d05708c5fc0d1ccc3e76d991d222e4089e4ed7717bdcc90ebcb7577b8a0d
+  data.tar.gz: 2dc5bb9be62bbb7f3251de7a52b538de4c3ed3c1fc9ef1a53615f617da5f8d1b
 SHA512:
-  metadata.gz: 38855ce47c28b248a67de636f9e530e850425b5b7823ccc3bd1f13bde14c6bacd5aa32b68b68f54244325b6c75f8050586b36e98d5c5f0f2e90265728594f854
-  data.tar.gz: 68c24d06b1f0c9ae4d109806d0459b38a58e6d6827a07bc745fe6dafaddf17a15c359f80a9b21e495c386eac8ceeba5e8e66d40162d3ee572544c01b5fc35e10
+  metadata.gz: 1934e543832c1b2df2811fdaed60687d223849b190cae86eeb3e67b2127b4e95cb89409f56d4609641c0bf9e99ba4fde7cb57836cfba0daef77ede66d7fde776
+  data.tar.gz: a9e3cc970f06aa8a36406fed5e8bff47de3070a9d2b1b0d8f3a3ab5bb4c544da21eb2c92cc158d25871250788d8b10a2f588d08c2851cc2c380916e63ce3b955

data/README.md

@@ -3,30 +3,25 @@
 This gem contains rake tasks to help visualize relationships between packwerk packs.
 
 # Usage
-## Building a package graph for a selection of packages (owned by 5 teams max)
-```
-bin/rails visualize_packwerk:package_relationships['packs/pack1','packs/pack2']
-```
-
-# Building a package graph for specific teams (5 teams max)
-```
-bin/rails visualize_packwerk:package_relationships_for_teams['Team1','Team2']
-```
-
-# Building a package graph for all packages (this is slow and produces a huge file)
-```
-bin/rails visualize_packwerk:package_relationships
+## Building a package graph for a selection of packages
+```ruby
+# Select the packs you want to include
+selected_packs = Packs.all
+selected_packs = Packs.all.select{ |p| ['packs/my_pack_1', 'packs/my_pack_2'].include?(p.name) }
+selected_packs = Packs.all.select{ |p| ['Team 1', 'Team 2'].include?(CodeOwnership.for_package(p)&.name) }
+VisualizePackwerk.package_graph!(selected_packs)
 ```
 
-# Building a TEAM graph for specific teams
-```
-bin/rails visualize_packwerk:team_relationships['Team1','Team2']
+# Building a team graph for specific teams
+```ruby
+# Select the teams you want to include
+selected_teams = CodeTeams.all
+selected_teams = CodeTeams.all.select{ |t| ['Team 1', 'Team 2'].include?(t.name) }
+VisualizePackwerk.team_graph!(selected_teams)
 ```
 
-# Building a TEAM graph for all teams (this is slow and produces a huge file)
-```
-bin/rails visualize_packwerk:team_relationships
-```
+## bin/packs
+For simpler use, use `bin/packs` in `use_packwerk` (https://github.com/rubyatscale/use_packwerk)
 
 # Want to change something or add a feature?
 Submit a PR or post an issue!

data/lib/visualize_packwerk/package_graph.rb

@@ -22,18 +22,26 @@ module VisualizePackwerk
     sig { returns(PackageGraph) }
     def self.construct
       package_nodes = Set.new
-      ParsePackwerk.all.each do |p|
-        # We could consider ignoring the root!
-        # We would also need to ignore it when parsing PackageNodes.
-        # next if p.name == ParsePackwerk::ROOT_PACKAGE_NAME
+      Packs.all.each do |p|
         owner = CodeOwnership.for_package(p)
-        violations_by_package = p.violations.group_by(&:to_package_name).transform_values(&:count)
+
+        # Here we need to load the package violations and dependencies,
+        # so we need to use ParsePackwerk to parse that information.
+        package_info = ParsePackwerk.find(p.name)
+        next unless package_info # This should not happen unless packs/parse_packwerk change implementation
+
+        violations = package_info.violations
+        violations_by_package = violations.group_by(&:to_package_name).transform_values(&:count)
+        violations_by_package.delete('.') # remove root package violations
+
+        dependencies = package_info.dependencies
+        dependencies.delete('.') # remove root package dependencies
 
         package_nodes << PackageNode.new(
           name: p.name,
           team_name: owner&.name || 'Unknown',
           violations_by_package: violations_by_package,
-          dependencies: Set.new(p.dependencies)
+          dependencies: Set.new(dependencies)
         )
       end
 

data/lib/visualize_packwerk/package_relationships.rb

@@ -8,7 +8,7 @@ module VisualizePackwerk
 
     sig { params(teams: T::Array[CodeTeams::Team]).void }
     def create_package_graph_for_teams!(teams)
-      packages = ParsePackwerk.all.select do |package|
+      packages = Packs.all.select do |package|
         teams.map(&:name).include?(CodeOwnership.for_package(package)&.name)
       end
 
@@ -24,14 +24,14 @@ module VisualizePackwerk
       draw_graph!(team_graph, node_names, show_all_nodes: show_all_teams)
     end
 
-    sig { params(packages: T::Array[ParsePackwerk::Package]).void }
+    sig { params(packages: T::Array[Packs::Pack]).void }
     def create_package_graph!(packages)
       graph = PackageGraph.construct
       node_names = packages.map(&:name)
       draw_graph!(graph, node_names)
     end
 
-    sig { params(packages: T::Array[ParsePackwerk::Package], show_all_nodes: T::Boolean).void }
+    sig { params(packages: T::Array[Packs::Pack], show_all_nodes: T::Boolean).void }
     def create_graph!(packages, show_all_nodes: false)
       graph = PackageGraph.construct
       node_names = packages.map(&:name)

data/lib/visualize_packwerk.rb

@@ -1,16 +1,29 @@
 # typed: strict
 
+require 'packs'
+require 'parse_packwerk'
+require 'code_ownership'
+require 'graphviz'
+require 'sorbet-runtime'
+
+require 'visualize_packwerk/node_interface'
+require 'visualize_packwerk/graph_interface'
+require 'visualize_packwerk/team_node'
+require 'visualize_packwerk/package_node'
+require 'visualize_packwerk/team_graph'
+require 'visualize_packwerk/package_graph'
+require 'visualize_packwerk/package_relationships'
+
 module VisualizePackwerk
-  require 'visualize_packwerk/railtie' if defined?(Rails)
-  require 'parse_packwerk'
-  require 'code_ownership'
-  require 'graphviz'
+  extend T::Sig
+
+  sig { params(packages: T::Array[Packs::Pack]).void }
+  def self.package_graph!(packages)
+    PackageRelationships.new.create_package_graph!(packages)
+  end
 
-  require 'visualize_packwerk/node_interface'
-  require 'visualize_packwerk/graph_interface'
-  require 'visualize_packwerk/team_node'
-  require 'visualize_packwerk/package_node'
-  require 'visualize_packwerk/team_graph'
-  require 'visualize_packwerk/package_graph'
-  require 'visualize_packwerk/package_relationships'
+  sig { params(teams: T::Array[CodeTeams::Team]).void }
+  def self.team_graph!(teams)
+    PackageRelationships.new.create_team_graph!(teams)
+  end
 end