graphwerk 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf78a60a25721799a4c6dc0623fa3678ceead0369974a26a7828ce05b10a81e6
-  data.tar.gz: 877ded46de6dd8a16320e0eca0b0bf4f9cd1bed69e70aaf28b6b37057d25cb8d
+  metadata.gz: 7af64b8123b10c0d175ca2b59b321cd0a5140ce3216dfc1d2bd5851f362b5642
+  data.tar.gz: 05c51382e40bc20ebf51deb955a2bf6b715ee3992f7ceb379d638233cfe998c9
 SHA512:
-  metadata.gz: 7f0abf8f377d771f2bd7fee6abc0d9872187493cca876b7ebea34511df1ef47b8c7c976f14d6b9671f9e5ad7a0fd3d6bef0aca56a3b199946fdfe73aedc5b009
-  data.tar.gz: be181ec7c607241974d2753cc0bc649a10d880624316a674e671b43bad259e8e56658d886486fb35970766dea95280eb8bfd209138af605da0ad64be299b6e36
+  metadata.gz: 1cef57b21fe954604e46777f4a35a8200c0bf33f4b0b7a36345faf6a38eb1af2ddbe86462cb79a9bd3ddf90fa3fc7845168b317f59fbd717f1f54e1cda5e88e8
+  data.tar.gz: fdd4b9b472b4ea595f0e13929448459a7524d10e2edf9efa2f5ef77afc77df2c61e1fe99af2f6bb66b2178974c954e9a823d02301fa71beacaaec8c1228f9bff

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+1.2.0
+
+* Deprecated references are now drawn on the output graph.
+
 1.1.0
 
 * Default layout switched to Dot

data/README.md

@@ -40,6 +40,7 @@ graph = Graphwerk::Builders::Graph.new(
    Packwerk::PackageSet.load_all_from("."),
    options: {
      layout: Graphwerk::Layout::Twopi,
+     deprecated_references_color: 'yellow',
      graph: { overlap: true },
      node: { fillcolor: '#000000' },
      edges: { len: '3.0' }

data/lib/graphwerk.rb

@@ -8,6 +8,7 @@ require 'active_support/core_ext/hash/deep_merge'
 require 'graphwerk/version'
 require 'graphwerk/constants'
 require 'graphwerk/layout'
+require 'graphwerk/deprecated_references_loader'
 require 'graphwerk/presenters/package'
 require 'graphwerk/builders/graph'
 require 'graphwerk/railtie' if defined?(Rails)

data/lib/graphwerk/builders/graph.rb

@@ -9,6 +9,7 @@ module Graphwerk
       OptionsShape = T.type_alias {
         {
           layout: Graphwerk::Layout,
+          deprecated_references_color: String,
           application: T::Hash[Symbol, Object],
           graph: T::Hash[Symbol, Object],
           node: T::Hash[Symbol, Object],
@@ -18,6 +19,7 @@ module Graphwerk
 
       DEFAULT_OPTIONS = T.let({
         layout: Graphwerk::Layout::Dot,
+        deprecated_references_color: 'red',
         application: {
           style: 'filled',
           fillcolor: '#333333',
@@ -41,10 +43,11 @@ module Graphwerk
         }
       }, OptionsShape)
 
-      sig { params(package_set: Packwerk::PackageSet, options: T::Hash[Symbol, Object]).void }
-      def initialize(package_set, options: {})
+      sig { params(package_set: Packwerk::PackageSet, options: T::Hash[Symbol, Object], root_path: Pathname).void }
+      def initialize(package_set, options: {}, root_path: Pathname.new(ENV['PWD']))
         @package_set = package_set
         @options = T.let(DEFAULT_OPTIONS.deep_merge(options), OptionsShape)
+        @root_path = root_path
         @graph = T.let(build_empty_graph, GraphViz)
         @nodes = T.let(build_empty_nodes, T::Hash[String, GraphViz::Node])
       end
@@ -85,7 +88,10 @@ module Graphwerk
 
       sig { void }
       def add_package_dependencies_to_graph
-        packages.each { |package| draw_dependencies(package) }
+        packages.each do |package|
+          draw_dependencies(package)
+          draw_deprecated_references(package)
+        end
       end
 
       sig { void }
@@ -102,10 +108,21 @@ module Graphwerk
         end
       end
 
+      sig { params(package: Presenters::Package).void }
+      def draw_deprecated_references(package)
+        package.deprecated_references.each do |reference|
+          @graph.add_edges(
+            @nodes[package.name],
+            @nodes[reference],
+            color: @options[:deprecated_references_color]
+          )
+        end
+      end
+
       sig { returns(T::Array[Presenters::Package]) }
       def packages
         @packages = T.let(@packages, T.nilable(T::Array[Presenters::Package]))
-        @packages ||= @package_set.map { |package| Presenters::Package.new(package) }
+        @packages ||= @package_set.map { |package| Presenters::Package.new(package, @root_path) }
       end
     end
   end

data/lib/graphwerk/deprecated_references_loader.rb

@@ -0,0 +1,31 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Graphwerk
+  class DeprecatedReferencesLoader
+    extend T::Sig
+
+    sig { params(package: Packwerk::Package, root_path: Pathname).void }
+    def initialize(package, root_path)
+      @package = package
+      @root_path = root_path
+    end
+
+    sig { returns(T::Array[String]) }
+    def load
+      return [] if !deprecated_references_file.exist?
+
+      (YAML.load_file(deprecated_references_file) || {}).keys
+    end
+
+    private
+
+    DEPRECATED_REFERENCES_FILENAME = 'deprecated_references.yml'
+
+    sig { returns(Pathname) }
+    def deprecated_references_file
+      @deprecated_references_file = T.let(@deprecated_references_file, T.nilable(Pathname))
+      @deprecated_references_file ||= @root_path.join(@package.name, DEPRECATED_REFERENCES_FILENAME)
+    end
+  end
+end

data/lib/graphwerk/presenters/package.rb

@@ -6,9 +6,10 @@ module Graphwerk
     class Package
       extend T::Sig
 
-      sig { params(package: Packwerk::Package).void }
-      def initialize(package)
+      sig { params(package: Packwerk::Package, root_path: Pathname).void }
+      def initialize(package, root_path)
         @package = package
+        @root_path = root_path
       end
 
       sig { returns(String) }
@@ -21,6 +22,13 @@ module Graphwerk
         @package.dependencies.map { |dependency| Name.new(dependency).node_name }
       end
 
+      sig { returns(T::Array[String]) }
+      def deprecated_references
+        DeprecatedReferencesLoader.new(@package, @root_path).load.map do |reference|
+          Name.new(reference).node_name
+        end
+      end
+
       ROOT_COLOR = 'black'
       COMPONENT_COLOR = 'azure4'
 
@@ -54,11 +62,9 @@ module Graphwerk
           Constants::ROOT_PACKAGE_NAME
         end
 
-        ROOT_PACKAGE = '.'
-
         sig { returns(T::Boolean) }
         def root?
-          @package_name == ROOT_PACKAGE
+          @package_name == Packwerk::Package::ROOT_PACKAGE_NAME
         end
 
         private
@@ -67,8 +73,6 @@ module Graphwerk
         def without_root_package
           T.must(@package_name.split('/', 2).last)
         end
-
-        private_constant :ROOT_PACKAGE
       end
 
       private_constant :ROOT_COLOR,

data/lib/graphwerk/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphwerk
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Samuel Giles
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-30 00:00:00.000000000 Z
+date: 2020-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -172,6 +172,7 @@ files:
 - lib/graphwerk.rb
 - lib/graphwerk/builders/graph.rb
 - lib/graphwerk/constants.rb
+- lib/graphwerk/deprecated_references_loader.rb
 - lib/graphwerk/layout.rb
 - lib/graphwerk/presenters/package.rb
 - lib/graphwerk/railtie.rb