pocky 1.1.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de85a86834e761f86f7bedb1752ff4f535386a8820b20f1e0efddaf82e9293f5
-  data.tar.gz: ab7fdbefec3d36ead1139ded153db6980f77590a93678d791c0ee4a0e84ae1e6
+  metadata.gz: 85bd82c4180bd9152f53dcf8dcfa2e0cdb54f93211f926823c62572b9c98c7bf
+  data.tar.gz: 759e6fe70c7981b6342957da759754833c275d086bf4c2b7caab6e4406cf6bf5
 SHA512:
-  metadata.gz: b789643c86e4953f8eca4edb1040c89200aa3441304ae4509e081678a4f85b7924f4027155f575b39cd1cd4d43c16c40b556e8c2160f07dbb8bc7f4aa226388b
-  data.tar.gz: 02dc8b3e3ae974b5917f6081300196d95aedbc8d0ba27eff7a7f0f550c3fc518f1b8f6edc8e82de3fa9825ad48fdea3e42fafc4e1b2e10a108943da5896d5ca8
+  metadata.gz: d7db906a22cfd1c05fca50101bc0f5c896c6d3ade27cb998a7ab0e6218094a420577a0bd59a67bc41c851007bd73590735b4251e6ed60cff79ef41532572e8c8
+  data.tar.gz: 2a8078b50d6d0f0fd46ae1269b18f2602d5f69487ac431400d122b4bcddf4415457cd2b695483eda803c3117f80a4b52d5c2c78221406fdbc156bae6b1530dcd

data/README.md

@@ -1,20 +1,31 @@
 # 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
 ```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
+  package_prefix: 'app/packages',     # this is for matching package names listed 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,Default,app/packages,packwerk-viz.png,150]
+```
 
 ## Installation
 

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/{graph.rb → packwerk.rb}

@@ -4,7 +4,9 @@ require 'yaml'
 require 'ruby-graphviz'
 
 module Pocky
-  class Graph
+  class Packwerk
+    MAX_EDGE_WIDTH = 5
+
     def self.generate(params)
       new(**params).generate
     end
@@ -14,13 +16,14 @@ module Pocky
       root_path:,
       default_package: 'Default',
       package_prefix: '',
-      output_filename: 'pocky-graph.png'
+      filename: 'packwerk-viz.png',
+      dpi: 150
     )
       @root_path = root_path
       @default_package = default_package
       @package_prefix = package_prefix
-      @output_filename = output_filename
-
+      @filename = filename
+      @dpi = dpi.to_i
       @deprecated_references = {}
       @nodes = {}
     end
@@ -33,7 +36,7 @@ module Pocky
     private
 
     def build_directed_graph
-      graph = GraphViz.new(:G, type: :digraph, dpi: 300)
+      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|
@@ -41,24 +44,24 @@ module Pocky
           @nodes[provider_package] ||= graph.add_nodes(provider_package)
 
           graph.add_edges(
-            @nodes[package],
             @nodes[provider_package],
+            @nodes[package],
             penwidth: edge_width(dependencies.length)
           )
         end
       end
 
-      graph.output(png: @output_filename)
+      graph.output(png: @filename)
     end
 
     def edge_width(count)
       [
         [(count / 5).to_i, 1].max,
-        5
+        MAX_EDGE_WIDTH
       ].min
     end
 
-    def load_dependencies
+    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)

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,8 @@
+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)
+  end
+end

data/lib/pocky/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pocky
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Quan Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-12-28 00:00:00.000000000 Z
+date: 2020-12-29 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