GenerateApiDocJsDocsTask::run() - Code Metrics - Inspection of "update config file comment" - Porto-SAP/Hello-API - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( c0d92b...c0ae4b )

by Mahmoud

created 2017-02-09 03:58 UTC

GenerateApiDocJsDocsTask::run() A

↳ Parent: GenerateApiDocJsDocsTask

Complexity

Conditions	2
Paths	2

Size

Total Lines	18
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	18
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	7
nc	2
nop	1

<?php

namespace App\Containers\Documentation\Tasks;

use App\Containers\Documentation\Contracts\ApiTypeInterface;
use App\Port\Task\Abstracts\Task;
use Illuminate\Config\Repository as Config;
use Symfony\Component\Process\Exception\ProcessFailedException;
use Symfony\Component\Process\Process;

/**
 * Class GenerateApiDocJsDocsTask.
 *
 * @author Mahmoud Zalt <[email protected]>
 */
class GenerateApiDocJsDocsTask extends Task
{

    /**
     * @var  \Illuminate\Config\Repository
     */
    private $config;

    /**
     * GenerateApiDocJsDocsTask constructor.
     *
     * @param \Illuminate\Config\Repository $config
     */
    public function __construct(Config $config)
    {
        $this->config = $config;
    }

    /**
     * @param \App\Containers\Documentation\Contracts\ApiTypeInterface $type
     *
     * @return  mixed
     */
    public function run(ApiTypeInterface $type)
    {
        // the actual command that needs to be executed
        $command = "{$this->config->get('apidoc.executable')} -c {$type->getJsonFilePath()} -f {$type->getType()}.php -i app -o {$type->getDocumentationPath()}";

        // execute the command
        ($process = new Process($command))->run();

        if (!$process->isSuccessful()) {
            throw new ProcessFailedException($process);
        }

        // echo the output
        echo $type->getType() . ': ' . $process->getOutput();

        // return the past to that generated documentation
        return $type->getUrl();
    }

}


1			<?php
2
3			namespace App\Containers\Documentation\Tasks;
4
5			use App\Containers\Documentation\Contracts\ApiTypeInterface;
6			use App\Port\Task\Abstracts\Task;
7			use Illuminate\Config\Repository as Config;
8			use Symfony\Component\Process\Exception\ProcessFailedException;
9			use Symfony\Component\Process\Process;
10
11			/**
12			* Class GenerateApiDocJsDocsTask.
13			*
14			* @author Mahmoud Zalt <[email protected]>
15			*/
16			class GenerateApiDocJsDocsTask extends Task
17			{
18
19			/**
20			* @var \Illuminate\Config\Repository
21			*/
22			private $config;
23
24			/**
25			* GenerateApiDocJsDocsTask constructor.
26			*
27			* @param \Illuminate\Config\Repository $config
28			*/
29			public function __construct(Config $config)
30			{
31			$this->config = $config;
32			}
33
34			/**
35			* @param \App\Containers\Documentation\Contracts\ApiTypeInterface $type
36			*
37			* @return mixed
38			*/
39			public function run(ApiTypeInterface $type)
40			{
41			// the actual command that needs to be executed
42			$command = "{$this->config->get('apidoc.executable')} -c {$type->getJsonFilePath()} -f {$type->getType()}.php -i app -o {$type->getDocumentationPath()}";
43
44			// execute the command
45			($process = new Process($command))->run();
46
47			if (!$process->isSuccessful()) {
48			throw new ProcessFailedException($process);
49			}
50
51			// echo the output
52			echo $type->getType() . ': ' . $process->getOutput();
53
54			// return the past to that generated documentation
55			return $type->getUrl();
56			}
57
58			}
59

Porto-SAP / Hello-API

Push — master ( c0d92b...c0ae4b )

GenerateApiDocJsDocsTask::run() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like