README

Laravel Relation Manager

Developing complex Laravel applications with many models can be difficult. Laravel Relation Manager helps by bringing all your model relationships together. It creates tests to make sure they work and documents them for easy reference. This saves you time, improves code quality, and keeps your project organized.

Laravel Relation Manager
- Installation
- Configuration
- Usage
- Testing
- Changelog
- License

Installation

You can install the package via composer:

composer require schenke-io/laravel-relation-manager

Install the config file of the package:

php artisan relation-manager:install

Configuration

The configuration file config/relation-manager.php has the following keys available.

key	definition	type
modelNameSpace	namespace of the models (commonly App\Models)	String
projectTestClass	empty test class which will be (over)written	String
extendedTestClass	class the written class should extend from	String
markdownFile	full path for the markdown file which is written	String
testCommand	console command to run the tests	String
useMermaidDiagram	true = mermaid, false = Graphviz	Boolean
showPivotTablesInDiagram	should pivot tables be shown in the diagram	Boolean
testDatabase	extend the tests to asserts of the database	Boolean

Usage

This package's core functionality is provided by two components:

Configuration File: The config/relation-manager.php file allows you to define directories, files and namespaces of your project.
Custom Relation Manager Command: This command, which extends the RelationManagerCommand class, facilitates the configuration process.

In the command file:

define models and their relations
decide if you want to add reverse relations
after the model-relation definition:
- write the test file
- run the test file (only)
- write text and graphical documentation
- echo tables

// app/Console/Commands/RelationWriteCommand

use SchenkeIo\LaravelRelationManager\Console\RelationManagerCommand;

class RelationWriteCommand extends RelationManagerCommand 
{
    
    public function handle(): void
    {       
        
        $this->relationManager->model('Country')
            ->hasOne('Capital', true)
            ->hasMany('Region', true);
            
        $this->relationManager->model('Region')
            ->hasMany('City', true);
            
                        
        // repeat this for any model    

        // finally 
        $this->relationManager
            ->writeMarkdown()
            ->showTables()
            ->writeTest(strict: true)
            ->runTest();
                   
        
    }    
}

This command is called by default with php artisan relation-manager:run.

The following methods can be used inside handle():

method	parameter	details
model($model)	name of the model	the model name is relative to the model namespace configured
writeTest($strict)	false: define the minimum, true: define everything	write the test file as defined
runTest	-	run the test file
writeMarkdown	-	write a markdown file with the documentation
showTables	-	Show the information as a table in the console

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

License

The MIT License (MIT). Please see License File for more information.

schenke-io / laravel-relation-manager

Maintainers

Details