Naneau\ProjectVersioner\Versioner

Complexity

Total Complexity

14

Size/Duplication

Total Lines	124
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	get()	0	13	3
A	getCombined()	0	18	4
A	has()	0	10	3
A	getReaders()	0	4	1
A	setReaders()	0	6	1
A	addReader()	0	6	1

<?php
/**
 * Versioner.php
 *
 * @package         ProjectVersioner
 * @subpackage      Versioner
 */

namespace Naneau\ProjectVersioner;

use Naneau\ProjectVersioner\ReaderInterface as Reader;

use \RuntimeException;

/**
 * Versioner
 *
 * Uses a set of readers to fetch versions from directories
 *
 * @category        Naneau
 * @package         ProjectVersioner
 * @subpackage      Versioner
 */
class Versioner
{
    /**
     * The readers
     *
     * @var Reader[]
     **/
    private $readers;

    /**
     * Constructor
     *
     * @param  Reader[] $readers
     * @return void

Adding a @return annotation to constructors is generally not recommended as a constructor does not have a meaningful return value.

     **/
    public function __construct(array $readers = array())
    {
        $this->setReaders($readers);
    }

    /**
     * Get the version for a directory
     *
     * @param  string $directory
     * @return string
     **/
    public function get($directory)
    {
        foreach ($this->getReaders() as $reader) {
            if ($reader->canRead($directory)) {
                return $reader->read($directory);
            }
        }

        throw new RuntimeException(sprintf(
            'Can not read version from directory "%s"',
            $directory
        ));
    }

    /**
     * Get the version for a directory
     *
     * Combining the output of all writers using the given separator
     *
     * Version will be considered "found" if at least one versioner returns
     * output.
     *
     * @param  string $directory
     * @param  string $separator
     * @return string
     **/
    public function getCombined($directory, $separator = '-')
    {
        $found = array();
        foreach ($this->getReaders() as $reader) {
            if ($reader->canRead($directory)) {
                $found[] = $reader->read($directory);
            }
        }

        if (count($found) === 0) {
            throw new RuntimeException(sprintf(
                'Can not read version from directory "%s"',
                $directory
            ));
        }

        return implode($separator, $found);
    }

    /**
     * Does a directory have a version?
     *
     * @param string $directory
     * @return bool
     **/
    public function has($directory)
    {
        foreach ($this->getReaders() as $reader) {
            if ($reader->canRead($directory)) {
                return true;
            }
        }

        return false;
    }

    /**
     * Get the set of readers
     *
     * @return Reader[]
     */
    public function getReaders()
    {
        return $this->readers;
    }

    /**
     * Set the set of readers
     *
     * @param  Reader[]  $readers
     * @return Versioner
     */
    public function setReaders(array $readers)
    {
        $this->readers = $readers;

        return $this;
    }

    /**
     * Add a reader
     *
     * @param  Reader[]  $reader
     * @return Versioner
     */
    public function addReader(Reader $reader)
    {
        $this->readers[] = $reader;

        return $this;
    }
}