From d2e6db71fa3605b56dd7e6162a6f3a101d9b71b1 Mon Sep 17 00:00:00 2001
From: Mark Baker <mark@lange.demon.co.uk>
Date: Fri, 7 May 2021 23:40:30 +0200
Subject: [PATCH] Lookup functions additional unit tests (#2074)

* Additional unit tests for VLOOKUP() and HLOOKUP()
* Additional unit tests for CHOOSE()
* Unit tests for HYPERLINK() function
* Fix CHOOSE() test for spillage
---
 .../Calculation/LookupRef/Hyperlink.php       |  2 +-
 src/PhpSpreadsheet/Reader/Xml.php             |  2 +-
 .../Functions/LookupRef/HyperlinkTest.php     | 51 +++++++++++++++++++
 tests/data/Calculation/LookupRef/CHOOSE.php   |  8 +++
 tests/data/Calculation/LookupRef/HLOOKUP.php  | 24 +++++++++
 .../data/Calculation/LookupRef/HYPERLINK.php  | 26 ++++++++++
 tests/data/Calculation/LookupRef/VLOOKUP.php  | 31 +++++++++++
 7 files changed, 142 insertions(+), 2 deletions(-)
 create mode 100644 tests/PhpSpreadsheetTests/Calculation/Functions/LookupRef/HyperlinkTest.php
 create mode 100644 tests/data/Calculation/LookupRef/HYPERLINK.php

diff --git a/src/PhpSpreadsheet/Calculation/LookupRef/Hyperlink.php b/src/PhpSpreadsheet/Calculation/LookupRef/Hyperlink.php
index d0324964..823d70c6 100644
--- a/src/PhpSpreadsheet/Calculation/LookupRef/Hyperlink.php
+++ b/src/PhpSpreadsheet/Calculation/LookupRef/Hyperlink.php
@@ -11,7 +11,7 @@ class Hyperlink
      * HYPERLINK.
      *
      * Excel Function:
-     *        =HYPERLINK(linkURL,displayName)
+     *        =HYPERLINK(linkURL, [displayName])
      *
      * @param mixed $linkURL Expect string. Value to check, is also the value returned when no error
      * @param mixed $displayName Expect string. Value to return when testValue is an error condition
diff --git a/src/PhpSpreadsheet/Reader/Xml.php b/src/PhpSpreadsheet/Reader/Xml.php
index 282cd528..4ef4efe7 100644
--- a/src/PhpSpreadsheet/Reader/Xml.php
+++ b/src/PhpSpreadsheet/Reader/Xml.php
@@ -284,7 +284,7 @@ class Xml extends BaseReader
             $worksheet_ss = self::getAttributes($worksheet, $namespaces['ss']);
 
             if (
-                (isset($this->loadSheetsOnly)) && (isset($worksheet_ss['Name'])) &&
+                isset($this->loadSheetsOnly, $worksheet_ss['Name']) &&
                 (!in_array($worksheet_ss['Name'], $this->loadSheetsOnly))
             ) {
                 continue;
diff --git a/tests/PhpSpreadsheetTests/Calculation/Functions/LookupRef/HyperlinkTest.php b/tests/PhpSpreadsheetTests/Calculation/Functions/LookupRef/HyperlinkTest.php
new file mode 100644
index 00000000..e71992ed
--- /dev/null
+++ b/tests/PhpSpreadsheetTests/Calculation/Functions/LookupRef/HyperlinkTest.php
@@ -0,0 +1,51 @@
+<?php
+
+namespace PhpOffice\PhpSpreadsheetTests\Calculation\Functions\LookupRef;
+
+use PhpOffice\PhpSpreadsheet\Calculation\Functions;
+use PhpOffice\PhpSpreadsheet\Calculation\LookupRef;
+use PhpOffice\PhpSpreadsheet\Cell\Cell;
+use PhpOffice\PhpSpreadsheet\Cell\Hyperlink;
+use PHPUnit\Framework\TestCase;
+
+class HyperlinkTest extends TestCase
+{
+    /**
+     * @dataProvider providerHYPERLINK
+     *
+     * @param mixed $expectedResult
+     * @param null|string $linkUrl
+     * @param null|string $description
+     */
+    public function testHYPERLINK($expectedResult, $linkUrl, $description): void
+    {
+        $hyperlink = new Hyperlink();
+
+        $cell = $this->getMockBuilder(Cell::class)
+            ->onlyMethods(['getHyperlink'])
+            ->disableOriginalConstructor()
+            ->getMock();
+        $cell->method('getHyperlink')
+            ->willReturn($hyperlink);
+
+        $result = LookupRef::HYPERLINK($linkUrl, $description, $cell);
+        if (!is_array($expectedResult)) {
+            self::assertSame($expectedResult, $result);
+        } else {
+            self::assertSame($expectedResult[1], $result);
+            self::assertSame($expectedResult[0], $hyperlink->getUrl());
+            self::assertSame($expectedResult[1], $hyperlink->getTooltip());
+        }
+    }
+
+    public function providerHYPERLINK(): array
+    {
+        return require 'tests/data/Calculation/LookupRef/HYPERLINK.php';
+    }
+
+    public function testHYPERLINKwithoutCell(): void
+    {
+        $result = LookupRef::HYPERLINK('https://phpspreadsheet.readthedocs.io/en/latest/', 'Read the Docs');
+        self::assertSame(Functions::REF(), $result);
+    }
+}
diff --git a/tests/data/Calculation/LookupRef/CHOOSE.php b/tests/data/Calculation/LookupRef/CHOOSE.php
index 06371c79..96c29780 100644
--- a/tests/data/Calculation/LookupRef/CHOOSE.php
+++ b/tests/data/Calculation/LookupRef/CHOOSE.php
@@ -25,4 +25,12 @@ return [
         '#VALUE!',
         0, 'red', 'blue', 'green', 'brown',
     ],
+    [
+        '#VALUE!',
+        'NaN', 'red', 'blue', 'green', 'brown',
+    ],
+    [
+        ['blue', 'purple'],
+        3, ['red', 'orange'], ['yellow', 'green'], ['blue', 'purple'],
+    ],
 ];
diff --git a/tests/data/Calculation/LookupRef/HLOOKUP.php b/tests/data/Calculation/LookupRef/HLOOKUP.php
index d2a8a446..61cb7e06 100644
--- a/tests/data/Calculation/LookupRef/HLOOKUP.php
+++ b/tests/data/Calculation/LookupRef/HLOOKUP.php
@@ -328,4 +328,28 @@ return [
         2,
         false,
     ],
+    [
+        0.61,
+        'Ed',
+        [
+            [null, 'Ann', 'Cara', 'Colin', 'Ed', 'Frank'],
+            ['Math', 0.58, 0.90, 0.67, 0.76, 0.80],
+            ['French', 0.61, 0.71, 0.59, 0.59, 0.76],
+            ['Physics', 0.75, 0.45, 0.39, 0.52, 0.69],
+            ['Bioogy', 0.39, 0.55, 0.77, 0.61, 0.45],
+        ],
+        5,
+        false,
+    ],
+    [
+        'Normal Weight',
+        23.5,
+        [
+            [null, 'Min', 0.0, 18.5, 25.0, 30.0],
+            ['BMI', 'Max', 18.4, 24.9, 29.9, null],
+            [null, 'Body Type', 'Underweight', 'Normal Weight', 'Overweight', 'Obese'],
+        ],
+        3,
+        true,
+    ],
 ];
diff --git a/tests/data/Calculation/LookupRef/HYPERLINK.php b/tests/data/Calculation/LookupRef/HYPERLINK.php
new file mode 100644
index 00000000..9a5e4c2e
--- /dev/null
+++ b/tests/data/Calculation/LookupRef/HYPERLINK.php
@@ -0,0 +1,26 @@
+<?php
+
+use PhpOffice\PhpSpreadsheet\Calculation\Functions;
+
+return [
+    [
+        ['https://phpspreadsheet.readthedocs.io/en/latest/', 'https://phpspreadsheet.readthedocs.io/en/latest/'],
+        'https://phpspreadsheet.readthedocs.io/en/latest/',
+        null,
+    ],
+    [
+        ['https://phpspreadsheet.readthedocs.io/en/latest/', 'Read the Docs'],
+        'https://phpspreadsheet.readthedocs.io/en/latest/',
+        'Read the Docs',
+    ],
+    [
+        Functions::REF(),
+        null,
+        null,
+    ],
+    [
+        Functions::REF(),
+        '',
+        null,
+    ],
+];
diff --git a/tests/data/Calculation/LookupRef/VLOOKUP.php b/tests/data/Calculation/LookupRef/VLOOKUP.php
index a5d6f615..0a059048 100644
--- a/tests/data/Calculation/LookupRef/VLOOKUP.php
+++ b/tests/data/Calculation/LookupRef/VLOOKUP.php
@@ -349,4 +349,35 @@ return [
         ],
         2.0,
     ],
+    [
+        3.50,
+        'Cornflakes',
+        [
+            ['Item Description', 'Price'],
+            ['Tinned Tomatoes', 0.90],
+            ['Tinned Tuna', 1.50],
+            ['Cornflakes', 3.50],
+            ['Shortcake Biscuits', 1.00],
+            ['Toothpaste', 4.10],
+            ['Tinned Baked Beans', 0.99],
+            ['White Sliced Bread', 0.80],
+        ],
+        2,
+        false,
+    ],
+    [
+        'E',
+        0.52,
+        [
+            ['Lower', 'Upper', 'Grade'],
+            [0.00, 0.44, 'F'],
+            [0.45, 0.54, 'E'],
+            [0.55, 0.64, 'D'],
+            [0.65, 0.74, 'C'],
+            [0.75, 0.84, 'B'],
+            [0.85, 1.00, 'A'],
+        ],
+        3,
+        true,
+    ],
 ];