NilPortugues\TodoFinder\Finder\FileParser

Complexity

Total Complexity

10

Size/Duplication

Total Lines	105
Duplicated Lines	18.1 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	8	1
A	validateFileStructure()	9	15	2
A	assertYamlKey()	10	13	2
A	getTotalAllowed()	0	15	3
A	getTodoExpressions()	0	16	2

<?php
/**
 * Author: Nil Portugués Calderó <contact@nilportugues.com>
 * Date: 11/9/15
 * Time: 10:53 PM
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace NilPortugues\TodoFinder\Finder;

use Symfony\Component\Yaml\Yaml;

class FileParser
{
    const TODO_FINDER = 'todo_finder';
    const TOTAL_ALLOWED = 'total_allowed';
    const EXPRESSIONS = 'expressions';

    /**
     * @var array
     */
    private $file;

    /**
     * @param string $file
     */
    public function __construct($file)
    {
        $yaml = new Yaml();
        $file = (array) $yaml->parse($file, true);

        $this->validateFileStructure($file);
        $this->file = $file;
    }

    /**
     * @param array $file
     *
     * @throws FileParserException
     */
    private function validateFileStructure(array &$file)
    {
        if (false === array_key_exists(self::TODO_FINDER, $file)) {

This code seems to be duplicated across your project.

            throw new FileParserException(
                sprintf(
                    'Provided YAML file does not compile with the required format. '
                    .'Expected \'%s\' key to be present but none was found.',
                    self::TODO_FINDER
                )
            );
        }

        $this->assertYamlKey($file[self::TODO_FINDER], self::TOTAL_ALLOWED);
        $this->assertYamlKey($file[self::TODO_FINDER], self::EXPRESSIONS);
    }

    /**
     * @param array  $file
     * @param string $key
     *
     * @throws FileParserException
     */
    private function assertYamlKey(array &$file, $key)
    {
        if (false === array_key_exists($key, $file)) {

This code seems to be duplicated across your project.

            throw new FileParserException(
                sprintf(
                    'Provided YAML file does not compile with the required format. '
                    .'Expected \'%s\' key under \'%s\' to be present but none was found.',
                    $key,
                    self::TODO_FINDER
                )
            );
        }
    }

    /**
     * @throws FileParserException
     * @return int
     */
    public function getTotalAllowed()
    {
        $totalAllowed = $this->file[self::TODO_FINDER][self::TOTAL_ALLOWED];
        $totalAllowedInt = (int) $totalAllowed;

        if (!is_numeric($totalAllowed) && $totalAllowed != $totalAllowedInt) {
            throw new FileParserException(
                'Provided value for %s was expected to be an integer but %s was given',
                self::TOTAL_ALLOWED,
                gettype($totalAllowed)
            );
        }

        return (int) $totalAllowedInt;
    }

    /**
     * @throws FileParserException
     * @return array
     */
    public function getTodoExpressions()
    {
        $list = $this->file[self::TODO_FINDER][self::EXPRESSIONS];

        if (!is_array($list)) {
            throw new FileParserException(
                'Provided value for %s was expected to be an array but %s was given',
                self::EXPRESSIONS,
                gettype($list)
            );
        }

        arsort($list);

        return (array) $list;
    }
}