Yapeal\Xsd\Creator

Complexity

Total Complexity

21

Size/Duplication

Total Lines	202
Duplicated Lines	18.81 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes	6
Bugs	0	Features	4

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
C	createXsd()	9	74	7
B	inferTypeFromName()	25	25	5
B	processRowset()	0	30	5
A	processValueOnly()	4	20	3

<?php
/**
 * Contains Creator class.
 *
 * PHP version 5.4
 *
 * LICENSE:
 * This file is part of Yet Another Php Eve Api Library also know as Yapeal which can be used to access the Eve Online
 * API data and place it into a database.
 * Copyright (C) 2015-2016 Michael Cummings
 *
 * This program is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
 * Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
 * any later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied
 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License along with this program. If not, see
 * <http://www.gnu.org/licenses/>.
 *
 * You should be able to find a copy of this license in the LICENSE.md file. A copy of the GNU GPL should also be
 * available in the GNU-GPL.md file.
 *
 * @copyright 2015-2016 Michael Cummings
 * @license   http://www.gnu.org/copyleft/lesser.html GNU LGPL
 * @author    Michael Cummings <mgcummings@yahoo.com>
 */
namespace Yapeal\Xsd;

use SimpleXMLElement;
use SimpleXMLIterator;
use tidy;
use Twig_Environment;
use Yapeal\Console\Command\EveApiCreatorTrait;
use Yapeal\Event\EveApiEventInterface;
use Yapeal\Event\MediatorInterface;
use Yapeal\Log\Logger;

/**
 * Class Creator
 */
class Creator
{
    use EveApiCreatorTrait;
    /**
     * Creator constructor.
     *
     * @param Twig_Environment $twig
     * @param string           $dir
     */
    public function __construct(Twig_Environment $twig, $dir = __DIR__)
    {
        $this->setDir($dir);
        $this->setTwig($twig);
    }
    /**
     * @param EveApiEventInterface $event
     * @param string               $eventName
     * @param MediatorInterface    $yem
     *
     * @return EveApiEventInterface
     * @throws \DomainException
     * @throws \InvalidArgumentException
     * @throws \LogicException
     */
    public function createXsd(EveApiEventInterface $event, $eventName, MediatorInterface $yem)
    {
        $this->setYem($yem);
        $data = $event->getData();
        $this->getYem()
            ->triggerLogEvent(
                'Yapeal.Log.log',
                Logger::DEBUG,
                $this->getReceivedEventMessage($data, $eventName, __CLASS__)
            );
        // Only work with raw unaltered XML data.
        if (false !== strpos($data->getEveApiXml(), '<?yapeal.parameters.json')) {
            return $event->setHandledSufficiently();
        }
        $outputFile = sprintf(
            '%1$s%2$s/%3$s.xsd',
            $this->getDir(),
            $data->getEveApiSectionName(),
            $data->getEveApiName()
        );
        // Nothing to do if NOT overwriting and file exists.
        if (false === $this->isOverwrite() && is_file($outputFile)) {
            return $event;
        }
        $this->sectionName = $data->getEveApiSectionName();
        $xml = $data->getEveApiXml();
         if (false === $xml) {
             return $event->setHandledSufficiently();
          }
        $sxi = new SimpleXMLIterator($xml);
        $this->tables = [];
        $this->processValueOnly($sxi, lcfirst($data->getEveApiName()));
        $this->processRowset($sxi);
        list($mSec, $sec) = explode(' ', microtime());
        $vars = [
            'className'   => lcfirst($data->getEveApiName()),
            'tables'      => $this->tables,
            'sectionName' => lcfirst($this->sectionName),
            'version' => gmdate('YmdHis', $sec) . sprintf('.%0-3s', floor($mSec * 1000))
        ];
        try {
            $contents = $this->getTwig()
                ->render('xsd.twig', $vars);
        } catch (\Twig_Error $exc) {
            $this->getYem()
                ->triggerLogEvent('Yapeal.Log.log', Logger::ERROR, 'Twig error', ['exception' => $exc]);
            $this->getYem()
                ->triggerLogEvent(
                    'Yapeal.Log.log',
                    Logger::WARNING,
                    $this->getFailedToWriteFile($data, $eventName, $outputFile)
                );
            return $event;
        }
        $tidyConfig = [
            'indent'        => true,
            'indent-spaces' => 4,
            'input-xml'     => true,
            'newline'       => 'LF',
            'output-xml'    => true,
            'wrap'          => '120'
        ];
        $contents = (new tidy())->repairString($contents, $tidyConfig, 'utf8');
        if (false === $this->saveToFile($outputFile, $contents)) {

This code seems to be duplicated across your project.

            $this->getYem()
                ->triggerLogEvent(
                    $eventName,
                    Logger::WARNING,
                    $this->getFailedToWriteFile($data, $eventName, $outputFile)
                );
            return $event;
        }
        return $event->setHandledSufficiently();
    }
    /**
     * Used to infer(choose) type from element or attribute's name.
     *
     * @param string $name     Name of the element or attribute.
     * @param bool   $forValue Determines if returned type is going to be used for element or an attribute.
     *
     * @return string Returns the inferred type from the name.
     */
    protected function inferTypeFromName($name, $forValue = false)

This method seems to be duplicated in your project.

    {
        if ('ID' === substr($name, -2)) {
            return 'eveIDType';
        }
        $name = strtolower($name);
        foreach ([
                     'descr'          => 'xs:string',
                     'name'           => 'eveNameType',
                     'balance'        => 'eveISKType',
                     'isk'            => 'eveISKType',
                     'tax'            => 'eveISKType',
                     'timeefficiency' => 'xs:unsignedByte',
                     'date'           => 'eveNEDTType',
                     'time'           => 'eveNEDTType',
                     'until'          => 'eveNEDTType',
                     'errorcode'      => 'xs:unsignedShort',
                     'level'          => 'xs:unsignedShort'
                 ] as $search => $replace) {
            if (false !== strpos($name, $search)) {
                return $replace;
            }
        }
        return $forValue ? 'xs:string' : 'xs:token';
    }
    /**
     * @param SimpleXMLIterator $sxi
     * @param string            $xpath
     */
    protected function processRowset(SimpleXMLIterator $sxi, $xpath = '//result/rowset')
    {
        $items = $sxi->xpath($xpath);
        if (0 === count($items)) {
            return;
        }
        $tables = [];
        foreach ($items as $ele) {
            $tableName = (string)$ele['name'];
            /**
             * @type string[] $colNames
             */
            $colNames = explode(',', (string)$ele['columns']);
            /**
             * @type string[] $keyNames
             */
            $keyNames = explode(',', (string)$ele['key']);
            $columns = [];
            foreach ($keyNames as $keyName) {
                $columns[$keyName] = $this->inferTypeFromName($keyName);
            }
            foreach ($colNames as $colName) {
                $columns[$colName] = $this->inferTypeFromName($colName);
            }
            ksort($columns);
            $tables[$tableName] = ['attributes' => $columns];
        }
        ksort($tables);
        $this->tables = array_merge($this->tables, $tables);
    }
    /**
     * @param SimpleXMLIterator $sxi
     *
     * @param string            $tableName
     * @param string            $xpath
     *
     * @return array
     */
    protected function processValueOnly(
        SimpleXMLIterator $sxi,
        $tableName,
        $xpath = '//result/child::*[not(*|@*|self::dataTime)]'
    ) {
        $items = $sxi->xpath($xpath);
        if (0 === count($items)) {
            return;
        }
        $columns = [];
        /**
         * @type SimpleXMLElement $ele
         */
        foreach ($items as $ele) {

This code seems to be duplicated across your project.

            $name = (string)$ele->getName();
            $columns[$name] = $this->inferTypeFromName($name, true);
        }
        ksort($columns);
        $this->tables[$tableName] = ['values' => $columns];
    }
    /**
     * @type string $sectionName
     */
    protected $sectionName;
    /**
     * @type array $tables
     */
    protected $tables;
}