stefanzweifel / laravel-stats by stefanzweifel

Get insights about your Laravel or Lumen Project. (Inspired by rake stats)

Installing

The easiest way to install the package is by using composer. The package requires PHP 7.0, Laravel 5.5 or higher or Lumen 5.5 or higher.

composer require "wnx/laravel-stats" --dev

The package will automatically register itself. However if you prefer to register Service Provider by yourself, update your config/app.php file:

'providers' => [
    \Wnx\LaravelStats\StatsServiceProvider
]

If you're using Lumen you have to manually register the Service Provider in your bootstrap/app.php file:

$app->register(\Wnx\LaravelStats\StatsServiceProvider::class);

Optionally, you can publish the config file of this package with this command (Laravel only):

php artisan vendor:publish --provider="Wnx\LaravelStats\StatsServiceProvider"

The following config file will be published in config/stats.php

<?php

return [

    /*
     * List of folders to be analyzed.
     */
    'paths' => [
        base_path('app'),
        base_path('database'),
        base_path('tests'),
    ],

    /*
     * List of files/folders to be excluded from analysis.
     */
    'exclude' => [
        // base_path('app/helpers.php'),
        // base_path('app/Services'),
    ],

    /*
     * List of your custom Classifiers
     */
    'custom_component_classifier' => [
        // \App\Classifiers\CustomerExportClassifier::class
    ],

    /*
     * The Strategy used to reject Classes from the project statistics.
     *
     * By default all Classes located in
     * the vendor directory are being rejected and don't
     * count to the statistics.
     *
     * The package ships with 2 strategies:
     * - \Wnx\LaravelStats\RejectionStrategies\RejectVendorClasses::class
     * - \Wnx\LaravelStats\RejectionStrategies\RejectInternalClasses::class
     *
     * If none of the default strategies fit for your usecase, you can
     * write your own class which implements the RejectionStrategy Contract.
     */
    'rejection_strategy' => \Wnx\LaravelStats\RejectionStrategies\RejectVendorClasses::class,

    /*
     * Namespaces which should be ignored.
     * Laravel Stats uses the `Str::startsWith()`class to
     * check if a Namespace should be ignored.
     *
     * You can use `Illuminate` to ignore the entire `Illuminate`-namespace
     * or `Illuminate\Support` to ignore a subset of the namespace.
     */
    'ignored_namespaces' => [
        'Wnx\LaravelStats',
        'Illuminate',
        'Symfony',
    ],

];

Usage

After installing you can generate the statistics by running the following Artisan Command.

php artisan stats

The statistics are also available as JSON.

php artisan stats --format=json

How does this package detect certain Laravel Components?

The package scans the files defined in the paths-array in the configuration file. It then applies Classifiers to those classes to determine which Laravel Component the class represents.

| Component | Classification | |:--|:--| | Controller | Must be registered with a Route | | Model | Must extend Illuminate\Database\Eloquent\Model | | Command | Must extend Illuminate\Console\Command | | Rule | Must extend Illuminate\Contracts\Validation\Rule | | Policy | The Policy must be registered in your AuthServiceProvider | | Middleware | The Middleware must be registered in your Http-Kernel | | Event | Must use Illuminate\Foundation\Events\Dispatchable-Trait | | Event Listener | Must be registered for an Event in EventServiceProvider | | Mail | Must extend Illuminate\Mail\Mailable | | Notification | Must extend Illuminate\Notifications\Notification | | Nova Action | Must extend Laravel\Nova\Actions\Action | | Nova Filter | Must extend Laravel\Nova\Filters\Filter | | Nova Lens | Must extend Laravel\Nova\Lenses\Lens | | Nova Resource | Must extend Laravel\Nova\Resource | | Job | Must use Illuminate\Foundation\Bus\Dispatchable-Trait | | Migration | Must extend Illuminate\Database\Migrations\Migration | | Request | Must extend Illuminate\Foundation\Http\FormRequest | | Resource | Must extend Illuminate\Http\Resources\Json\Resource | | Seeder | Must extend Illuminate\Database\Seeder | | ServiceProvider | Must extend Illuminate\Support\ServiceProvider | | Dusk Tests | Must extend Laravel\Dusk\TestCase | | BrowserKit Test | Must extend Laravel\BrowserKitTesting\TestCase | | PHPUnit Test | Must extend PHPUnit\Framework\TestCase |

Create your own Classifiers

If your application has it's own components you would like to see in laravel-stats you can create your own Classifiers. Create your own Classifiers by implementing the Classifier-contract and adding the class to the stats.custom_component_classifier config array.

For example:

// app/Classifiers/RepositoryClassifier.php
<?php

namespace App\Classifiers;

use Wnx\LaravelStats\ReflectionClass;
use Wnx\LaravelStats\Contracts\Classifier;

class RepositoryClassifier implements Classifier
{
    public function getName()
    {
        return 'Repository';
    }

    public function satisfies(ReflectionClass $class)
    {
        return $class->isSubclassOf(\App\Repositories\BaseRepository::class);
    }
}

// config/stats.php
<?php
    ...
    'custom_component_classifier' => [
        \App\Classifiers\RepositoryClassifier::class
    ],
    ...

Running the tests

The package has tests written in phpunit. You can run them with the following command.

./vendor/bin/phpunit

Running the command in a local test project

If you're working on the package locally and want to just run the command in a demo project you can use the composer path-repository format. Add the following snippet to the composer.json in your demo project.

{
    "repositories": [
        {
            "type": "path",
            "url": "/path/to/laravel-stats/",
            "options": {
                "symlink": true
            }
        }
    ],
}

And "install" the package with composer require wnx/laravel-stats. The package should now be symlinked in your demo project.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Credits

• Stefan Zweifel
• Jerguš Lejko
• All Contributors

License

This project is licensed under the MIT License - see the LICENSE file for details.