DataManager::parseDataItems() - Code Metrics - Inspection of "Fix unit testing on AppVeyor" - stakx-io/stakx - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#88)

by Vladimir

created 2018-11-10 02:55 UTC

DataManager::parseDataItems() A

↳ Parent: DataManager

Complexity

Conditions	3
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	8
CRAP Score	3.0123

Importance

Changes

Metric	Value
dl	0
loc	16
ccs	8
cts	9
cp	0.8889
rs	9.7333
c	0
b	0
f	0
cc	3
nc	3
nop	1
crap	3.0123

<?php

/**
 * @copyright 2018 Vladimir Jimenez
 * @license   https://github.com/stakx-io/stakx/blob/master/LICENSE.md MIT
 */

namespace allejo\stakx\Manager;

use allejo\stakx\Configuration;
use allejo\stakx\DataTransformer\DataTransformerManager;
use allejo\stakx\Document\DataItem;
use allejo\stakx\Event\DataItemAdded;
use allejo\stakx\Event\DataItemFolderAdded;
use allejo\stakx\Event\DatasetDefinitionAdded;
use allejo\stakx\Exception\DependencyMissingException;
use allejo\stakx\Exception\UnsupportedDataTypeException;
use allejo\stakx\Filesystem\File;
use allejo\stakx\Filesystem\FilesystemLoader as fs;
use Psr\Log\LoggerInterface;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;

/**
 * This class handles everything in regards to DataItems and DataSets.
 */
class DataManager extends TrackingManager
{
    private $dataTransformerManager;
    private $configuration;
    private $eventDispatcher;
    private $logger;

    /**
     * DataManager constructor.
     */
    public function __construct(DataTransformerManager $dataTransformerManager, Configuration $configuration, EventDispatcherInterface $eventDispatcher, LoggerInterface $logger)
    {
        $this->dataTransformerManager = $dataTransformerManager;
        $this->configuration = $configuration;
        $this->eventDispatcher = $eventDispatcher;
        $this->logger = $logger;
    }

    /**
     * {@inheritdoc}
     */
    public function compileManager()
    {
        if (!$this->configuration->hasDataItems())
        {
            $this->logger->notice('No DataItems or Datasets detected... Ignoring.');

            return;
        }

        $this->parseDataItems($this->configuration->getDataFolders());
        $this->parseDataSets($this->configuration->getDataSets());
    }

    /**
     * Get all of the DataItems and DataSets in this manager.
     *
     * @return array
     */
    public function &getDataItems()
    {
        return $this->trackedItems;
    }

    /**
     * {@inheritdoc}
     */
    public function getJailedDataItems()
    {
        return self::getJailedTrackedItems($this->trackedItemsFlattened, function (DataItem $dataItem) {
            return $dataItem->getBasename();
        });
    }

    /**
     * Loop through all of the DataItems specified in `$folders`. Each folder will have contain just DataItems.
     *
     * For each folder, supported file type is read, parsed, and made available through `$this->getDataItems()`
     *
     * @param string[] $folders An array of folders to be searched for to contain DataItems
     */
    public function parseDataItems($folders)
    {
        if ($folders === null)
        {
            return;
        }

        foreach ($folders as $folder)
        {
            $event = new DataItemFolderAdded($folder);
            $this->eventDispatcher->dispatch(DataItemFolderAdded::NAME, $event);

            $this->saveFolderDefinition($folder);
            $this->scanTrackableItems(fs::absolutePath($folder));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        }
    }

    /**
     * Loop through all of the DataSets specified in `$dataSets`. Each DataSet contains a name and a folder location.
     *
     * For each folder, supported file type is read, parsed, and made available through `$this->getDataItems()`
     *
     * @param string[] $dataSets An array of DataSets
     */
    public function parseDataSets($dataSets)
    {
        if ($dataSets === null)
        {
            return;
        }

        /**
         * The information which each DataSet has from the configuration file.
         *
         * @var array $dataSet = [
         *   'name' => '(string) The name of the collection',
         *   'folder' => '(string) The folder where this collection has its ContentItems'
         * ]
         */
        foreach ($dataSets as $dataSet)
        {
            $event = new DatasetDefinitionAdded($dataSet['name'], $dataSet['folder']);
            $this->eventDispatcher->dispatch(DatasetDefinitionAdded::NAME, $event);

            $this->saveFolderDefinition($dataSet['folder'], [
                'namespace' => $dataSet['name'],
            ]);
            $this->scanTrackableItems(
                fs::absolutePath($dataSet['folder']),
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                ['namespace' => $dataSet['name']]
            );
        }
    }

    /**
     * {@inheritdoc}
     */
    protected function handleTrackableItem(File $filePath, array $options = [])
    {
        try
        {
            $namespace = (isset($options['namespace'])) ? $options['namespace'] : null;

            $dataItem = new DataItem($filePath);
            $dataItem->setDataTransformer($this->dataTransformerManager);
            $dataItem->setNamespace($namespace);

            $event = new DataItemAdded($dataItem);
            $this->eventDispatcher->dispatch(DataItemAdded::NAME, $event);

            $this->addObjectToTracker($dataItem, $namespace);
            $this->saveTrackerOptions($dataItem->getRelativeFilePath(), $options);

            return $dataItem->getRelativeFilePath();
        }
        catch (DependencyMissingException $e)
        {
            if ($e->getDependency() === 'XML')
            {
                $this->logger->critical('XML support is not available in your PHP installation. For XML support, please install the appropriate package for your system:');
                $this->logger->critical('  e.g. php7.0-xml');
            }
        }
        catch (UnsupportedDataTypeException $e)
        {
            $this->logger->warning('There is no function to handle {ext} file format.', [
                'ext' => $e->getDataType(),
            ]);
        }

        return $filePath->getBasename();
    }
}


1		<?php
2
3		/**
4		* @copyright 2018 Vladimir Jimenez
5		* @license https://github.com/stakx-io/stakx/blob/master/LICENSE.md MIT
6		*/
7
8		namespace allejo\stakx\Manager;
9
10		use allejo\stakx\Configuration;
11		use allejo\stakx\DataTransformer\DataTransformerManager;
12		use allejo\stakx\Document\DataItem;
13		use allejo\stakx\Event\DataItemAdded;
14		use allejo\stakx\Event\DataItemFolderAdded;
15		use allejo\stakx\Event\DatasetDefinitionAdded;
16		use allejo\stakx\Exception\DependencyMissingException;
17		use allejo\stakx\Exception\UnsupportedDataTypeException;
18		use allejo\stakx\Filesystem\File;
19		use allejo\stakx\Filesystem\FilesystemLoader as fs;
20		use Psr\Log\LoggerInterface;
21		use Symfony\Component\EventDispatcher\EventDispatcherInterface;
22
23		/**
24		* This class handles everything in regards to DataItems and DataSets.
25		*/
26		class DataManager extends TrackingManager
27		{
28		private $dataTransformerManager;
29		private $configuration;
30		private $eventDispatcher;
31		private $logger;
32
33		/**
34		* DataManager constructor.
35		*/
36	2	public function __construct(DataTransformerManager $dataTransformerManager, Configuration $configuration, EventDispatcherInterface $eventDispatcher, LoggerInterface $logger)
37		{
38	2	$this->dataTransformerManager = $dataTransformerManager;
39	2	$this->configuration = $configuration;
40	2	$this->eventDispatcher = $eventDispatcher;
41	2	$this->logger = $logger;
42	2	}
43
44		/**
45		* {@inheritdoc}
46		*/
47		public function compileManager()
48		{
49		if (!$this->configuration->hasDataItems())
50		{
51		$this->logger->notice('No DataItems or Datasets detected... Ignoring.');
52
53		return;
54		}
55
56		$this->parseDataItems($this->configuration->getDataFolders());
57		$this->parseDataSets($this->configuration->getDataSets());
58		}
59
60		/**
61		* Get all of the DataItems and DataSets in this manager.
62		*
63		* @return array
64		*/
65	2	public function &getDataItems()
66		{
67	2	return $this->trackedItems;
68		}
69
70		/**
71		* {@inheritdoc}
72		*/
73		public function getJailedDataItems()
74		{
75	2	return self::getJailedTrackedItems($this->trackedItemsFlattened, function (DataItem $dataItem) {
76	2	return $dataItem->getBasename();
77	2	});
78		}
79
80		/**
81		* Loop through all of the DataItems specified in `$folders`. Each folder will have contain just DataItems.
82		*
83		* For each folder, supported file type is read, parsed, and made available through `$this->getDataItems()`
84		*
85		* @param string[] $folders An array of folders to be searched for to contain DataItems
86		*/
87	1	public function parseDataItems($folders)
88		{
89	1	if ($folders === null)
90		{
91		return;
92		}
93
94	1	foreach ($folders as $folder)
95		{
96	1	$event = new DataItemFolderAdded($folder);
97	1	$this->eventDispatcher->dispatch(DataItemFolderAdded::NAME, $event);
98
99	1	$this->saveFolderDefinition($folder);
100	1	$this->scanTrackableItems(fs::absolutePath($folder));
		0 ignored issues – show Documentation introduced 2018-05-10 07:09 UTC by Report Bug Copy Issue Report `$folder` is of type `string`, but the function expects a `object<string>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
101		}
102	1	}
103
104		/**
105		* Loop through all of the DataSets specified in `$dataSets`. Each DataSet contains a name and a folder location.
106		*
107		* For each folder, supported file type is read, parsed, and made available through `$this->getDataItems()`
108		*
109		* @param string[] $dataSets An array of DataSets
110		*/
111	1	public function parseDataSets($dataSets)
112		{
113	1	if ($dataSets === null)
114		{
115		return;
116		}
117
118		/**
119		* The information which each DataSet has from the configuration file.
120		*
121		* @var array $dataSet = [
122		* 'name' => '(string) The name of the collection',
123		* 'folder' => '(string) The folder where this collection has its ContentItems'
124		* ]
125		*/
126	1	foreach ($dataSets as $dataSet)
127		{
128	1	$event = new DatasetDefinitionAdded($dataSet['name'], $dataSet['folder']);
129	1	$this->eventDispatcher->dispatch(DatasetDefinitionAdded::NAME, $event);
130
131	1	$this->saveFolderDefinition($dataSet['folder'], [
132	1	'namespace' => $dataSet['name'],
133		]);
134	1	$this->scanTrackableItems(
135	1	fs::absolutePath($dataSet['folder']),
		0 ignored issues – show Documentation introduced 2018-05-10 07:09 UTC by Report Bug Copy Issue Report `$dataSet['folder']` is of type `string`, but the function expects a `object<string>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
136	1	['namespace' => $dataSet['name']]
137		);
138		}
139	1	}
140
141		/**
142		* {@inheritdoc}
143		*/
144	2	protected function handleTrackableItem(File $filePath, array $options = [])
145		{
146		try
147		{
148	2	$namespace = (isset($options['namespace'])) ? $options['namespace'] : null;
149
150	2	$dataItem = new DataItem($filePath);
151	2	$dataItem->setDataTransformer($this->dataTransformerManager);
152	2	$dataItem->setNamespace($namespace);
153
154	2	$event = new DataItemAdded($dataItem);
155	2	$this->eventDispatcher->dispatch(DataItemAdded::NAME, $event);
156
157	2	$this->addObjectToTracker($dataItem, $namespace);
158	2	$this->saveTrackerOptions($dataItem->getRelativeFilePath(), $options);
159
160	2	return $dataItem->getRelativeFilePath();
161		}
162		catch (DependencyMissingException $e)
163		{
164		if ($e->getDependency() === 'XML')
165		{
166		$this->logger->critical('XML support is not available in your PHP installation. For XML support, please install the appropriate package for your system:');
167		$this->logger->critical(' e.g. php7.0-xml');
168		}
169		}
170		catch (UnsupportedDataTypeException $e)
171		{
172		$this->logger->warning('There is no function to handle {ext} file format.', [
173		'ext' => $e->getDataType(),
174		]);
175		}
176
177		return $filePath->getBasename();
178		}
179		}
180

stakx-io / stakx

Pull Request — master (#88)

DataManager::parseDataItems() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like