Robo\Common\ResourceExistenceChecker

Complexity

Total Complexity

20

Size/Duplication

Total Lines	117
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
B	checkResources()	0	24	7
B	checkResource()	0	23	8
A	checkSourceAndTargetResource()	0	14	3
A	isDir()	0	4	1
A	isFile()	0	4	1

<?php

namespace Robo\Common;

trait ResourceExistenceChecker
{
    /**
     * Checks if the given input is a file or folder.
     *
     * @param string|string[] $resources
     * @param string $type
     *   Allowed values: "file", "dir", "fileAndDir"
     *
     * @return bool
     *   True if no errors were encountered otherwise false.
     */
    protected function checkResources($resources, $type = 'fileAndDir')
    {
        if (!in_array($type, ['file', 'dir', 'fileAndDir'])) {
            throw new \InvalidArgumentException(sprintf('Invalid resource check of type "%s" used!', $type));
        }
        if (is_string($resources)) {
            $resources = [$resources];
        }
        $success = true;
        foreach ($resources as $resource) {
            $glob = glob($resource);
            if ($glob === false) {
                $this->printTaskError(sprintf('Invalid glob "%s"!', $resource), $this);

It seems like printTaskError() must be provided by classes using this trait. How about adding it as abstract method to this trait?

                $success = false;
                continue;
            }
            foreach ($glob as $resource) {
                if (!$this->checkResource($resource, $type)) {
                    $success = false;
                }
            }
        }
        return $success;
    }

    /**
     * Checks a single resource, file or directory.
     *
     * It will print an error as well on the console.
     *
     * @param string $resource
     *   File or folder.
     * @param string $type
     *   Allowed values: "file", "dir", "fileAndDir".
     *
     * @return bool
     */
    protected function checkResource($resource, $type)
    {
        switch ($type) {
            case 'file':
                if (!$this->isFile($resource)) {
                    $this->printTaskError(sprintf('File "%s" does not exist!', $resource), $this);

It seems like printTaskError() must be provided by classes using this trait. How about adding it as abstract method to this trait?

                    return false;
                }
                return true;
            case 'dir':
                if (!$this->isDir($resource)) {
                    $this->printTaskError(sprintf('Directory "%s" does not exist!', $resource), $this);

It seems like printTaskError() must be provided by classes using this trait. How about adding it as abstract method to this trait?

                    return false;
                }
                return true;
            case 'fileAndDir':
                if (!$this->isDir($resource) && !$this->isFile($resource)) {
                    $this->printTaskError(sprintf('File or directory "%s" does not exist!', $resource), $this);

It seems like printTaskError() must be provided by classes using this trait. How about adding it as abstract method to this trait?

                    return false;
                }
                return true;
        }
    }

    /**
     * Convenience method to check the often uses "source => target" file / folder arrays.
     *
     * @param string|array $resources
     */
    protected function checkSourceAndTargetResource($resources)
    {
        if (is_string($resources)) {
            $resources = [$resources];
        }
        $sources = [];
        $targets = [];
        foreach ($resources as $source => $target) {
            $sources[] = $source;
            $target[] = $target;
        }
        $this->checkResources($sources);
        $this->checkResources($targets);
    }

   /**
    * Wrapper method around phps is_dir()
    *
    * @param string $directory
    *
    * @return bool
    */
    protected function isDir($directory)
    {
        return is_dir($directory);
    }

   /**
    * Wrapper method around phps file_exists()
    *
    * @param string $file
    *
    * @return bool
    */
    protected function isFile($file)
    {
        return file_exists($file);
    }
}