Completed
Pull Request — master (#1875)
by romain
02:37
created

DateRangeTest   A

Complexity

Total Complexity 13

Size/Duplication

Total Lines 127
Duplicated Lines 55.91 %

Coupling/Cohesion

Components 1
Dependencies 9

Importance

Changes 0
Metric Value
wmc 13
lcom 1
cbo 9
dl 71
loc 127
c 0
b 0
f 0
rs 10

6 Methods

Rating   Name   Duplication   Size   Complexity  
A testSetTimezone() 16 16 1
A testDateRangeAggregation() 18 18 4
A testDateRangeAggregationWithMissing() 19 19 4
A testDateRangeSetFormat() 0 13 1
A testDateRangeSetFormatAccordingToFormatTargetField() 0 20 2
A _getIndexForTest() 18 18 1

How to fix   Duplicated Code   

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

1
<?php
2
3
namespace Elastica\Test\Aggregation;
4
5
use Elastica\Aggregation\DateRange;
6
use Elastica\Document;
7
use Elastica\Exception\ResponseException;
8
use Elastica\Index;
9
use Elastica\Mapping;
10
use Elastica\Query;
11
12
/**
13
 * @internal
14
 */
15
class DateRangeTest extends BaseAggregationTest
16
{
17
    /**
18
     * @group unit
19
     */
20 View Code Duplication
    public function testSetTimezone(): void
0 ignored issues
show
Duplication introduced by
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...
21
    {
22
        $agg = (new DateRange('name'))
23
            ->setField('date')
24
            ->setTimezone('CET')
25
        ;
26
27
        $expected = [
28
            'date_range' => [
29
                'field' => 'date',
30
                'time_zone' => 'CET',
31
            ],
32
        ];
33
34
        $this->assertEquals($expected, $agg->toArray());
35
    }
36
37
    /**
38
     * @group functional
39
     */
40 View Code Duplication
    public function testDateRangeAggregation(): void
0 ignored issues
show
Duplication introduced by
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...
41
    {
42
        $agg = new DateRange('date');
43
        $agg->setField('created');
44
        $agg->addRange(1390958535000)->addRange(null, 1390958535000);
45
46
        $query = new Query();
47
        $query->addAggregation($agg);
48
        $results = $this->_getIndexForTest()->search($query)->getAggregation('date');
49
50
        foreach ($results['buckets'] as $bucket) {
51
            if (\array_key_exists('to', $bucket)) {
52
                $this->assertEquals(1, $bucket['doc_count']);
53
            } elseif (\array_key_exists('from', $bucket)) {
54
                $this->assertEquals(2, $bucket['doc_count']);
55
            }
56
        }
57
    }
58
59
    /**
60
     * @group functional
61
     */
62 View Code Duplication
    public function testDateRangeAggregationWithMissing(): void
0 ignored issues
show
Duplication introduced by
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...
63
    {
64
        $agg = new DateRange('date');
65
        $agg->setField('created');
66
        $agg->addRange(1390958535000)->addRange(null, 1390958535000);
67
        $agg->setMissing(1390958534000);
68
69
        $query = new Query();
70
        $query->addAggregation($agg);
71
        $results = $this->_getIndexForTest()->search($query)->getAggregation('date');
72
73
        foreach ($results['buckets'] as $bucket) {
74
            if (\array_key_exists('to', $bucket)) {
75
                $this->assertEquals(2, $bucket['doc_count']);
76
            } elseif (\array_key_exists('from', $bucket)) {
77
                $this->assertEquals(2, $bucket['doc_count']);
78
            }
79
        }
80
    }
81
82
    /**
83
     * @group functional
84
     */
85
    public function testDateRangeSetFormat(): void
86
    {
87
        $agg = new DateRange('date');
88
        $agg->setField('created');
89
        $agg->addRange(1390958535000)->addRange(null, 1390958535000);
90
        $agg->setFormat('epoch_millis');
91
92
        $query = new Query();
93
        $query->addAggregation($agg);
94
        $results = $this->_getIndexForTest()->search($query)->getAggregation('date');
95
96
        $this->assertEquals('1390958535000', $results['buckets'][0]['to_as_string']);
97
    }
98
99
    /**
100
     * @group functional
101
     */
102
    public function testDateRangeSetFormatAccordingToFormatTargetField(): void
103
    {
104
        $agg = new DateRange('date');
105
        $agg->setField('created');
106
        $agg->addRange(1390958535000)->addRange(null, 1390958535000);
107
        $agg->setFormat('m-d-y');
108
109
        $query = new Query();
110
        $query->addAggregation($agg);
111
112
        try {
113
            $results = $this->_getIndexForTest()->search($query)->getAggregation('date');
0 ignored issues
show
Unused Code introduced by
$results is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
114
            $this->fail('Should throw exception to and from parameters in date_range aggregation are interpreted according of the target field');
115
        } catch (ResponseException $e) {
116
            $error = $e->getResponse()->getFullError();
117
118
            $this->assertSame('search_phase_execution_exception', $error['type']);
119
            $this->assertStringStartsWith('failed to parse date field', $error['root_cause'][0]['reason']);
120
        }
121
    }
122
123 View Code Duplication
    protected function _getIndexForTest(): Index
0 ignored issues
show
Duplication introduced by
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...
124
    {
125
        $index = $this->_createIndex();
126
        $index->setMapping(new Mapping([
127
            'created' => ['type' => 'date', 'format' => 'epoch_millis'],
128
        ]));
129
130
        $index->addDocuments([
131
            new Document(1, ['created' => 1390962135000]),
132
            new Document(2, ['created' => 1390965735000]),
133
            new Document(3, ['created' => 1390954935000]),
134
            new Document(4, []),
135
        ]);
136
137
        $index->refresh();
138
139
        return $index;
140
    }
141
}
142