pocky 1.6.0 → 1.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 85bd82c4180bd9152f53dcf8dcfa2e0cdb54f93211f926823c62572b9c98c7bf
-  data.tar.gz: 759e6fe70c7981b6342957da759754833c275d086bf4c2b7caab6e4406cf6bf5
+  metadata.gz: 8ad303bcc76eff49ab35053c61a7ad277165d40b999fcadac1d310be525ab69b
+  data.tar.gz: 16e002a3989465994fa932da11696b166468da711336f354fae58ece194087c4
 SHA512:
-  metadata.gz: d7db906a22cfd1c05fca50101bc0f5c896c6d3ade27cb998a7ab0e6218094a420577a0bd59a67bc41c851007bd73590735b4251e6ed60cff79ef41532572e8c8
-  data.tar.gz: 2a8078b50d6d0f0fd46ae1269b18f2602d5f69487ac431400d122b4bcddf4415457cd2b695483eda803c3117f80a4b52d5c2c78221406fdbc156bae6b1530dcd
+  metadata.gz: 9bc982c815e4becd96436596522ea9adf543ec3830e04e812185a452a263ee8715572dd260d2b912d2fd7ffaa2f2866ab5d9445b3ea841fa6486a9fd4bc1880e
+  data.tar.gz: 82a64fb0e51915f78085510a3b1aa78ea1e9a9b48a2a163f29610b280e613e2cfccfb7fb9e1bd6ff59df7b053b8decbcfd389f73d4aa96b0b2785aab318cb692

data/README.md

@@ -6,14 +6,16 @@ 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: 'app',       # The default package listed as "." in package.yml and deprecated_references.yml
   filename: 'packwerk-viz.png', # Name of output file
-  dpi: 150                     # Output file resolution
+  dpi: 100,                     # Output file resolution
+  package_color: 'darkgray',   # color name or hex color, see https://graphviz.org/doc/info/colors.html for more details
+  deprecated_reference_edge: 'black',
+  dependency_edge: 'darkgreen',
 )
 ```
 
@@ -21,11 +23,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 +69,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,12 @@ require 'yaml'
 require 'ruby-graphviz'
 
 module Pocky
+  class InvalidRootPathError < StandardError
+  end
+
   class Packwerk
+    DEPENDENCIES_FILENAME = 'package.yml'
+    DEPRECATED_REFERENCES_FILENAME = 'deprecated_references.yml'
     MAX_EDGE_WIDTH = 5
 
     def self.generate(params)
@@ -14,44 +19,86 @@ module Pocky
     private_class_method :new
     def initialize(
       root_path:,
-      default_package: 'Default',
-      package_prefix: '',
+      default_package: 'app',
       filename: 'packwerk-viz.png',
-      dpi: 150
+      dpi: 100,
+      package_color: 'darkgray',
+      dependency_edge: 'green3',
+      deprecated_reference_edge: 'black'
     )
-      @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
       @filename = filename
       @dpi = dpi.to_i
       @deprecated_references = {}
+      @package_dependencies = {}
       @nodes = {}
+
+      @node_options = {
+        fontsize: 26.0,
+        fontcolor: 'white',
+        fillcolor: package_color,
+        color: package_color,
+        style: 'filled, rounded',
+        shape: 'box',
+      }
+
+      @deprecated_references_edge_options = {
+        color: deprecated_reference_edge,
+      }
+
+      @dependency_edge_options = {
+        color: dependency_edge
+      }
     end
 
     def generate
-      load_package_dependencies
+      load_dependencies
+      load_deprecated_references
       build_directed_graph
     end
 
     private
 
     def build_directed_graph
-      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|
+      @graph = GraphViz.new(:G, type: :digraph, dpi: @dpi)
+      draw_dependencies
+      draw_deprecated_references
+      @graph.output(png: @filename)
+    end
+
+    def draw_dependencies
+      @package_dependencies.each do |package, file|
+        @nodes[package] ||= @graph.add_nodes(package, **@node_options)
+        file.each do |provider|
           provider_package = package_name_for_dependency(provider)
-          @nodes[provider_package] ||= graph.add_nodes(provider_package)
+          @nodes[provider_package] ||= @graph.add_nodes(provider_package, **@node_options)
 
-          graph.add_edges(
-            @nodes[provider_package],
+          @graph.add_edges(
             @nodes[package],
-            penwidth: edge_width(dependencies.length)
+            @nodes[provider_package],
+            **@dependency_edge_options
           )
         end
       end
+    end
 
-      graph.output(png: @filename)
+    def draw_deprecated_references
+      @deprecated_references.each do |package, references|
+        @nodes[package] ||= @graph.add_nodes(package, **@node_options)
+        references.each do |provider, invocations|
+          provider_package = package_name_for_dependency(provider)
+          @nodes[provider_package] ||= @graph.add_nodes(provider_package, **@node_options)
+
+          @graph.add_edges(
+            @nodes[package],
+            @nodes[provider_package],
+            **@deprecated_references_edge_options.merge(penwidth: edge_width(invocations.length)),
+          )
+        end
+      end
     end
 
     def edge_width(count)
@@ -61,33 +108,55 @@ 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 deprecated_references_files
+      @deprecated_references_files ||= @root_paths.flat_map do |path|
+        Dir["#{path}/**/#{DEPRECATED_REFERENCES_FILENAME}"]
+      end
+    end
+
+    def dependencies_files
+      @dependencies_files ||= @root_paths.flat_map do |path|
+        Dir["#{path}/**/#{DEPENDENCIES_FILENAME}"]
       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
-          {}
+    def load_dependencies
+      return if dependencies_files.empty?
+
+      dependencies_files.each do |filename|
+        package = parse_package_name(filename)
+        @package_dependencies[package] ||= begin
+          yml = YAML.load_file(filename) || {}
+          yml['dependencies'] || []
         end
       end
     end
 
-    def deprecated_references_file_for(package)
-      File.join(@root_path, package, 'deprecated_references.yml')
+    def load_deprecated_references
+      return if deprecated_references_files.empty?
+
+      deprecated_references_files.each do |filename|
+        package = parse_package_name(filename)
+        @deprecated_references[package] ||= YAML.load_file(filename) || {}
+      end
+    end
+
+    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 = deprecated_references_files.find do |ref|
+        ref.match(/#{name}\/#{DEPRECATED_REFERENCES_FILENAME}$/)
+      end
+
+      if reference_filename
+        parse_package_name(reference_filename)
+      else
+        name
+      end
     end
   end
 end

data/lib/pocky/tasks/generate.rake

@@ -2,7 +2,9 @@ require 'pocky'
 
 namespace :pocky do
   desc 'Generate dependency graph for packwerk packages'
-  task :generate, [:root_path, :default_package, :package_prefix, :filename, :dpi] do |_task, args|
-    Pocky::Packwerk.generate(args)
+  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.6.0"
+  VERSION = "1.9.2"
 end

data/pocky.gemspec

@@ -14,7 +14,6 @@ Gem::Specification.new do |spec|
   spec.license       = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
 
-
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/mquan/pocky"
   spec.metadata["changelog_uri"] = "https://github.com/mquan/pocky"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pocky
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.9.2
 platform: ruby
 authors:
 - Quan Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-12-29 00:00:00.000000000 Z
+date: 2021-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-graphviz