pocky 1.4.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1bd1bd4dd6b8693596464cce4a18d69e015acb74d0534bf80c0f4861dbcb3487
-  data.tar.gz: b04b473ba73db68dcdd62ba9e76bf8ef25d2febba6ffe9cc11d1d90946f74243
+  metadata.gz: a33d7a33b47a8ec7b5763188f1670934db2b63df6e16409371ec10456a06ff98
+  data.tar.gz: afe4ed9619ec1d6843fb23a92fde8ef89349650fec21abc2e584cccdd7ba9096
 SHA512:
-  metadata.gz: b572f0aeb26942d289a15ac2d066bcdaa2908810f3cc729725f212c41598dabb33690b72da3e3deb35b7945e668d70ddccca498f00043abc25ac5a36252949cb
-  data.tar.gz: 29c7d372e528161abc4e3c833521860a89a4411fd2f5cb35f294df150b0c697256b38dd8ca34009be21250467b14a1600bda76fa556e0fa2bdd2d96bf8701571
+  metadata.gz: 2469169116f8afcebfd1fd41e05b6a74526c37e4abcdd78b94feae73867773fcc277192a6e8ea89ac57f35ce4608d9ec657e4b7309e59875bd11b0eb40b6bfa3
+  data.tar.gz: 6ef340611027d6ffea6044c1f03576d5b78ea1b70b2d852a9a1784c99d66d644abd07c4c71ccf58f9edeb98b7dbe42c3cb7eb2867afcc5fdf1a0ed60b692ded2

data/README.md

@@ -6,14 +6,13 @@ Pocky generates dependency graphs for your packwerk packages. The gem is named a
 
 ## Usage
 
-Invoke from irb or code
+Invoke from irb or code, only `root_path` is required.
 ```ruby
 Pocky::Packwerk.generate(
   root_path: 'path/to/app/packages',
-  default_package: 'Default',    # The default package listed as "." in deprecated_references.yml
-  package_prefix: 'app/packages',     # this is for matching package names listed in deprecated_references.yml
+  default_package: 'Default',   # The default package listed as "." in deprecated_references.yml
   filename: 'packwerk-viz.png', # Name of output file
-  dpi: 150                     # Output file resolution
+  dpi: 150                      # Output file resolution
 )
 ```
 
@@ -21,11 +20,27 @@ Pocky::Packwerk.generate(
 
 Note that the the bold edges indicate heavier dependencies.
 
-Invoke as a rake task
+Invoke as a rake task:
 
+    $ rake pocky:generate"[path/to/app/packages,Monolith,packages.png,100]"
+
+
+#### `root_path` as an array
+`root_path` can also be an array in case your packages are organized in multiple directories. Alternatively, you can also provide paths to individual packages to generate more focused graphs for your package subsystems.
+
+```ruby
+Pocky::Packwerk.generate(
+  root_path: [
+    'path/to/app/packages/a',
+    'path/to/app/packages/z',
+  ]
+)
 ```
-rake pocky:generate[path/to/app/packages,Default,app/packages,packwerk-viz.png,150]
-```
+
+Generate the same graph using the rake task:
+
+    $ rake pocky:generate"[path/to/app/packages/a path/to/app/packages/z]"
+
 
 ## Installation
 
@@ -51,7 +66,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/pocky.
+Bug reports and pull requests are welcome on GitHub at https://github.com/mquan/pocky.
 
 ## License
 

data/lib/pocky/packwerk.rb

@@ -4,7 +4,11 @@ require 'yaml'
 require 'ruby-graphviz'
 
 module Pocky
+  class InvalidRootPathError < StandardError
+  end
+
   class Packwerk
+    REFERENCE_FILE_NAME = 'deprecated_references.yml'
     MAX_EDGE_WIDTH = 5
 
     def self.generate(params)
@@ -15,28 +19,28 @@ module Pocky
     def initialize(
       root_path:,
       default_package: 'Default',
-      package_prefix: '',
       filename: 'packwerk-viz.png',
       dpi: 150
     )
-      @root_path = root_path
+      @root_paths = [*root_path]
+      raise InvalidRootPathError, 'root_path is required' if @root_paths.empty?
+
       @default_package = default_package
-      @package_prefix = package_prefix
-      @output_filename = output_filename
-      @output_dpi = output_dpi.to_i
+      @filename = filename
+      @dpi = dpi.to_i
       @deprecated_references = {}
       @nodes = {}
     end
 
     def generate
-      load_package_dependencies
+      load_package_references
       build_directed_graph
     end
 
     private
 
     def build_directed_graph
-      graph = GraphViz.new(:G, type: :digraph, dpi: @output_dpi)
+      graph = GraphViz.new(:G, type: :digraph, dpi: @dpi)
       @deprecated_references.each do |package, references|
         @nodes[package] ||= graph.add_nodes(package)
         references.each do |provider, dependencies|
@@ -44,14 +48,14 @@ module Pocky
           @nodes[provider_package] ||= graph.add_nodes(provider_package)
 
           graph.add_edges(
-            @nodes[provider_package],
             @nodes[package],
+            @nodes[provider_package],
             penwidth: edge_width(dependencies.length)
           )
         end
       end
 
-      graph.output(png: @output_filename)
+      graph.output(png: @filename)
     end
 
     def edge_width(count)
@@ -61,33 +65,39 @@ module Pocky
       ].min
     end
 
-    def load_package_dependencies
-      Dir.each_child(@root_path) do |elem|
-        if Dir.exist?(File.join(@root_path, elem))
-          load_deprecated_references_for_package(elem)
-        end
+    def package_references
+      @package_references ||= @root_paths.flat_map do |path|
+        Dir["#{path}/**/#{REFERENCE_FILE_NAME}"]
       end
     end
 
-    def load_deprecated_references_for_package(package)
-      @deprecated_references[package] ||= begin
-        filename = deprecated_references_file_for(package)
-        if File.exist?(filename)
-          YAML.load_file(filename) || {}
-        else
-          {}
-        end
+    def load_package_references
+      if package_references.empty?
+        raise InvalidRootPathError, "Cannot find any #{REFERENCE_FILE_NAME} in provided root_path"
+      end
+
+      package_references.each do |filename|
+        package = parse_package_name(filename)
+        @deprecated_references[package] ||= YAML.load_file(filename) || {}
       end
     end
 
-    def deprecated_references_file_for(package)
-      File.join(@root_path, package, 'deprecated_references.yml')
+    def parse_package_name(filename)
+      File.basename(File.dirname(filename))
     end
 
     def package_name_for_dependency(name)
       return @default_package if name == '.'
 
-      name.gsub(@package_prefix, '').gsub(/^\//, '')
+      reference_filename = package_references.find do |ref|
+        ref.match(/#{name}\/#{REFERENCE_FILE_NAME}$/)
+      end
+
+      if reference_filename
+        parse_package_name(reference_filename)
+      else
+        name
+      end
     end
   end
 end

data/lib/pocky/tasks/generate.rake

@@ -0,0 +1,10 @@
+require 'pocky'
+
+namespace :pocky do
+  desc 'Generate dependency graph for packwerk packages'
+  task :generate, [:root_path, :default_package, :filename, :dpi] do |_task, args|
+    Pocky::Packwerk.generate(args.merge(
+      root_path: arg[:root_path].split(/\s+/)
+    ))
+  end
+end

data/lib/pocky/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Pocky
-  VERSION = "1.4.0"
+  VERSION = "1.9.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pocky
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.9.0
 platform: ruby
 authors:
 - Quan Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-12-29 00:00:00.000000000 Z
+date: 2021-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-graphviz
@@ -40,12 +40,12 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- lib/Rakefile
 - lib/pocky.rb
+- lib/pocky/Rakefile
 - lib/pocky/packwerk.rb
+- lib/pocky/railtie.rb
+- lib/pocky/tasks/generate.rake
 - lib/pocky/version.rb
-- lib/railtie.rb
-- lib/tasks/generate.rake
 - pocky.gemspec
 homepage: https://github.com/mquan/pocky
 licenses:

data/lib/tasks/generate.rake

@@ -1,8 +0,0 @@
-require 'pocky'
-
-namespace :pocky do
-  desc 'Generate dependency graph for packwerk packages'
-  task :generate, [:root_path, :default_package, :package_prefix, :filename, :dpi]: :environment do |_task, args|
-    Pocky::Packwerk.generate(args)
-  end
-end