App\Helpers\GistBackupHandler

Complexity

Total Complexity

11

Size/Duplication

Total Lines	103
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	backup()	0	14	2
B	prepareFiles()	0	22	4
A	zipFiles()	0	18	3
A	removeFiles()	0	4	1

<?php

namespace App\Helpers;

use App\Models\User;

class GistBackupHandler
{
    /** @var User $user */
    private $user;

    /** @var GistFinder $gistFinder */
    private $gistFinder;

    /** Max size in bytes of file that can be archived */
    const MAX_FILE_SIZE = 100000;

    function __construct(GistFinder $gistFinder)

It is generally recommended to explicitly declare the visibility for methods.

    {
        $this->user = auth()->user();

The method user does only exist in Illuminate\Contracts\Auth\Guard, but not in Illuminate\Contracts\Auth\Factory.

        $this->gistFinder = $gistFinder;
    }

    /**
     * Backup gists.
     *
     * @return string|integer A path to gist archive or 0 if there are no files to backup.
     */
    public function backup()
    {
        $files = $this->prepareFiles();

        if (!count($files)) {
            return 0;
        }

        $zipPath = $this->zipFiles($files);

        $this->removeFiles();

        return $zipPath;
    }

    /**
     * Get each gist file and save it in the user folder.
     *
     * Also checks the size of a file to determine if it should be ignored.
     *
     * @return array Paths to gist files.
     */
    private function prepareFiles()
    {
        $gists = $this->gistFinder->fetchRawGists();

        $files = [];
        foreach ($gists as $gist) {
            foreach ($gist['files'] as $file) {
                if ($file['size'] < self::MAX_FILE_SIZE) {
                    $filename = $file['filename'];
                    $contents = $this->gistFinder->getGistFileContents($file['raw_url']);
                    $fileDate = date('YmdHis', strtotime($gist['updated_at']));
                    $filePath = "backups/{$this->user->id}/tmp/{$fileDate}-{$filename}";

The property id does not exist on object<App\Models\User>. Since you implemented __get, maybe consider adding a @property annotation.

                    \Storage::put($filePath, $contents);

The method put() does not seem to exist on object<Illuminate\Contracts\Filesystem\Factory>.

                    $files[] = storage_path("app/$filePath");
                }
            }
        }

        return $files;
    }

    /**
     * Create a zip archive and add files to it.
     *
     * @param array $files
     *
     * @return string Path to zip archive.
     *
     * @throws \Exception If the archive cannot be created.
     */
    private function zipFiles(array $files)
    {
        $zipName = date("YmdHis") . '-gists-' . str_slug($this->user->nickname);

The property nickname does not exist on object<App\Models\User>. Since you implemented __get, maybe consider adding a @property annotation.

        $zipPath = storage_path("app/backups/{$this->user->id}/{$zipName}.zip");

The property id does not exist on object<App\Models\User>. Since you implemented __get, maybe consider adding a @property annotation.

        $zip = new \ZipArchive;
        if ($zip->open($zipPath, \ZipArchive::CREATE) === true) {
            foreach ($files as $file) {
                $zip->addFile($file, basename($file));
            }

            $zip->close();

            return $zipPath;
        } else {
            throw new \Exception("Cannot open $zipPath for writing.");
        }
    }

    /**
     * Delete the previously prepared files.
     */
    private function removeFiles()
    {
        \Storage::deleteDirectory("backups/{$this->user->id}/tmp");

The property id does not exist on object<App\Models\User>. Since you implemented __get, maybe consider adding a @property annotation.

The method deleteDirectory() does not seem to exist on object<Illuminate\Contracts\Filesystem\Factory>.

    }
}