visualize_packwerk 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dbd24c4c7be488fb37b173c00512196884dafe06e1788bbfb9fd3161988f395b
-  data.tar.gz: 0c4da79eef14eba7759074636a556d03f2e74a1b964b485bba0d7e090c83471b
+  metadata.gz: a0b2682a8a34f87cc58bd46f0896ff4a743908035942abd58c49bbd13e1d0715
+  data.tar.gz: '08a6f4c9bf22cf18d6951d5ca594c2fbe79222921641a98ec6c1f3646587b398'
 SHA512:
-  metadata.gz: 38855ce47c28b248a67de636f9e530e850425b5b7823ccc3bd1f13bde14c6bacd5aa32b68b68f54244325b6c75f8050586b36e98d5c5f0f2e90265728594f854
-  data.tar.gz: 68c24d06b1f0c9ae4d109806d0459b38a58e6d6827a07bc745fe6dafaddf17a15c359f80a9b21e495c386eac8ceeba5e8e66d40162d3ee572544c01b5fc35e10
+  metadata.gz: cff9630c1df4d9dc684b2dda3c76c6e7dc14e95add1d00c117b9b9f641cdb80318aac6e523cf4fe0aac434b9fc40ddd9105fd993ebc1890a63bcf5825d04a8dd
+  data.tar.gz: 8c8e2208ddccbf4da02c68c747341667557cfb4df311477230d120f0979e6ab2d5a2add59ca7bd0aa2cae3e98028acaae4d39af3faefcece6e7112d34d2d355f

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 a selection of packages
+```ruby
+# Select the packs you want to include
+selected_packs = ParsePackwerk.all
+selected_packs = ParsePackwerk.all.select{|p| ['packs/my_pack_1', 'packs/my_pack_2'].include?(p.name) }
+selected_packs = ParsePackwerk.all.select{|p| ['Team 1', 'Team 2'].include?(CodeOwnership.for_package(p)&.name) }
+VisualizePackwerk.package_graph!(selected_packs)
 ```
 
-# Building a package graph for specific teams (5 teams max)
+# Building a team graph for specific teams
 ```
-bin/rails visualize_packwerk:package_relationships_for_teams['Team1','Team2']
+# Select the teams you want to include
+selected_teams = CodeTeams.all
+selected_teams = CodeTeams.all.select{ ... }
+VisualizePackwerk.team_graph!(selected_teams)
 ```
 
-# Building a package graph for all packages (this is slow and produces a huge file)
-```
-bin/rails visualize_packwerk:package_relationships
-```
-
-# Building a TEAM graph for specific teams
-```
-bin/rails visualize_packwerk:team_relationships['Team1','Team2']
-```
-
-# 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.rb

@@ -1,16 +1,28 @@
 # typed: strict
 
+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[ParsePackwerk::Package]).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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: visualize_packwerk
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-08 00:00:00.000000000 Z
+date: 2022-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
@@ -150,8 +150,6 @@ files:
 - lib/visualize_packwerk/package_graph.rb
 - lib/visualize_packwerk/package_node.rb
 - lib/visualize_packwerk/package_relationships.rb
-- lib/visualize_packwerk/railtie.rb
-- lib/visualize_packwerk/tasks/visualize_packwerk.rake
 - lib/visualize_packwerk/team_graph.rb
 - lib/visualize_packwerk/team_node.rb
 - sorbet/config

data/lib/visualize_packwerk/railtie.rb

@@ -1,15 +0,0 @@
-# typed: ignore
-
-require 'visualize_packwerk'
-require 'rails'
-
-module VisualizePackwerk
-  class Railtie < Rails::Railtie
-    railtie_name :visualize_packwerk
-
-    rake_tasks do
-      path = File.expand_path(__dir__)
-      Dir.glob("#{path}/tasks/visualize_packwerk.rake").each { |f| load f }
-    end
-  end
-end

data/lib/visualize_packwerk/tasks/visualize_packwerk.rake

@@ -1,73 +0,0 @@
-# typed: strict
-
-module VisualizePackwerk
-  class TaskLoader
-    include Rake::DSL
-    extend T::Sig
-
-    sig { void }
-    def create_tasks!
-      namespace(:visualize_packwerk) do
-        # This creates the array of symbols that are needed to declare an argument to a rake task
-        package_args = (1..100).map { |i| "package#{i}".to_sym }
-
-        desc('Graph packages')
-        task(:package_relationships, package_args => :environment) do |_task, args|
-          show_all_packs = args.to_hash.values.none?
-          packages = if show_all_packs
-            ParsePackwerk.all
-          else
-            args.to_hash.values.map do |pack_name|
-              found_package = ParsePackwerk.all.find { |p| p.name == pack_name }
-              if found_package.nil?
-                abort "Could not find pack with name: #{pack_name}"
-              end
-
-              found_package
-            end
-          end
-
-          PackageRelationships.new.create_package_graph!(packages)
-        end
-
-        # This creates the array of symbols that are needed to declare an argument to a rake task
-        team_args = (1..5).map { |i| "team#{i}".to_sym }
-
-        desc('Graph packages for teams')
-        task(:package_relationships_for_teams, team_args => :environment) do |_task, args|
-          teams = args.to_hash.values.map do |team_name|
-            team = CodeTeams.find(team_name)
-            if team.nil?
-              abort("Could not find team with name: #{team_name}. Check your config/teams/subdirectory/team.yml for correct team spelling, e.g. `Product Infrastructure`")
-            end
-
-            team
-          end
-
-          PackageRelationships.new.create_package_graph_for_teams!(teams)
-        end
-
-        desc('Graph team relationships')
-        task(:team_relationships, team_args => :environment) do |_task, args|
-          show_all_teams = args.to_hash.values.none?
-          teams = if show_all_teams
-            CodeTeams.all
-          else
-            args.to_hash.values.map do |team_name|
-              team = CodeTeams.find(team_name)
-              if team.nil?
-                abort("Could not find team with name: #{team_name}. Check your config/teams/subdirectory/team.yml for correct team spelling, e.g. `Product Infrastructure`")
-              end
-
-              team
-            end
-          end
-
-          PackageRelationships.new.create_team_graph!(teams, show_all_teams: show_all_teams)
-        end
-      end
-    end
-  end
-end
-
-VisualizePackwerk::TaskLoader.new.create_tasks!