graphwerk 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14fe65bc2ddbecc3e621774f3ce56173f837ef84c8967e66238b4e1914f86134
-  data.tar.gz: c5a2218164c40cce1fa5c9131e581754fdd7797b1ae3e96d024b25701f249c0a
+  metadata.gz: 4740933529aec75ed8570637a356ed28477b4490fe7276980dc26a58ae87c563
+  data.tar.gz: 2ccabcdeaaedd6fce1488658fb3642459db87ff72e8dcd6768c33032a684fa70
 SHA512:
-  metadata.gz: 84160d2620769c3347b418a4a583b1b9226f564eb7d1cb4159e985ed4451fa98da6d020f353058fe0615a103d1860156215ffae6c9c9c185df0c7ce5a2185827
-  data.tar.gz: 18a3046303f1c74d48bb87638ba43a978fdaa7189543154da95a4565d5b2ba80e389aa002e0b6610e3d0c4f7b90f4ab4b193b3bc1f2e427466fc9779db5f727f
+  metadata.gz: 46ca8349efe1370511c43b1375184646295dcaea7ff5b16d9ea24b5b165afa1aad20feb5c0055fa5179ce00f47299e1429799be8fcc08b4a1e5c40863819fa5a
+  data.tar.gz: bca7bc7aa9393eedd5122ce7c6e4e836eb06a458dbca2751a2b51d11cd63ea7540baecf3449369e0ae08bcbfa25a05075480328e33bca7736905216aea100e24

data/.github/workflows/ci.yml

@@ -1,5 +1,7 @@
 ---
 name: Continuous Integration
+env:
+  SLACK_CHANNEL_ID: C0317P7C9C2
 on:
   push:
     branches-ignore:
@@ -38,9 +40,9 @@ jobs:
         || github.ref == 'refs/heads/stable')
       uses: pullreminders/slack-action@a5a262c896a1cc80dcbae59ba95513e2dfb21439
       env:
-        SLACK_BOT_TOKEN: "${{ secrets.SLACK_BOT_TOKEN }}"
+        SLACK_BOT_TOKEN: "${{ secrets.BELLROY_SLACK_TOKEN }}"
       with:
-        args: '{\"channel\":\"C33574SJJ\",\"text\":\"* ${{ github.repository }} BUILD
+        args: '{\"channel\":\"{{ env.SLACK_CHANNEL_ID }}\",\"text\":\"* ${{ github.repository }} BUILD
           FAILURE*\", \"attachments\": [{ \"fallback\": \"Failure summary\", \"color\":
           \"#ff0000\", \"fields\": [{\"title\": \"Branch\", \"value\":\"${{ steps.extract_branch.outputs.branch
           }}\"}, {\"title\": \"Who broke it\", \"value\":\"${{ github.actor }}\"},

data/.gitignore

@@ -13,7 +13,6 @@
 # rspec failure tracking
 .rspec_status
 
-/shell.nix
 /tags
 
 *.log

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+1.3.0
+
+* Draw package_todo.yml dependencies
+* Add configuration option to hide todo edges on the graph
+
 1.2.1
 
 * Add some nicer error messages when dependencies are not found

data/README.md

@@ -1,6 +1,6 @@
 ![graphwerk-logo](https://user-images.githubusercontent.com/2643026/95463568-cfaada80-0970-11eb-8305-aea01a0d77a9.png)
 
-# Graphwerk [![Gem Version](https://badge.fury.io/rb/graphwerk.svg)](https://badge.fury.io/rb/graphwerk) ![CI Badge](https://github.com/tricycle/graphwerk/workflows/RSpec%20Test%20Suite/badge.svg)
+# Graphwerk [![Gem Version](https://badge.fury.io/rb/graphwerk.svg)](https://badge.fury.io/rb/graphwerk) [![Continuous Integration](https://github.com/bellroy/graphwerk/actions/workflows/ci.yml/badge.svg)](https://github.com/bellroy/graphwerk/actions/workflows/ci.yml)
 
 Graphwerk is a small Ruby gem that can generate a diagram of dependencies between packages within an application that's using Packwerk to enforce boundaries.
 
@@ -41,6 +41,7 @@ graph = Graphwerk::Builders::Graph.new(
    options: {
      layout: Graphwerk::Layout::Twopi,
      deprecated_references_color: 'yellow',
+     package_todo_color: 'yellow',
      graph: { overlap: true },
      node: { fillcolor: '#000000' },
      edges: { len: '3.0' }

data/lib/graphwerk/builders/graph.rb

@@ -10,6 +10,8 @@ module Graphwerk
         {
           layout: Graphwerk::Layout,
           deprecated_references_color: String,
+          package_todo_color: String,
+          hide_todo: T::Boolean,
           application: T::Hash[Symbol, Object],
           graph: T::Hash[Symbol, Object],
           node: T::Hash[Symbol, Object],
@@ -20,6 +22,8 @@ module Graphwerk
       DEFAULT_OPTIONS = T.let({
         layout: Graphwerk::Layout::Dot,
         deprecated_references_color: 'red',
+        package_todo_color: 'red',
+        hide_todo: false,
         application: {
           style: 'filled',
           fillcolor: '#333333',
@@ -90,7 +94,10 @@ module Graphwerk
       def add_package_dependencies_to_graph
         packages.each do |package|
           draw_dependencies(package)
+          next if @options[:hide_todo]
+
           draw_deprecated_references(package)
+          draw_package_todos(package)
         end
       end
 
@@ -122,6 +129,17 @@ module Graphwerk
         end
       end
 
+      sig { params(package: Presenters::Package).void }
+      def draw_package_todos(package)
+        package.package_todos.each do |todo|
+          @graph.add_edges(
+            @nodes[package.name],
+            @nodes[todo],
+            color: @options[:package_todo_color]
+          )
+        end
+      end
+
       sig { returns(T::Array[Presenters::Package]) }
       def packages
         @packages = T.let(@packages, T.nilable(T::Array[Presenters::Package]))

data/lib/graphwerk/package_todo_loader.rb

@@ -0,0 +1,31 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Graphwerk
+  class PackageTodoLoader
+    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 !package_todo_file.exist?
+
+      (YAML.load_file(package_todo_file) || {}).keys
+    end
+
+    private
+
+    PACKAGE_TODO_FILENAME = 'package_todo.yml'
+
+    sig { returns(Pathname) }
+    def package_todo_file
+      @package_todo_file = T.let(@package_todo_file, T.nilable(Pathname))
+      @package_todo_file ||= @root_path.join(@package.name, PACKAGE_TODO_FILENAME)
+    end
+  end
+end

data/lib/graphwerk/presenters/package.rb

@@ -29,6 +29,13 @@ module Graphwerk
         end
       end
 
+      sig { returns(T::Array[String]) }
+      def package_todos
+        PackageTodoLoader.new(@package, @root_path).load.map do |todo|
+          Name.new(todo).node_name
+        end
+      end
+
       ROOT_COLOR = 'black'
       COMPONENT_COLOR = 'azure4'
 

data/lib/graphwerk/version.rb

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

data/lib/graphwerk.rb

@@ -9,6 +9,7 @@ require 'graphwerk/version'
 require 'graphwerk/constants'
 require 'graphwerk/layout'
 require 'graphwerk/deprecated_references_loader'
+require 'graphwerk/package_todo_loader'
 require 'graphwerk/presenters/package'
 require 'graphwerk/builders/graph'
 require 'graphwerk/railtie' if defined?(Rails)

data/shell.nix

@@ -0,0 +1,20 @@
+{ sources ? import ./nix/sources.nix }:
+let
+  nixpkgs = import sources.nixpkgs { };
+in
+nixpkgs.mkShell {
+  name = "bellroy-gem-env";
+  buildInputs = with nixpkgs; [
+    bundler
+    libnotify
+    niv
+    pkg-config
+    readline
+    ruby_2_7
+    zlib
+  ]
+  ++ (if stdenv.hostPlatform.isDarwin then [ libiconv darwin.apple_sdk.frameworks.CoreServices ] else [ ]);
+  shellHook = ''
+    bundle config --local path "$PWD/vendor/bundle"
+  '';
+}

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: graphwerk
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Samuel Giles
-autorequire:
 bindir: exe
 cert_chain: []
-date: 1980-01-01 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -164,7 +163,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
 email:
 - samuel.giles@bellroy.com
 executables: []
@@ -172,7 +170,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/ci.yml"
-- ".github/workflows/rspec.yml"
 - ".gitignore"
 - ".rspec"
 - CHANGELOG.md
@@ -189,6 +186,7 @@ files:
 - lib/graphwerk/constants.rb
 - lib/graphwerk/deprecated_references_loader.rb
 - lib/graphwerk/layout.rb
+- lib/graphwerk/package_todo_loader.rb
 - lib/graphwerk/presenters/package.rb
 - lib/graphwerk/railtie.rb
 - lib/graphwerk/tasks/rails.rake
@@ -196,11 +194,11 @@ files:
 - nix/sources.json
 - nix/sources.nix
 - run_ci.sh
+- shell.nix
 homepage: https://github.com/tricycle/graphwerk
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -215,8 +213,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.16
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Visualise dependencies between your application and it's Packwerk packages
   using Graphviz.

data/.github/workflows/rspec.yml

@@ -1,23 +0,0 @@
-name: RSpec Test Suite
-
-on: [push]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-    - name: Checkout branch
-      uses: actions/checkout@v1
-    - name: Set up Ruby
-      uses: actions/setup-ruby@v1
-      with:
-        ruby-version: 2.6.6
-    - name: Install latest bundler
-      run: |
-        command -v bundler || gem install bundler
-    - name: Install gems
-      run: bundle install --jobs $(nproc) --retry 3
-    - name: Typecheck with Sorbet
-      run: bundle exec srb tc . --ignore=/vendor
-    - name: Run RSpec test suite
-      run: bundle exec rspec spec