ComponentManager\Step\ValidateProjectStep

Complexity

Total Complexity

12

Size/Duplication

Total Lines	99
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

0%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
C	execute()	0	41	7
A	isValidComponentName()	0	4	1
A	isValidPackageRepository()	0	4	1
A	isComponentSpecificationComplete()	0	4	2

<?php

/**
 * Moodle component manager.
 *
 * @author Luke Carrier <luke@carrier.im>
 * @copyright 2016 Luke Carrier
 * @license GPL-3.0+
 */

namespace ComponentManager\Step;

use ComponentManager\ComponentSpecification;
use ComponentManager\Exception\InvalidProjectException;
use ComponentManager\Project\Project;
use Psr\Log\LoggerInterface;

/**
 * Validate the project file.
 */
class ValidateProjectStep implements Step {
    /**
     * Project to validate.
     *
     * @var \ComponentManager\Project\Project
     */
    protected $project;

    /**
     * Initialiser.
     *
     * @param \ComponentManager\Project\Project $project
     */
    public function __construct(Project $project) {
        $this->project = $project;
    }

    /**
     * @override \ComponentManager\Step\Step
     */
    public function execute($task, LoggerInterface $logger) {
        $componentSpecifications = $this->project->getProjectFile()->getComponentSpecifications();

This line exceeds maximum limit of 80 characters; contains 98 characters

        $packageRepositories = $this->project->getPackageRepositories();

        $result = true;

        if (!$this->project->getProjectFile()->getMoodleVersion()) {
            $result = false;
            $logger->warn('No moodle.version key; package operations will fail');

It seems like you code against a concrete implementation and not the interface Psr\Log\LoggerInterface as the method warn() does only exist in the following implementations of said interface: Monolog\Logger, Symfony\Bridge\Monolog\Logger.

This line exceeds maximum limit of 80 characters; contains 81 characters

        }

        foreach ($componentSpecifications as $componentSpecification) {
            if (!$this->isValidComponentName($componentSpecification)) {
                $result = false;
                $logger->error('An invalid component name was specified', [
                    'componentName' => $componentSpecification->getName(),
                ]);
            }

            if (!$this->isComponentSpecificationComplete($componentSpecification)) {

This line exceeds maximum limit of 80 characters; contains 84 characters

                $result = false;
                $logger->error('An incomplete component specification was specified', [

This line exceeds maximum limit of 80 characters; contains 87 characters

                    'componentSpecification' => $componentSpecification,
                ]);
            }

            if (!$this->isValidPackageRepository($componentSpecification, $packageRepositories)) {

This line exceeds maximum limit of 80 characters; contains 98 characters

                $result = false;
                $logger->error('Component uses undeclared package repository', [
                    'componentName'         => $componentSpecification->getName(),

This line exceeds maximum limit of 80 characters; contains 82 characters

                    'packageRepositoryName' => $componentSpecification->getPackageRepository(),

This line exceeds maximum limit of 80 characters; contains 95 characters

                ]);
            }

            if (!$result) {
                throw new InvalidProjectException(
                        'The supplied project file is invalid',
                        InvalidProjectException::CODE_VALIDATION_FAILED);
            }
        }
    }

    /**
     * Does the supplied component have a valid name?
     *
     * @param \ComponentManager\ComponentSpecification $componentSpecification
     *
     * @return boolean
     */
    protected function isValidComponentName(ComponentSpecification $componentSpecification) {

This line exceeds maximum limit of 80 characters; contains 93 characters

        $parts = explode('_', $componentSpecification->getName(), 2);
        return count($parts) === 2;
    }

    /**
     * Is the supplied component's package repository known to us?
     *
     * @param \ComponentManager\ComponentSpecification                $componentSpecification

This line exceeds maximum limit of 80 characters; contains 93 characters

     * @param \ComponentManager\PackageRepository\PackageRepository[] $packageRepositories

This line exceeds maximum limit of 80 characters; contains 90 characters

     *
     * @return boolean
     */
    protected function isValidPackageRepository(ComponentSpecification $componentSpecification, $packageRepositories) {

This line exceeds maximum limit of 80 characters; contains 119 characters

        return array_key_exists(
                $componentSpecification->getPackageRepository(), $packageRepositories);

This line exceeds maximum limit of 80 characters; contains 87 characters

    }

    /**
     * Is the supplied component's specification complete?
     *
     * @param \ComponentManager\ComponentSpecification $componentSpecification
     *
     * @return boolean
     */
    protected function isComponentSpecificationComplete(ComponentSpecification $componentSpecification) {

This line exceeds maximum limit of 80 characters; contains 105 characters

        return !!$componentSpecification->getPackageRepository()
                && !!$componentSpecification->getPackageSource();
    }
}