graphwerk 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d3fb33710355e47f3bbfaa7c9f78e01547cad92a379d0d449e9f9e4b9f2be5a
-  data.tar.gz: 16c12353022a3b87bc1aae310fddbb176b0d4718ac7a85a33b17672d3ed1edab
+  metadata.gz: bf78a60a25721799a4c6dc0623fa3678ceead0369974a26a7828ce05b10a81e6
+  data.tar.gz: 877ded46de6dd8a16320e0eca0b0bf4f9cd1bed69e70aaf28b6b37057d25cb8d
 SHA512:
-  metadata.gz: ca38ee1799a0c4bb6fc08ed41836c6773d80c2ffbb86333baedbcd390ac390866a9d4bb416282a06dba7d8e3520ac33d5089c6aa6814159479995c74c4fb12b1
-  data.tar.gz: ca18e12ca29229fd82aaa316bd24bf40053fac581e3c25be1a71649c58498ecab3b131087183d54aa125f7348e03916c2352d71712fd2d374073eb616628983e
+  metadata.gz: 7f0abf8f377d771f2bd7fee6abc0d9872187493cca876b7ebea34511df1ef47b8c7c976f14d6b9671f9e5ad7a0fd3d6bef0aca56a3b199946fdfe73aedc5b009
+  data.tar.gz: be181ec7c607241974d2753cc0bc649a10d880624316a674e671b43bad259e8e56658d886486fb35970766dea95280eb8bfd209138af605da0ad64be299b6e36

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+1.1.0
+
+* Default layout switched to Dot
+* Fixed a bug when running on an application where packages depend on the root package
+
 1.0.0
 
 * Initial release

data/README.md

@@ -8,13 +8,13 @@ The gem builds on top of [Packwerk](https://github.com/Shopify/packwerk) and [Gr
 
 Here's an example application package dependency diagram:
 
-![example](https://user-images.githubusercontent.com/2643026/95458900-c159c000-096a-11eb-86b7-b5ef7c1e936d.png)
+![example](https://user-images.githubusercontent.com/2643026/97689408-6ca1f480-1a93-11eb-9999-22e79791b300.png)
 
 ## Install
 
 Add this line to your application's Gemfile and run `bundle install`:
 
-`gem 'graphwerk'`
+`gem 'graphwerk', group: %i[development test]`
 
 ## Usage
 
@@ -24,7 +24,7 @@ For Rails applications a Railtie automatically loads a rake task that makes it e
 bundle exec rake graphwerk:update
 ```
 
-More advance usage is possible by passing a `Packwerk::PackageSet` directly to `Graphwerk::Builders::Graph` and calling `#build` returning a `Graphviz` instance:
+More advance usage is possible by passing a [`Packwerk::PackageSet`](https://github.com/Shopify/packwerk/blob/main/lib/packwerk/package_set.rb) directly to `Graphwerk::Builders::Graph` and calling `#build` returning a `Graphviz` instance:
 
 ```ruby
 graph = Graphwerk::Builders::Graph.new(
@@ -33,7 +33,7 @@ graph = Graphwerk::Builders::Graph.new(
 graph.output(svg: 'packwerk.svg')
 ```
 
-All Graphviz layouts are supported and options for the graph, nodes and edges can be set via an optional `options` argument:
+All [Graphviz layouts](https://graphviz.org/documentation/#layout-manual-pages) are supported and options for the graph, nodes and edges can be set via an optional `options` argument:
 
 ```ruby
 graph = Graphwerk::Builders::Graph.new(

data/lib/graphwerk/builders/graph.rb

@@ -17,7 +17,7 @@ module Graphwerk
       }
 
       DEFAULT_OPTIONS = T.let({
-        layout: Graphwerk::Layout::Fdp,
+        layout: Graphwerk::Layout::Dot,
         application: {
           style: 'filled',
           fillcolor: '#333333',

data/lib/graphwerk/layout.rb

@@ -2,6 +2,7 @@
 # frozen_string_literal: true
 
 module Graphwerk
+  # https://graphviz.org/documentation/#layout-manual-pages
   class Layout < T::Enum
     enums do
       Dot = new

data/lib/graphwerk/presenters/package.rb

@@ -11,21 +11,14 @@ module Graphwerk
         @package = package
       end
 
-      WITHOUT_ROOT_FOLDER = T.let(
-        ->(package_name) { package_name.split('/', 2).last },
-        T.proc.params(package_name: String).returns(String)
-      )
-
       sig { returns(String) }
       def name
-        return WITHOUT_ROOT_FOLDER.call(@package.name) unless root?
-
-        Constants::ROOT_PACKAGE_NAME
+        package_name.node_name
       end
 
       sig { returns(T::Array[String]) }
       def dependencies
-        @package.dependencies.map { |dependency| WITHOUT_ROOT_FOLDER.call(dependency) }
+        @package.dependencies.map { |dependency| Name.new(dependency).node_name }
       end
 
       ROOT_COLOR = 'black'
@@ -33,24 +26,54 @@ module Graphwerk
 
       sig { returns(String) }
       def color
-        return ROOT_COLOR if root?
+        return ROOT_COLOR if package_name.root?
 
         COMPONENT_COLOR
       end
 
       private
 
-      ROOT_PACKAGE = '.'
+      sig { returns(Name) }
+      def package_name
+        @package_name = T.let(@package_name, T.nilable(Name))
+        @package_name ||= Name.new(@package.name)
+      end
+
+      class Name
+        extend T::Sig
+
+        sig { params(package_name: String).void }
+        def initialize(package_name)
+          @package_name = package_name
+        end
+
+        sig { returns(String) }
+        def node_name
+          return without_root_package unless root?
+
+          Constants::ROOT_PACKAGE_NAME
+        end
+
+        ROOT_PACKAGE = '.'
+
+        sig { returns(T::Boolean) }
+        def root?
+          @package_name == ROOT_PACKAGE
+        end
+
+        private
+
+        sig { returns(String) }
+        def without_root_package
+          T.must(@package_name.split('/', 2).last)
+        end
 
-      sig { returns(T::Boolean) }
-      def root?
-        @package.name == ROOT_PACKAGE
+        private_constant :ROOT_PACKAGE
       end
 
-      private_constant :ROOT_PACKAGE,
-                       :ROOT_COLOR,
+      private_constant :ROOT_COLOR,
                        :COMPONENT_COLOR,
-                       :WITHOUT_ROOT_FOLDER
+                       :Name
     end
   end
 end

data/lib/graphwerk/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module Graphwerk
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphwerk
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Samuel Giles
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-08 00:00:00.000000000 Z
+date: 2020-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport