Merge pull request #11 from Surfoo/develop

Throw an exception if the referenceCode is too short.

.gitignore

@@ -2,4 +2,5 @@ composer.lock
 cache
 vendor
 .php_cs.cache
+.phpunit.result.cache
 sami.phar

.travis.yml

@@ -2,6 +2,7 @@ language: php
 php:
   - 7.3
   - 7.4
+  - 8.0
 
 env:
 #  - dependencies=--prefer-lowest

CHANGELOG

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [3.14.0] - 2021-01-19
+### Added
+    - Throw an exception if the referenceCode is too short
+
 ## [3.13.0] - 2021-01-17
 ### Added
     - New API method added:

phpunit.xml

@@ -1,13 +1,13 @@
-<phpunit bootstrap="vendor/autoload.php">
+<?xml version="1.0"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" bootstrap="vendor/autoload.php" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
+  <coverage>
+    <include>
+      <directory>src</directory>
+    </include>
+  </coverage>
   <testsuites>
     <testsuite name="units">
       <directory>tests</directory>
     </testsuite>
   </testsuites>
-
-  <filter>
-        <whitelist>
-            <directory>src</directory>
-        </whitelist>
-    </filter>
-</phpunit>
+</phpunit>

src/Lib/Utils/Utils.php

@@ -59,10 +59,14 @@ public static function decimalToDegreeDecimal(float $latitude, float $longitude)
     }
 
     /**
-     * Concert a reference code to an Id
+     * Convert a reference code to an Id
      */
     public static function referenceCodeToId(string $referenceCode): int
     {
+        if (\strlen($referenceCode) <= 2) {
+            throw new UtilsException('referenceCode "' . $referenceCode . '" too short.');
+        }
+
         if (\substr($referenceCode, 0, 2) == 'GC') {
             $referenceCode = \str_replace('SO', '50', $referenceCode);
         }

tests/Lib/Utils/UtilsTest.php

@@ -2,11 +2,11 @@
 
 declare(strict_types=1);
 
-use PHPUnit\Framework\TestCase;
 use Geocaching\Lib\Utils\Utils;
+use PHPUnit\Framework\TestCase;
+
 final class UtilsTest extends TestCase
 {
-
     public function providerDecimalToDegreeDecimal()
     {
         return [
@@ -20,10 +20,6 @@ public function providerDecimalToDegreeDecimal()
 
     /**
      * @dataProvider providerDecimalToDegreeDecimal
-     *
-     * @param float $latitude
-     * @param float $longitude
-     * @param string $expected
      */
     public function testDecimalToDegreeDecimal(float $latitude, float $longitude, string $expected)
     {
@@ -46,9 +42,6 @@ public function providerReferenceCode()
 
     /**
      * @dataProvider providerReferenceCode
-     * 
-     * @param string $referenceCode
-     * @param integer $expected
      */
     public function testReferenceCodeToIdSuccessful(string $referenceCode, int $expected): void
     {
@@ -61,17 +54,18 @@ public function testReferenceCodeToIdSuccessful(string $referenceCode, int $expe
     public function providerReferenceCodeFail()
     {
         return [
-            ['GCSRTOP']
+            ['GC', 'referenceCode "GC" too short.'],
+            ['GCSRTOP', 'Only chars 0123456789ABCDEFGHJKMNPQRTVWXYZ are supported.'],
         ];
     }
 
     /**
      * @dataProvider providerReferenceCodeFail
      */
-    public function testReferenceCodeToIdFail(string $referenceCode)
+    public function testReferenceCodeToIdFail(string $referenceCode, string $expected)
     {
         $this->expectException(Geocaching\Exception\UtilsException::class);
-        $this->expectExceptionMessage("Only chars 0123456789ABCDEFGHJKMNPQRTVWXYZ are supported.");
+        $this->expectExceptionMessage($expected);
 
         Utils::referenceCodeToId($referenceCode);
     }
@@ -90,10 +84,6 @@ public function providerId()
 
     /**
      * @dataProvider providerId
-     * 
-     * @param string $number
-     * @param string $prefix
-     * @param string $expected
      */
     public function testIdToReferenceCodeSucessful(string $number, string $prefix, string $expected): void
     {
@@ -102,5 +92,4 @@ public function testIdToReferenceCodeSucessful(string $number, string $prefix, s
         $this->assertEquals($expected, $result);
         $this->assertIsString($result);
     }
-
-}
+}