CleanUpModelsCommand::getClassNamesInDirectory() - Code Metrics - Inspection of "Merge pull request #1 from spatie/human-scrutinize..." - spatie/laravel-model-cleanup - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 3cd240...ef1fc0 )

by Freek

created 2016-03-18 12:32 UTC

CleanUpModelsCommand::getClassNamesInDirectory() A

↳ Parent: CleanUpModelsCommand

Complexity

Conditions	1
Paths	1

Size

Total Lines	8
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Metric	Value
dl	0
loc	8
rs	9.4285
cc	1
eloc	3
nc	1
nop	1

<?php

namespace Spatie\ModelCleanup;

use Illuminate\Console\Command;
use Illuminate\Support\Collection;
use Illuminate\Filesystem\Filesystem;
use PhpParser\Node\Stmt\Class_;
use PhpParser\ParserFactory;
use ClassPreloader\Parser\NodeTraverser;
use PhpParser\NodeVisitor\NameResolver;

class CleanUpModelsCommand extends Command
{
    /**
     * The console command name.
     *
     * @var string
     */
    protected $signature = 'clean:models';
    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'Clean up models.';

    protected $filesystem;

    public function __construct(Filesystem $filesystem)
    {
        parent::__construct();

        $this->filesystem = $filesystem;
    }

    public function handle()
    {
        $this->comment('Cleaning models...');

        $cleanableModels = $this->getModelsThatShouldBeCleanedUp();

        $this->cleanUp($cleanableModels);

        $this->comment('All done!');
    }

    protected function getModelsThatShouldBeCleanedUp() : Collection
    {
        $directories = config('laravel-model-cleanup.directories');

        $modelsFromDirectories = $this->getAllModelsFromEachDirectory($directories);

        return $modelsFromDirectories
            ->merge(collect(config('laravel-model-cleanup.models')))
            ->filter(function ($modelClass) {
                return in_array(GetsCleanedUp::class, class_implements($modelClass));
            });
    }

    protected function cleanUp(Collection $cleanableModels)
    {
        $cleanableModels->each(function (string $class) {

            $numberOfDeletedRecords = $class::cleanUp($class::query())->delete();

            $this->info("Deleted {$numberOfDeletedRecords} record(s) from {$class}.");

        });
    }

    protected function getAllModelsFromEachDirectory(array $directories) : Collection
    {
        return collect($directories)
            ->map(function ($directory) {
                return $this->getClassNamesInDirectory($directory)->all();
            })
            ->flatten();
    }

    protected function getClassNamesInDirectory(string $directory) : Collection
    {
        return collect($this->filesystem->files($directory))->map(function ($path) {

            return $this->getFullyQualifiedClassNameFromFile($path);

        });
    }

    protected function getFullyQualifiedClassNameFromFile(string $path) : string
    {
        $parser = (new ParserFactory())->create(ParserFactory::PREFER_PHP7);

        $traverser = new NodeTraverser();

        $traverser->addVisitor(new NameResolver());

        $code = file_get_contents($path);

        $statements = $parser->parse($code);

        $statements = $traverser->traverse($statements);

        return collect($statements[0]->stmts)
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
            ->filter(function ($statement) {
                return $statement instanceof Class_;
            })
            ->map(function (Class_ $statement) {
                return $statement->namespacedName->toString();

            })
            ->first();
    }
}


1			<?php
2
3			namespace Spatie\ModelCleanup;
4
5			use Illuminate\Console\Command;
6			use Illuminate\Support\Collection;
7			use Illuminate\Filesystem\Filesystem;
8			use PhpParser\Node\Stmt\Class_;
9			use PhpParser\ParserFactory;
10			use ClassPreloader\Parser\NodeTraverser;
11			use PhpParser\NodeVisitor\NameResolver;
12
13			class CleanUpModelsCommand extends Command
14			{
15			/**
16			* The console command name.
17			*
18			* @var string
19			*/
20			protected $signature = 'clean:models';
21			/**
22			* The console command description.
23			*
24			* @var string
25			*/
26			protected $description = 'Clean up models.';
27
28			protected $filesystem;
29
30			public function __construct(Filesystem $filesystem)
31			{
32			parent::__construct();
33
34			$this->filesystem = $filesystem;
35			}
36
37			public function handle()
38			{
39			$this->comment('Cleaning models...');
40
41			$cleanableModels = $this->getModelsThatShouldBeCleanedUp();
42
43			$this->cleanUp($cleanableModels);
44
45			$this->comment('All done!');
46			}
47
48			protected function getModelsThatShouldBeCleanedUp() : Collection
49			{
50			$directories = config('laravel-model-cleanup.directories');
51
52			$modelsFromDirectories = $this->getAllModelsFromEachDirectory($directories);
53
54			return $modelsFromDirectories
55			->merge(collect(config('laravel-model-cleanup.models')))
56			->filter(function ($modelClass) {
57			return in_array(GetsCleanedUp::class, class_implements($modelClass));
58			});
59			}
60
61			protected function cleanUp(Collection $cleanableModels)
62			{
63			$cleanableModels->each(function (string $class) {
64
65			$numberOfDeletedRecords = $class::cleanUp($class::query())->delete();
66
67			$this->info("Deleted {$numberOfDeletedRecords} record(s) from {$class}.");
68
69			});
70			}
71
72			protected function getAllModelsFromEachDirectory(array $directories) : Collection
73			{
74			return collect($directories)
75			->map(function ($directory) {
76			return $this->getClassNamesInDirectory($directory)->all();
77			})
78			->flatten();
79			}
80
81			protected function getClassNamesInDirectory(string $directory) : Collection
82			{
83			return collect($this->filesystem->files($directory))->map(function ($path) {
84
85			return $this->getFullyQualifiedClassNameFromFile($path);
86
87			});
88			}
89
90			protected function getFullyQualifiedClassNameFromFile(string $path) : string
91			{
92			$parser = (new ParserFactory())->create(ParserFactory::PREFER_PHP7);
93
94			$traverser = new NodeTraverser();
95
96			$traverser->addVisitor(new NameResolver());
97
98			$code = file_get_contents($path);
99
100			$statements = $parser->parse($code);
101
102			$statements = $traverser->traverse($statements);
103
104			return collect($statements[0]->stmts)
			0 ignored issues – show Bug introduced 2016-03-18 09:10 UTC by Report Bug Copy Issue Report Accessing `stmts` on the interface `PhpParser\Node` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
105			->filter(function ($statement) {
106			return $statement instanceof Class_;
107			})
108			->map(function (Class_ $statement) {
109			return $statement->namespacedName->toString();
			0 ignored issues – show Bug introduced 2016-03-18 09:10 UTC by Report Bug Copy Issue Report The property `namespacedName` does not seem to exist in `PhpParser\Node\Stmt\Class_`. An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
110			})
111			->first();
112			}
113			}
114

spatie / laravel-model-cleanup

Push — master ( 3cd240...ef1fc0 )

CleanUpModelsCommand::getClassNamesInDirectory() A

Complexity

Size

Duplication

Available Fixes

Duplication Side-by-Side

Filter issues like