Completed
Push — master ( 95d836...63ebe6 )
by BENOIT
09:05
created

AverageExchangeRateProviderTest::testPrecision()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 9
Code Lines 6

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 9
rs 9.6666
c 0
b 0
f 0
cc 1
eloc 6
nc 1
nop 0
1
<?php
2
3
namespace BenTools\Currency\Tests\Provider;
4
5
use BenTools\Currency\Model\Currency;
6
use BenTools\Currency\Model\ExchangeRateInterface;
7
use BenTools\Currency\Provider\AverageExchangeRateProvider;
8
use BenTools\Currency\Tests\ProviderMockTrait;
9
use PHPUnit\Framework\TestCase;
10
11
class AverageExchangeRateProviderTest extends TestCase
12
{
13
    use ProviderMockTrait;
14
15
    public function testGetExchangeRate()
16
    {
17
18
        $numberOfProviders = random_int(3, 10);
19
        $ratios = [];
20
        for ($i = 1; $i <= $numberOfProviders; $i++) {
21
            $ratios[] = $ratio = $this->generateFakeRatio();
22
            $providers[] = $this->generateFakeProvider($ratio);
0 ignored issues
show
Coding Style Comprehensibility introduced by
$providers was never initialized. Although not strictly required by PHP, it is generally a good practice to add $providers = array(); before regardless.

Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code.

Let’s take a look at an example:

foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}

As you can see in this example, the array $myArray is initialized the first time when the foreach loop is entered. You can also see that the value of the bar key is only written conditionally; thus, its value might result from a previous iteration.

This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization $myArray = array() either outside or inside the foreach loop.

Loading history...
23
        }
24
25
        $provider = AverageExchangeRateProvider::create()->withProviders(...$providers);
0 ignored issues
show
Bug introduced by
The variable $providers does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
26
27
        $averageRatio = array_sum($ratios) / count($ratios);
28
        $exchangeRate = $provider->getExchangeRate(new Currency('EUR'), new Currency('USD'));
29
        $this->assertInstanceOf(ExchangeRateInterface::class, $exchangeRate);
30
        $this->assertEquals($averageRatio, $exchangeRate->getRatio());
31
    }
32
33
    public function testPrecision()
34
    {
35
        $provider = AverageExchangeRateProvider::create(0.02)->withProviders(
36
            $this->generateFakeProvider(1.12),
37
            $this->generateFakeProvider(1.13)
38
        );
39
        $exchangeRate = $provider->getExchangeRate(new Currency('EUR'), new Currency('USD'));
40
        $this->assertEquals(1.125, $exchangeRate->getRatio());
41
    }
42
43
    /**
44
     * @expectedException  \RuntimeException
45
     * @expectedExceptionMessage Tolerance fault: 0.03 difference between minimum and maximum ratio, 0.02 allowed.
46
     */
47
    public function testPrecisionFails()
48
    {
49
        $provider = AverageExchangeRateProvider::create(0.02)->withProviders(
50
            $this->generateFakeProvider(1.10),
51
            $this->generateFakeProvider(1.13)
52
        );
53
        $exchangeRate = $provider->getExchangeRate(new Currency('EUR'), new Currency('USD'));
0 ignored issues
show
Unused Code introduced by
$exchangeRate 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...
54
    }
55
56
}
57