willpower232/cloverparser-laravel

A Laravel/Lumen wrapper for willpower232/cloverparser to generate an image and store files

v1.1.0 2024-03-11 17:58 UTC

Requires

• php: ^7.4 || ^8.0
• illuminate/support: ^6.0 || 7.0 || ^8.0 || ^9.0 || ^10.0
• willpower232/cloverparser: ^1.1

Requires (Dev)

• nunomaduro/larastan: ^2.9
• orchestra/testbench: ^8.0
• php-parallel-lint/php-parallel-lint: ^1.3
• phpstan/extension-installer: ^1.3
• phpunit/phpunit: ^10.0 || ^11.0
• robiningelbrecht/phpunit-coverage-tools: ^1.8
• squizlabs/php_codesniffer: ^3.6

MIT

README

This is a wrapper which takes the percentage coverage generated by willpower232/cloverparser and then gives you the ability to use Laravel to create a coverage badge SVG using a view and store that image somewhere using the storage class.

This is also compatible with Lumen but I haven't figured out how to statically analyse both Lumen and Laravel.

A former casual user of codecov and interested in controlling my own data, I decided to see how complicated it would be to operate a similar setup myself after their uploader script was compromised.

This is the second part of this project, turning the coverage percentage into something displayable and storing that somewhere easily accessible.

Installation

composer require willpower232/cloverparser-laravel

Usage

Set a path to your CloverParser instance and then you can store files. Paths are made up of a project folder and a branch as the base name of the file.

Storing files in a folder per project and with the branch name as the file name should allow the files to be structured in a way that makes sense and also in a way that allows for future use without having to look anything else up. As a branch continues and is tested more often, stale files are replaced so that only the most recent are stored.

If you are looking to create a dataset of coverage over time, you can record the percentages as you wish in your application (or even prefix the clover file names to avoid overwriting them).

use WillPower232\CloverParserLaravel\CloverParser;

$urlToSVG = app(CloverParser::class)
	->setPath($project, $branch)
	->addFile($pathToCloverFile)
	->storeImage();

You could also store other files for your future reference.

use WillPower232\CloverParserLaravel\CloverParser;

$parser = app(CloverParser::class)
	->setPath($project, $branch)
	->addFile($pathToCloverFile);

$urlToSVG = $parser->storeImage();

$urlToFile = $parser->store("$branch.clover", file_get_contents($pathToCloverFile));

Alternatively, making more use of Laravel

$file = new \Illuminate\Http\File($pathToCloverFile);

$parser = app(CloverParser::class)
	->setPath($project, $branch)
	->addFile($file);

$urlToFile = $parser->store("$branch.clover", $file);

or via upload directly

$file = $request->file('file');

$parser = app(CloverParser::class)
	->setPath($project, $branch)
	->addFile($file);

$urlToFile = $parser->store("$branch.clover", $file);

Don't forget to validate user uploaded files before hosting them yourself.

Configuration

If you want to store the files in a different disk, you can specify its name in your environment.

CLOVER_PARSER_DISK=s3