BrightNucleus\View\Location\FilesystemLocation

Complexity

Total Complexity

15

Size/Duplication

Total Lines	162
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

100%

Importance

Changes	8
Bugs	0	Features	3

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	getURI()	0	8	2
B	getURIs()	0	22	4
A	getNamePattern()	0	14	3
A	getPathPattern()	0	4	1
A	arrayToRegexPattern()	0	8	1
A	validateExtensions()	0	12	3

<?php
/**
 * Bright Nucleus View Component.
 *
 * @package   BrightNucleus\View
 * @author    Alain Schlesser <alain.schlesser@gmail.com>
 * @license   MIT
 * @link      http://www.brightnucleus.com/
 * @copyright 2016 Alain Schlesser, Bright Nucleus
 */

namespace BrightNucleus\View\Location;

use BrightNucleus\View\Support\ExtensionCollection;
use BrightNucleus\View\Support\URIHelper;
use Exception;
use Symfony\Component\Finder\Finder;
use Symfony\Component\Finder\SplFileInfo;

/**
 * Class FilesystemLocation.
 *
 * @since   0.1.0
 *
 * @package BrightNucleus\View\Location
 * @author  Alain Schlesser <alain.schlesser@gmail.com>
 */
class FilesystemLocation implements LocationInterface
{

    /**
     * Path that this location points to.
     *
     * @since 0.1.0
     *
     * @var string
     */
    protected $path;

    /**
     * Extensions that this location can accept.
     *
     * @since 0.1.0
     *
     * @var ExtensionCollection
     */
    protected $extensions;

    /**
     * Instantiate a FilesystemLocation object.
     *
     * @since 0.1.0
     *
     * @param string                                $path       Path that this location points to.
     * @param ExtensionCollection|array|string|null $extensions Optional. Extensions that this location can accept.
     */
    public function __construct($path, $extensions = null)
    {
        $this->path       = $path;
        $this->extensions = $this->validateExtensions($extensions);
    }

    /**
     * Get the first URI that matches the given criteria.
     *
     * @since 0.1.0
     *
     * @param array $criteria Criteria to match.
     *
     * @return string|false URI that matches the criteria or false if none found.
     */
    public function getURI(array $criteria)
    {
        $uris = $this->getURIs($criteria);

        return $uris->count() > 0
            ? $this->getURIs($criteria)->first()
            : false;
    }

    /**
     * Get all URIs that match the given criteria.
     *
     * @since 0.1.1
     *
     * @param array $criteria Criteria to match.
     *
     * @return URICollection URIs that match the criteria or an empty collection if none found.
     */
    public function getURIs(array $criteria)
    {
        $uris = new URICollection();

        foreach ($this->extensions as $extension) {
            $finder = new Finder();

            try {
                $finder->files()
                       ->name($this->getNamePattern($criteria, $extension))
                       ->in($this->getPathPattern());
                foreach ($finder as $file) {
                    /** @var SplFileInfo $file */
                    $uris->add($file->getPathname());
                }
            } catch (Exception $exception) {
                // Fail silently;
            }
        }

        return $uris;
    }

    /**
     * Get the name pattern to pass to the file finder.
     *
     * @since 0.1.3
     *
     * @param array  $criteria  Criteria to match.
     * @param string $extension Extension to match.
     *
     * @return string Name pattern to pass to the file finder.
     */
    protected function getNamePattern(array $criteria, $extension)
    {
        $names = [];

        $names[] = array_map(function ($criterion) use ($extension) {
            $criterion = URIHelper::getFilename($criterion);

            return empty($extension) || URIHelper::hasExtension($criterion, $extension)
                ? $criterion
                : $criterion . $extension;
        }, $criteria)[0];

        return $this->arrayToRegexPattern(array_unique($names));
    }

    /**
     * Get the path pattern to pass to the file finder.
     *
     * @since 0.1.3
     *
     * @return string Path pattern to pass to the file finder.
     */
    protected function getPathPattern()
    {
        return $this->path;
    }

    /**
     * Get an array as a regular expression pattern string.
     *
     * @since 0.1.3
     *
     * @param array $array Array to generate the pattern for.
     *
     * @return string Generated regular expression pattern.
     */
    protected function arrayToRegexPattern(array $array)
    {
        $array = array_map(function ($entry) {
            return preg_quote($entry);
        }, $array);

        return '/' . implode('|', $array) . '/';
    }

    /**
     * Validate the extensions and return a collection.
     *
     * @since 0.1.1
     *
     * @param ExtensionCollection|array|string|null $extensions Extensions to validate.
     *
     * @return ExtensionCollection Validated extensions collection.
     */
    protected function validateExtensions($extensions)
    {
        if (empty($extensions)) {
            $extensions = new ExtensionCollection(['']);
        }

        if (! $extensions instanceof ExtensionCollection) {
            $extensions = new ExtensionCollection((array)$extensions);
        }

        return $extensions;
    }
}