ManagerFactory::extractAnalysisFromProperties() - Code Metrics - Inspection of "Changed analysis collection from config to documen..." - ongr-io/ElasticsearchBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — 5.0 (#720)

unknown

created 2016-11-22 13:59 UTC

ManagerFactory::extractAnalysisFromProperties() A

↳ Parent: ManagerFactory

Complexity

Conditions	4
Paths	5

Size

Total Lines	17
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	17
rs	9.2
cc	4
eloc	10
nc	5
nop	3

<?php

/*
 * This file is part of the ONGR package.
 *
 * (c) NFQ Technologies UAB <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace ONGR\ElasticsearchBundle\Service;

use Elasticsearch\ClientBuilder;
use ONGR\ElasticsearchBundle\Event\Events;
use ONGR\ElasticsearchBundle\Event\PostCreateManagerEvent;
use ONGR\ElasticsearchBundle\Event\PreCreateManagerEvent;
use ONGR\ElasticsearchBundle\Mapping\MetadataCollector;
use ONGR\ElasticsearchBundle\Result\Converter;
use Psr\Log\LoggerInterface;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use Symfony\Component\Stopwatch\Stopwatch;

/**
 * Elasticsearch Manager factory class.
 */
class ManagerFactory
{
    /**
     * @var MetadataCollector
     */
    private $metadataCollector;

    /**
     * @var Converter
     */
    private $converter;

    /**
     * @var LoggerInterface
     */
    private $logger;

    /**
     * @var LoggerInterface
     */
    private $tracer;

    /**
     * @var EventDispatcherInterface
     */
    private $eventDispatcher;

    /**
     * @var Stopwatch
     */
    private $stopwatch;

    /**
     * @param MetadataCollector $metadataCollector Metadata collector service.
     * @param Converter         $converter         Converter service to transform arrays to objects and visa versa.
     * @param LoggerInterface   $tracer
     * @param LoggerInterface   $logger
     */
    public function __construct($metadataCollector, $converter, $tracer = null, $logger = null)
    {
        $this->metadataCollector = $metadataCollector;
        $this->converter = $converter;
        $this->tracer = $tracer;
        $this->logger = $logger;
    }

    /**
     * @param EventDispatcherInterface   $eventDispatcher
     */
    public function setEventDispatcher(EventDispatcherInterface $eventDispatcher)
    {
        $this->eventDispatcher = $eventDispatcher;
    }

    /**
     * @param Stopwatch $stopwatch
     */
    public function setStopwatch(Stopwatch $stopwatch)
    {
        $this->stopwatch = $stopwatch;
    }

    /**
     * Factory function to create a manager instance.
     *
     * @param string $managerName   Manager name.
     * @param array  $connection    Connection configuration.
     * @param array  $analysis      Analyzers, filters and tokenizers config.
     * @param array  $managerConfig Manager configuration.
     *
     * @return Manager
     */
    public function createManager($managerName, $connection, $analysis, $managerConfig)
    {
        $managerAnalysis = [];
        $mappings = $this->metadataCollector->getClientMapping($managerConfig['mappings']);

        foreach ($mappings as $type) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            $this->extractAnalysisFromProperties($type['properties'], $analysis, $managerAnalysis);
        }

        $connection['settings']['analysis'] = array_filter($managerAnalysis);

        if (!isset($connection['settings']['number_of_replicas'])) {
            $connection['settings']['number_of_replicas'] = 0;
        }

        if (!isset($connection['settings']['number_of_shards'])) {
            $connection['settings']['number_of_shards'] = 1;
        }

        $mappings = $this->metadataCollector->getClientMapping($managerConfig['mappings']);

        $client = ClientBuilder::create();
        $client->setHosts($connection['hosts']);
        $client->setTracer($this->tracer);

        if ($this->logger && $managerConfig['logger']['enabled']) {
            $client->setLogger($this->logger);
        }

        $indexSettings = [
            'index' => $connection['index_name'],
            'body' => array_filter(
                [
                    'settings' => $connection['settings'],
                    'mappings' => $mappings,
                ]
            ),
        ];

        $this->eventDispatcher &&
            $this->eventDispatcher->dispatch(
                Events::PRE_MANAGER_CREATE,
                new PreCreateManagerEvent($client, $indexSettings)
            );

        $manager = new Manager(
            $managerName,
            $managerConfig,
            $client->build(),
            $indexSettings,
            $this->metadataCollector,
            $this->converter
        );

        if (isset($this->stopwatch)) {
            $manager->setStopwatch($this->stopwatch);
        }

        $manager->setCommitMode($managerConfig['commit_mode']);
        $manager->setEventDispatcher($this->eventDispatcher);
        $manager->setBulkCommitSize($managerConfig['bulk_size']);

        $this->eventDispatcher &&
            $this->eventDispatcher->dispatch(Events::POST_MANAGER_CREATE, new PostCreateManagerEvent($manager));

        return $manager;
    }

    /**
     * Extracts analysis configuration from all the documents
     *
     * @param array $properties      Properties of a type or an object
     * @param array $analysis        The full analysis node from configuration
     * @param array $managerAnalysis The data that is being formed for the manager
     */
    private function extractAnalysisFromProperties($properties, $analysis, &$managerAnalysis)
    {
        foreach ($properties as $property) {
            if (isset($property['analyzer'])) {
                $analyzer = $analysis['analyzer'][$property['analyzer']];
                $managerAnalysis['analyzer'][$property['analyzer']] = $analyzer;

                $this->extractSubData('filter', $analyzer, $analysis, $managerAnalysis);
                $this->extractSubData('char_filter', $analyzer, $analysis, $managerAnalysis);
                $this->extractSubData('tokenizer', $analyzer, $analysis, $managerAnalysis);
            }

            if (isset($property['properties'])) {
                $this->extractAnalysisFromProperties($property['properties'], $analysis, $managerAnalysis);
            }
        }
    }

    /**
     * Extracts tokenizers and filters from analysis configuration
     *
     * @param string $type     Either filter or tokenizer
     * @param array  $analyzer The current analyzer
     * @param array  $analysis The full analysis node from configuration
     * @param array  $data     The data that is being formed for the manager
     */
    private function extractSubData($type, $analyzer, $analysis, &$data)
    {
        if (!isset($analyzer[$type])) {
            return;
        }

        if (is_array($analyzer[$type])) {
            foreach ($analyzer[$type] as $name) {
                if (isset($analysis[$type][$name])) {

                    $data[$type][$name] = $analysis[$type][$name];
                }
            }
        } else {
            $name = $analyzer[$type];

            if (isset($analysis[$type][$name])) {

                $data[$type][$name] = $analysis[$type][$name];
            }
        }
    }
}


1		<?php
2
3		/*
4		* This file is part of the ONGR package.
5		*
6		* (c) NFQ Technologies UAB <[email protected]>
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*/
11
12		namespace ONGR\ElasticsearchBundle\Service;
13
14		use Elasticsearch\ClientBuilder;
15		use ONGR\ElasticsearchBundle\Event\Events;
16		use ONGR\ElasticsearchBundle\Event\PostCreateManagerEvent;
17		use ONGR\ElasticsearchBundle\Event\PreCreateManagerEvent;
18		use ONGR\ElasticsearchBundle\Mapping\MetadataCollector;
19		use ONGR\ElasticsearchBundle\Result\Converter;
20		use Psr\Log\LoggerInterface;
21		use Symfony\Component\EventDispatcher\EventDispatcherInterface;
22		use Symfony\Component\Stopwatch\Stopwatch;
23
24		/**
25		* Elasticsearch Manager factory class.
26		*/
27		class ManagerFactory
28		{
29		/**
30		* @var MetadataCollector
31		*/
32		private $metadataCollector;
33
34		/**
35		* @var Converter
36		*/
37		private $converter;
38
39		/**
40		* @var LoggerInterface
41		*/
42		private $logger;
43
44		/**
45		* @var LoggerInterface
46		*/
47		private $tracer;
48
49		/**
50		* @var EventDispatcherInterface
51		*/
52		private $eventDispatcher;
53
54		/**
55		* @var Stopwatch
56		*/
57		private $stopwatch;
58
59		/**
60		* @param MetadataCollector $metadataCollector Metadata collector service.
61		* @param Converter $converter Converter service to transform arrays to objects and visa versa.
62		* @param LoggerInterface $tracer
63		* @param LoggerInterface $logger
64		*/
65		public function __construct($metadataCollector, $converter, $tracer = null, $logger = null)
66		{
67		$this->metadataCollector = $metadataCollector;
68		$this->converter = $converter;
69		$this->tracer = $tracer;
70		$this->logger = $logger;
71		}
72
73		/**
74		* @param EventDispatcherInterface $eventDispatcher
75		*/
76		public function setEventDispatcher(EventDispatcherInterface $eventDispatcher)
77		{
78		$this->eventDispatcher = $eventDispatcher;
79		}
80
81		/**
82		* @param Stopwatch $stopwatch
83		*/
84		public function setStopwatch(Stopwatch $stopwatch)
85		{
86		$this->stopwatch = $stopwatch;
87		}
88
89		/**
90		* Factory function to create a manager instance.
91		*
92		* @param string $managerName Manager name.
93		* @param array $connection Connection configuration.
94		* @param array $analysis Analyzers, filters and tokenizers config.
95		* @param array $managerConfig Manager configuration.
96		*
97		* @return Manager
98		*/
99		public function createManager($managerName, $connection, $analysis, $managerConfig)
100		{
101		$managerAnalysis = [];
102		$mappings = $this->metadataCollector->getClientMapping($managerConfig['mappings']);
103
104		foreach ($mappings as $type) {
		0 ignored issues – show Bug introduced 2016-11-22 14:01 UTC by Report Bug Copy Issue Report The expression `$mappings` of type `array\|null` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
105		$this->extractAnalysisFromProperties($type['properties'], $analysis, $managerAnalysis);
106		}
107
108		$connection['settings']['analysis'] = array_filter($managerAnalysis);
109
110		if (!isset($connection['settings']['number_of_replicas'])) {
111		$connection['settings']['number_of_replicas'] = 0;
112		}
113
114		if (!isset($connection['settings']['number_of_shards'])) {
115		$connection['settings']['number_of_shards'] = 1;
116		}
117
118		$mappings = $this->metadataCollector->getClientMapping($managerConfig['mappings']);
119
120		$client = ClientBuilder::create();
121		$client->setHosts($connection['hosts']);
122		$client->setTracer($this->tracer);
123
124		if ($this->logger && $managerConfig['logger']['enabled']) {
125		$client->setLogger($this->logger);
126		}
127
128		$indexSettings = [
129		'index' => $connection['index_name'],
130		'body' => array_filter(
131		[
132		'settings' => $connection['settings'],
133		'mappings' => $mappings,
134		]
135		),
136		];
137
138		$this->eventDispatcher &&
139		$this->eventDispatcher->dispatch(
140		Events::PRE_MANAGER_CREATE,
141		new PreCreateManagerEvent($client, $indexSettings)
142		);
143
144		$manager = new Manager(
145		$managerName,
146		$managerConfig,
147		$client->build(),
148		$indexSettings,
149		$this->metadataCollector,
150		$this->converter
151		);
152
153		if (isset($this->stopwatch)) {
154		$manager->setStopwatch($this->stopwatch);
155		}
156
157		$manager->setCommitMode($managerConfig['commit_mode']);
158		$manager->setEventDispatcher($this->eventDispatcher);
159		$manager->setBulkCommitSize($managerConfig['bulk_size']);
160
161		$this->eventDispatcher &&
162		$this->eventDispatcher->dispatch(Events::POST_MANAGER_CREATE, new PostCreateManagerEvent($manager));
163
164		return $manager;
165		}
166
167		/**
168		* Extracts analysis configuration from all the documents
169		*
170		* @param array $properties Properties of a type or an object
171		* @param array $analysis The full analysis node from configuration
172		* @param array $managerAnalysis The data that is being formed for the manager
173		*/
174		private function extractAnalysisFromProperties($properties, $analysis, &$managerAnalysis)
175		{
176		foreach ($properties as $property) {
177		if (isset($property['analyzer'])) {
178		$analyzer = $analysis['analyzer'][$property['analyzer']];
179		$managerAnalysis['analyzer'][$property['analyzer']] = $analyzer;
180
181		$this->extractSubData('filter', $analyzer, $analysis, $managerAnalysis);
182		$this->extractSubData('char_filter', $analyzer, $analysis, $managerAnalysis);
183		$this->extractSubData('tokenizer', $analyzer, $analysis, $managerAnalysis);
184		}
185
186		if (isset($property['properties'])) {
187		$this->extractAnalysisFromProperties($property['properties'], $analysis, $managerAnalysis);
188		}
189		}
190		}
191
192		/**
193		* Extracts tokenizers and filters from analysis configuration
194		*
195		* @param string $type Either filter or tokenizer
196		* @param array $analyzer The current analyzer
197		* @param array $analysis The full analysis node from configuration
198		* @param array $data The data that is being formed for the manager
199		*/
200		private function extractSubData($type, $analyzer, $analysis, &$data)
201		{
202		if (!isset($analyzer[$type])) {
203		return;
204		}
205
206		if (is_array($analyzer[$type])) {
207		foreach ($analyzer[$type] as $name) {
208	View Code Duplication	if (isset($analysis[$type][$name])) {
		0 ignored issues – show Duplication introduced 2016-11-22 14:01 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
209		$data[$type][$name] = $analysis[$type][$name];
210		}
211		}
212		} else {
213		$name = $analyzer[$type];
214
215	View Code Duplication	if (isset($analysis[$type][$name])) {
		0 ignored issues – show Duplication introduced 2016-11-22 14:01 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
216		$data[$type][$name] = $analysis[$type][$name];
217		}
218		}
219		}
220		}
221

ongr-io / ElasticsearchBundle

Pull Request — 5.0 (#720)

ManagerFactory::extractAnalysisFromProperties() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like