pocky 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fce51337b66240934ecb460959861226aafedb75
-  data.tar.gz: 75f97f5c6c17fade8d7e70b1119256e70bddd833
+SHA256:
+  metadata.gz: 1bd1bd4dd6b8693596464cce4a18d69e015acb74d0534bf80c0f4861dbcb3487
+  data.tar.gz: b04b473ba73db68dcdd62ba9e76bf8ef25d2febba6ffe9cc11d1d90946f74243
 SHA512:
-  metadata.gz: c71ef6721a70df6cbe50e76faf256faf8021255e08406fcca9f9d1d0a22acee48c1cdf44b074db6703b183746ac5513a27620975936302f4199218511ba79b21
-  data.tar.gz: 1a3ee14c5c8f52150ec2e46bff9208d5f82c45d3163098117904ecf4994e52ecb8f36ae1dd6e09347195266a821a603d5f6624ff64a68088eb5ce26151ba32f6
+  metadata.gz: b572f0aeb26942d289a15ac2d066bcdaa2908810f3cc729725f212c41598dabb33690b72da3e3deb35b7945e668d70ddccca498f00043abc25ac5a36252949cb
+  data.tar.gz: 29c7d372e528161abc4e3c833521860a89a4411fd2f5cb35f294df150b0c697256b38dd8ca34009be21250467b14a1600bda76fa556e0fa2bdd2d96bf8701571

data/README.md

@@ -6,18 +6,26 @@ Pocky generates dependency graphs for your packwerk packages. The gem is named a
 
 ## 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 wider edges indicate more references.
+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/Rakefile

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

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

@@ -4,7 +4,7 @@ require 'yaml'
 require 'ruby-graphviz'
 
 module Pocky
-  class Graph
+  class Packwerk
     MAX_EDGE_WIDTH = 5
 
     def self.generate(params)
@@ -16,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
-
+      @output_dpi = output_dpi.to_i
       @deprecated_references = {}
       @nodes = {}
     end
@@ -35,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: @output_dpi)
       @deprecated_references.each do |package, references|
         @nodes[package] ||= graph.add_nodes(package)
         references.each do |provider, dependencies|

data/lib/pocky/version.rb

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

data/lib/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/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]: :environment do |_task, args|
+    Pocky::Packwerk.generate(args)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pocky
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Quan Nguyen
@@ -40,9 +40,12 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- lib/Rakefile
 - lib/pocky.rb
-- lib/pocky/graph.rb
+- lib/pocky/packwerk.rb
 - lib/pocky/version.rb
+- lib/railtie.rb
+- lib/tasks/generate.rake
 - pocky.gemspec
 homepage: https://github.com/mquan/pocky
 licenses:
@@ -66,8 +69,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: A ruby gem that generates dependency graph for your packwerk packages