.gitignore

@@ -3,4 +3,6 @@ composer.lock
 docs
 vendor
 coverage
-.idea
+.idea
+tests/__snapshots__/
+.phpunit.result.cache

README.md

@@ -1,14 +1,14 @@
 # Laravel ER Diagram Generator
 
 [![Latest Version on Packagist](https://img.shields.io/packagist/v/beyondcode/laravel-er-diagram-generator.svg?style=flat-square)](https://packagist.org/packages/beyondcode/laravel-er-diagram-generator)
-[![Build Status](https://img.shields.io/travis/beyondcode/laravel-er-diagram-generator/master.svg?style=flat-square)](https://travis-ci.org/beyondcode/laravel-er-diagram-generator)
-[![Quality Score](https://img.shields.io/scrutinizer/g/beyondcode/laravel-er-diagram-generator.svg?style=flat-square)](https://scrutinizer-ci.com/g/beyondcode/laravel-er-diagram-generator)
 [![Total Downloads](https://img.shields.io/packagist/dt/beyondcode/laravel-er-diagram-generator.svg?style=flat-square)](https://packagist.org/packages/beyondcode/laravel-er-diagram-generator)
 
 This package lets you generate entity relation diagrams by inspecting the relationships defined in your model files.
 It is highly customizable.
 Behind the scenes, it uses [GraphViz](https://www.graphviz.org) to generate the graph.
 
+> If you want to learn how to create reusable PHP packages yourself, take a look at my upcoming [PHP Package Development](https://phppackagedevelopment.com) video course.
+
 ## Prerequisites
 
 The minimum required PHP version is 7.1.0.
@@ -29,6 +29,8 @@ Or, if you are using Homestead:
 sudo apt-get install graphviz
 ```
 
+To install Graphviz on Windows, download it from the [official website](https://graphviz.gitlab.io/_pages/Download/Download_windows.html).
+
 ## Installation
 
 You can install the package via composer:
@@ -42,13 +44,13 @@ If you are using Laravel 5.5+, the package will automatically register the servi
 If you are using Lumen, you will need to add the following to `bootstrap\app.php`:
 
 ```php
-\\ Register Service Providers
+# Register Service Providers
 $app->register(BeyondCode\ErdGenerator\ErdGeneratorServiceProvider::class);
 ```
 
 ## Usage
 
-By default, the package will automatically detect all models in your `app` directory that extend the Eloquent Model class. If you would like you explicitly define where your models are located, you can publish the configuration file using the following command.
+By default, the package will automatically detect all models in your `app/Models` directory that extend the Eloquent Model class. If you would like you explicitly define where your models are located, you can publish the configuration file using the following command.
 
 ```bash
 php artisan vendor:publish --provider=BeyondCode\\ErdGenerator\\ErdGeneratorServiceProvider

composer.json

@@ -16,16 +16,16 @@
         }
     ],
     "require": {
-        "php": "^7.1",
-        "doctrine/dbal": "~2.3",
+        "php": "^7.1|^8.0",
+        "doctrine/dbal": "~2.3|^3.3|^4.0",
         "phpdocumentor/graphviz": "^1.0",
-        "nikic/php-parser":"^2.0|^3.0|^4.0"
+        "nikic/php-parser": "^2.0|^3.0|^4.0|^5.0"
     },
     "require-dev": {
         "larapack/dd": "^1.0",
-        "orchestra/testbench": "~3.5",
-        "phpunit/phpunit": "^7.0",
-        "spatie/phpunit-snapshot-assertions": "^1.3"
+        "orchestra/testbench": "~3.5|~3.6|~3.7|~3.8|^4.0|^7.0|^8.0|^9.0",
+        "phpunit/phpunit": "^7.0| ^8.0|^9.5.10|^10.5|^11.0.1",
+        "spatie/phpunit-snapshot-assertions": "^1.3|^4.2|^5.1"
     },
     "autoload": {
         "psr-4": {
@@ -40,7 +40,6 @@
     "scripts": {
         "test": "vendor/bin/phpunit",
         "test-coverage": "vendor/bin/phpunit --coverage-html coverage"
-
     },
     "config": {
         "sort-packages": true
@@ -49,10 +48,7 @@
         "laravel": {
             "providers": [
                 "BeyondCode\\ErdGenerator\\ErdGeneratorServiceProvider"
-            ],
-            "aliases": {
-                "ErdGenerator": "BeyondCode\\ErdGenerator\\ErdGeneratorFacade"
-            }
+            ]
         }
     }
 }

config/config.php

@@ -7,7 +7,32 @@
      * By default, the `app` directory will be scanned recursively for models.
      */
     'directories' => [
-        base_path('app'),
+        base_path('app' . DIRECTORY_SEPARATOR . 'Models'),
+    ],
+
+    /*
+     * If you want to ignore complete models or certain relations of a specific model,
+     * you can specify them here.
+     * To ignore a model completely, just add the fully qualified classname.
+     * To ignore only a certain relation of a model, enter the classname as the key
+     * and an array of relation names to ignore.
+     */
+    'ignore' => [
+        // User::class,
+        // Post::class => [
+        //     'user'
+        // ]
+    ],
+
+    /*
+     * If you want to see only specific models, specify them here using fully qualified
+     * classnames.
+     *
+     * Note: that if this array is filled, the 'ignore' array will not be used.
+    */
+    'whitelist' => [
+        // App\User::class,
+        // App\Post::class,
     ],
 
     /*

phpunit.xml.dist

@@ -1,29 +1,12 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phpunit bootstrap="vendor/autoload.php"
          backupGlobals="false"
-         backupStaticAttributes="false"
          colors="true"
-         verbose="true"
-         convertErrorsToExceptions="true"
-         convertNoticesToExceptions="true"
-         convertWarningsToExceptions="true"
          processIsolation="false"
          stopOnFailure="false">
     <testsuites>
         <testsuite name="BeyondCode Test Suite">
             <directory>tests</directory>
         </testsuite>
     </testsuites>
-    <filter>
-        <whitelist>
-            <directory suffix=".php">src/</directory>
-        </whitelist>
-    </filter>
-    <logging>
-        <log type="tap" target="build/report.tap"/>
-        <log type="junit" target="build/report.junit.xml"/>
-        <log type="coverage-html" target="build/coverage" charset="UTF-8" yui="true" highlight="true"/>
-        <log type="coverage-text" target="build/coverage.txt"/>
-        <log type="coverage-clover" target="build/logs/clover.xml"/>
-    </logging>
 </phpunit>

src/Edge.php

@@ -4,12 +4,24 @@
 
 use phpDocumentor\GraphViz\Node;
 
+/**
+ * Class Edge
+ * @package BeyondCode\ErdGenerator
+ * @method void setLabel(string $name)
+ * @method void setXLabel(string $name)
+ *
+ */
 class Edge extends \phpDocumentor\GraphViz\Edge
 {
     protected $fromPort = null;
 
     protected $toPort = null;
 
+    /**
+     * @param Node $from
+     * @param Node $to
+     * @return Edge|\phpDocumentor\GraphViz\Edge
+     */
     public static function create(Node $from, Node $to) {
         return new static($from, $to);
     }

src/GenerateDiagramCommand.php

@@ -2,11 +2,11 @@
 
 namespace BeyondCode\ErdGenerator;
 
-use ReflectionClass;
+use BeyondCode\ErdGenerator\Model as GraphModel;
 use Illuminate\Console\Command;
-use phpDocumentor\GraphViz\Graph;
 use Illuminate\Support\Collection;
-use BeyondCode\ErdGenerator\Model as GraphModel;
+use phpDocumentor\GraphViz\Graph;
+use ReflectionClass;
 
 class GenerateDiagramCommand extends Command
 {
@@ -49,6 +49,9 @@ public function __construct(ModelFinder $modelFinder, RelationFinder $relationFi
         $this->graphBuilder = $graphBuilder;
     }
 
+    /**
+     * @throws \phpDocumentor\GraphViz\Exception
+     */
     public function handle()
     {
         $models = $this->getModelsThatShouldBeInspected();