EntityExtractorTrait::processFile() - Code Metrics - Inspection of "Merge pull request #8 from smartbooster/7_csv" - smartbooster/etl-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( d88042...0c5536 )

by Nicolas

created 2018-11-23 16:17 UTC

EntityExtractorTrait::processFile() A

↳ Parent: EntityExtractorTrait

Complexity

Conditions	4
Paths	4

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	11
CRAP Score	4

Importance

Changes

Metric	Value
dl	0
loc	16
ccs	11
cts	11
cp	1
rs	9.7333
c	0
b	0
f	0
nc	4
cc	4
nop	1
crap	4

<?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 <[email protected]>
 */
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());
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            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();

    }

    /**
     * @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);
        }

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

        foreach ($data as $key => $value) {
            $valueToSet = $value;
            if (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);
class MyClass { }

$x = new MyClass();
$x->foo = true;

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

        foreach ($data as $values) {
            $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;
            }
        }
    }
}


1		<?php
2
3		namespace Smart\EtlBundle\Extractor;
4
5		use Smart\EtlBundle\Exception\Extractor\EntityAlreadyRegisteredException;
6		use Smart\EtlBundle\Exception\Extractor\EntityIdentifiedNotFoundException;
7		use Smart\EtlBundle\Exception\Extractor\EntityIdentifierAlreadyProcessedException;
8		use Smart\EtlBundle\Exception\Extractor\EntityTypeNotHandledException;
9		use Symfony\Component\PropertyAccess\PropertyAccess;
10
11		/**
12		* Nicolas Bastien <[email protected]>
13		*/
14		trait EntityExtractorTrait
15		{
16		/**
17		* List of entities to extract
18		* [
19		* 'entity_code' => 'Model Classname'
20		* ]
21		* @var array
22		*/
23		protected $entitiesToProcess = [];
24
25		/**
26		* @var array
27		*/
28		protected $entities = [];
29
30		/**
31		* @var PropertyAccessor
32		*/
33		protected $accessor;
34
35		/**
36		* @param string $entityType
37		* @param string$entityClass
38		* @param function $identifierCallback
39		* @return $this
40		* @throws \Exception
41		*/
42	5	public function addEntityToProcess($entityType, $entityClass, $identifierCallback)
43		{
44	5	if (isset($this->entitiesToProcess[$entityType])) {
45	1	throw new EntityAlreadyRegisteredException($entityType);
46		}
47
48	5	$this->entitiesToProcess[$entityType] = [
49	5	'type' => $entityType,
50	5	'class' => $entityClass,
51	5	'callback' => $identifierCallback
52		];
53
54	5	return $this;
55		}
56
57		/**
58		* @inheritDoc
59		*/
60	4	public function extract()
61		{
62		try {
63	4	$this->init();
64	4	$this->check();
65
66	4	$files = $this->getFiles($this->getFileExtension());
		0 ignored issues – show Bug introduced 2018-11-23 16:17 UTC by Report Bug Copy Issue Report It seems like `getFileExtension()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history... Bug introduced 2018-11-23 16:17 UTC by Report Bug Copy Issue Report It seems like `getFiles()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
67	4	foreach ($this->entitiesToProcess as $entityType => $data) {
68	4	if (!isset($files[$entityType])) {
69		continue;
70		}
71	4	$this->processFile($entityType);
72		}
73
74	2	return $this->entities;
75	2	} catch (\Exception $e) {
76	2	throw $e;
77		}
78		}
79
80	4	protected function check()
81		{
82	4	parent::check();
83
84	4	if (count($this->entitiesToProcess) === 0) {
85		throw new \BadMethodCallException('Nothing to process');
86		}
87	4	}
88
89	4	protected function init()
90		{
91	4	$this->accessor = PropertyAccess::createPropertyAccessor();
		0 ignored issues – show Documentation Bug introduced 2018-11-23 16:17 UTC by Report Bug Copy Issue Report It seems like `\Symfony\Component\Prope...reatePropertyAccessor()` of type `object<Symfony\Component...ccess\PropertyAccessor>` is incompatible with the declared type `object<Smart\EtlBundle\E...actor\PropertyAccessor>` of property `$accessor`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
92	4	}
93
94		/**
95		* @param string $entityType
96		* @param array $data
97		* @return mixed
98		* @throws \Exception
99		*/
100	4	protected function processObject($entityType, array $data)
101		{
102	4	if (!isset($this->entitiesToProcess[$entityType])) {
103		throw new EntityTypeNotHandledException($entityType);
104		}
105
106	4	$objectClass = $this->entitiesToProcess[$entityType]['class'];
107	4	$object = new $objectClass();
108
109	4	foreach ($data as $key => $value) {
110	4	$valueToSet = $value;
111	4	if (strpos($value, '@') === 0) {
112		//handle relations
113	3	$valueToSet = $this->getEntity($value);
114		}
115
116	4	$this->accessor->setValue($object, $key, $valueToSet);
117		}
118
119	3	return $object;
120		}
121
122		/**
123		* @param string $identifier
124		* @return mixed
125		* @throws \Exception
126		*/
127	3	protected function getEntity($identifier)
128		{
129	3	if (strpos($identifier, '@') === 0) {
130	3	$identifier = substr($identifier, 1);
131		}
132	3	if (!isset($this->entities[$identifier])) {
133	1	throw new EntityIdentifiedNotFoundException($identifier);
134		}
135
136	2	return $this->entities[$identifier];
137		}
138
139		/**
140		* @param string $filename
141		* @throws \Exception
142		*/
143	4	protected function processFile($filename)
144		{
145	4	$filepath = sprintf('%s/%s.' . $this->getFileExtension(), $this->folderToExtract, $filename);
		0 ignored issues – show Bug introduced 2018-11-23 16:17 UTC by Report Bug Copy Issue Report The property `folderToExtract` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history... Bug introduced 2018-11-23 16:17 UTC by Report Bug Copy Issue Report It seems like `getFileExtension()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
146
147	4	$data = $this->extractFileContent($filepath);
		0 ignored issues – show Bug introduced 2018-11-23 16:17 UTC by Report Bug Copy Issue Report The method `extractFileContent()` does not exist on `Smart\EtlBundle\Extractor\EntityExtractorTrait`. Did you maybe mean `extract()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
148	4	foreach ($data as $values) {
149	4	$object = $this->processObject($filename, $values);
150	3	if ($object !== null) {
151	3	$entityIdentifier = $this->entitiesToProcess[$filename]['callback']($object);
152	3	if (isset($this->entities[$entityIdentifier])) {
153	1	throw new EntityIdentifierAlreadyProcessedException($entityIdentifier);
154		}
155	3	$this->entities[$entityIdentifier] = $object;
156		}
157		}
158	2	}
159		}
160

smartbooster / etl-bundle

Push — master ( d88042...0c5536 )

EntityExtractorTrait::processFile() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like