Apparat\Resource\Domain\Model\Resource\AbstractResource

Complexity

Total Complexity

21

Size/Duplication

Total Lines	208
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	7

Test Coverage

Coverage

100%

Importance

Changes	11
Bugs	0	Features	1

12 Methods

Rating	Name	Duplication	Size	Complexity
A	load()	0	6	1
A	dump()	0	5	1
A	setPart()	0	5	1
A	getPart()	0	6	1
A	__call()	0	12	2
A	reset()	0	4	1
A	__construct()	0	15	3
A	part()	0	9	3
A	partPath()	0	11	2
A	callPartMethod()	0	7	2
A	callGetterPartMethod()	0	4	2
A	callNonGetterPartMethod()	0	5	2

<?php

/**
 * apparat-resource
 *
 * @category    Apparat
 * @package     Apparat\Resource
 * @subpackage Apparat\Resource\Domain
 * @author      Joschi Kuphal <joschi@kuphal.net> / @jkphl
 * @copyright   Copyright © 2016 Joschi Kuphal <joschi@kuphal.net> / @jkphl
 * @license     http://opensource.org/licenses/MIT The MIT License (MIT)
 */

/***********************************************************************************
 *  The MIT License (MIT)
 *
 *  Copyright © 2016 Joschi Kuphal <joschi@kuphal.net> / @jkphl
 *
 *  Permission is hereby granted, free of charge, to any person obtaining a copy of
 *  this software and associated documentation files (the "Software"), to deal in
 *  the Software without restriction, including without limitation the rights to
 *  use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 *  the Software, and to permit persons to whom the Software is furnished to do so,
 *  subject to the following conditions:
 *
 *  The above copyright notice and this permission notice shall be included in all
 *  copies or substantial portions of the Software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 *  FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 *  COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 *  IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 *  CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 ***********************************************************************************/

namespace Apparat\Resource\Domain\Model\Resource;

use Apparat\Resource\Domain\Contract\ReaderInterface;
use Apparat\Resource\Domain\Contract\WriterInterface;
use Apparat\Resource\Domain\Factory\HydratorFactory;
use Apparat\Resource\Domain\Model\Hydrator\HydratorInterface;
use Apparat\Resource\Domain\Model\Part\AbstractPart;
use Apparat\Resource\Domain\Model\Part\PartInterface;

/**
 * File
 *
 * @package     Apparat\Resource
 * @subpackage Apparat\Resource\Domain
 * @method string getMediaTypePart($part = '/') getMediaTypePart($part = '/') Get the media type of a particular part
 */
abstract class AbstractResource
{
    /**
     * Part or part aggregate
     *
     * @var PartInterface
     */
    protected $part = null;

    /**
     * Reader instance
     *
     * @var ReaderInterface
     */
    protected $reader = null;
    /**
     * File hydrator
     *
     * @var HydratorInterface
     */
    private $hydrator = null;

    /*******************************************************************************
     * PUBLIC METHODS
     *******************************************************************************/

    /**
     * Set a reader instance for this file
     *
     * @param ReaderInterface $reader Reader instance
     * @return Resource Self reference
     */
    public function load(ReaderInterface $reader)
    {
        $this->reset();
        $this->reader = $reader;
        return $this;
    }

    /**
     * Dump this files contents into a writer
     *
     * @param WriterInterface $writer Writer instance
     * @return Resource Self reference
     */
    public function dump(WriterInterface $writer)
    {
        $writer->write($this->getPart('/'));
        return $this;
    }

    /**
     * Set the content of a particular part
     *
     * @param mixed $data Content
     * @param string $part Part path
     * @return Resource Self reference
     */
    public function setPart($data, $part = '/')
    {
        $this->part = $this->part()->set($data, $this->partPath($part));
        return $this;
    }

    /**
     * Return the part's content
     *
     * @param string $part Part path
     * @return string Part content
     */
    public function getPart($part = '/')
    {
        $partPath = $this->partPath($part);
        $part = $this->part()->get($partPath);
        return $part->getHydrator()->dehydrate($part);
    }

    /**
     * Magic caller for part methods
     *
     * @param string $name Part method name
     * @param array $arguments Part method arguments
     * @return mixed|AbstractResource Self reference
     * @throw RuntimeException  If an invalid file method is called
     * @throw RuntimeException  If an invalid file part method is called
     */
    public function __call($name, array $arguments)
    {
        // If a (sub)part method is called
        if (preg_match("%^(.+)Part$%", $name, $partMethod)) {
            return $this->callPartMethod($partMethod, $arguments);
        }

        throw new RuntimeException(
            sprintf('Invalid file method "%s"', $name),
            RuntimeException::INVALID_FILE_METHOD
        );
    }

    /*******************************************************************************
     * PRIVATE METHODS
     *******************************************************************************/

    /**
     * Private constructor
     *
     * @param HydratorInterface|array|string $hydrator File hydrator
     * @param ReaderInterface $reader Reader instance
     */
    protected function __construct($hydrator, ReaderInterface $reader = null)
    {
        // If the hydrator needs to be instantiated from a string or array
        if (!($hydrator instanceof HydratorInterface)) {
            $hydrator = HydratorFactory::build((array)$hydrator);
        }

        // Register the hydrator
        $this->hydrator = $hydrator;

        // Register the reader if available
        if ($reader instanceof ReaderInterface) {
            $this->load($reader);
        }
    }

    /**
     * Reset the file
     *
     * @return void
     */
    protected function reset()
    {
        $this->part = null;
    }

    /**
     * Lazy-hydrate and return the main file part
     *
     * @return PartInterface Main file part
     */
    protected function part()
    {
        if (!($this->part instanceof PartInterface)) {
            $this->part = $this->hydrator->hydrate(
                ($this->reader instanceof ReaderInterface) ? $this->reader->read() : ''
            );
        }
        return $this->part;
    }

    /**
     * Split a part path string into path identifiers
     *
     * @param string $path Part path string
     * @return array Part path identifiers
     */
    protected function partPath($path)
    {
        return (trim($path) == '/') ? [] : array_map(
            function ($pathIdentifier) {
                $pathIdentifier = trim($pathIdentifier);
                AbstractPart::validatePartIdentifier($pathIdentifier);
                return $pathIdentifier;
            },
            explode('/', ltrim($path, '/'))
        );
    }

    /**
     * Call a method on one of the subparts
     *
     * @param array $partMethod Part method components
     * @param array $arguments Part method arguments
     * @return mixed|AbstractResource Getter result / self reference
     */
    protected function callPartMethod(array $partMethod, array $arguments)
    {
        $partMethod = $partMethod[1];
        return strncmp('get', $partMethod, 3)
            ? $this->callNonGetterPartMethod($partMethod, $arguments)
            : $this->callGetterPartMethod($partMethod, $arguments);
    }

    /**
     * Call a getter method on one of the subparts
     *
     * @param string $partMethod Part method
     * @param array $arguments Part method arguments
     * @return mixed Getter result
     */
    protected function callGetterPartMethod($partMethod, array $arguments) {
        $subparts = $this->partPath(count($arguments) ? $arguments[0] : '/');
        return $this->part()->delegate($partMethod, $subparts, []);
    }

    /**
     * Call a non-getter method on one of the subparts
     *
     * @param string $partMethod Part method
     * @param array $arguments Part method arguments
     * @return AbstractResource Self reference
     */
    protected function callNonGetterPartMethod($partMethod, array $arguments) {
        $subparts = $this->partPath((count($arguments) > 1) ? $arguments[1] : '/');
        $this->part = $this->part()->delegate($partMethod, $subparts, array_slice($arguments, 0, 1));
        return $this;
    }
}