Passed
Pull Request — master (#3448)
by Mark
22:11
created

YearFracTest::testDirectCallToYEARFRAC()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
eloc 2
dl 0
loc 4
rs 10
c 0
b 0
f 0
cc 1
nc 1
nop 2
1
<?php
2
3
namespace PhpOffice\PhpSpreadsheetTests\Calculation\Functions\DateTime;
4
5
use PhpOffice\PhpSpreadsheet\Calculation\Calculation;
6
use PhpOffice\PhpSpreadsheet\Calculation\DateTimeExcel\YearFrac;
7
use PhpOffice\PhpSpreadsheet\Calculation\Exception as CalculationException;
8
use PhpOffice\PhpSpreadsheet\Spreadsheet;
9
use PhpOffice\PhpSpreadsheetTests\Calculation\Functions\FormulaArguments;
10
use PHPUnit\Framework\TestCase;
11
12
class YearFracTest extends TestCase
13
{
14
    /**
15
     * @dataProvider providerYEARFRAC
16
     *
17
     * @param mixed $expectedResult
18
     */
19
    public function testDirectCallToYEARFRAC($expectedResult, ...$args): void
20
    {
21
        $result = YearFrac::fraction(...$args);
22
        self::assertEqualsWithDelta($expectedResult, $result, 1.0e-6);
23
    }
24
25
    /**
26
     * @dataProvider providerYEARFRAC
27
     *
28
     * @param mixed $expectedResult
29
     */
30
    public function testYEARFRACAsFormula($expectedResult, ...$args): void
31
    {
32
        $arguments = new FormulaArguments(...$args);
33
34
        $calculation = Calculation::getInstance();
35
        $formula = "=YEARFRAC({$arguments})";
36
37
        $result = $calculation->_calculateFormulaValue($formula);
38
        self::assertEqualsWithDelta($expectedResult, $result, 1.0e-6);
39
    }
40
41
    /**
42
     * @dataProvider providerYEARFRAC
43
     *
44
     * @param mixed $expectedResult
45
     */
46
    public function testYEARFRACInWorksheet($expectedResult, ...$args): void
47
    {
48
        $arguments = new FormulaArguments(...$args);
49
50
        $spreadsheet = new Spreadsheet();
51
        $worksheet = $spreadsheet->getActiveSheet();
52
        $argumentCells = $arguments->populateWorksheet($worksheet);
53
        $formula = "=YEARFRAC({$argumentCells})";
54
55
        $result = $worksheet->setCellValue('A1', $formula)
56
            ->getCell('A1')
57
            ->getCalculatedValue();
58
        self::assertEqualsWithDelta($expectedResult, $result, 1.0e-6);
59
60
        $spreadsheet->disconnectWorksheets();
61
    }
62
63
    public function providerYEARFRAC(): array
64
    {
65
        return require 'tests/data/Calculation/DateTime/YEARFRAC.php';
66
    }
67
68
    /**
69
     * @dataProvider providerUnhappyYEARFRAC
70
     */
71
    public function testYEARFRACUnhappyPath(string $expectedException, ...$args): void
72
    {
73
        $arguments = new FormulaArguments(...$args);
74
75
        $spreadsheet = new Spreadsheet();
76
        $worksheet = $spreadsheet->getActiveSheet();
77
        $argumentCells = $arguments->populateWorksheet($worksheet);
78
        $formula = "=YEARFRAC({$argumentCells})";
79
80
        $this->expectException(CalculationException::class);
81
        $this->expectExceptionMessage($expectedException);
82
        $worksheet->setCellValue('A1', $formula)
83
            ->getCell('A1')
84
            ->getCalculatedValue();
85
86
        $spreadsheet->disconnectWorksheets();
87
    }
88
89
    public function providerUnhappyYEARFRAC(): array
90
    {
91
        return [
92
            ['Formula Error: Wrong number of arguments for YEARFRAC() function'],
93
            ['Formula Error: Wrong number of arguments for YEARFRAC() function', '2023-03-09'],
94
        ];
95
    }
96
97
    /**
98
     * @dataProvider providerYearFracArray
99
     */
100
    public function testYearFracArray(array $expectedResult, string $startDate, string $endDate, ?string $methods): void
101
    {
102
        $calculation = Calculation::getInstance();
103
104
        if ($methods === null) {
105
            $formula = "=YEARFRAC({$startDate}, {$endDate})";
106
        } else {
107
            $formula = "=YEARFRAC({$startDate}, {$endDate}, {$methods})";
108
        }
109
        $result = $calculation->_calculateFormulaValue($formula);
110
        self::assertEqualsWithDelta($expectedResult, $result, 1.0e-14);
111
    }
112
113
    public function providerYearFracArray(): array
114
    {
115
        return [
116
            'row vector #1' => [[[1.0, 0.55277777777778, 0.56111111111111]], '{"2022-01-01", "2022-06-12", "2023-07-22"}', '"2022-12-31"', null],
117
            'column vector #1' => [[[1.0], [0.99444444444445], [0.98611111111111]], '{"2022-01-01"; "2022-01-03"; "2022-01-06"}', '"2022-12-31"', null],
118
            'matrix #1' => [[[0.002777777777778, 0.027777777777778], [0.625, 1.0]], '{"2022-01-01", "2022-01-10"; "2022-08-15", "2022-12-31"}', '"2021-12-31"', null],
119
            'column vector with methods' => [[[0.99726027397260, 0.99722222222222], [0.99178082191781, 0.99166666666667], [0.98356164383562, 0.98333333333333]], '{"2022-01-01"; "2022-01-03"; "2022-01-06"}', '"2022-12-31"', '{1, 4}'],
120
        ];
121
    }
122
}
123