File size: 6,612 Bytes
bf8c0ce
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
<?php

/**
 * Matomo - free/libre analytics platform
 *
 * @link    https://matomo.org
 * @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
 */

namespace Piwik\Tests\Integration\Columns;

use Piwik\Columns\Dimension;
use Piwik\Columns\DimensionMetricFactory;
use Piwik\Plugin\ArchivedMetric;
use Piwik\Plugin\ComputedMetric;
use Piwik\Plugins\UserCountry\Columns\Country;
use Piwik\Tests\Framework\Fixture;
use Piwik\Tests\Framework\TestCase\IntegrationTestCase;

/**
 * @group Core
 */
class DimensionMetricFactoryTest extends IntegrationTestCase
{
    /** @var  Dimension */
    private $country;

    public function setUp(): void
    {
        parent::setUp();

        Fixture::loadAllTranslations();

        $this->country = new Country();
    }

    public function tearDown(): void
    {
        Fixture::resetTranslations();
        parent::tearDown();
    }

    private function makeFactory($dimension)
    {
        return new DimensionMetricFactory($dimension);
    }

    public function testCreateMetricCount()
    {
        $factory = $this->makeFactory($this->country);
        $metric = $factory->createMetric(ArchivedMetric::AGGREGATION_COUNT);

        $this->assertSame('nb_usercountry_country', $metric->getName());
        $this->assertSame('Countries', $metric->getTranslatedName());
        $this->assertSame('The number of Countries', $metric->getDocumentation());
        $this->assertSame('UserCountry_VisitLocation', $metric->getCategoryId());
        $this->assertSame('count(log_visit.location_country)', $metric->getQuery());
    }

    public function testCreateMetricUniqueCount()
    {
        $factory = $this->makeFactory($this->country);
        $metric = $factory->createMetric(ArchivedMetric::AGGREGATION_UNIQUE);

        $this->assertSame('nb_uniq_usercountry_country', $metric->getName());
        $this->assertSame('Unique Countries', $metric->getTranslatedName());
        $this->assertSame('The unique number of Countries', $metric->getDocumentation());
        $this->assertSame('UserCountry_VisitLocation', $metric->getCategoryId());
        $this->assertSame('count(distinct log_visit.location_country)', $metric->getQuery());
    }

    public function testCreateMetricSum()
    {
        $factory = $this->makeFactory($this->country);
        $metric = $factory->createMetric(ArchivedMetric::AGGREGATION_SUM);

        $this->assertSame('sum_usercountry_country', $metric->getName());
        $this->assertSame('Total Countries', $metric->getTranslatedName());
        $this->assertSame('The total number (sum) of Countries', $metric->getDocumentation());
        $this->assertSame('UserCountry_VisitLocation', $metric->getCategoryId());
        $this->assertSame('sum(log_visit.location_country)', $metric->getQuery());
    }

    public function testCreateMetricMin()
    {
        $factory = $this->makeFactory($this->country);
        $metric = $factory->createMetric(ArchivedMetric::AGGREGATION_MIN);

        $this->assertSame('min_usercountry_country', $metric->getName());
        $this->assertSame('Min Countries', $metric->getTranslatedName());
        $this->assertSame('The minimum value for Countries', $metric->getDocumentation());
        $this->assertSame('UserCountry_VisitLocation', $metric->getCategoryId());
        $this->assertSame('min(log_visit.location_country)', $metric->getQuery());
    }

    public function testCreateMetricMax()
    {
        $factory = $this->makeFactory($this->country);
        $metric = $factory->createMetric(ArchivedMetric::AGGREGATION_MAX);

        $this->assertSame('max_usercountry_country', $metric->getName());
        $this->assertSame('Max Countries', $metric->getTranslatedName());
        $this->assertSame('The maximum value for Countries', $metric->getDocumentation());
        $this->assertSame('UserCountry_VisitLocation', $metric->getCategoryId());
        $this->assertSame('max(log_visit.location_country)', $metric->getQuery());
    }

    public function testCreateMetricWithValue()
    {
        $factory = $this->makeFactory($this->country);
        $metric = $factory->createMetric(ArchivedMetric::AGGREGATION_COUNT_WITH_NUMERIC_VALUE);

        $this->assertSame('nb_with_usercountry_country', $metric->getName());
        $this->assertSame('Entries with Country', $metric->getTranslatedName());
        $this->assertSame('The number of entries that have a value set for Country', $metric->getDocumentation());
        $this->assertSame('UserCountry_VisitLocation', $metric->getCategoryId());
        $this->assertSame('sum(if(log_visit.location_country > 0, 1, 0))', $metric->getQuery());
    }


    public function testCreateCustomMetric()
    {
        $factory = $this->makeFactory($this->country);
        $metric = $factory->createCustomMetric($name = 'sum_times_10', $translated = 'MyMetric', $aggregation = 'sum(%s) * 10', $documentation = 'FoobarBaz');

        $this->assertSame($name, $metric->getName());
        $this->assertSame($translated, $metric->getTranslatedName());
        $this->assertSame($documentation, $metric->getDocumentation());
        $this->assertSame('UserCountry_VisitLocation', $metric->getCategoryId());
        $this->assertSame('sum(log_visit.location_country) * 10', $metric->getQuery());
    }

    public function testCreateComputedMetricAverage()
    {
        $factory = $this->makeFactory($this->country);
        $metric = $factory->createComputedMetric($metricName1 = 'bounce_count', 'nb_visits', ComputedMetric::AGGREGATION_AVG);

        $this->assertSame('avg_bounce_count_per_visits', $metric->getName());
        $this->assertSame('Avg. Actions In Visit per Visit', $metric->getTranslatedName());
        $this->assertSame('Average value of "Actions In Visit" per "Visits".', $metric->getDocumentation());
        $this->assertSame('UserCountry_VisitLocation', $metric->getCategoryId());
        $this->assertCount(2, $metric->getDependentMetrics());
    }

    public function testCreateComputedMetricRate()
    {
        $factory = $this->makeFactory($this->country);
        $metric = $factory->createComputedMetric($metricName1 = 'bounce_count', 'nb_visits', ComputedMetric::AGGREGATION_RATE);

        $this->assertSame('bounce_count_visits_rate', $metric->getName());
        $this->assertSame('Bounces Rate', $metric->getTranslatedName());
        $this->assertSame('The ratio of "Actions In Visit" out of all "Visits".', $metric->getDocumentation());
        $this->assertSame('UserCountry_VisitLocation', $metric->getCategoryId());
        $this->assertCount(2, $metric->getDependentMetrics());
    }
}