hanneskod\readmetester\ExampleFactory

Complexity

Total Complexity

23

Size/Duplication

Total Lines	129
Duplicated Lines	15.5 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	2
C	createExamples()	0	46	8
A	readName()	10	10	4
A	shouldIgnoreExample()	0	10	3
A	shouldExtendExample()	10	10	4
A	createExpectations()	0	10	2

<?php

namespace hanneskod\readmetester;

use hanneskod\readmetester\Expectation\ExpectationFactory;

/**
 * Create examples from definitions created by Parser
 */
class ExampleFactory
{
    /**
     * @var ExpectationFactory
     */
    private $expectationFactory;

    public function __construct(ExpectationFactory $expectationFactory = null)
    {
        $this->expectationFactory = $expectationFactory ?: new ExpectationFactory;
    }

    /**
     * Create examples from definitions
     *
     * @param  array $defenitions Example definitions as created by Parser
     * @return Example[]
     */
    public function createExamples(array $defenitions)
    {
        $examples = [];

        foreach ($defenitions as $index => $def) {
            if ($this->shouldIgnoreExample($def['annotations'])) {
                continue;
            }

            $name = $this->readName($def['annotations']) ?: (string)($index + 1);

            if (isset($examples[$name])) {
                throw new \RuntimeException("Example '$name' already exists in definition " . ($index + 1));
            }

            if ($extends = $this->shouldExtendExample($def['annotations'])) {
                if (!isset($examples[$extends])) {
                    throw new \RuntimeException(
                        "Example '$extends' does not exist and can not be extended in definition " . ($index + 1)
                    );
                }

                $def['code'] = sprintf(
                    "%s\n%s%s\n%s",
                    'ob_start();',
                    $examples[$extends]->getCodeBlock()->getCode(),
                    'ob_end_clean();',
                    $def['code']
                );
            }

            $expectations = $this->createExpectations($def['annotations']);

            if (!$expectations) {

The expression $expectations of type hanneskod\readmetester\Expectation\ExpectationInterface[] is implicitly converted to a boolean; are you sure this is intended? If so, consider using empty($expr) instead to make it clear that you intend to check for an array without elements.

                $expectations[] = $this->expectationFactory->createExpectation('expectnothing', []);
            }

            $examples[$name] = new Example(
                $name,
                new CodeBlock($def['code']),
                $expectations
            );
        }

        return $examples;
    }

    /**
     * Read name from example annotation
     *
     * @return string
     */
    private function readName(array $annotations)

This method seems to be duplicated in your project.

    {
        foreach ($annotations as list($name, $args)) {
            if (strcasecmp($name, 'example') == 0) {
                return isset($args[0]) ? $args[0] : '';
            }
        }

        return '';
    }

    /**
     * Check if this example is marked as ignored
     *
     * @return boolean
     */
    private function shouldIgnoreExample(array $annotations)
    {
        foreach ($annotations as list($name, $args)) {
            if (strcasecmp($name, 'ignore') == 0) {
                return true;
            }
        }

        return false;
    }

    /**
     * Get name of example this example should extend
     *
     * @return string
     */
    private function shouldExtendExample(array $annotations)

This method seems to be duplicated in your project.

    {
        foreach ($annotations as list($name, $args)) {
            if (strcasecmp($name, 'extends') == 0) {
                return isset($args[0]) ? $args[0] : '';
            }
        }

        return '';
    }

    /**
     * Create expectation from definition data
     *
     * @return Expectation\ExpectationInterface[]
     */
    private function createExpectations(array $annotations)
    {
        $expectations = [];

        foreach ($annotations as list($name, $args)) {
            $expectations[] = $this->expectationFactory->createExpectation($name, $args);
        }

        return array_filter($expectations);
    }
}