SyncFile::getFilepath() - Code Metrics - Inspection of "Added sync command" - spatie/laravel-server-monitor - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#16)

unknown

created 2017-02-27 11:35 UTC

SyncFile::getFilepath() A

↳ Parent: SyncFile

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	0

<?php

namespace Spatie\ServerMonitor\Commands;

use File;
use Illuminate\Database\Eloquent\Collection;
use Spatie\ServerMonitor\Models\Host;
use Spatie\ServerMonitor\Models\Check;

class SyncFile extends BaseCommand
{
    protected $signature = 'server-monitor:sync-file
                            {--force-export : Overwrite existing entries in hosts file with database entries}
                            {--delete-missing : Delete hosts from the database that are not in the hosts file}';

    protected $description = 'Syncs hosts in file with the database';

    protected $path;

    protected $filename = 'hosts.json';

    public function handle()
    {
        $this->prepareStorageDirectory();

        if($this->option('force-export') || ! File::exists($this->getFilepath())) {
            $this->exportAll();

            return;
        }

        $hostsInFile = collect(json_decode(File::get($this->getFilepath()), true));

        $this->updateOrCreateHosts($hostsInFile);

        $this->deleteMissingHosts($hostsInFile);

        $this->writeToFile(Host::all());

    }

    protected function getFilepath(): string
    {
        return $this->path.DIRECTORY_SEPARATOR.$this->filename;
    }

    protected function writeToFile(Collection $hosts)
    {
        $json = $hosts
            ->map(function (Host $host) {
                $checks = $host->checks->pluck('type');
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
                $host = collect($host)->only('name', 'ssh_user', 'ip', 'port')->toArray();
                $host['checks'] = $checks;

                return $host;
            })
            ->toJson();

        File::put($this->getFilepath(), $json);
    }

    protected function prepareStorageDirectory()
    {
        $this->path = storage_path('server-monitor');

        if (!File::exists($this->path)) {
            File::makeDirectory($this->path);
        }
    }

    protected function exportAll()
    {
        $this->writeToFile(Host::all());


        $this->info('Exported all hosts from database to ' . $this->getFilepath());

        return;
    }

    /**
     * @param $hostsInFile
     */
    protected function deleteMissingHosts($hostsInFile)
    {
        if ($this->option('delete-missing')) {
            Host::all()->each(function (Host $host) use ($hostsInFile) {
                if (!$hostsInFile->contains('name', $host->name)) {
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
                    $this->comment("Deleted host '{$host->name}' from database (was not found in hosts file)");
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
                    $host->delete();
                }
            });
        }
    }

    /**
     * @param $hostsInFile
     */
    protected function updateOrCreateHosts($hostsInFile)
    {
        $hostsInFile->each(function ($host) {
            $host = collect($host);

            $hostModel = Host::firstOrNew(['name' => $host['name']]);

            $hostModel
                ->fill($host->except('checks')->toArray())
                ->save();

            // Delete checks that were deleted from the file
            $hostModel->checks->each(function (Check $check) use ($host) {
                if (!in_array($check->type, $host['checks'])) {
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
                    $this->comment("Deleted '{$check->type}' from host '{$host['name']}' (not found in hosts file)");
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
                    $check->delete();
                }
            });

            // Add checks that do not exist in db
            foreach ($host['checks'] as $check) {
                if ($hostModel->checks->where('type', $check)->count() === 0) {
                    $hostModel->checks()->create(['type' => $check]);
                }
            }
        });

        $this->info("Synced {$hostsInFile->count()} host(s) to database");
    }
}


1			<?php
2
3			namespace Spatie\ServerMonitor\Commands;
4
5			use File;
6			use Illuminate\Database\Eloquent\Collection;
7			use Spatie\ServerMonitor\Models\Host;
8			use Spatie\ServerMonitor\Models\Check;
9
10			class SyncFile extends BaseCommand
11			{
12			protected $signature = 'server-monitor:sync-file
13			{--force-export : Overwrite existing entries in hosts file with database entries}
14			{--delete-missing : Delete hosts from the database that are not in the hosts file}';
15
16			protected $description = 'Syncs hosts in file with the database';
17
18			protected $path;
19
20			protected $filename = 'hosts.json';
21
22			public function handle()
23			{
24			$this->prepareStorageDirectory();
25
26			if($this->option('force-export') \|\| ! File::exists($this->getFilepath())) {
27			$this->exportAll();
28
29			return;
30			}
31
32			$hostsInFile = collect(json_decode(File::get($this->getFilepath()), true));
33
34			$this->updateOrCreateHosts($hostsInFile);
35
36			$this->deleteMissingHosts($hostsInFile);
37
38			$this->writeToFile(Host::all());
			0 ignored issues – show Bug introduced 2017-02-27 11:38 UTC by Report Bug Copy Issue Report It seems like `\Spatie\ServerMonitor\Models\Host::all()` targeting `Illuminate\Database\Eloquent\Model::all()` can also be of type `array<integer,object<Ill...base\Eloquent\Builder>>`; however, `Spatie\ServerMonitor\Com...SyncFile::writeToFile()` does only seem to accept `object<Illuminate\Database\Eloquent\Collection>`, maybe add an additional type check? This check looks at variables that are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
39			}
40
41			protected function getFilepath(): string
42			{
43			return $this->path.DIRECTORY_SEPARATOR.$this->filename;
44			}
45
46			protected function writeToFile(Collection $hosts)
47			{
48			$json = $hosts
49			->map(function (Host $host) {
50			$checks = $host->checks->pluck('type');
			0 ignored issues – show Documentation introduced 2017-02-27 11:38 UTC by Report Bug Copy Issue Report The property `checks` does not exist on `object<Spatie\ServerMonitor\Models\Host>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
51			$host = collect($host)->only('name', 'ssh_user', 'ip', 'port')->toArray();
52			$host['checks'] = $checks;
53
54			return $host;
55			})
56			->toJson();
57
58			File::put($this->getFilepath(), $json);
59			}
60
61			protected function prepareStorageDirectory()
62			{
63			$this->path = storage_path('server-monitor');
64
65			if (!File::exists($this->path)) {
66			File::makeDirectory($this->path);
67			}
68			}
69
70			protected function exportAll()
71			{
72			$this->writeToFile(Host::all());
			0 ignored issues – show Bug introduced 2017-02-27 11:38 UTC by Report Bug Copy Issue Report It seems like `\Spatie\ServerMonitor\Models\Host::all()` targeting `Illuminate\Database\Eloquent\Model::all()` can also be of type `array<integer,object<Ill...base\Eloquent\Builder>>`; however, `Spatie\ServerMonitor\Com...SyncFile::writeToFile()` does only seem to accept `object<Illuminate\Database\Eloquent\Collection>`, maybe add an additional type check? This check looks at variables that are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
73
74			$this->info('Exported all hosts from database to ' . $this->getFilepath());
75
76			return;
77			}
78
79			/**
80			* @param $hostsInFile
81			*/
82			protected function deleteMissingHosts($hostsInFile)
83			{
84			if ($this->option('delete-missing')) {
85			Host::all()->each(function (Host $host) use ($hostsInFile) {
86			if (!$hostsInFile->contains('name', $host->name)) {
			0 ignored issues – show Documentation introduced 2017-02-27 11:38 UTC by Report Bug Copy Issue Report The property `name` does not exist on `object<Spatie\ServerMonitor\Models\Host>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
87			$this->comment("Deleted host '{$host->name}' from database (was not found in hosts file)");
			0 ignored issues – show Documentation introduced 2017-02-27 11:38 UTC by Report Bug Copy Issue Report The property `name` does not exist on `object<Spatie\ServerMonitor\Models\Host>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
88			$host->delete();
89			}
90			});
91			}
92			}
93
94			/**
95			* @param $hostsInFile
96			*/
97			protected function updateOrCreateHosts($hostsInFile)
98			{
99			$hostsInFile->each(function ($host) {
100			$host = collect($host);
101
102			$hostModel = Host::firstOrNew(['name' => $host['name']]);
103
104			$hostModel
105			->fill($host->except('checks')->toArray())
106			->save();
107
108			// Delete checks that were deleted from the file
109			$hostModel->checks->each(function (Check $check) use ($host) {
110			if (!in_array($check->type, $host['checks'])) {
			0 ignored issues – show Documentation introduced 2017-02-27 11:38 UTC by Report Bug Copy Issue Report The property `type` does not exist on `object<Spatie\ServerMonitor\Models\Check>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
111			$this->comment("Deleted '{$check->type}' from host '{$host['name']}' (not found in hosts file)");
			0 ignored issues – show Documentation introduced 2017-02-27 11:38 UTC by Report Bug Copy Issue Report The property `type` does not exist on `object<Spatie\ServerMonitor\Models\Check>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
112			$check->delete();
113			}
114			});
115
116			// Add checks that do not exist in db
117			foreach ($host['checks'] as $check) {
118			if ($hostModel->checks->where('type', $check)->count() === 0) {
119			$hostModel->checks()->create(['type' => $check]);
120			}
121			}
122			});
123
124			$this->info("Synced {$hostsInFile->count()} host(s) to database");
125			}
126			}
127

spatie / laravel-server-monitor

Pull Request — master (#16)

SyncFile::getFilepath() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like