Smart\EtlBundle\Extractor\EntityExtractorTrait

Complexity

Total Complexity

23

Size/Duplication

Total Lines	154
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

93.33%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	addEntityToProcess()	0	14	2
A	check()	0	8	2
A	init()	0	4	1
A	extract()	0	19	4
B	processObject()	0	26	6
A	getEntity()	0	11	3
A	processFile()	0	19	5

<?php

namespace Smart\EtlBundle\Extractor;

use Smart\EtlBundle\Exception\Extractor\EntityAlreadyRegisteredException;
use Smart\EtlBundle\Exception\Extractor\EntityIdentifiedNotFoundException;
use Smart\EtlBundle\Exception\Extractor\EntityIdentifierAlreadyProcessedException;
use Smart\EtlBundle\Exception\Extractor\EntityTypeNotHandledException;
use Symfony\Component\PropertyAccess\PropertyAccess;

/**
 * Nicolas Bastien <nicolas.bastien@smartbooster.io>
 */
trait EntityExtractorTrait
{
    /**
     * List of entities to extract
     * [
     *      'entity_code' => 'Model Classname'
     * ]
     * @var array
     */
    protected $entitiesToProcess = [];

    /**
     * @var array
     */
    protected $entities = [];

    /**
     * @var PropertyAccessor
     */
    protected $accessor;

    /**
     * @param string $entityType
     * @param string$entityClass
     * @param function $identifierCallback
     * @return $this
     * @throws \Exception
     */
    public function addEntityToProcess($entityType, $entityClass, $identifierCallback)
    {
        if (isset($this->entitiesToProcess[$entityType])) {
            throw new EntityAlreadyRegisteredException($entityType);
        }

        $this->entitiesToProcess[$entityType] = [
            'type' => $entityType,
            'class' => $entityClass,
            'callback' => $identifierCallback
        ];

        return $this;
    }

    /**
     * @inheritDoc
     */
    public function extract()
    {
        try {
            $this->init();
            $this->check();

            $files = $this->getFiles($this->getFileExtension());

It seems like getFileExtension() must be provided by classes using this trait. How about adding it as abstract method to this trait?

It seems like getFiles() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            foreach ($this->entitiesToProcess as $entityType => $data) {
                if (!isset($files[$entityType])) {
                    continue;
                }
                $this->processFile($entityType);
            }

            return $this->entities;
        } catch (\Exception $e) {
            throw $e;
        }
    }

    protected function check()
    {
        parent::check();

        if (count($this->entitiesToProcess) === 0) {
            throw new \BadMethodCallException('Nothing to process');
        }
    }

    protected function init()
    {
        $this->accessor = PropertyAccess::createPropertyAccessor();

It seems like \Symfony\Component\PropertyAccess\PropertyAccess::createPropertyAccessor() of type object<Symfony\Component\PropertyAccess\PropertyAccessor> is incompatible with the declared type object<Smart\EtlBundle\Extractor\PropertyAccessor> of property $accessor.

    }

    /**
     * @param string $entityType
     * @param array $data
     * @return mixed
     * @throws \Exception
     */
    protected function processObject($entityType, array $data)
    {
        if (!isset($this->entitiesToProcess[$entityType])) {
            throw new EntityTypeNotHandledException($entityType);
        }

        $data = $this->transformData($data);

It seems like transformData() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        if ($data === null) {
            return null;
        }

        $objectClass = $this->entitiesToProcess[$entityType]['class'];
        $object = new $objectClass();

        foreach ($data as $key => $value) {
            $valueToSet = $value;
            if (is_string($value) && strpos($value, '@') === 0) {
                //handle relations
                $valueToSet = $this->getEntity($value);
            }

            $this->accessor->setValue($object, $key, $valueToSet);
        }

        return $object;
    }

    /**
     * @param string $identifier
     * @return mixed
     * @throws \Exception
     */
    protected function getEntity($identifier)
    {
        if (strpos($identifier, '@') === 0) {
            $identifier = substr($identifier, 1);
        }
        if (!isset($this->entities[$identifier])) {
            throw new EntityIdentifiedNotFoundException($identifier);
        }

        return $this->entities[$identifier];
    }

    /**
     * @param  string $filename
     * @throws \Exception
     */
    protected function processFile($filename)
    {
        $filepath = sprintf('%s/%s.' . $this->getFileExtension(), $this->folderToExtract, $filename);

The property folderToExtract does not exist. Did you maybe forget to declare it?

It seems like getFileExtension() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $data = $this->extractFileContent($filepath);

The method extractFileContent() does not exist on Smart\EtlBundle\Extractor\EntityExtractorTrait. Did you maybe mean extract()?

        foreach ($data as $values) {
            if ($values === null) {
                continue;
            }
            $object = $this->processObject($filename, $values);
            if ($object !== null) {
                $entityIdentifier = $this->entitiesToProcess[$filename]['callback']($object);
                if (isset($this->entities[$entityIdentifier])) {
                    throw new EntityIdentifierAlreadyProcessedException($entityIdentifier);
                }
                $this->entities[$entityIdentifier] = $object;
            }
        }
    }
}