CompositeTest - Code Metrics - Inspection of "Fix Composite::addAfter(null) aggregation behavior" - ruflin/Elastica - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#1877)

by romain

created 2020-11-23 18:43 UTC

CompositeTest A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	220
Duplicated Lines	36.36 %

Coupling/Cohesion

Components	1
Dependencies	7

Importance

Changes

Metric	Value
wmc	8
lcom	1
cbo	7
dl	80
loc	220
rs	10
c	0
b	0
f	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	testSize()	0	13	1
A	testAddSource()	0	20	1
A	testAddAfter()	0	13	1
A	testCompositeNoAfterAggregation()	0	37	1
A	testCompositeWithAfterAggregation()	0	26	1
A	testCompositeWithSizeAggregation()	32	32	1
A	testCompositeWithNullAfter()	33	33	1
A	_getIndexForTest()	15	15	1

How to fix Duplicated Code

<?php

namespace Elastica\Test\Aggregation;

use Elastica\Aggregation\Composite;
use Elastica\Aggregation\Terms;
use Elastica\Document;
use Elastica\Index;
use Elastica\Query;

/**
 * @internal
 */
class CompositeTest extends BaseAggregationTest
{
    /**
     * @group unit
     */
    public function testSize(): void
    {
        $composite = new Composite('products');
        $composite->setSize(200);
        $this->assertEquals(200, $composite->getParam('size'));

        $expected = [
            'composite' => [
                'size' => 200,
            ],
        ];
        $this->assertEquals($expected, $composite->toArray());
    }

    /**
     * @group unit
     */
    public function testAddSource(): void
    {
        $expected = [
            'composite' => [
                'sources' => [
                    [
                        'product' => [
                            'terms' => [
                                'field' => 'product_id',
                            ],
                        ],
                    ],
                ],
            ],
        ];

        $composite = new Composite('products');
        $composite->addSource((new Terms('product'))->setField('product_id'));
        $this->assertEquals($expected, $composite->toArray());
    }

    /**
     * @group unit
     */
    public function testAddAfter(): void
    {
        $checkpoint = ['checkpointproduct' => 'checkpoint'];
        $expected = [
            'composite' => [
                'after' => $checkpoint,
            ],
        ];

        $composite = new Composite('products');
        $composite->addAfter($checkpoint);
        $this->assertEquals($expected, $composite->toArray());
    }

    /**
     * @group functional
     */
    public function testCompositeNoAfterAggregation(): void
    {
        $composite = new Composite('products');
        $composite->addSource((new Terms('color'))->setField('color.keyword'));

        $query = new Query();
        $query->addAggregation($composite);

        $results = $this->_getIndexForTest()->search($query)->getAggregation('products');
        $expected = [
            'after_key' => [
                'color' => 'red',
            ],
            'buckets' => [
                [
                    'key' => [
                        'color' => 'blue',
                    ],
                    'doc_count' => 2,
                ],
                [
                    'key' => [
                        'color' => 'green',
                    ],
                    'doc_count' => 1,
                ],
                [
                    'key' => [
                        'color' => 'red',
                    ],
                    'doc_count' => 1,
                ],
            ],
        ];

        $this->assertEquals($expected, $results);
    }

    /**
     * @group functional
     */
    public function testCompositeWithSizeAggregation(): void

    {
        $composite = new Composite('products');
        $composite->setSize(2);
        $composite->addSource((new Terms('color'))->setField('color.keyword'));

        $query = new Query();
        $query->addAggregation($composite);

        $results = $this->_getIndexForTest()->search($query)->getAggregation('products');
        $expected = [
            'after_key' => [
                'color' => 'green',
            ],
            'buckets' => [
                [
                    'key' => [
                        'color' => 'blue',
                    ],
                    'doc_count' => 2,
                ],
                [
                    'key' => [
                        'color' => 'green',
                    ],
                    'doc_count' => 1,
                ],
            ],
        ];

        $this->assertEquals($expected, $results);
    }

    /**
     * @group functional
     */
    public function testCompositeWithAfterAggregation(): void
    {
        $composite = new Composite('products');
        $composite->setSize(2);
        $composite->addSource((new Terms('color'))->setField('color.keyword'));
        $composite->addAfter(['color' => 'green']);
        $query = new Query();
        $query->addAggregation($composite);

        $results = $this->_getIndexForTest()->search($query)->getAggregation('products');
        $expected = [
            'after_key' => [
                'color' => 'red',
            ],
            'buckets' => [
                [
                    'key' => [
                        'color' => 'red',
                    ],
                    'doc_count' => 1,
                ],
            ],
        ];

        $this->assertEquals($expected, $results);
    }

    /**
     * @group functional
     */
    public function testCompositeWithNullAfter(): void

    {
        $composite = new Composite('products');
        $composite->setSize(2);
        $composite->addSource((new Terms('color'))->setField('color.keyword'));
        $composite->addAfter(null);

        $query = new Query();
        $query->addAggregation($composite);

        $results = $this->_getIndexForTest()->search($query)->getAggregation('products');
        $expected = [
            'after_key' => [
                'color' => 'green',
            ],
            'buckets' => [
                [
                    'key' => [
                        'color' => 'blue',
                    ],
                    'doc_count' => 2,
                ],
                [
                    'key' => [
                        'color' => 'green',
                    ],
                    'doc_count' => 1,
                ],
            ],
        ];

        $this->assertEquals($expected, $results);
    }

    protected function _getIndexForTest(): Index

    {
        $index = $this->_createIndex();

        $index->addDocuments([
            new Document(1, ['price' => 5, 'color' => 'blue']),
            new Document(2, ['price' => 5, 'color' => 'blue']),
            new Document(3, ['price' => 3, 'color' => 'red']),
            new Document(4, ['price' => 3, 'color' => 'green']),
        ]);

        $index->refresh();

        return $index;
    }
}


1		<?php
2
3		namespace Elastica\Test\Aggregation;
4
5		use Elastica\Aggregation\Composite;
6		use Elastica\Aggregation\Terms;
7		use Elastica\Document;
8		use Elastica\Index;
9		use Elastica\Query;
10
11		/**
12		* @internal
13		*/
14		class CompositeTest extends BaseAggregationTest
15		{
16		/**
17		* @group unit
18		*/
19		public function testSize(): void
20		{
21		$composite = new Composite('products');
22		$composite->setSize(200);
23		$this->assertEquals(200, $composite->getParam('size'));
24
25		$expected = [
26		'composite' => [
27		'size' => 200,
28		],
29		];
30		$this->assertEquals($expected, $composite->toArray());
31		}
32
33		/**
34		* @group unit
35		*/
36		public function testAddSource(): void
37		{
38		$expected = [
39		'composite' => [
40		'sources' => [
41		[
42		'product' => [
43		'terms' => [
44		'field' => 'product_id',
45		],
46		],
47		],
48		],
49		],
50		];
51
52		$composite = new Composite('products');
53		$composite->addSource((new Terms('product'))->setField('product_id'));
54		$this->assertEquals($expected, $composite->toArray());
55		}
56
57		/**
58		* @group unit
59		*/
60		public function testAddAfter(): void
61		{
62		$checkpoint = ['checkpointproduct' => 'checkpoint'];
63		$expected = [
64		'composite' => [
65		'after' => $checkpoint,
66		],
67		];
68
69		$composite = new Composite('products');
70		$composite->addAfter($checkpoint);
71		$this->assertEquals($expected, $composite->toArray());
72		}
73
74		/**
75		* @group functional
76		*/
77		public function testCompositeNoAfterAggregation(): void
78		{
79		$composite = new Composite('products');
80		$composite->addSource((new Terms('color'))->setField('color.keyword'));
81
82		$query = new Query();
83		$query->addAggregation($composite);
84
85		$results = $this->_getIndexForTest()->search($query)->getAggregation('products');
86		$expected = [
87		'after_key' => [
88		'color' => 'red',
89		],
90		'buckets' => [
91		[
92		'key' => [
93		'color' => 'blue',
94		],
95		'doc_count' => 2,
96		],
97		[
98		'key' => [
99		'color' => 'green',
100		],
101		'doc_count' => 1,
102		],
103		[
104		'key' => [
105		'color' => 'red',
106		],
107		'doc_count' => 1,
108		],
109		],
110		];
111
112		$this->assertEquals($expected, $results);
113		}
114
115		/**
116		* @group functional
117		*/
118	View Code Duplication	public function testCompositeWithSizeAggregation(): void
		0 ignored issues – show Duplication introduced 2020-11-23 18:44 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
119		{
120		$composite = new Composite('products');
121		$composite->setSize(2);
122		$composite->addSource((new Terms('color'))->setField('color.keyword'));
123
124		$query = new Query();
125		$query->addAggregation($composite);
126
127		$results = $this->_getIndexForTest()->search($query)->getAggregation('products');
128		$expected = [
129		'after_key' => [
130		'color' => 'green',
131		],
132		'buckets' => [
133		[
134		'key' => [
135		'color' => 'blue',
136		],
137		'doc_count' => 2,
138		],
139		[
140		'key' => [
141		'color' => 'green',
142		],
143		'doc_count' => 1,
144		],
145		],
146		];
147
148		$this->assertEquals($expected, $results);
149		}
150
151		/**
152		* @group functional
153		*/
154		public function testCompositeWithAfterAggregation(): void
155		{
156		$composite = new Composite('products');
157		$composite->setSize(2);
158		$composite->addSource((new Terms('color'))->setField('color.keyword'));
159		$composite->addAfter(['color' => 'green']);
160		$query = new Query();
161		$query->addAggregation($composite);
162
163		$results = $this->_getIndexForTest()->search($query)->getAggregation('products');
164		$expected = [
165		'after_key' => [
166		'color' => 'red',
167		],
168		'buckets' => [
169		[
170		'key' => [
171		'color' => 'red',
172		],
173		'doc_count' => 1,
174		],
175		],
176		];
177
178		$this->assertEquals($expected, $results);
179		}
180
181		/**
182		* @group functional
183		*/
184	View Code Duplication	public function testCompositeWithNullAfter(): void
		0 ignored issues – show Duplication introduced 2020-11-23 18:44 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
185		{
186		$composite = new Composite('products');
187		$composite->setSize(2);
188		$composite->addSource((new Terms('color'))->setField('color.keyword'));
189		$composite->addAfter(null);
190
191		$query = new Query();
192		$query->addAggregation($composite);
193
194		$results = $this->_getIndexForTest()->search($query)->getAggregation('products');
195		$expected = [
196		'after_key' => [
197		'color' => 'green',
198		],
199		'buckets' => [
200		[
201		'key' => [
202		'color' => 'blue',
203		],
204		'doc_count' => 2,
205		],
206		[
207		'key' => [
208		'color' => 'green',
209		],
210		'doc_count' => 1,
211		],
212		],
213		];
214
215		$this->assertEquals($expected, $results);
216		}
217
218	View Code Duplication	protected function _getIndexForTest(): Index
		0 ignored issues – show Duplication introduced 2020-10-07 09:10 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
219		{
220		$index = $this->_createIndex();
221
222		$index->addDocuments([
223		new Document(1, ['price' => 5, 'color' => 'blue']),
224		new Document(2, ['price' => 5, 'color' => 'blue']),
225		new Document(3, ['price' => 3, 'color' => 'red']),
226		new Document(4, ['price' => 3, 'color' => 'green']),
227		]);
228
229		$index->refresh();
230
231		return $index;
232		}
233		}
234

ruflin / Elastica

Pull Request — master (#1877)

CompositeTest A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

8 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like