SyncerCommand::__construct() - Code Metrics - bmitch/envsync - Measure and Improve Code Quality continuously with Scrutinizer

SyncerCommand::__construct() A
last analyzed 2016-11-24 21:37 UTC

↳ Parent: SyncerCommand

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	6
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	4
nc	1
nop	3

<?php

namespace Bmitch\Envsync;

use Bmitch\Envsync\Collectors\FileCollector;
use Bmitch\Envsync\Finders\EnvironmentFinder;
use Bmitch\Envsync\Builders\TableBuilder;

class SyncerCommand
{

    /**
     * Will be returned when program exits.
     * @var integer
     */
    protected $exitCode = 0;

    /**
     * The mode the program is running in.
     * @var string
     */
    protected $mode;

    /**
     * Instance of the FileCollector class.
     * @var FileCollector
     */
    protected $fileCollector;

    /**
     * Instance of the EnvironmentFilder class.
     * @var EnvironmentFinder
     */
    protected $envFinder;

    /**
     * Instance of the TableBuilder class.
     * @var TableBuilder
     */
    protected $tableBuilder;

    /**
     * The source colde folder that will be inspected.
     * @var string
     */
    protected $folder;

    /**
     * Holds an error message if command runs into an error.
     * @var string
     */
    protected $error;

    /**
     * Creates a new instance of the SyncerCommand.
     * @param FileCollector     $fileCollector File Collector.
     * @param EnvironmentFinder $envFinder     Environment Variable Filder.
     * @param TableBuilder      $tableBuilder  Table Builder.
     */
    public function __construct(FileCollector $fileCollector, EnvironmentFinder $envFinder, TableBuilder $tableBuilder)
    {
        $this->fileCollector = $fileCollector;
        $this->envFinder = $envFinder;
        $this->tableBuilder = $tableBuilder;
    }

    /**
     * Runs the command.
     * @param  array $arguments Command line arguments.
     * @return void
     */
    public function handle(array $arguments)
    {
        if (! $this->argumentsValid($arguments)) {
            echo $this->error;
            return;
        }

        print "\n\nEnvSyncer Report - https://github.com/bmitch/envsync\n";

        $envData = $this->getEnvironmentVariables();

        $results = $this->getResults($envData);

        if ($this->mode == 'ci') {
            $this->checkForCiBuild($results);
        }

        if ($this->mode == 'deploy') {
            $this->checkForDeploy($results);
        }

        $this->tableBuilder->outputTable($results, $this->mode);


        exit($this->exitCode);
    }

    /**
     * Gets a list of the environment variables defined in the
     * source code, .env and .env.example file.
     * @return array
     */
    protected function getEnvironmentVariables()
    {
        $files = $this->fileCollector
                    ->get('.php')
                    ->from($this->folder);

        $env            = [];
        $env['source']  = $this->envFinder->getFromFiles($files);
        $env['example'] = $this->envFinder->getFromFile('.env.example');
        $env['env']     = $this->envFinder->getFromFile('.env');
        $env['all']     = $this->mergeEnvs($env);

        return $env;
    }

    /**
     * Takes the list of environment variables defined and creates
     * a results array showing each variable and where it is or is not
     * defined.
     * @param  array $envData Environment Variable Data.
     * @return array
     */
    protected function getResults(array $envData)
    {
        $results = [];

        foreach ($envData['all'] as $variable) {
            $results[] = [
                'variable'     => $variable,
                'insource'     => in_array($variable, $envData['source']) ? 'Yes' : 'No',
                'inenvexample' => in_array($variable, $envData['example']) ? 'Yes' : 'No',
                'inenv'        => in_array($variable, $envData['env']) ? 'Yes' : 'No',
            ];
        }

        return $results;
    }

    /**
     * Looks through all the current env variables from all
     * sources and makes a master list of all of them.
     * @param  array $currentEnvs Current Env Variables.
     * @return array
     */
    protected function mergeEnvs(array $currentEnvs)
    {
        $allEnvs = [];
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        $allEnvs     = array_unique(array_merge($currentEnvs['env'], $currentEnvs['example']));
        $allEnvs     = array_unique(array_merge($allEnvs, $currentEnvs['source']));

        return $allEnvs;
    }

    /**
     * If a variable is defined in the source code but
     * not defined in the .env.example file we write
     * to the message and set response to 1
     * @param  array $results Environment Variable Results.
     * @return void
     */
    protected function checkForCiBuild(array $results)

    {
        foreach ($results as $row) {
            if ($row['insource'] == 'Yes' && $row['inenvexample'] == 'No') {
                $this->exitCode = 1;
            }
        }
    }

    /**
     * If a variable is defined in the source code but
     * not defined in the .env file we write
     * to the message and set response to 1
     * @param  array $results Environment Variable Results.
     * @return void
     */
    protected function checkForDeploy(array $results)

    {
        foreach ($results as $row) {
            if ($row['insource'] == 'Yes' && $row['inenv'] == 'No') {
                $this->exitCode = 1;
            }
        }
    }

    /**
     * Collects the command line arguments.
     * @param  array $arguments Command line arguments.
     * @return boolean
     */
    protected function argumentsValid(array $arguments)
    {
        // Default value
        $this->folder = '.';

        if (isset($arguments[1])) {
            $this->folder = $arguments[1];
            if (! file_exists($this->folder)) {
                $this->error = "Error: Folder {$this->folder} does not exist.";
                return false;
            }
        }

        if (isset($arguments[2])) {
            $this->mode = strtolower($arguments[2]);
            if (!in_array($this->mode, ['ci', 'deploy', 'default'])) {
                $this->error = "Error: Invalid argument {$this->mode}";
                return false;
            }
            return true;
        }

        $this->mode = 'default';

        return true;
    }
}


1		<?php
2
3		namespace Bmitch\Envsync;
4
5		use Bmitch\Envsync\Collectors\FileCollector;
6		use Bmitch\Envsync\Finders\EnvironmentFinder;
7		use Bmitch\Envsync\Builders\TableBuilder;
8
9		class SyncerCommand
10		{
11
12		/**
13		* Will be returned when program exits.
14		* @var integer
15		*/
16		protected $exitCode = 0;
17
18		/**
19		* The mode the program is running in.
20		* @var string
21		*/
22		protected $mode;
23
24		/**
25		* Instance of the FileCollector class.
26		* @var FileCollector
27		*/
28		protected $fileCollector;
29
30		/**
31		* Instance of the EnvironmentFilder class.
32		* @var EnvironmentFinder
33		*/
34		protected $envFinder;
35
36		/**
37		* Instance of the TableBuilder class.
38		* @var TableBuilder
39		*/
40		protected $tableBuilder;
41
42		/**
43		* The source colde folder that will be inspected.
44		* @var string
45		*/
46		protected $folder;
47
48		/**
49		* Holds an error message if command runs into an error.
50		* @var string
51		*/
52		protected $error;
53
54		/**
55		* Creates a new instance of the SyncerCommand.
56		* @param FileCollector $fileCollector File Collector.
57		* @param EnvironmentFinder $envFinder Environment Variable Filder.
58		* @param TableBuilder $tableBuilder Table Builder.
59		*/
60		public function __construct(FileCollector $fileCollector, EnvironmentFinder $envFinder, TableBuilder $tableBuilder)
61		{
62		$this->fileCollector = $fileCollector;
63		$this->envFinder = $envFinder;
64		$this->tableBuilder = $tableBuilder;
65		}
66
67		/**
68		* Runs the command.
69		* @param array $arguments Command line arguments.
70		* @return void
71		*/
72		public function handle(array $arguments)
73		{
74		if (! $this->argumentsValid($arguments)) {
75		echo $this->error;
76		return;
77		}
78
79		print "\n\nEnvSyncer Report - https://github.com/bmitch/envsync\n";
80
81		$envData = $this->getEnvironmentVariables();
82
83		$results = $this->getResults($envData);
84
85		if ($this->mode == 'ci') {
86		$this->checkForCiBuild($results);
87		}
88
89		if ($this->mode == 'deploy') {
90		$this->checkForDeploy($results);
91		}
92
93		$this->tableBuilder->outputTable($results, $this->mode);
94
95
96		exit($this->exitCode);
97		}
98
99		/**
100		* Gets a list of the environment variables defined in the
101		* source code, .env and .env.example file.
102		* @return array
103		*/
104		protected function getEnvironmentVariables()
105		{
106		$files = $this->fileCollector
107		->get('.php')
108		->from($this->folder);
109
110		$env = [];
111		$env['source'] = $this->envFinder->getFromFiles($files);
112		$env['example'] = $this->envFinder->getFromFile('.env.example');
113		$env['env'] = $this->envFinder->getFromFile('.env');
114		$env['all'] = $this->mergeEnvs($env);
115
116		return $env;
117		}
118
119		/**
120		* Takes the list of environment variables defined and creates
121		* a results array showing each variable and where it is or is not
122		* defined.
123		* @param array $envData Environment Variable Data.
124		* @return array
125		*/
126		protected function getResults(array $envData)
127		{
128		$results = [];
129
130		foreach ($envData['all'] as $variable) {
131		$results[] = [
132		'variable' => $variable,
133		'insource' => in_array($variable, $envData['source']) ? 'Yes' : 'No',
134		'inenvexample' => in_array($variable, $envData['example']) ? 'Yes' : 'No',
135		'inenv' => in_array($variable, $envData['env']) ? 'Yes' : 'No',
136		];
137		}
138
139		return $results;
140		}
141
142		/**
143		* Looks through all the current env variables from all
144		* sources and makes a master list of all of them.
145		* @param array $currentEnvs Current Env Variables.
146		* @return array
147		*/
148		protected function mergeEnvs(array $currentEnvs)
149		{
150		$allEnvs = [];
		0 ignored issues – show Unused Code introduced 2016-10-26 23:34 UTC by Report Bug Copy Issue Report `$allEnvs` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
151		$allEnvs = array_unique(array_merge($currentEnvs['env'], $currentEnvs['example']));
152		$allEnvs = array_unique(array_merge($allEnvs, $currentEnvs['source']));
153
154		return $allEnvs;
155		}
156
157		/**
158		* If a variable is defined in the source code but
159		* not defined in the .env.example file we write
160		* to the message and set response to 1
161		* @param array $results Environment Variable Results.
162		* @return void
163		*/
164	View Code Duplication	protected function checkForCiBuild(array $results)
		0 ignored issues – show Duplication introduced 2016-11-04 23:07 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
165		{
166		foreach ($results as $row) {
167		if ($row['insource'] == 'Yes' && $row['inenvexample'] == 'No') {
168		$this->exitCode = 1;
169		}
170		}
171		}
172
173		/**
174		* If a variable is defined in the source code but
175		* not defined in the .env file we write
176		* to the message and set response to 1
177		* @param array $results Environment Variable Results.
178		* @return void
179		*/
180	View Code Duplication	protected function checkForDeploy(array $results)
		0 ignored issues – show Duplication introduced 2016-11-04 23:07 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
181		{
182		foreach ($results as $row) {
183		if ($row['insource'] == 'Yes' && $row['inenv'] == 'No') {
184		$this->exitCode = 1;
185		}
186		}
187		}
188
189		/**
190		* Collects the command line arguments.
191		* @param array $arguments Command line arguments.
192		* @return boolean
193		*/
194		protected function argumentsValid(array $arguments)
195		{
196		// Default value
197		$this->folder = '.';
198
199		if (isset($arguments[1])) {
200		$this->folder = $arguments[1];
201		if (! file_exists($this->folder)) {
202		$this->error = "Error: Folder {$this->folder} does not exist.";
203		return false;
204		}
205		}
206
207		if (isset($arguments[2])) {
208		$this->mode = strtolower($arguments[2]);
209		if (!in_array($this->mode, ['ci', 'deploy', 'default'])) {
210		$this->error = "Error: Invalid argument {$this->mode}";
211		return false;
212		}
213		return true;
214		}
215
216		$this->mode = 'default';
217
218		return true;
219		}
220		}
221

bmitch / envsync

SyncerCommand::__construct() A last analyzed 2016-11-24 21:37 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

SyncerCommand::__construct() A
last analyzed 2016-11-24 21:37 UTC