Baleen\Migrations\Version\Collection

Complexity

Total Complexity

44

Size/Duplication

Total Lines	293
Duplicated Lines	2.39 %

Coupling/Cohesion

Components	1
Dependencies	9

Test Coverage

Coverage

100%

Importance

Changes	15
Bugs	1	Features	6

14 Methods

Rating	Name	Duplication	Size	Complexity
B	__construct()	0	25	5
A	getResolver()	0	4	1
B	get()	0	18	7
A	getById()	0	5	1
C	indexOfId()	0	28	7
A	resolve()	0	4	1
A	has()	0	4	1
A	validate()	0	11	3
A	invalidateResolverCache()	0	4	1
A	add()	7	21	4
A	remove()	0	13	3
A	addOrReplace()	0	8	2
B	hydrate()	0	20	6
A	merge()	0	8	2

<?php
/*
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * This software consists of voluntary contributions made by many individuals
 * and is licensed under the MIT license. For more information, see
 * <http://www.doctrine-project.org>.
 */

namespace Baleen\Migrations\Version;

use Baleen\Migrations\Exception\InvalidArgumentException;
use Baleen\Migrations\Exception\Version\Collection\AlreadyExistsException;
use Baleen\Migrations\Exception\Version\Collection\CollectionException;
use Baleen\Migrations\Version;
use Baleen\Migrations\Version\Collection\Resolver\DefaultResolverStackFactory;
use Baleen\Migrations\Version\Collection\Resolver\ResolverInterface;
use Doctrine\Common\Collections\ArrayCollection;
use Zend\Stdlib\ArrayUtils;

/**
 * Class Collection.
 *
 * @author Gabriel Somoza <gabriel@strategery.io>
 *
 * IMPROVE: this class has many methods. Consider refactoring it to keep number of methods under 10.
 *
 * @SuppressWarnings(PHPMD.TooManyMethods)
 * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
 *
 * @method VersionInterface first()
 * @method VersionInterface last()
 * @method VersionInterface next()
 * @method VersionInterface current()
 * @method VersionInterface offsetGet($offset)
 * @method VersionInterface offsetUnset($offset)
 * @method VersionInterface[] toArray()
 * @method VersionInterface[] getValues()
 * @property VersionInterface[] elements
 */
class Collection extends ArrayCollection
{
    /** @var ResolverInterface */
    private $resolver;

    /**
     * @param VersionInterface[]|\Traversable $versions
     * @param ResolverInterface $resolver

Should the type for parameter $resolver not be null|ResolverInterface?

     *
     * @throws AlreadyExistsException
     * @throws InvalidArgumentException
     * @throws CollectionException
     */
    public function __construct(
        $versions = array(),
        ResolverInterface $resolver = null
    ) {
        if (!is_array($versions)) {
            if ($versions instanceof \Traversable) {
                $versions = ArrayUtils::iteratorToArray($versions);
            } else {
                throw new InvalidArgumentException(
                    "Constructor parameter 'versions' must be an array or Traversable object."
                );
            }
        }

        if (null === $resolver) {
            $resolver = DefaultResolverStackFactory::create();
        }
        $this->resolver = $resolver;

        foreach ($versions as $version) {
            $this->validate($version);
        }

        parent::__construct($versions);
    }

    /**
     * @return ResolverInterface
     */
    final protected function getResolver()
    {
        return $this->resolver;
    }

    /**
     * Gets an element.
     *
     * @param mixed $key If an alias is given then it will be resolved to an element. Otherwise the $key will be used
     *                   to fetch the element by index.
     * @param bool $resolve Whether to use the resolver or not.
     *
     * @return VersionInterface|null Null if not present
     */
    public function get($key, $resolve = true)
    {
        $result = null;

        if (is_object($key) && $key instanceof VersionInterface) {
            return $this->getById($key->getId());
        }

        if ($resolve && is_string($key)) {
            $result = $this->resolve($key);
        }

        if (null === $result && is_scalar($key)) {
            $result = parent::get($key);
        }

        return $result;
    }

    /**
     * Gets a version by id
     *
     * @param $id
     *
     * @return VersionInterface

Should the return type not be VersionInterface|null?

     */
    public function getById($id)
    {
        $index = $this->indexOfId($id);
        return $this->get($index, false);
    }

    /**
     * Returns the index of the version that has the given id. Returns null if not found.
     *
     * @param string $id
     *
     * @return int|null

Should the return type not be integer|string|null?

     */
    public function indexOfId($id)
    {
        $id = (string) $id;
        $result = null;
        $lazy = true;
        foreach ($this as $index => $version) {
            // perfect match
            $currentId = $version->getId();
            if ($currentId === $id) {
                $result = $index;
                break;
            }

            // lazy match:
            if ($lazy && strlen($id) < strlen($currentId) && substr($currentId, 0, strlen($id)) === $id) {
                if ($result === null) {
                    // make this version a candidate, but continue searching to see if any other items also meet the
                    // condition (in which case we'd know the $id being searched for is "ambiguous")
                    $result = $index;
                } else {
                    // the $id is ambiguous when used for lazy matching
                    $lazy = false; // abort lazy search, match by exact ID from now on
                    $result = null; // remove the candidate
                }
            }
        }
        return $result;
    }

    /**
     * Resolves an alias in to a version
     *
     * @param string $alias
     *
     * @return VersionInterface|null
     */
    protected function resolve($alias)
    {
        return $this->getResolver()->resolve((string) $alias, $this);
    }

    /**
     * Returns whether the key exists in the collection.
     *
     * @param      $index
     * @param bool $resolve
     *
     * @return bool
     */
    public function has($index, $resolve = true)
    {
        return $this->get($index, $resolve) !== null;
    }

    /**
     * Returns true if the specified version is valid (can be added) to the collection. Otherwise, it MUST throw
     * an exception.
     *
     * @param VersionInterface $version
     *
     * @return bool
     *
     * @throws AlreadyExistsException
     * @throws CollectionException
     */
    public function validate(VersionInterface $version)
    {
        // validate the version can be added to the collection
        if (!$this->isEmpty() && $this->contains($version)) {
            throw new AlreadyExistsException(
                sprintf('Item with id "%s" already exists.', $version->getId())
            );
        }

        return true; // if there are no exceptions then result is true
    }

    /**
     * invalidateResolverCache
     */
    protected function invalidateResolverCache()
    {
        $this->getResolver()->clearCache($this);
    }

    /**
     * Add a version to the collection
     *
     * @param mixed $element
     *
     * @return bool
     *
     * @throws CollectionException
     * @throws InvalidArgumentException
     */
    public function add($element)
    {
        if (!$element instanceof VersionInterface) {

This code seems to be duplicated across your project.

            throw new InvalidArgumentException(sprintf(
                'Invalid type "%s". Can only add instances of "%s" to this collection.',
                VersionInterface::class,
                is_object($element) ? get_class($element) : gettype($element)
            ));
        }

        if ($this->validate($element)) {
            parent::add($element);
            $this->invalidateResolverCache();
        } else {
            // this should never happen
            throw new CollectionException(
                'Validate should either return true or throw an exception'
            );
        }
        return true;
    }

    /**
     * @param $key
     *
     * @return VersionInterface|null
     */
    public function remove($key)
    {
        if (is_object($key)) {
            $result = $this->removeElement($key);
        } else {
            $result = parent::remove($key);
        }

        if (null !== $result) {
            $this->invalidateResolverCache();
        }
        return $result;
    }

    /**
     * Adds a new version to the collection if it doesn't exist or replaces it if it does.
     *
     * @param VersionInterface $version
     */
    public function addOrReplace(VersionInterface $version)
    {
        $index = $this->indexOfId($version->getId());
        if (null !== $index) {
            $this->remove($index);
        }
        $this->add($version);
    }

    /**
     * Returns a new collection with "enriched" elements based on the information provided in the parameter.
     * An "enriched" Version is one that was originally not linked and now is linked, not migrated and now is migrated,
     * or both.
     *
     * @param Collection $versions
     *
     * @return static
     *
     * @throws CollectionException
     * @throws InvalidArgumentException
     */
    public function hydrate(Collection $versions)
    {
        foreach ($versions as $update) {
            $current = $this->getById($update->getId());
            if ($current !== null) {
                $current->setMigrated($update->isMigrated());
                if ($update instanceof LinkedVersion && $current instanceof Version) {
                    $key = $this->indexOf($current);
                    $current = $current->withMigration($update->getMigration());
                    $this->set($key, $current);
                }
                try {
                    $this->validate($current);
                } catch (AlreadyExistsException $e) {
                    // we don't care for this validation, but yes for the rest
                }
            }
        }
        return $this;
    }

    /**
     * Merges another set into this one, replacing versions that exist and adding those that don't.
     *
     * @param Collection $collection
     * @return $this
     */
    public function merge(Collection $collection)
    {
        foreach ($collection as $version) {
            $this->addOrReplace($version);
        }

        return $this;
    }
}