pocky 1.9.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ad303bcc76eff49ab35053c61a7ad277165d40b999fcadac1d310be525ab69b
-  data.tar.gz: 16e002a3989465994fa932da11696b166468da711336f354fae58ece194087c4
+  metadata.gz: 817ec28553db2266db7aad79d4a6a007c185f72e07473e08f3cd406bd55da240
+  data.tar.gz: 1f35a2c830b7462c57a1860c851a349d11f5387d1ba9f04b0e91a44615ef8270
 SHA512:
-  metadata.gz: 9bc982c815e4becd96436596522ea9adf543ec3830e04e812185a452a263ee8715572dd260d2b912d2fd7ffaa2f2866ab5d9445b3ea841fa6486a9fd4bc1880e
-  data.tar.gz: 82a64fb0e51915f78085510a3b1aa78ea1e9a9b48a2a163f29610b280e613e2cfccfb7fb9e1bd6ff59df7b053b8decbcfd389f73d4aa96b0b2785aab318cb692
+  metadata.gz: cec156a41900ee641e2a71e1745c90196d7a7b4e7ee11fc0a8da50311462baa83559746244e3f548646aa26d14d1c619a12908b03353ea219f647baf289db853
+  data.tar.gz: 42bf0e9dd7c5bbee96cbb6756ef1d42dc5ecb49002dd9cdcad615a008f1e2e2ab995d50f04a705ac3094316ac389f31bf6d0eadd21cc0629f0012ca184964c46

data/README.md

@@ -2,18 +2,28 @@
 
 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.
+Invoke from irb or code.
+
+```ruby
+Pocky::Packwerk.generate
+```
+
+Invoke as a rake task:
+
+    $ rake pocky:generate
+
+
+#### Generate with custom options
 ```ruby
 Pocky::Packwerk.generate(
-  root_path: 'path/to/app/packages',
+  package_path: 'app/packages', # Relative path to packages directory
   default_package: 'app',       # The default package listed as "." in package.yml and deprecated_references.yml
-  filename: 'packwerk-viz.png', # Name of output file
+  filename: 'packwerk.png',     # Name of output file
   dpi: 100,                     # Output file resolution
-  package_color: 'darkgray',   # color name or hex color, see https://graphviz.org/doc/info/colors.html for more details
+  package_color: '#5CC8FF',   # color name or hex color, see https://graphviz.org/doc/info/colors.html for more details
   deprecated_reference_edge: 'black',
   dependency_edge: 'darkgreen',
 )
@@ -25,7 +35,7 @@ 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]"
+    $ rake pocky:generate"[app/packages,Monolith,packages.png,100]"
 
 
 #### `root_path` as an array
@@ -33,16 +43,16 @@ Invoke as a rake task:
 
 ```ruby
 Pocky::Packwerk.generate(
-  root_path: [
-    'path/to/app/packages/a',
-    'path/to/app/packages/z',
+  package_path: [
+    'app/packages/a',
+    'app/packages/z',
   ]
 )
 ```
 
 Generate the same graph using the rake task:
 
-    $ rake pocky:generate"[path/to/app/packages/a path/to/app/packages/z]"
+    $ rake pocky:generate"[app/packages/a app/packages/z]"
 
 
 ## Installation

data/lib/pocky/packwerk.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'pathname'
 require 'yaml'
 require 'ruby-graphviz'
 
@@ -18,16 +19,16 @@ module Pocky
 
     private_class_method :new
     def initialize(
-      root_path:,
+      package_path: nil,
       default_package: 'app',
-      filename: 'packwerk-viz.png',
+      filename: 'packwerk.png',
       dpi: 100,
-      package_color: 'darkgray',
-      dependency_edge: 'green3',
+      package_color: '#5CC8FF',
+      dependency_edge: 'darkgreen',
       deprecated_reference_edge: 'black'
     )
-      @root_paths = [*root_path]
-      raise InvalidRootPathError, 'root_path is required' if @root_paths.empty?
+      @package_paths = [*package_path] if package_path
+      @root_path = defined?(Rails) ? Rails.root : Pathname.new(Dir.pwd)
 
       @default_package = default_package
       @filename = filename
@@ -41,6 +42,7 @@ module Pocky
         fontcolor: 'white',
         fillcolor: package_color,
         color: package_color,
+        height: 1.0,
         style: 'filled, rounded',
         shape: 'box',
       }
@@ -109,14 +111,22 @@ module Pocky
     end
 
     def deprecated_references_files
-      @deprecated_references_files ||= @root_paths.flat_map do |path|
-        Dir["#{path}/**/#{DEPRECATED_REFERENCES_FILENAME}"]
+      @deprecated_references_files ||= begin
+        return Dir[@root_path.join('**', DEPRECATED_REFERENCES_FILENAME).to_s] unless @package_paths
+
+        @package_paths.flat_map do |path|
+          Dir[@root_path.join(path, '**', DEPRECATED_REFERENCES_FILENAME).to_s]
+        end
       end
     end
 
     def dependencies_files
-      @dependencies_files ||= @root_paths.flat_map do |path|
-        Dir["#{path}/**/#{DEPENDENCIES_FILENAME}"]
+      @dependencies_files ||= begin
+        return Dir[@root_path.join('**', DEPENDENCIES_FILENAME).to_s] unless @package_paths
+
+        @package_paths.flat_map do |path|
+          Dir[@root_path.join(path, '**', DEPENDENCIES_FILENAME).to_s]
+        end
       end
     end
 
@@ -142,21 +152,12 @@ module Pocky
     end
 
     def parse_package_name(filename)
-      File.basename(File.dirname(filename))
+      name = File.dirname(filename).gsub(@root_path.to_s, '')
+      name == '' ? @default_package : name.gsub(/^\//, '')
     end
 
     def package_name_for_dependency(name)
-      return @default_package if name == '.'
-
-      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
+      name == '.' ? @default_package : name
     end
   end
 end

data/lib/pocky/version.rb

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

metadata

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