├── .editorconfig
├── .gitattributes
├── .gitignore
├── README.md
├── app
    ├── Application
    │   ├── .gitkeep
    │   ├── Load
    │   │   ├── LoadHandler.php
    │   │   ├── LoadOutputInterface.php
    │   │   └── LoadRequestInterface.php
    │   └── Report
    │   │   ├── ReportHandler.php
    │   │   ├── ReportOutputInterface.php
    │   │   └── ReportRequestInterface.php
    ├── Domain
    │   ├── .gitkeep
    │   ├── Aggregators
    │   │   ├── ReportAggregator.php
    │   │   └── TrackedFileAggregator.php
    │   ├── Contracts
    │   │   ├── Gateways
    │   │   │   └── FileVersionControlGateway.php
    │   │   └── Repositories
    │   │   │   └── TrackedFileRepository.php
    │   ├── Entities
    │   │   ├── Analysis.php
    │   │   ├── Metric.php
    │   │   ├── Path.php
    │   │   ├── ReportLine.php
    │   │   └── TrackedFile.php
    │   └── Services
    │   │   ├── ReportGenerator.php
    │   │   ├── TrackedFileAnalyzer.php
    │   │   └── TrackedFileService.php
    ├── Infrastructure
    │   ├── .gitkeep
    │   ├── Gateways
    │   │   └── CliGitGateway.php
    │   └── Repositories
    │   │   └── TrackedFileStorageRepository.php
    ├── Presenter
    │   └── Commands
    │   │   ├── .gitkeep
    │   │   ├── Load
    │   │       ├── LoadCliOutput.php
    │   │       ├── LoadCliRequest.php
    │   │       └── LoadCommand.php
    │   │   └── Report
    │   │       ├── Cli
    │   │           ├── Concerns
    │   │           │   ├── Sorts.php
    │   │           │   └── Thresholds.php
    │   │           ├── ReportCliOutput.php
    │   │           ├── ReportCliRequest.php
    │   │           └── ReportClipOutputOptions.php
    │   │       └── ReportCommand.php
    └── Providers
    │   └── AppServiceProvider.php
├── bootstrap
    └── app.php
├── box.json
├── builds
    └── php-git-insights-analyzer
├── composer.json
├── composer.lock
├── config
    ├── app.php
    ├── commands.php
    └── filesystems.php
├── php-git-insights-analyzer
├── phpunit.xml.dist
└── tests
    ├── CreatesApplication.php
    ├── Feature
        └── InspireCommandTest.php
    ├── Pest.php
    ├── TestCase.php
    └── Unit
        └── ExampleTest.php


/.editorconfig:
--------------------------------------------------------------------------------
 1 | root = true
 2 | 
 3 | [*]
 4 | charset = utf-8
 5 | end_of_line = lf
 6 | insert_final_newline = true
 7 | indent_style = space
 8 | indent_size = 4
 9 | trim_trailing_whitespace = true
10 | 
11 | [*.md]
12 | trim_trailing_whitespace = false
13 | 
14 | [*.yml]
15 | indent_size = 2
16 | 


--------------------------------------------------------------------------------
/.gitattributes:
--------------------------------------------------------------------------------
1 | * text=auto eol=lf
2 | /.github export-ignore
3 | .scrutinizer.yml export-ignore
4 | BACKERS.md export-ignore
5 | CONTRIBUTING.md export-ignore
6 | CHANGELOG.md export-ignore
7 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
 1 | /vendor
 2 | /.idea
 3 | /.vscode
 4 | /.vagrant
 5 | .phpunit.result.cache
 6 | 
 7 | storage/app/analyse.json
 8 | 
 9 | analyse.json
10 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | <p align="center">
 2 | <img src="https://github.com/DeGraciaMathieu/php-smelly-code-detector/blob/master/arts/robot.png" width="250">
 3 | </p>
 4 | 
 5 | # php-git-insights-analyzer
 6 | 
 7 | ## Phar
 8 | This tool is distributed as a [PHP Archive (PHAR)](https://www.php.net/phar):
 9 | 
10 | ```
11 | wget https://github.com/DeGraciaMathieu/php-git-insights-analyzer/raw/master/builds/php-git-insights-analyzer
12 | ```
13 | 
14 | ```
15 | php php-git-insights-analyzer --version
16 | ```
17 | 
18 | ## Usage
19 | 
20 | First, you need to load the data required for the analysis :
21 | 
22 | ```
23 | php php-git-insights-analyzer app:load
24 | ```
25 | 
26 | Package uses git commands to retrieve files history, which is relatively time-consuming, so it was more efficient to create a database before carrying out the analyses.
27 | 
28 | > For information, database is stored in the analyse.json
29 | 
30 | Then analyse the data using the following command :
31 | 
32 | ```
33 | php php-git-insights-analyzer app:report
34 | ```
35 | 
36 | ```
37 | $ php php-git-insights-analyzer app:report
38 | 
39 |  ❀ PHP Git Insights Analyzer ❀
40 | 
41 |  ┌─────────────────────────────────────────────┬───────┬───────┬───────┬─────┬──────┬─────┬──────┐
42 |  │ name                                        │ lines │ comm. │ cont. │ acs │ acsr │ wpc │ wpcr │
43 |  ├─────────────────────────────────────────────┼───────┼───────┼───────┼─────┼──────┼─────┼──────┤
44 |  │ Actions/GameAndRandomClipsSample.php        │ 55    │ 2     │ 1     │ 27  │ 49   │ 55  │ 100  │
45 |  │ Console/Kernel.php                          │ 27    │ 1     │ 1     │ 27  │ 100  │ 27  │ 100  │
46 |  │ Dtos/Uuid.php                               │ 37    │ 3     │ 1     │ 12  │ 32   │ 37  │ 100  │
47 |  │ Enums/AutoplayEnum.php                      │ 9     │ 1     │ 1     │ 9   │ 100  │ 9   │ 100  │
48 |  │ Enums/ClipStateEnum.php                     │ 15    │ 2     │ 1     │ 7   │ 46   │ 15  │ 100  │
49 |  │ Exceptions/AssertException.php              │ 10    │ 1     │ 1     │ 10  │ 100  │ 10  │ 100  │
50 |  │ Exceptions/Handler.php                      │ 35    │ 4     │ 1     │ 8   │ 22   │ 35  │ 100  │
51 |  │ Http/Controllers/Controller.php             │ 12    │ 1     │ 1     │ 12  │ 100  │ 12  │ 100  │
52 |  │ Http/Controllers/HomeController.php         │ 37    │ 9     │ 2     │ 4   │ 10   │ 18  │ 48   │
53 |  │ Http/Controllers/PaginateClipController.php │ 48    │ 8     │ 2     │ 6   │ 12   │ 24  │ 50   │
54 |  └─────────────────────────────────────────────┴───────┴───────┴───────┴─────┴──────┴─────┴──────┘
55 | ```
56 | 
57 | Understanding analysis :
58 | 
59 | | Abbreviation | Metric                         | Description                                                                    |
60 | | ------------ | ------------------------------ | ------------------------------------------------------------------------------ |
61 | | comm.        | Commits                        | Number of file commits.                                                        |
62 | | cont.        | Contributors                   | Number of distinct contributors.                                               |
63 | | acs          | Average Commit Size            | Average size of file commits.                                                  |
64 | | acsr         | Average Commit Size Ratio      | Proportion of average commit size compared to the total file size.             |
65 | | wpc          | Workload Per Contributor       | Average size of a contributor's commits.                                       |
66 | | wpcr         | Workload Per Contributor Ratio | Proportion of average contributor commit size compared to the total file size. |
67 | 
68 | ## Options
69 | 
70 | | Options               | Description |
71 | |-----------------------|-------------|
72 | | --folder=             | Filter results by folder (e.g., --folder=Http/Controllers).|
73 | | --limit=              | Specify the maximum number of results to display (default is 10).|
74 | | --sorts=               | Sets the sorting order for results. The first value (lines, commits, contributors, acs, acsr, wpc, wpcr) corresponds to the affected field, and the second value (desc,asc; default desc) determines the sorting order.|
75 | | --thresholds=         | Sets a threshold for the specified metric to filter results. The first value (lines, commits, contributors, acs, acsr, wpc, wpcr) corresponds to the affected metric, and the second value (e.g., 60) represents the minimum value required to apply the threshold.|
76 | 
77 | ## Examples
78 | 
79 | Files with more than 300 lines and low contributor diversity :
80 | 
81 | ```
82 | php php-git-insights-analyzer app:report --limit=10 --thresholds=wpcr,60 --thresholds=lines,300
83 | ```
84 | 
85 | Files with more than 10 commits and low contributor diversity :
86 | 
87 | ```
88 | php php-git-insights-analyzer app:report --limit=10 --thresholds=wpcr,60 --thresholds=commits,10
89 | ```
90 | 
91 | File with more than 10 commits and a renewal ratio of 10% with each commit.
92 | 
93 | ```
94 | php php-git-insights-analyzer app:report --limit=10 --thresholds=acsr,10 --thresholds=commits,10
95 | ```
96 | 
97 | > [!TIP]  
98 | > Other analysis [tools](https://github.com/DeGraciaMathieu) are available.
99 | 


--------------------------------------------------------------------------------
/app/Application/.gitkeep:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/DeGraciaMathieu/php-git-insights-analyzer/9b94a4f4aa6a615a31d38e4c0ba92ec04fe578e6/app/Application/.gitkeep


--------------------------------------------------------------------------------
/app/Application/Load/LoadHandler.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace App\Application\Load;
 4 | 
 5 | use Throwable;
 6 | use App\Domain\Entities\Path;
 7 | use App\Application\Load\LoadOutputInterface;
 8 | use App\Application\Load\LoadRequestInterface;
 9 | use App\Domain\Services\TrackedFileService;
10 | use App\Domain\Services\TrackedFileAnalyzer;
11 | use App\Domain\Contracts\Repositories\TrackedFileRepository;
12 | 
13 | class LoadHandler
14 | {
15 |     public function __construct(
16 |         private TrackedFileService $trackedFileService,
17 |         private TrackedFileAnalyzer $trackedFileAnalyzer,
18 |         private TrackedFileRepository $trackedFileRepository,
19 |     ) {
20 |     }
21 | 
22 |     public function handle(
23 |         LoadRequestInterface $request,
24 |         LoadOutputInterface $output,
25 |     ): void {
26 | 
27 |         try {
28 | 
29 |             $output->hello();
30 | 
31 |             $output->inProgress();
32 | 
33 |             $aggregator = $this->trackedFileService->all(
34 |                 new Path($request->path()),
35 |             );
36 | 
37 |             $this->trackedFileAnalyzer->analyze($aggregator);
38 | 
39 |             $this->trackedFileRepository->store($aggregator);
40 | 
41 |             $output->present();
42 | 
43 |         } catch (Throwable $th) {
44 |             $output->error($th);
45 |         }
46 |     }
47 | }


--------------------------------------------------------------------------------
/app/Application/Load/LoadOutputInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace App\Application\Load;
 4 | 
 5 | use Throwable;
 6 | 
 7 | interface LoadOutputInterface
 8 | {
 9 |     public function hello(): void;
10 |     
11 |     public function inProgress(): void;
12 | 
13 |     public function present(): void;
14 | 
15 |     public function error(Throwable $throwable): void;
16 | }


--------------------------------------------------------------------------------
/app/Application/Load/LoadRequestInterface.php:
--------------------------------------------------------------------------------
1 | <?php
2 | 
3 | namespace App\Application\Load;
4 | 
5 | interface LoadRequestInterface
6 | {
7 |     public function path(): string;
8 | }


--------------------------------------------------------------------------------
/app/Application/Report/ReportHandler.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace App\Application\Report;
 4 | 
 5 | use Throwable;
 6 | use App\Domain\Services\ReportGenerator;
 7 | use App\Application\Report\ReportOutputInterface;
 8 | use App\Application\Report\ReportRequestInterface;
 9 | 
10 | class ReportHandler
11 | {
12 |     public function __construct(
13 |         private ReportGenerator $reportGenerator,
14 |     ) {
15 |     }
16 | 
17 |     public function handle(
18 |         ReportRequestInterface $request,
19 |         ReportOutputInterface $output,
20 |     ): void {
21 | 
22 |         try {
23 | 
24 |             $output->hello();
25 | 
26 |             $reportAggregator = $this->reportGenerator->make();
27 | 
28 |             $output->present($reportAggregator);
29 | 
30 |         } catch (Throwable $th) {
31 |             $output->error($th);
32 |         }
33 |     }
34 | }


--------------------------------------------------------------------------------
/app/Application/Report/ReportOutputInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace App\Application\Report;
 4 | 
 5 | use Throwable;
 6 | use App\Domain\Aggregators\ReportAggregator;
 7 | 
 8 | interface ReportOutputInterface
 9 | {
10 |     public function hello(): void;
11 |     public function present(ReportAggregator $reportAggregator): void;
12 |     public function error(Throwable $throwable): void;
13 | }


--------------------------------------------------------------------------------
/app/Application/Report/ReportRequestInterface.php:
--------------------------------------------------------------------------------
1 | <?php
2 | 
3 | namespace App\Application\Report;
4 | 
5 | interface ReportRequestInterface
6 | {
7 |     //
8 | }


--------------------------------------------------------------------------------
/app/Domain/.gitkeep:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/DeGraciaMathieu/php-git-insights-analyzer/9b94a4f4aa6a615a31d38e4c0ba92ec04fe578e6/app/Domain/.gitkeep


--------------------------------------------------------------------------------
/app/Domain/Aggregators/ReportAggregator.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace App\Domain\Aggregators;
 4 | 
 5 | use App\Domain\Entities\ReportLine;
 6 | 
 7 | class ReportAggregator
 8 | {
 9 |     public function __construct(
10 |         private array $reportLines = [],
11 |     ) {
12 |     }
13 | 
14 |     public function add(ReportLine $reportLine): void
15 |     {
16 |         $this->reportLines[] = $reportLine;
17 |     }
18 | 
19 |     public function toArray(): array
20 |     {
21 |         return array_map(function (ReportLine $reportLine) {
22 |             return $reportLine->toArray();
23 |         }, $this->reportLines);
24 |     }
25 | }
26 | 


--------------------------------------------------------------------------------
/app/Domain/Aggregators/TrackedFileAggregator.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace App\Domain\Aggregators;
 4 | 
 5 | use App\Domain\Entities\TrackedFile;
 6 | use App\Domain\Entities\Path;
 7 | 
 8 | class TrackedFileAggregator
 9 | {
10 |     public function __construct(
11 |         private Path|null $path = null,
12 |         private array $trackedFiles = [],
13 |     ) {
14 |     }
15 | 
16 |     public function setPath(Path $path): void
17 |     {
18 |         $this->path = $path;
19 |     }
20 | 
21 |     public function add(TrackedFile $trackedFile): void
22 |     {
23 |         $this->trackedFiles[] = $trackedFile;
24 |     }
25 | 
26 |     public function path(): Path|null
27 |     {
28 |         return $this->path;
29 |     }
30 | 
31 |     public function trackedFiles(): array
32 |     {
33 |         return $this->trackedFiles;
34 |     }
35 | }
36 | 


--------------------------------------------------------------------------------
/app/Domain/Contracts/Gateways/FileVersionControlGateway.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace App\Domain\Contracts\Gateways;
 4 | 
 5 | use App\Domain\Entities\Path;
 6 | use App\Domain\Entities\Analysis;
 7 | use App\Domain\Entities\TrackedFile;
 8 | 
 9 | interface FileVersionControlGateway
10 | {
11 |     public function allTrackedFilesName(Path $path): array;
12 |     public function analyze(TrackedFile $file): Analysis;
13 | }
14 | 


--------------------------------------------------------------------------------
/app/Domain/Contracts/Repositories/TrackedFileRepository.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace App\Domain\Contracts\Repositories;
 4 | 
 5 | use App\Domain\Entities\TrackedFile;
 6 | use App\Domain\Aggregators\TrackedFileAggregator;
 7 | 
 8 | interface TrackedFileRepository
 9 | {
10 |     /**
11 |      * @return array<TrackedFile>
12 |      */
13 |     public function get(): array;
14 |     
15 |     public function store(TrackedFileAggregator $aggregator): void;
16 | }
17 | 


--------------------------------------------------------------------------------
/app/Domain/Entities/Analysis.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace App\Domain\Entities;
 4 | 
 5 | class Analysis
 6 | {
 7 |     public function __construct(
 8 |         public Metric $totalLine,
 9 |         public Metric $commitsCount,
10 |         public Metric $contributorsCount,
11 |     ) {}
12 | }
13 | 


--------------------------------------------------------------------------------
/app/Domain/Entities/Metric.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace App\Domain\Entities;
 4 | 
 5 | class Metric
 6 | {
 7 |     public int $value;
 8 | 
 9 |     public function __construct(int|string|null $value = 0) 
10 |     {
11 |         if (is_string($value)) {
12 |             $value = trim($value);
13 |         }
14 | 
15 |         $this->value = $value ?: 1;
16 |     }
17 | }
18 | 


--------------------------------------------------------------------------------
/app/Domain/Entities/Path.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace App\Domain\Entities;
 4 | 
 5 | class Path
 6 | {
 7 |     public function __construct(
 8 |         public string $value,
 9 |     ) {}
10 | }
11 | 


--------------------------------------------------------------------------------
/app/Domain/Entities/ReportLine.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace App\Domain\Entities;
 4 | 
 5 | use App\Domain\Entities\Analysis;
 6 | 
 7 | class ReportLine
 8 | {
 9 |     private string $name;
10 |     private int $totalLines;
11 |     private int $totalCommits;
12 |     private int $totalContributors;
13 |     private int $averageCommitSize;
14 |     private int $averageCommitSizeRatio;
15 |     private int $workloadPerContributor;
16 |     private int $workloadPerContributorRatio;
17 | 
18 |     public function __construct(string $name, Analysis $analysis) 
19 |     {
20 |         $this->name = $name;
21 | 
22 |         $this->load($analysis);
23 | 
24 |         $this->computeAverageSize();
25 | 
26 |         $this->computeWorkloadPerContributor();
27 |     }
28 | 
29 |     private function load(Analysis $analysis): void
30 |     {
31 |         $this->totalLines = $analysis->totalLine->value;
32 |         $this->totalCommits = $analysis->commitsCount->value;
33 |         $this->totalContributors = $analysis->contributorsCount->value;
34 |     }
35 | 
36 |     private function computeAverageSize(): void
37 |     {
38 |         $this->averageCommitSize = $this->totalLines / $this->totalCommits;
39 |         $this->averageCommitSizeRatio = $this->averageCommitSize * 100 / $this->totalLines;
40 |     }
41 | 
42 |     private function computeWorkloadPerContributor(): void
43 |     {
44 |         $this->workloadPerContributor = $this->totalLines / $this->totalContributors;
45 |         $this->workloadPerContributorRatio = $this->workloadPerContributor * 100 / $this->totalLines;
46 |     }
47 | 
48 |     public function toArray(): array
49 |     {
50 |         return get_object_vars($this);
51 |     }
52 | }
53 | 


--------------------------------------------------------------------------------
/app/Domain/Entities/TrackedFile.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace App\Domain\Entities;
 4 | 
 5 | use App\Domain\Entities\Path;
 6 | use App\Domain\Entities\Analysis;
 7 | 
 8 | class TrackedFile
 9 | {
10 |     public function __construct(
11 |         public string $name,
12 |         public Analysis|null $analysis = null,
13 |     ) {}
14 | }
15 | 


--------------------------------------------------------------------------------
/app/Domain/Services/ReportGenerator.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace App\Domain\Services;
 4 | 
 5 | use App\Domain\Entities\ReportLine;
 6 | use App\Domain\Aggregators\ReportAggregator;
 7 | use App\Domain\Contracts\Repositories\TrackedFileRepository;
 8 | 
 9 | class ReportGenerator
10 | {
11 |     public function __construct(
12 |         private ReportAggregator $aggregator,
13 |         private TrackedFileRepository $trackedFileRepository,
14 |     ) {
15 |     }
16 | 
17 |     public function make(): ReportAggregator
18 |     {
19 |         $trackedFiles = $this->trackedFileRepository->get();
20 | 
21 |         foreach ($trackedFiles as $trackedFile) {
22 | 
23 |             $reportLine = new ReportLine(
24 |                 name: $trackedFile->name,
25 |                 analysis: $trackedFile->analysis,
26 |             );
27 | 
28 |             $this->aggregator->add($reportLine);
29 |         }
30 | 
31 |         return $this->aggregator;
32 |     }
33 | }
34 | 


--------------------------------------------------------------------------------
/app/Domain/Services/TrackedFileAnalyzer.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace App\Domain\Services;
 4 | 
 5 | use App\Domain\Aggregators\TrackedFileAggregator;
 6 | use App\Domain\Contracts\Gateways\FileVersionControlGateway;
 7 | 
 8 | class TrackedFileAnalyzer
 9 | {
10 |     public function __construct(
11 |         private FileVersionControlGateway $fileVersionControl,
12 |     ) {
13 |     }
14 | 
15 |     public function analyze(TrackedFileAggregator $aggregator): void
16 |     {
17 |         $trackedFiles = $aggregator->trackedFiles();
18 | 
19 |         foreach ($trackedFiles as $trackedFile) {
20 | 
21 |             $analysis = $this->fileVersionControl->analyze($trackedFile);
22 | 
23 |             $trackedFile->analysis = $analysis;
24 |         }
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/app/Domain/Services/TrackedFileService.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace App\Domain\Services;
 4 | 
 5 | use App\Domain\Entities\Path;
 6 | use App\Domain\Entities\TrackedFile;
 7 | use App\Domain\Aggregators\TrackedFileAggregator;
 8 | use App\Domain\Contracts\Gateways\FileVersionControlGateway;
 9 | 
10 | class TrackedFileService
11 | {
12 |     public function __construct(
13 |         private TrackedFileAggregator $aggregator,
14 |         private FileVersionControlGateway $fileVersionControl,
15 |     ) {
16 |     }
17 | 
18 |     public function all(Path $path): TrackedFileAggregator
19 |     {
20 |         $this->aggregator->setPath($path);
21 | 
22 |         $names = $this->fileVersionControl->allTrackedFilesName($path);
23 | 
24 |         foreach ($names as $name) {
25 | 
26 |             $trackedFile = new TrackedFile($name);
27 | 
28 |             $this->aggregator->add($trackedFile);
29 |         }
30 | 
31 |         return $this->aggregator;
32 |     }
33 | }


--------------------------------------------------------------------------------
/app/Infrastructure/.gitkeep:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/DeGraciaMathieu/php-git-insights-analyzer/9b94a4f4aa6a615a31d38e4c0ba92ec04fe578e6/app/Infrastructure/.gitkeep


--------------------------------------------------------------------------------
/app/Infrastructure/Gateways/CliGitGateway.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace App\Infrastructure\Gateways;
 4 | 
 5 | use App\Domain\Entities\Path;
 6 | use App\Domain\Entities\Metric;
 7 | use App\Domain\Entities\Analysis;
 8 | use App\Domain\Entities\TrackedFile;
 9 | use App\Domain\Aggregators\TrackedFileAggregator;
10 | use App\Domain\Contracts\Gateways\FileVersionControlGateway;
11 | 
12 | class CliGitGateway implements FileVersionControlGateway
13 | {
14 |     public function allTrackedFilesName(Path $path): array
15 |     {
16 |         chdir($path->value);
17 | 
18 |         $cmdFiles = "git ls-files '*.php'";
19 | 
20 |         $names = explode("\n", trim(shell_exec($cmdFiles)));
21 | 
22 |         return $names;
23 |     }
24 | 
25 |     public function analyze(TrackedFile $trackedFile): Analysis
26 |     {
27 |         $name = $trackedFile->name;
28 | 
29 |         $cdm = "git log --pretty=format:'%an' -- " . $name . "| awk '!seen[$0]++ { contributors++ } END { print contributors }' && git log --oneline -- $name | wc -l";
30 |         
31 |         $output = trim(shell_exec($cdm));
32 | 
33 |         [$contributorsCount, $commitsCount] = explode("\n", trim($output));
34 | 
35 |         $lines = file($name);
36 | 
37 |         $totalLine = count($lines) ?: 0;
38 | 
39 |         return new Analysis(
40 |             totalLine: new Metric($totalLine),
41 |             commitsCount: new Metric($commitsCount),
42 |             contributorsCount: new Metric($contributorsCount),
43 |         );
44 |     }
45 | }


--------------------------------------------------------------------------------
/app/Infrastructure/Repositories/TrackedFileStorageRepository.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace App\Infrastructure\Repositories;
 4 | 
 5 | use Exception;
 6 | use App\Domain\Entities\TrackedFile;
 7 | use Illuminate\Filesystem\FilesystemManager;
 8 | use App\Domain\Aggregators\TrackedFileAggregator;
 9 | use App\Domain\Contracts\Repositories\TrackedFileRepository;
10 | 
11 | class TrackedFileStorageRepository implements TrackedFileRepository
12 | {
13 |     public function __construct(
14 |         private FilesystemManager $filesystem,        
15 |     ) {}
16 | 
17 |     public function store(TrackedFileAggregator $aggregator): void
18 |     {
19 |         $storageFileName = $this->makeStorageFileName();
20 | 
21 |         $trackedFiles = $aggregator->trackedFiles();
22 | 
23 |         $this->filesystem->put($storageFileName, serialize($trackedFiles));
24 |     }
25 | 
26 |     /**
27 |      * @return array<TrackedFile>
28 |      */
29 |     public function get(): array
30 |     {
31 |         $storageFileName = $this->makeStorageFileName();
32 | 
33 |         $trackedFiles = $this->filesystem->get($storageFileName);
34 | 
35 |         if ($trackedFiles === null) {
36 |             throw new Exception('Please, run app:load command before.');
37 |         }
38 | 
39 |         return unserialize($trackedFiles);
40 |     }
41 | 
42 |     private function makeStorageFileName(): string
43 |     {
44 |         return 'analyse.json';
45 |     }
46 | }


--------------------------------------------------------------------------------
/app/Presenter/Commands/.gitkeep:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/DeGraciaMathieu/php-git-insights-analyzer/9b94a4f4aa6a615a31d38e4c0ba92ec04fe578e6/app/Presenter/Commands/.gitkeep


--------------------------------------------------------------------------------
/app/Presenter/Commands/Load/LoadCliOutput.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace App\Presenter\Commands\Load;
 4 | 
 5 | use Throwable;
 6 | use function Laravel\Prompts\info;
 7 | use function Laravel\Prompts\note;
 8 | use function Laravel\Prompts\error;
 9 | use function Laravel\Prompts\warning;
10 | use App\Application\Load\LoadOutputInterface;
11 | 
12 | class LoadCliOutput implements LoadOutputInterface
13 | {
14 |     public function hello(): void
15 |     {
16 |         note('❀ PHP Git Insights Analyzer ❀');
17 |     }
18 | 
19 |     public function inProgress(): void
20 |     {
21 |         warning('In progress, load may take several minutes');
22 |     }
23 | 
24 |     public function present(): void
25 |     {
26 |         info('Done ! Data has been correctly loaded.');
27 | 
28 |         info('You can run the app:report command to display the analysis.');
29 |     }
30 |     
31 |     public function error(Throwable $throwable): void
32 |     {
33 |         error($throwable->getMessage());
34 |     }
35 | }
36 | 


--------------------------------------------------------------------------------
/app/Presenter/Commands/Load/LoadCliRequest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace App\Presenter\Commands\Load;
 4 | 
 5 | use App\Application\Load\LoadRequestInterface;
 6 | 
 7 | class LoadCliRequest implements LoadRequestInterface
 8 | {
 9 |     public function __construct(
10 |         private string $path,
11 |     ) {}
12 | 
13 |     public function path(): string
14 |     {
15 |         return $this->path;
16 |     }
17 | }
18 | 


--------------------------------------------------------------------------------
/app/Presenter/Commands/Load/LoadCommand.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace App\Presenter\Commands\Load;
 4 | 
 5 | use App\Application\Load\LoadHandler;
 6 | use App\Application\Load\LoadRequest;
 7 | use LaravelZero\Framework\Commands\Command;
 8 | use App\Presenter\Commands\Load\LoadCliOutput;
 9 | use App\Presenter\Commands\Load\LoadCliRequest;
10 | use App\Presenter\Commands\Load\LoadCliResponse;
11 | 
12 | class LoadCommand extends Command
13 | {
14 |     /**
15 |      * The signature of the command.
16 |      *
17 |      * @var string
18 |      */
19 |     protected $signature = 'app:load {path}';
20 | 
21 |     /**
22 |      * The description of the command.
23 |      *
24 |      * @var string
25 |      */
26 |     protected $description = '';
27 | 
28 |     /**
29 |      * Execute the console command.
30 |      */
31 |     public function handle(LoadHandler $loadHandler): void
32 |     {
33 |         $loadHandler->handle(
34 |             new LoadCliRequest(
35 |                 path: $this->argument('path'),
36 |             ),
37 |             new LoadCliOutput(),
38 |         );
39 |     }
40 | }
41 | 


--------------------------------------------------------------------------------
/app/Presenter/Commands/Report/Cli/Concerns/Sorts.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace App\Presenter\Commands\Report\Cli\Concerns;
 4 | 
 5 | trait Sorts
 6 | {
 7 |     public function getSorts(): array
 8 |     {
 9 |         return $this->sorts === []
10 |             ? $this->getDefaultSorting()
11 |             : $this->sanitizeSortingPairing();
12 |     }
13 | 
14 |     private function getDefaultSorting(): array
15 |     {
16 |         return [
17 |             'totalCommits',
18 |             'desc',
19 |         ];
20 |     }
21 | 
22 |     private function sanitizeSortingPairing(): array
23 |     {
24 |         return array_map(function ($sort) {
25 | 
26 |             [$sortKey, $sortValue] = explode(',', $sort);
27 | 
28 |             $sortValue ??= 'desc';
29 | 
30 |             return [
31 |                 $this->mapIdentifier($sortKey),
32 |                 $sortValue,
33 |             ];
34 | 
35 |         }, $this->sorts);
36 |     }
37 | }
38 | 


--------------------------------------------------------------------------------
/app/Presenter/Commands/Report/Cli/Concerns/Thresholds.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace App\Presenter\Commands\Report\Cli\Concerns;
 4 | 
 5 | trait Thresholds
 6 | {
 7 |     public function getThresholds(): array
 8 |     {
 9 |         if ($this->thresholds === []) {
10 |             return [];
11 |         }
12 | 
13 |         return $this->sanitizeThresholdsPairing();
14 |     }
15 | 
16 |     private function sanitizeThresholdsPairing(): ?array
17 |     {
18 |         return array_map(function ($threshold) {
19 | 
20 |             [$minKey, $minValue] = explode(',', $threshold);
21 | 
22 |             return [
23 |                 $this->mapIdentifier($minKey),
24 |                 $minValue,
25 |             ];
26 | 
27 |         }, $this->thresholds);
28 |     }
29 | }
30 | 


--------------------------------------------------------------------------------
/app/Presenter/Commands/Report/Cli/ReportCliOutput.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace App\Presenter\Commands\Report\Cli;
  4 | 
  5 | use Throwable;
  6 | use function Laravel\Prompts\note;
  7 | use Illuminate\Support\Collection;
  8 | use function Laravel\Prompts\error;
  9 | use function Laravel\Prompts\table;
 10 | use App\Domain\Aggregators\ReportAggregator;
 11 | use App\Application\Report\ReportOutputInterface;
 12 | use App\Presenter\Commands\Report\Cli\ReportClipOutputOptions;
 13 | 
 14 | class ReportCliOutput implements ReportOutputInterface
 15 | {
 16 |     public function __construct(
 17 |         private ReportClipOutputOptions $options,
 18 |     ) {}
 19 | 
 20 |     public function hello(): void
 21 |     {
 22 |         note('❀ PHP Git Insights Analyzer ❀');
 23 |     }
 24 | 
 25 |     public function present(ReportAggregator $reportAggregator): void
 26 |     {
 27 |         $rows = collect($reportAggregator->toArray());
 28 | 
 29 |         $rows = $this->sort($rows);
 30 | 
 31 |         $rows = $this->cut($rows);
 32 | 
 33 |         $this->display($rows);
 34 |     }
 35 | 
 36 |     public function error(Throwable $throwable): void
 37 |     {
 38 |         error($throwable->getMessage());
 39 | 
 40 |         error('Maybe run app:load again ?');
 41 |     }
 42 | 
 43 |     private function sort(Collection $rows): Collection
 44 |     {
 45 |         $sorts = $this->options->getSorts();
 46 | 
 47 |         $rows = $rows->sortBy($sorts);
 48 | 
 49 |         return $rows;
 50 |     }
 51 | 
 52 |     private function cut(Collection $rows): Collection
 53 |     {
 54 |         $rows = $this->cuttingFolder($rows);
 55 | 
 56 |         $rows = $this->cuttingThresholds($rows);
 57 | 
 58 |         return $rows->take($this->options->getLimit());
 59 |     }
 60 | 
 61 |     private function cuttingFolder(Collection $rows): Collection
 62 |     {
 63 |         $rows = $rows->filter(function ($row) {
 64 | 
 65 |             if ($folder = $this->options->getFolder()) {
 66 |                 return str_starts_with($row['name'], $folder);
 67 |             }
 68 | 
 69 |             return true;
 70 |         });
 71 | 
 72 |         return $rows;
 73 |     }
 74 | 
 75 |     private function cuttingThresholds(Collection $rows): Collection
 76 |     {
 77 |         $rows = $rows->filter(function ($row) {
 78 | 
 79 |             $thresholds = $this->options->getThresholds();
 80 | 
 81 |             foreach ($thresholds as $threshold) {
 82 | 
 83 |                 [$key, $value] = $threshold;
 84 | 
 85 |                 if ($row[$key] < $value) {
 86 |                     return false;
 87 |                 }
 88 |             }
 89 | 
 90 |             return true;
 91 |         });
 92 | 
 93 |         return $rows;
 94 |     }
 95 | 
 96 |     private function display(Collection $rows): void
 97 |     {
 98 |         table(
 99 |             [
100 |                 'name',
101 |                 'lines',
102 |                 'comm.',
103 |                 'cont.',
104 |                 'acs',
105 |                 'acsr%',
106 |                 'wpc',
107 |                 'wpcr%',
108 |             ],
109 |             $rows,
110 |         );
111 |     }
112 | }
113 | 


--------------------------------------------------------------------------------
/app/Presenter/Commands/Report/Cli/ReportCliRequest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace App\Presenter\Commands\Report\Cli;
 4 | 
 5 | use App\Application\Report\ReportRequestInterface;
 6 | 
 7 | class ReportCliRequest implements ReportRequestInterface
 8 | {
 9 |     public function __construct(
10 |         //
11 |     ) {
12 |     }
13 | }


--------------------------------------------------------------------------------
/app/Presenter/Commands/Report/Cli/ReportClipOutputOptions.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace App\Presenter\Commands\Report\Cli;
 4 | 
 5 | class ReportClipOutputOptions
 6 | {
 7 |     use Concerns\Sorts;
 8 |     use Concerns\Thresholds;
 9 | 
10 |     public function __construct(
11 |         private string|null $folder,
12 |         private int|null $limit,
13 |         private array $thresholds = [],
14 |         private array $sorts = [],
15 |     ) {}
16 | 
17 |     public function getFolder(): string|null
18 |     {
19 |         return $this->folder;
20 |     }
21 | 
22 |     public function getLimit(): int|null
23 |     {
24 |         return $this->limit;
25 |     }
26 | 
27 |     protected function mapIdentifier(string $key): string
28 |     {
29 |         return match ($key) {
30 |             'lines' => 'totalLines',
31 |             'commits' => 'totalCommits',
32 |             'contributors' => 'totalContributors',
33 |             'acs' => 'averageCommitSize',
34 |             'acsr' => 'averageCommitSizeRatio',
35 |             'wpc' => 'workloadPerContributor',
36 |             'wpcr' => 'workloadPerContributorRatio',
37 |             default => 'totalCommits',
38 |         };
39 |     }
40 | }
41 | 


--------------------------------------------------------------------------------
/app/Presenter/Commands/Report/ReportCommand.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace App\Presenter\Commands\Report;
 4 | 
 5 | use App\Application\Report\ReportHandler;
 6 | use LaravelZero\Framework\Commands\Command;
 7 | use App\Presenter\Commands\Report\Cli\ReportCliOutput;
 8 | use App\Presenter\Commands\Report\Cli\ReportCliRequest;
 9 | use App\Presenter\Commands\Report\Cli\ReportClipOutputOptions;
10 | 
11 | class ReportCommand extends Command
12 | {
13 |     /**
14 |      * The signature of the command.
15 |      *
16 |      * @var string
17 |      */
18 |     protected $signature = 'app:report 
19 |         {--folder=} 
20 |         {--limit=10} 
21 |         {--sorts=*}
22 |         {--thresholds=*}
23 |     ';
24 | 
25 |     /**
26 |      * The description of the command.
27 |      *
28 |      * @var string
29 |      */
30 |     protected $description = '';
31 | 
32 |     /**
33 |      * Execute the console command.
34 |      */
35 |     public function handle(ReportHandler $reportHandler): void
36 |     {
37 |         $options = new ReportClipOutputOptions(
38 |             folder: $this->option('folder'),
39 |             limit: $this->option('limit'),
40 |             sorts: $this->option('sorts'),
41 |             thresholds: $this->option('thresholds'),
42 |         );
43 | 
44 |         $reportHandler->handle(
45 |             new ReportCliRequest(),
46 |             new ReportCliOutput($options),
47 |         );
48 |     }
49 | }
50 | 


--------------------------------------------------------------------------------
/app/Providers/AppServiceProvider.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace App\Providers;
 4 | 
 5 | use Illuminate\Support\ServiceProvider;
 6 | use Illuminate\Filesystem\FilesystemManager;
 7 | use App\Infrastructure\Gateways\CliGitGateway;
 8 | use App\Domain\Aggregators\TrackedFileAggregator;
 9 | use App\Domain\Contracts\Gateways\FileVersionControlGateway;
10 | use App\Domain\Contracts\Repositories\TrackedFileRepository;
11 | use App\Infrastructure\Repositories\TrackedFileStorageRepository;
12 | 
13 | class AppServiceProvider extends ServiceProvider
14 | {
15 |     /**
16 |      * Bootstrap any application services.
17 |      */
18 |     public function boot(): void
19 |     {
20 |         //
21 |     }
22 | 
23 |     /**
24 |      * Register any application services.
25 |      */
26 |     public function register(): void
27 |     {
28 |         $this->app->singleton(FileVersionControlGateway::class, function ($app) {
29 | 
30 |             $aggregator = $app[TrackedFileAggregator::class];
31 | 
32 |             return new CliGitGateway($aggregator);
33 |         });
34 | 
35 |         $this->app->singleton(TrackedFileRepository::class, function ($app) {
36 | 
37 |             $filesystem = $app[FilesystemManager::class];
38 | 
39 |             return new TrackedFileStorageRepository($filesystem);
40 |         });
41 |     }
42 | }
43 | 


--------------------------------------------------------------------------------
/bootstrap/app.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /*
 4 | |--------------------------------------------------------------------------
 5 | | Create The Application
 6 | |--------------------------------------------------------------------------
 7 | |
 8 | | The first thing we will do is create a new Laravel application instance
 9 | | which serves as the "glue" for all the components of Laravel, and is
10 | | the IoC container for the system binding all of the various parts.
11 | |
12 | */
13 | 
14 | $app = new LaravelZero\Framework\Application(
15 |     dirname(__DIR__)
16 | );
17 | 
18 | /*
19 | |--------------------------------------------------------------------------
20 | | Bind Important Interfaces
21 | |--------------------------------------------------------------------------
22 | |
23 | | Next, we need to bind some important interfaces into the container so
24 | | we will be able to resolve them when needed. The kernels serve the
25 | | incoming requests to this application from both the web and CLI.
26 | |
27 | */
28 | 
29 | $app->singleton(
30 |     Illuminate\Contracts\Console\Kernel::class,
31 |     LaravelZero\Framework\Kernel::class
32 | );
33 | 
34 | $app->singleton(
35 |     Illuminate\Contracts\Debug\ExceptionHandler::class,
36 |     Illuminate\Foundation\Exceptions\Handler::class
37 | );
38 | 
39 | /*
40 | |--------------------------------------------------------------------------
41 | | Return The Application
42 | |--------------------------------------------------------------------------
43 | |
44 | | This script returns the application instance. The instance is given to
45 | | the calling script so we can separate the building of the instances
46 | | from the actual running of the application and sending responses.
47 | |
48 | */
49 | 
50 | return $app;
51 | 


--------------------------------------------------------------------------------
/box.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "chmod": "0755",
 3 |     "directories": [
 4 |         "app",
 5 |         "bootstrap",
 6 |         "config",
 7 |         "vendor"
 8 |     ],
 9 |     "files": [
10 |         "composer.json"
11 |     ],
12 |     "exclude-composer-files": false,
13 |     "compression": "GZ",
14 |     "compactors": [
15 |         "KevinGH\\Box\\Compactor\\Php",
16 |         "KevinGH\\Box\\Compactor\\Json"
17 |     ]
18 | }
19 | 


--------------------------------------------------------------------------------
/builds/php-git-insights-analyzer:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/DeGraciaMathieu/php-git-insights-analyzer/9b94a4f4aa6a615a31d38e4c0ba92ec04fe578e6/builds/php-git-insights-analyzer


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "laravel-zero/laravel-zero",
 3 |     "description": "The Laravel Zero Framework.",
 4 |     "keywords": ["framework", "laravel", "laravel zero", "console", "cli"],
 5 |     "homepage": "https://laravel-zero.com",
 6 |     "type": "project",
 7 |     "license": "MIT",
 8 |     "support": {
 9 |         "issues": "https://github.com/laravel-zero/laravel-zero/issues",
10 |         "source": "https://github.com/laravel-zero/laravel-zero"
11 |     },
12 |     "authors": [
13 |         {
14 |             "name": "Nuno Maduro",
15 |             "email": "enunomaduro@gmail.com"
16 |         }
17 |     ],
18 |     "require": {
19 |         "php": "^8.1",
20 |         "laravel-zero/framework": "^10.2",
21 |         "nunomaduro/termwind": "^1.15.1"
22 |     },
23 |     "require-dev": {
24 |         "laravel/pint": "^1.13",
25 |         "mockery/mockery": "^1.6",
26 |         "pestphp/pest": "^2.22"
27 |     },
28 |     "autoload": {
29 |         "psr-4": {
30 |             "App\\": "app/",
31 |             "Database\\Factories\\": "database/factories/",
32 |             "Database\\Seeders\\": "database/seeders/"
33 |         }
34 |     },
35 |     "autoload-dev": {
36 |         "psr-4": {
37 |             "Tests\\": "tests/"
38 |         }
39 |     },
40 |     "config": {
41 |         "preferred-install": "dist",
42 |         "sort-packages": true,
43 |         "optimize-autoloader": true,
44 |         "allow-plugins": {
45 |             "pestphp/pest-plugin": true
46 |         }
47 |     },
48 |     "minimum-stability": "stable",
49 |     "prefer-stable": true,
50 |     "bin": ["php-git-insights-analyzer"]
51 | }
52 | 


--------------------------------------------------------------------------------
/config/app.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | return [
 4 | 
 5 |     /*
 6 |     |--------------------------------------------------------------------------
 7 |     | Application Name
 8 |     |--------------------------------------------------------------------------
 9 |     |
10 |     | This value is the name of your application. This value is used when the
11 |     | framework needs to place the application's name in a notification or
12 |     | any other location as required by the application or its packages.
13 |     |
14 |     */
15 | 
16 |     'name' => 'Php-git-insights-analyzer',
17 | 
18 |     /*
19 |     |--------------------------------------------------------------------------
20 |     | Application Version
21 |     |--------------------------------------------------------------------------
22 |     |
23 |     | This value determines the "version" your application is currently running
24 |     | in. You may want to follow the "Semantic Versioning" - Given a version
25 |     | number MAJOR.MINOR.PATCH when an update happens: https://semver.org.
26 |     |
27 |     */
28 | 
29 |     'version' => app('git.version'),
30 | 
31 |     /*
32 |     |--------------------------------------------------------------------------
33 |     | Application Environment
34 |     |--------------------------------------------------------------------------
35 |     |
36 |     | This value determines the "environment" your application is currently
37 |     | running in. This may determine how you prefer to configure various
38 |     | services the application utilizes. This can be overridden using
39 |     | the global command line "--env" option when calling commands.
40 |     |
41 |     */
42 | 
43 |     'env' => 'development',
44 | 
45 |     /*
46 |     |--------------------------------------------------------------------------
47 |     | Application Timezone
48 |     |--------------------------------------------------------------------------
49 |     |
50 |     | Here you may specify the default timezone for your application, which
51 |     | will be used by the PHP date and date-time functions. We have gone
52 |     | ahead and set this to a sensible default for you out of the box.
53 |     |
54 |     */
55 | 
56 |     'timezone' => 'UTC',
57 | 
58 |     /*
59 |     |--------------------------------------------------------------------------
60 |     | Autoloaded Service Providers
61 |     |--------------------------------------------------------------------------
62 |     |
63 |     | The service providers listed here will be automatically loaded on the
64 |     | request to your application. Feel free to add your own services to
65 |     | this array to grant expanded functionality to your applications.
66 |     |
67 |     */
68 | 
69 |     'providers' => [
70 |         App\Providers\AppServiceProvider::class,
71 |     ],
72 | 
73 | ];
74 | 


--------------------------------------------------------------------------------
/config/commands.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | return [
 4 | 
 5 |     /*
 6 |     |--------------------------------------------------------------------------
 7 |     | Default Command
 8 |     |--------------------------------------------------------------------------
 9 |     |
10 |     | Laravel Zero will always run the command specified below when no command name is
11 |     | provided. Consider update the default command for single command applications.
12 |     | You cannot pass arguments to the default command because they are ignored.
13 |     |
14 |     */
15 | 
16 |     'default' => NunoMaduro\LaravelConsoleSummary\SummaryCommand::class,
17 | 
18 |     /*
19 |     |--------------------------------------------------------------------------
20 |     | Commands Paths
21 |     |--------------------------------------------------------------------------
22 |     |
23 |     | This value determines the "paths" that should be loaded by the console's
24 |     | kernel. Foreach "path" present on the array provided below the kernel
25 |     | will extract all "Illuminate\Console\Command" based class commands.
26 |     |
27 |     */
28 | 
29 |     'paths' => [app_path('Presenter/Commands')],
30 | 
31 |     /*
32 |     |--------------------------------------------------------------------------
33 |     | Added Commands
34 |     |--------------------------------------------------------------------------
35 |     |
36 |     | You may want to include a single command class without having to load an
37 |     | entire folder. Here you can specify which commands should be added to
38 |     | your list of commands. The console's kernel will try to load them.
39 |     |
40 |     */
41 | 
42 |     'add' => [
43 |         // ..
44 |     ],
45 | 
46 |     /*
47 |     |--------------------------------------------------------------------------
48 |     | Hidden Commands
49 |     |--------------------------------------------------------------------------
50 |     |
51 |     | Your application commands will always be visible on the application list
52 |     | of commands. But you can still make them "hidden" specifying an array
53 |     | of commands below. All "hidden" commands can still be run/executed.
54 |     |
55 |     */
56 | 
57 |     'hidden' => [
58 |         NunoMaduro\LaravelConsoleSummary\SummaryCommand::class,
59 |         Symfony\Component\Console\Command\DumpCompletionCommand::class,
60 |         Symfony\Component\Console\Command\HelpCommand::class,
61 |         Illuminate\Console\Scheduling\ScheduleRunCommand::class,
62 |         Illuminate\Console\Scheduling\ScheduleListCommand::class,
63 |         Illuminate\Console\Scheduling\ScheduleFinishCommand::class,
64 |         Illuminate\Foundation\Console\VendorPublishCommand::class,
65 |         LaravelZero\Framework\Commands\StubPublishCommand::class,
66 |     ],
67 | 
68 |     /*
69 |     |--------------------------------------------------------------------------
70 |     | Removed Commands
71 |     |--------------------------------------------------------------------------
72 |     |
73 |     | Do you have a service provider that loads a list of commands that
74 |     | you don't need? No problem. Laravel Zero allows you to specify
75 |     | below a list of commands that you don't to see in your app.
76 |     |
77 |     */
78 | 
79 |     'remove' => [
80 |         // ..
81 |     ],
82 | 
83 | ];
84 | 


--------------------------------------------------------------------------------
/config/filesystems.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | return [
 4 |     'default' => 'local',
 5 |     'disks' => [
 6 |         'local' => [
 7 |             'driver' => 'local',
 8 |             'root' => getcwd(),
 9 |         ],
10 |     ],
11 | ];
12 | 


--------------------------------------------------------------------------------
/php-git-insights-analyzer:
--------------------------------------------------------------------------------
 1 | #!/usr/bin/env php
 2 | <?php
 3 | 
 4 | define('LARAVEL_START', microtime(true));
 5 | 
 6 | /*
 7 | |--------------------------------------------------------------------------
 8 | | Register The Auto Loader
 9 | |--------------------------------------------------------------------------
10 | |
11 | | Composer provides a convenient, automatically generated class loader
12 | | for our application. We just need to utilize it! We'll require it
13 | | into the script here so that we do not have to worry about the
14 | | loading of any our classes "manually". Feels great to relax.
15 | |
16 | */
17 | 
18 | $autoloader = require file_exists(__DIR__.'/vendor/autoload.php') ?  __DIR__.'/vendor/autoload.php' : __DIR__.'/../../autoload.php';
19 | 
20 | $app = require_once __DIR__.'/bootstrap/app.php';
21 | 
22 | /*
23 | |--------------------------------------------------------------------------
24 | | Run The Artisan Application
25 | |--------------------------------------------------------------------------
26 | |
27 | | When we run the console application, the current CLI command will be
28 | | executed in this console and the response sent back to a terminal
29 | | or another output device for the developers. Here goes nothing!
30 | |
31 | */
32 | 
33 | $kernel = $app->make(Illuminate\Contracts\Console\Kernel::class);
34 | 
35 | $status = $kernel->handle(
36 |     $input = new Symfony\Component\Console\Input\ArgvInput,
37 |     new Symfony\Component\Console\Output\ConsoleOutput
38 | );
39 | 
40 | /*
41 | |--------------------------------------------------------------------------
42 | | Shutdown The Application
43 | |--------------------------------------------------------------------------
44 | |
45 | | Once Artisan has finished running, we will fire off the shutdown events
46 | | so that any final work may be done by the application before we shut
47 | | down the process. This is the last thing to happen to the request.
48 | |
49 | */
50 | 
51 | $kernel->terminate($input, $status);
52 | 
53 | exit($status);
54 | 


--------------------------------------------------------------------------------
/phpunit.xml.dist:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 3 |          xsi:noNamespaceSchemaLocation="./vendor/phpunit/phpunit/phpunit.xsd"
 4 |          bootstrap="vendor/autoload.php"
 5 |          colors="true"
 6 | >
 7 |     <testsuites>
 8 |         <testsuite name="Feature">
 9 |             <directory suffix="Test.php">./tests/Feature</directory>
10 |         </testsuite>
11 |         <testsuite name="Unit">
12 |             <directory suffix="Test.php">./tests/Unit</directory>
13 |         </testsuite>
14 |     </testsuites>
15 |     <source>
16 |         <include>
17 |             <directory suffix=".php">./app</directory>
18 |         </include>
19 |     </source>
20 | </phpunit>
21 | 


--------------------------------------------------------------------------------
/tests/CreatesApplication.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Tests;
 4 | 
 5 | use Illuminate\Contracts\Console\Kernel;
 6 | use Illuminate\Foundation\Application;
 7 | 
 8 | trait CreatesApplication
 9 | {
10 |     /**
11 |      * Creates the application.
12 |      */
13 |     public function createApplication(): Application
14 |     {
15 |         $app = require __DIR__.'/../bootstrap/app.php';
16 | 
17 |         $app->make(Kernel::class)->bootstrap();
18 | 
19 |         return $app;
20 |     }
21 | }
22 | 


--------------------------------------------------------------------------------
/tests/Feature/InspireCommandTest.php:
--------------------------------------------------------------------------------
1 | <?php
2 | 
3 | it('inspires artisans', function () {
4 |     $this->artisan('inspire')->assertExitCode(0);
5 | });
6 | 


--------------------------------------------------------------------------------
/tests/Pest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /*
 4 | |--------------------------------------------------------------------------
 5 | | Test Case
 6 | |--------------------------------------------------------------------------
 7 | |
 8 | | The closure you provide to your test functions is always bound to a specific PHPUnit test
 9 | | case class. By default, that class is "PHPUnit\Framework\TestCase". Of course, you may
10 | | need to change it using the "uses()" function to bind a different classes or traits.
11 | |
12 | */
13 | 
14 | uses(Tests\TestCase::class)->in('Feature');
15 | 
16 | /*
17 | |--------------------------------------------------------------------------
18 | | Expectations
19 | |--------------------------------------------------------------------------
20 | |
21 | | When you're writing tests, you often need to check that values meet certain conditions. The
22 | | "expect()" function gives you access to a set of "expectations" methods that you can use
23 | | to assert different things. Of course, you may extend the Expectation API at any time.
24 | |
25 | */
26 | 
27 | expect()->extend('toBeOne', function () {
28 |     return $this->toBe(1);
29 | });
30 | 
31 | /*
32 | |--------------------------------------------------------------------------
33 | | Functions
34 | |--------------------------------------------------------------------------
35 | |
36 | | While Pest is very powerful out-of-the-box, you may have some testing code specific to your
37 | | project that you don't want to repeat in every file. Here you can also expose helpers as
38 | | global functions to help you to reduce the number of lines of code in your test files.
39 | |
40 | */
41 | 
42 | function something(): void
43 | {
44 |     // ..
45 | }
46 | 


--------------------------------------------------------------------------------
/tests/TestCase.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Tests;
 4 | 
 5 | use LaravelZero\Framework\Testing\TestCase as BaseTestCase;
 6 | 
 7 | abstract class TestCase extends BaseTestCase
 8 | {
 9 |     use CreatesApplication;
10 | }
11 | 


--------------------------------------------------------------------------------
/tests/Unit/ExampleTest.php:
--------------------------------------------------------------------------------
1 | <?php
2 | 
3 | test('example', function () {
4 |     expect(true)->toBeTrue();
5 | });
6 | 


--------------------------------------------------------------------------------