graphwerk 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7af64b8123b10c0d175ca2b59b321cd0a5140ce3216dfc1d2bd5851f362b5642
-  data.tar.gz: 05c51382e40bc20ebf51deb955a2bf6b715ee3992f7ceb379d638233cfe998c9
+  metadata.gz: 4740933529aec75ed8570637a356ed28477b4490fe7276980dc26a58ae87c563
+  data.tar.gz: 2ccabcdeaaedd6fce1488658fb3642459db87ff72e8dcd6768c33032a684fa70
 SHA512:
-  metadata.gz: 1cef57b21fe954604e46777f4a35a8200c0bf33f4b0b7a36345faf6a38eb1af2ddbe86462cb79a9bd3ddf90fa3fc7845168b317f59fbd717f1f54e1cda5e88e8
-  data.tar.gz: fdd4b9b472b4ea595f0e13929448459a7524d10e2edf9efa2f5ef77afc77df2c61e1fe99af2f6bb66b2178974c954e9a823d02301fa71beacaaec8c1228f9bff
+  metadata.gz: 46ca8349efe1370511c43b1375184646295dcaea7ff5b16d9ea24b5b165afa1aad20feb5c0055fa5179ce00f47299e1429799be8fcc08b4a1e5c40863819fa5a
+  data.tar.gz: bca7bc7aa9393eedd5122ce7c6e4e836eb06a458dbca2751a2b51d11cd63ea7540baecf3449369e0ae08bcbfa25a05075480328e33bca7736905216aea100e24

data/.github/workflows/ci.yml

@@ -0,0 +1,50 @@
+---
+name: Continuous Integration
+env:
+  SLACK_CHANNEL_ID: C0317P7C9C2
+on:
+  push:
+    branches-ignore:
+    - refs/tags/*_staging
+    - refs/tags/*_production
+jobs:
+  build:
+    runs-on: ubuntu-18.04
+    steps:
+    - name: Checkout branch
+      uses: actions/checkout@v2
+    - name: Extract branch name
+      shell: bash
+      run: echo "##[set-output name=branch;]$(echo ${GITHUB_REF#refs/heads/})"
+      id: extract_branch
+    - name: Cache gems
+      uses: actions/cache@v2
+      with:
+        path: vendor/bundle
+        key: "${{ runner.OS }}-gem-cache-${{ hashFiles('**/*.gemspec')
+          }}"
+        restore-keys: "${{ runner.OS }}-gem-cache-\n"
+    - uses: "cachix/install-nix-action@8d6d5e949675fbadb765c6b1a975047fa5f09b27"
+      with:
+        extra_nix_config: |
+          post-build-hook = /etc/nix/upload-to-cache.sh
+          substituters = https://cache.nixos.org/
+          trusted-public-keys = cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY=
+        nix_path: nixpkgs=channel:nixos-21.05
+    - name: Run CI through nix-shell
+      env:
+        GEMFURY_DEPLOY_TOKEN: ${{ secrets.GEMFURY_DEPLOY_TOKEN }}
+      run: nix-shell --run "chmod 755 ./run_ci.sh && ./run_ci.sh"
+    - name: Post to Slack if build fails
+      if: failure() && (github.ref == 'refs/heads/master' || github.ref == 'refs/heads/main'
+        || github.ref == 'refs/heads/stable')
+      uses: pullreminders/slack-action@a5a262c896a1cc80dcbae59ba95513e2dfb21439
+      env:
+        SLACK_BOT_TOKEN: "${{ secrets.BELLROY_SLACK_TOKEN }}"
+      with:
+        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 }}\"},
+          { \"title\": \"Build output\", \"value\": \"https://github.com/${{ github.repository
+          }}/commit/${{ github.sha }}/checks\", \"short\": false }]}]}'

data/.gitignore

@@ -13,10 +13,11 @@
 # rspec failure tracking
 .rspec_status
 
-/shell.nix
 /tags
 
 *.log
 .DS_Store
 
 .ruby-gemset
+.direnv
+.envrc

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+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
+* Use Tapioca for RBI generation
+* Use Nix for development environment and CI (Bellroy standard)
+
 1.2.0
 
 * Deprecated references are now drawn on the output graph.

data/Gemfile

@@ -10,5 +10,4 @@ group :development, :test do
   gem 'rb-fsevent', require: false
   gem 'rb-readline'
   gem 'rspec'
-  gem 'shoulda-matchers', require: false
 end

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/bin/tapioca

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'tapioca' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("tapioca", "tapioca")

data/graphwerk.gemspec

@@ -33,4 +33,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'sorbet'
   spec.add_development_dependency 'rspec-sorbet'
+  spec.add_development_dependency 'tapioca'
 end

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
 
@@ -104,6 +111,9 @@ module Graphwerk
       sig { params(package: Presenters::Package).void }
       def draw_dependencies(package)
         package.dependencies.each do |dependency|
+          unless @nodes[dependency]
+            abort "Unable to add edge `#{package.name}`->`#{dependency}`"
+          end
           @graph.add_edges(@nodes[package.name], @nodes[dependency], color: package.color)
         end
       end
@@ -119,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/railtie.rb

@@ -1,4 +1,4 @@
-# typed: false
+# typed: ignore
 # frozen_string_literal: true
 
 module Graphwerk

data/lib/graphwerk/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module Graphwerk
-  VERSION = '1.2.0'
+  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/nix/sources.json

@@ -0,0 +1,14 @@
+{
+    "nixpkgs": {
+        "branch": "nixos-21.05",
+        "description": "Nix packages collection",
+        "homepage": "https://github.com/NixOS/nixpkgs",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "e85f0175e3effe9ba191d66c09e8f1b7d6362d5e",
+        "sha256": "1qr2hmymbzwj8jrz6smcgc04scgwp2v5070x22k4fvh261g1n4zw",
+        "type": "tarball",
+        "url": "https://github.com/NixOS/nixpkgs/archive/e85f0175e3effe9ba191d66c09e8f1b7d6362d5e.tar.gz",
+        "url_template": "https://github.com/<owner>/<repo>/archive/<rev>.tar.gz"
+    }
+}

data/nix/sources.nix

@@ -0,0 +1,174 @@
+# This file has been generated by Niv.
+
+let
+
+  #
+  # The fetchers. fetch_<type> fetches specs of type <type>.
+  #
+
+  fetch_file = pkgs: name: spec:
+    let
+      name' = sanitizeName name + "-src";
+    in
+      if spec.builtin or true then
+        builtins_fetchurl { inherit (spec) url sha256; name = name'; }
+      else
+        pkgs.fetchurl { inherit (spec) url sha256; name = name'; };
+
+  fetch_tarball = pkgs: name: spec:
+    let
+      name' = sanitizeName name + "-src";
+    in
+      if spec.builtin or true then
+        builtins_fetchTarball { name = name'; inherit (spec) url sha256; }
+      else
+        pkgs.fetchzip { name = name'; inherit (spec) url sha256; };
+
+  fetch_git = name: spec:
+    let
+      ref =
+        if spec ? ref then spec.ref else
+          if spec ? branch then "refs/heads/${spec.branch}" else
+            if spec ? tag then "refs/tags/${spec.tag}" else
+              abort "In git source '${name}': Please specify `ref`, `tag` or `branch`!";
+    in
+      builtins.fetchGit { url = spec.repo; inherit (spec) rev; inherit ref; };
+
+  fetch_local = spec: spec.path;
+
+  fetch_builtin-tarball = name: throw
+    ''[${name}] The niv type "builtin-tarball" is deprecated. You should instead use `builtin = true`.
+        $ niv modify ${name} -a type=tarball -a builtin=true'';
+
+  fetch_builtin-url = name: throw
+    ''[${name}] The niv type "builtin-url" will soon be deprecated. You should instead use `builtin = true`.
+        $ niv modify ${name} -a type=file -a builtin=true'';
+
+  #
+  # Various helpers
+  #
+
+  # https://github.com/NixOS/nixpkgs/pull/83241/files#diff-c6f540a4f3bfa4b0e8b6bafd4cd54e8bR695
+  sanitizeName = name:
+    (
+      concatMapStrings (s: if builtins.isList s then "-" else s)
+        (
+          builtins.split "[^[:alnum:]+._?=-]+"
+            ((x: builtins.elemAt (builtins.match "\\.*(.*)" x) 0) name)
+        )
+    );
+
+  # The set of packages used when specs are fetched using non-builtins.
+  mkPkgs = sources: system:
+    let
+      sourcesNixpkgs =
+        import (builtins_fetchTarball { inherit (sources.nixpkgs) url sha256; }) { inherit system; };
+      hasNixpkgsPath = builtins.any (x: x.prefix == "nixpkgs") builtins.nixPath;
+      hasThisAsNixpkgsPath = <nixpkgs> == ./.;
+    in
+      if builtins.hasAttr "nixpkgs" sources
+      then sourcesNixpkgs
+      else if hasNixpkgsPath && ! hasThisAsNixpkgsPath then
+        import <nixpkgs> {}
+      else
+        abort
+          ''
+            Please specify either <nixpkgs> (through -I or NIX_PATH=nixpkgs=...) or
+            add a package called "nixpkgs" to your sources.json.
+          '';
+
+  # The actual fetching function.
+  fetch = pkgs: name: spec:
+
+    if ! builtins.hasAttr "type" spec then
+      abort "ERROR: niv spec ${name} does not have a 'type' attribute"
+    else if spec.type == "file" then fetch_file pkgs name spec
+    else if spec.type == "tarball" then fetch_tarball pkgs name spec
+    else if spec.type == "git" then fetch_git name spec
+    else if spec.type == "local" then fetch_local spec
+    else if spec.type == "builtin-tarball" then fetch_builtin-tarball name
+    else if spec.type == "builtin-url" then fetch_builtin-url name
+    else
+      abort "ERROR: niv spec ${name} has unknown type ${builtins.toJSON spec.type}";
+
+  # If the environment variable NIV_OVERRIDE_${name} is set, then use
+  # the path directly as opposed to the fetched source.
+  replace = name: drv:
+    let
+      saneName = stringAsChars (c: if isNull (builtins.match "[a-zA-Z0-9]" c) then "_" else c) name;
+      ersatz = builtins.getEnv "NIV_OVERRIDE_${saneName}";
+    in
+      if ersatz == "" then drv else
+        # this turns the string into an actual Nix path (for both absolute and
+        # relative paths)
+        if builtins.substring 0 1 ersatz == "/" then /. + ersatz else /. + builtins.getEnv "PWD" + "/${ersatz}";
+
+  # Ports of functions for older nix versions
+
+  # a Nix version of mapAttrs if the built-in doesn't exist
+  mapAttrs = builtins.mapAttrs or (
+    f: set: with builtins;
+    listToAttrs (map (attr: { name = attr; value = f attr set.${attr}; }) (attrNames set))
+  );
+
+  # https://github.com/NixOS/nixpkgs/blob/0258808f5744ca980b9a1f24fe0b1e6f0fecee9c/lib/lists.nix#L295
+  range = first: last: if first > last then [] else builtins.genList (n: first + n) (last - first + 1);
+
+  # https://github.com/NixOS/nixpkgs/blob/0258808f5744ca980b9a1f24fe0b1e6f0fecee9c/lib/strings.nix#L257
+  stringToCharacters = s: map (p: builtins.substring p 1 s) (range 0 (builtins.stringLength s - 1));
+
+  # https://github.com/NixOS/nixpkgs/blob/0258808f5744ca980b9a1f24fe0b1e6f0fecee9c/lib/strings.nix#L269
+  stringAsChars = f: s: concatStrings (map f (stringToCharacters s));
+  concatMapStrings = f: list: concatStrings (map f list);
+  concatStrings = builtins.concatStringsSep "";
+
+  # https://github.com/NixOS/nixpkgs/blob/8a9f58a375c401b96da862d969f66429def1d118/lib/attrsets.nix#L331
+  optionalAttrs = cond: as: if cond then as else {};
+
+  # fetchTarball version that is compatible between all the versions of Nix
+  builtins_fetchTarball = { url, name ? null, sha256 }@attrs:
+    let
+      inherit (builtins) lessThan nixVersion fetchTarball;
+    in
+      if lessThan nixVersion "1.12" then
+        fetchTarball ({ inherit url; } // (optionalAttrs (!isNull name) { inherit name; }))
+      else
+        fetchTarball attrs;
+
+  # fetchurl version that is compatible between all the versions of Nix
+  builtins_fetchurl = { url, name ? null, sha256 }@attrs:
+    let
+      inherit (builtins) lessThan nixVersion fetchurl;
+    in
+      if lessThan nixVersion "1.12" then
+        fetchurl ({ inherit url; } // (optionalAttrs (!isNull name) { inherit name; }))
+      else
+        fetchurl attrs;
+
+  # Create the final "sources" from the config
+  mkSources = config:
+    mapAttrs (
+      name: spec:
+        if builtins.hasAttr "outPath" spec
+        then abort
+          "The values in sources.json should not have an 'outPath' attribute"
+        else
+          spec // { outPath = replace name (fetch config.pkgs name spec); }
+    ) config.sources;
+
+  # The "config" used by the fetchers
+  mkConfig =
+    { sourcesFile ? if builtins.pathExists ./sources.json then ./sources.json else null
+    , sources ? if isNull sourcesFile then {} else builtins.fromJSON (builtins.readFile sourcesFile)
+    , system ? builtins.currentSystem
+    , pkgs ? mkPkgs sources system
+    }: rec {
+      # The sources, i.e. the attribute set of spec name to spec
+      inherit sources;
+
+      # The "pkgs" (evaluated nixpkgs) to use for e.g. non-builtin fetchers
+      inherit pkgs;
+    };
+
+in
+mkSources (mkConfig {}) // { __functor = _: settings: mkSources (mkConfig settings); }

data/run_ci.sh

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -e
+rm -f Gemfile.lock
+bundle install
+bundle exec srb tc
+bundle exec rspec spec

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.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Samuel Giles
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-10 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -150,17 +149,29 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
+- !ruby/object:Gem::Dependency
+  name: tapioca
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 email:
 - samuel.giles@bellroy.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/rspec.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
-- ".ruby-version"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -168,21 +179,26 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- bin/tapioca
 - graphwerk.gemspec
 - lib/graphwerk.rb
 - lib/graphwerk/builders/graph.rb
 - 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
 - lib/graphwerk/version.rb
+- 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
@@ -197,8 +213,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-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

data/.ruby-version

@@ -1 +0,0 @@
-2.6.6