pocky 1.2.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf07028aa68c5a375d8e63ab24b67c71632dbcce2ec3102f9aaa3f0151e2c8bd
-  data.tar.gz: f57f39306821dda1b71d214f1f1ba9e9f92975274c6473451e51dcc6ab74fe60
+  metadata.gz: 22de5def074e1cb08bee99280a266ea9ebcf29056ae4dd117f75682e2e3d3221
+  data.tar.gz: 7c8258dbf32e3c30099e7d3b4f7d5b7404c7d28348163b7b9a5f51671b490e2c
 SHA512:
-  metadata.gz: 8097c6fdd3a673bbb3b4c583c923a818fb0fb901fe206f105676db6803538bbc85ecf9990ce250b386c7a1e16120690220769eb9c18ff928db5ebd3c650f1e16
-  data.tar.gz: e3a6d19e6afbc51055b15f8fed056553c8aac32b515fe462fa4fea3f60a7def7ca9d1feacbaf6c67e34ec03e3424d893a85e9fe16aec6790feaca0bfce1cab7a
+  metadata.gz: e659f0fd8a2a3c0f4a6c9e0bc195ae7493a0b27d774996c533cedce3898a20d14d7f703a9c6f6715e290175c02435519ddfa486ca6ce506d5ac38d97017f7f80
+  data.tar.gz: a67332ec4f9dc8503b4267fef328a8d98eb0894bd90554867c3b6f299eba35a898f1e42560c190adf94e4748d182bf16b016fccf0636bb1b28c2e6e44edb4432

data/README.md

@@ -1,20 +1,46 @@
 # Pocky
 
-Pocky is used to generate dependency graphs for your packwerk packages. The gem is named after pocky, a beloved Japanese snack that comes in small packages.
+Pocky generates dependency graphs for your packwerk packages. The gem is named after pocky, a beloved Japanese snack that comes in small packages.
 
 ![Pocky](https://user-images.githubusercontent.com/138784/103248942-c141de80-4921-11eb-99bd-3744816abc37.png)
 
 ## Usage
 
+Invoke from irb or code, only `root_path` is required.
 ```ruby
-Pocky::Graph.generate(
+Pocky::Packwerk.generate(
   root_path: 'path/to/app/packages',
-  default_package: 'The Monolith', # The default package listed as "." in deprecated_references.yml
-  package_prefix: 'app/packages', # this is for matching package names listed in deprecated_references.yml
-  output_filename: 'pocky-graph.png'
+  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
 )
 ```
 
+![pocky-graph](https://user-images.githubusercontent.com/138784/103251690-a6299b80-492e-11eb-92f1-205752d850d8.png)
+
+Note that the the bold edges indicate heavier dependencies.
+
+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',
+  ]
+)
+```
+
+Generate the same graph using the rake task:
+
+    $ rake pocky:generate"[path/to/app/packages/a path/to/app/packages/z]"
+
 
 ## Installation
 
@@ -40,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/Rakefile

@@ -3,6 +3,6 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
-RSpec::Core::RakeTask.new(:spec)
-
-task default: :spec
+spec = Gem::Specification.find_by_name 'pocky'
+rakefile = "#{spec.gem_dir}/lib/pocky/Rakefile"
+load rakefile

data/lib/pocky.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
 require_relative 'pocky/version'
-require_relative 'pocky/graph'
+require_relative 'pocky/packwerk'
 
 module Pocky
+  require 'pocky/railtie' if defined?(Rails)
 end

data/lib/pocky/Rakefile

@@ -0,0 +1,4 @@
+require 'pocky'
+
+path = File.expand_path(__dir__)
+Dir.glob("#{path}/tasks/**/*.rake").each { |f| import f }

data/lib/pocky/packwerk.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+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)
+      new(**params).generate
+    end
+
+    private_class_method :new
+    def initialize(
+      root_path:,
+      default_package: 'Default',
+      filename: 'packwerk-viz.png',
+      dpi: 150
+    )
+      @root_paths = [*root_path]
+      raise InvalidRootPathError, 'root_path is required' if @root_paths.empty?
+
+      @default_package = default_package
+      @filename = filename
+      @dpi = dpi.to_i
+      @deprecated_references = {}
+      @nodes = {}
+    end
+
+    def generate
+      load_package_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|
+          provider_package = package_name_for_dependency(provider)
+          @nodes[provider_package] ||= graph.add_nodes(provider_package)
+
+          graph.add_edges(
+            @nodes[provider_package],
+            @nodes[package],
+            penwidth: edge_width(dependencies.length)
+          )
+        end
+      end
+
+      graph.output(png: @filename)
+    end
+
+    def edge_width(count)
+      [
+        [(count / 5).to_i, 1].max,
+        MAX_EDGE_WIDTH
+      ].min
+    end
+
+    def package_references
+      @package_references ||= @root_paths.flat_map do |path|
+        Dir["#{path}/**/#{REFERENCE_FILE_NAME}"]
+      end
+    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 parse_package_name(filename)
+      File.basename(File.dirname(filename))
+    end
+
+    def package_name_for_dependency(name)
+      return @default_package if name == '.'
+
+      reference_filename = package_references.find do |ref|
+        ref.match(/#{name}\/#{REFERENCE_FILE_NAME}$/)
+      end
+
+      parse_package_name(reference_filename)
+    end
+  end
+end

data/lib/pocky/railtie.rb

@@ -0,0 +1,13 @@
+require 'pocky'
+require 'rails'
+
+module Pocky
+  class Railtie < Rails::Railtie
+    railtie_name :pocky
+
+    rake_tasks do
+      path = File.expand_path(__dir__)
+      Dir.glob("#{path}/tasks/**/*.rake").each { |f| load f }
+    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.2.0"
+  VERSION = "1.7.0"
 end

metadata

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

data/lib/pocky/graph.rb

@@ -1,90 +0,0 @@
-# frozen_string_literal: true
-
-require 'yaml'
-require 'ruby-graphviz'
-
-module Pocky
-  class Graph
-    def self.generate(params)
-      new(**params).generate
-    end
-
-    private_class_method :new
-    def initialize(
-      root_path:,
-      default_package: 'Default',
-      package_prefix: '',
-      output_filename: 'pocky-graph.png'
-    )
-      @root_path = root_path
-      @default_package = default_package
-      @package_prefix = package_prefix
-      @output_filename = output_filename
-
-      @deprecated_references = {}
-      @nodes = {}
-    end
-
-    def generate
-      load_package_dependencies
-      build_directed_graph
-    end
-
-    private
-
-    def build_directed_graph
-      graph = GraphViz.new(:G, type: :digraph, dpi: 300)
-      @deprecated_references.each do |package, references|
-        @nodes[package] ||= graph.add_nodes(package)
-        references.each do |provider, dependencies|
-          provider_package = package_name_for_dependency(provider)
-          @nodes[provider_package] ||= graph.add_nodes(provider_package)
-
-          graph.add_edges(
-            @nodes[package],
-            @nodes[provider_package],
-            penwidth: edge_width(dependencies.length)
-          )
-        end
-      end
-
-      graph.output(png: @output_filename)
-    end
-
-    def edge_width(count)
-      [
-        [(count / 5).to_i, 1].max,
-        5
-      ].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
-      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
-      end
-    end
-
-    def deprecated_references_file_for(package)
-      File.join(@root_path, package, 'deprecated_references.yml')
-    end
-
-    def package_name_for_dependency(name)
-      return @default_package if name == '.'
-
-      name.gsub(@package_prefix, '').gsub(/^\//, '')
-    end
-  end
-end