MakeUser::fileHandlerFactory() - Code Metrics - Inspection of "Patch 1" - michaeldyrynda/laravel-make-user - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#6)

unknown

created 2018-03-07 07:03 UTC

MakeUser::fileHandlerFactory() A

↳ Parent: MakeUser

Complexity

Conditions	3
Paths	3

Size

Total Lines	14
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	3

Importance

Changes

Metric	Value
dl	0
loc	14
ccs	7
cts	7
cp	1
rs	9.4285
c	0
b	0
f	0
cc	3
eloc	7
nc	3
nop	1
crap	3

<?php

namespace Dyrynda\Artisan\Console\Commands;

use Exception;
use SplFileInfo;
use Illuminate\Console\Command;
use Illuminate\Support\Facades\Password;
use Dyrynda\Artisan\Exceptions\MakeUserException;
use Dyrynda\Artisan\Exceptions\ImportFileException;
use Dyrynda\Artisan\BulkImport\BulkImportFileHandler;

class MakeUser extends Command
{
    /**
     * The name and signature of the console command.
     *
     * @var string
     */
    protected $signature = 'make:user
                                {--email=       : Set the email for the new user}
                                {--name=        : Set the name for the new user}
                                {--password=    : The password to set for the new user}
                                {--send-reset   : Send a password reset email for the new user}
                                {--fields=      : Additional database fields to set on the user}
                                {--force        : Create the user model circumventing guarded fields}
                                {--import-file= : Relative path and filename for a file to import users from. File name MUST contain the extension representing the type of file (Ex: ./path/to/file.csv)}
    ';

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'Create new application users';

    /**
     * Execute the console command.
     *
     * Handle creation of the new application user.
     *
     * @return void
     */
    public function handle()
    {
        $dataToProcess = [];

        try {
            $bulkImportFile = is_string($this->option('import-file')) ? $this->fileHandlerFactory($this->option('import-file')) : null;

            $modelCommand = $this->option('force') ? 'forceCreate' : 'create';

            if (! is_null($bulkImportFile)) {
                $dataToProcess = $bulkImportFile->getData();

                $sendReset = false;

                if (! in_array('password', array_keys($dataToProcess[0])) || $this->option('send-reset')) {
                    $sendReset = true;
                }
                $dataToProcess = $this->setPasswords($dataToProcess);

            } else {
                $email = $this->option('email');
                $name = $this->option('name') ?: '';
                $password = bcrypt($this->option('password') ?: str_random(32));
                $sendReset = ! $this->option('password') || $this->option('send-reset');

                $dataToProcess[0] = [
                    'email' => $email,
                    'name' => $name,
                    'password' => $password,
                ];
            }

            foreach ($dataToProcess as $dataRow) {

                $email = $dataRow['email'] ?? null;

                app('db')->beginTransaction();

                $this->validateEmail($email);

                app(config('auth.providers.users.model'))->{$modelCommand}(array_merge(
                    $dataRow,
                    $bulkImportFile ? [] : $this->additionalFields()
                ));

                if ($sendReset) {
                    Password::sendResetLink(compact('email'));
                }

                app('db')->commit();
            }

            if (count($dataToProcess)) {
                $createdMessage = $bulkImportFile
                    ? 'Created '.count($dataToProcess).' user(s).'
                    : "Created new user for email {$email}.";
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

                $passwordResetMessage = $bulkImportFile
                    ? 'Sent password reset emails.'
                    : "Sent password reset email to {$email}.";

                $this->info($createdMessage);

                if ($sendReset) {
                    $this->info($passwordResetMessage);
                }

            } else {
                $this->error('The user(s) were not created');
            }

        } catch (Exception $e) {
            $this->error($e->getMessage());

            $this->error('The user(s) were not created');

            app('db')->rollBack();
        }
    }

    /**
     * Determine if the given email address already exists.
     *
     * @param  string  $email
     * @return void
     *
     * @throws \Dyrynda\Artisan\Exceptions\MakeUserException
     */
    private function validateEmail($email)
    {
        if (! filter_var($email, FILTER_VALIDATE_EMAIL)) {
            throw MakeUserException::invalidEmail($email);
        }

        if (app(config('auth.providers.users.model'))->where('email', $email)->exists()) {
            throw MakeUserException::emailExists($email);
        }
    }

    /**
     * Return any additional database fields passed by the --fields option.
     *
     * @return array
     */
    private function additionalFields()
    {
        if (! $this->option('fields')) {
            return [];
        }

        return collect(explode(',', $this->option('fields')))->mapWithKeys(function ($field) {
            list($column, $value) = explode(':', $field);

            return [trim($column) => $this->normaliseValue($value)];
        })->toArray();
    }

    /**
     * Normalise the given (database) field input value.
     *
     * @param  mixed  $value
     * @return mixed
     */
    private function normaliseValue($value)
    {
        if ($value == 'null') {
            return;
        }

        if (in_array($value, [1, 'true', true], true)) {
            return true;
        }

        if (in_array($value, [0, 'false', false], true)) {
            return false;
        }

        return trim($value);
    }

    /**
     * Create file handler objects.
     *
     * @param string  $path
     * @return BulkImportFileHandler
     *
     * @throws \Dyrynda\Artisan\Exceptions\ImportFileException
     */
    private function fileHandlerFactory($path) : BulkImportFileHandler
    {
        if (! strpos($path, '.')) {
            throw ImportFileException::noExtension();
        }

        $file = new SplFileInfo($path);

        if (! class_exists($class = '\\Dyrynda\\Artisan\\BulkImport\\Handlers\\'.studly_case($file->getExtension()))) {
            throw ImportFileException::unsupported($file->getExtension());
        }

        return new $class($file);
    }

    /**
     * Add default password to data.
     *
     * @param array  $data
     * @return array
     */
    private function setPasswords($data)
    {
        return collect($data)->map(function ($row) {
            return array_merge(
                $row,
                ! isset($row['password']) ? ['password' => str_random(32)] : ['password' => bcrypt($row['password'])]
            );
        })->all();
    }
}


1			<?php
2
3			namespace Dyrynda\Artisan\Console\Commands;
4
5			use Exception;
6			use SplFileInfo;
7			use Illuminate\Console\Command;
8			use Illuminate\Support\Facades\Password;
9			use Dyrynda\Artisan\Exceptions\MakeUserException;
10			use Dyrynda\Artisan\Exceptions\ImportFileException;
11			use Dyrynda\Artisan\BulkImport\BulkImportFileHandler;
12
13			class MakeUser extends Command
14			{
15			/**
16			* The name and signature of the console command.
17			*
18			* @var string
19			*/
20			protected $signature = 'make:user
21			{--email= : Set the email for the new user}
22			{--name= : Set the name for the new user}
23			{--password= : The password to set for the new user}
24			{--send-reset : Send a password reset email for the new user}
25			{--fields= : Additional database fields to set on the user}
26			{--force : Create the user model circumventing guarded fields}
27			{--import-file= : Relative path and filename for a file to import users from. File name MUST contain the extension representing the type of file (Ex: ./path/to/file.csv)}
28			';
29
30			/**
31			* The console command description.
32			*
33			* @var string
34			*/
35			protected $description = 'Create new application users';
36
37			/**
38			* Execute the console command.
39			*
40			* Handle creation of the new application user.
41			*
42			* @return void
43			*/
44	27		public function handle()
45			{
46	27		$dataToProcess = [];
47
48			try {
49	27		$bulkImportFile = is_string($this->option('import-file')) ? $this->fileHandlerFactory($this->option('import-file')) : null;
50
51	21		$modelCommand = $this->option('force') ? 'forceCreate' : 'create';
52
53	21		if (! is_null($bulkImportFile)) {
54	12		$dataToProcess = $bulkImportFile->getData();
55
56	12		$sendReset = false;
57
58	12		if (! in_array('password', array_keys($dataToProcess[0])) \|\| $this->option('send-reset')) {
59	4		$sendReset = true;
60			}
61	12		$dataToProcess = $this->setPasswords($dataToProcess);
62
63			} else {
64	9		$email = $this->option('email');
65	9		$name = $this->option('name') ?: '';
66	9		$password = bcrypt($this->option('password') ?: str_random(32));
67	9		$sendReset = ! $this->option('password') \|\| $this->option('send-reset');
68
69	9		$dataToProcess[0] = [
70	9		'email' => $email,
71	9		'name' => $name,
72	9		'password' => $password,
73			];
74			}
75
76	21		foreach ($dataToProcess as $dataRow) {
77
78	21		$email = $dataRow['email'] ?? null;
79
80	21		app('db')->beginTransaction();
81
82	21		$this->validateEmail($email);
83
84	17		app(config('auth.providers.users.model'))->{$modelCommand}(array_merge(
85	17		$dataRow,
86	17		$bulkImportFile ? [] : $this->additionalFields()
87			));
88
89	17		if ($sendReset) {
90	7		Password::sendResetLink(compact('email'));
91			}
92
93	17		app('db')->commit();
94			}
95
96	17		if (count($dataToProcess)) {
97	17		$createdMessage = $bulkImportFile
98	10		? 'Created '.count($dataToProcess).' user(s).'
99	17		: "Created new user for email {$email}.";
			0 ignored issues – show Bug introduced 2018-03-04 23:59 UTC by Report Bug Copy Issue Report The variable `$email` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
100
101	17		$passwordResetMessage = $bulkImportFile
102	10		? 'Sent password reset emails.'
103	17		: "Sent password reset email to {$email}.";
104
105	17		$this->info($createdMessage);
106
107	17		if ($sendReset) {
108	17		$this->info($passwordResetMessage);
109			}
110
111			} else {
112	17		$this->error('The user(s) were not created');
113			}
114
115	10		} catch (Exception $e) {
116	10		$this->error($e->getMessage());
117
118	10		$this->error('The user(s) were not created');
119
120	10		app('db')->rollBack();
121			}
122	27		}
123
124			/**
125			* Determine if the given email address already exists.
126			*
127			* @param string $email
128			* @return void
129			*
130			* @throws \Dyrynda\Artisan\Exceptions\MakeUserException
131			*/
132	21		private function validateEmail($email)
133			{
134	21		if (! filter_var($email, FILTER_VALIDATE_EMAIL)) {
135	3		throw MakeUserException::invalidEmail($email);
136			}
137
138	18		if (app(config('auth.providers.users.model'))->where('email', $email)->exists()) {
139	1		throw MakeUserException::emailExists($email);
140			}
141	17		}
142
143			/**
144			* Return any additional database fields passed by the --fields option.
145			*
146			* @return array
147			*/
148	7		private function additionalFields()
149			{
150	7		if (! $this->option('fields')) {
151	4		return [];
152			}
153
154	3		return collect(explode(',', $this->option('fields')))->mapWithKeys(function ($field) {
155	3		list($column, $value) = explode(':', $field);
156
157	3		return [trim($column) => $this->normaliseValue($value)];
158	3		})->toArray();
159			}
160
161			/**
162			* Normalise the given (database) field input value.
163			*
164			* @param mixed $value
165			* @return mixed
166			*/
167	3		private function normaliseValue($value)
168			{
169	3		if ($value == 'null') {
170	1		return;
171			}
172
173	2	View Code Duplication	if (in_array($value, [1, 'true', true], true)) {
174	1		return true;
175			}
176
177	1	View Code Duplication	if (in_array($value, [0, 'false', false], true)) {
178	1		return false;
179			}
180
181	1		return trim($value);
182			}
183
184			/**
185			* Create file handler objects.
186			*
187			* @param string $path
188			* @return BulkImportFileHandler
189			*
190			* @throws \Dyrynda\Artisan\Exceptions\ImportFileException
191			*/
192	18		private function fileHandlerFactory($path) : BulkImportFileHandler
193			{
194	18		if (! strpos($path, '.')) {
195	1		throw ImportFileException::noExtension();
196			}
197
198	17		$file = new SplFileInfo($path);
199
200	17		if (! class_exists($class = '\\Dyrynda\\Artisan\\BulkImport\\Handlers\\'.studly_case($file->getExtension()))) {
201	1		throw ImportFileException::unsupported($file->getExtension());
202			}
203
204	16		return new $class($file);
205			}
206
207			/**
208			* Add default password to data.
209			*
210			* @param array $data
211			* @return array
212			*/
213			private function setPasswords($data)
214			{
215	12		return collect($data)->map(function ($row) {
216	12		return array_merge(
217	12		$row,
218	12		! isset($row['password']) ? ['password' => str_random(32)] : ['password' => bcrypt($row['password'])]
219			);
220	12		})->all();
221			}
222			}
223

michaeldyrynda / laravel-make-user

Pull Request — master (#6)

MakeUser::fileHandlerFactory() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like