StaticData linking fixes + tests (#26)

[LeagueAPI] StaticData linking fixes + tests
dolejska-daniel · Dec 13, 2018 · 205d6d7 · 205d6d7
1 parent 3dd3294
commit 205d6d7
Show file tree

Hide file tree

Showing 10 changed files with 58 additions and 36 deletions.
diff --git a/src/RiotAPI/Objects/ApiObject.php b/src/RiotAPI/Objects/ApiObject.php
@@ -48,7 +48,7 @@ public function __construct( array $data, RiotAPI $api = null )
 			: false;
 		$linkableProp = $selfRef->hasProperty('staticData')
 			? self::getLinkablePropertyData($selfRef->getDocComment())
-			: [ 'name' => false, 'function' => false];
+			: [ 'function' => false, 'parameter' => false ];
 
 		foreach ($data as $property => $value)
 		{
@@ -88,20 +88,42 @@ public function __construct( array $data, RiotAPI $api = null )
 				if ($api)
 				{
 					//  Should this property be linked and is it allowed?
-					if ($linkableProp['name'] == $property && $api->getSetting(RiotAPI::SET_STATICDATA_LINKING, false))
+					if ($linkableProp['parameter'] == $property && $api->getSetting(RiotAPI::SET_STATICDATA_LINKING, false))
 					{
-						$params = [];
-						//  Request locale
-						$params[] = $api->getSetting(RiotAPI::SET_STATICDATA_LOCALE, null);
-						//  Static data version
-						$params[] = $api->getSetting(RiotAPI::SET_STATICDATA_VERSION, null);
-						//  Data by ID?
-						$params[] = true;
-						//  Included tags
-						$params[] = $api->getSetting(RiotAPI::SET_STATICDATA_TAGS, 'info');
-
-						$data = call_user_func_array(array($api, $linkableProp['function']), $params);
-						$this->staticData = $data->data[$value];
+						$apiRef = new \ReflectionClass(RiotAPI::class);
+						$linkingFunctionRef = $apiRef->getMethod($linkableProp['function']);
+
+						$params = [ $value ];
+						foreach ($linkingFunctionRef->getParameters() as $parameter)
+						{
+							switch ($parameter->getName())
+							{
+								// Extended data fetch?
+								case "extended":
+									$params[] = true;
+									break;
+
+								// Data by key?
+								case "data_by_key":
+									$params[] = true;
+									break;
+
+								// Request locale
+								case "locale":
+									$params[] = $api->getSetting(RiotAPI::SET_STATICDATA_LOCALE, $parameter->getDefaultValue());
+									break;
+
+								// Static data version
+								case "version":
+									$params[] = $api->getSetting(RiotAPI::SET_STATICDATA_VERSION, $parameter->getDefaultValue());
+									break;
+
+								default:
+									break;
+							}
+						}
+
+						$this->staticData = $linkingFunctionRef->invokeArgs($api, $params);
 					}
 				}
 			}
@@ -150,9 +172,12 @@ public static function getIterablePropertyName( string $phpDocComment )
 	 */
 	public static function getLinkablePropertyData( string $phpDocComment )
 	{
-		preg_match('/@linkable\s\$([\w]+)\s\(([\w\$]+)\)/', $phpDocComment, $matches);
-		if (isset($matches[1]) && isset($matches[2]))
-			return [ 'name' => $matches[1], 'function' => $matches[2]];
+		preg_match('/@linkable\s(?<function>[\w]+)(?:\(\$(?<parameter>[\w]+)+?\))?/', $phpDocComment, $matches);
+
+		// Filter only named capture groups
+		$matches = array_filter($matches, function ($v, $k) { return is_string($k); }, ARRAY_FILTER_USE_BOTH);
+		if (@$matches['function'] && @$matches['parameter'])
+			return $matches;
 
 		return false;
 	}

diff --git a/src/RiotAPI/Objects/BannedChampion.php b/src/RiotAPI/Objects/BannedChampion.php
@@ -28,7 +28,7 @@
  *     @link https://developer.riotgames.com/api-methods/#spectator-v4/GET_getCurrentGameInfoBySummoner
  *     @link https://developer.riotgames.com/api-methods/#spectator-v4/GET_getFeaturedGames
  *
- * @linkable $championId (getStaticChampions)
+ * @linkable getStaticChampion($championId)
  *
  * @package RiotAPI\Objects
  */

diff --git a/src/RiotAPI/Objects/ChampionDto.php b/src/RiotAPI/Objects/ChampionDto.php
@@ -29,7 +29,7 @@
  *     @link https://developer.riotgames.com/api-methods/#champion-v3/GET_getChampions
  *     @link https://developer.riotgames.com/api-methods/#champion-v3/GET_getChampionsById
  *
- * @linkable $id (getStaticChampions)
+ * @linkable getStaticChampion($id)
  *
  * @package RiotAPI\Objects
  */

diff --git a/src/RiotAPI/Objects/ChampionMasteryDto.php b/src/RiotAPI/Objects/ChampionMasteryDto.php
@@ -24,12 +24,7 @@
  *   Class ChampionMasteryDto
  * This object contains single Champion Mastery information for player and champion combination.
  *
- * Used in:
- *   champion-mastery (v4)
- *     @link https://developer.riotgames.com/api-methods/#champion-mastery-v4/GET_getAllChampionMasteries
- *     @link https://developer.riotgames.com/api-methods/#champion-mastery-v4/GET_getChampionMastery
- *
- * @linkable $championId (getStaticChampions)
+ * @linkable getStaticChampion($championId)
  *
  * @package RiotAPI\Objects
  */

diff --git a/src/RiotAPI/Objects/CurrentGameParticipant.php b/src/RiotAPI/Objects/CurrentGameParticipant.php
@@ -27,7 +27,7 @@
  *   spectator (v4)
  *     @link https://developer.riotgames.com/api-methods/#spectator-v4/GET_getCurrentGameInfoBySummoner
  *
- * @linkable $championId (getStaticChampions)
+ * @linkable getStaticChampion($championId)
  *
  * @package RiotAPI\Objects
  */

diff --git a/src/RiotAPI/Objects/MatchReferenceDto.php b/src/RiotAPI/Objects/MatchReferenceDto.php
@@ -27,7 +27,7 @@
  *   match (v4)
  *     @link https://developer.riotgames.com/api-methods/#match-v4/GET_getMatchlist
  *
- * @linkable $champion (getStaticChampions)
+ * @linkable getStaticChampion($champion)
  *
  * @package RiotAPI\Objects
  */

diff --git a/src/RiotAPI/Objects/Participant.php b/src/RiotAPI/Objects/Participant.php
@@ -27,7 +27,7 @@
  *   spectator (v4)
  *     @link https://developer.riotgames.com/api-methods/#spectator-v4/GET_getFeaturedGames
  *
- * @linkable $championId (getStaticChampions)
+ * @linkable getStaticChampion($championId)
  *
  * @package RiotAPI\Objects
  */

diff --git a/src/RiotAPI/Objects/ParticipantDto.php b/src/RiotAPI/Objects/ParticipantDto.php
@@ -28,7 +28,7 @@
  *     @link https://developer.riotgames.com/api-methods/#match-v4/GET_getMatchIdsByTournamentCode
  *     @link https://developer.riotgames.com/api-methods/#match-v4/GET_getMatchByTournamentCode
  *
- * @linkable $championId (getStaticChampions)
+ * @linkable getStaticChampion($championId)
  *
  * @package RiotAPI\Objects
  */

diff --git a/src/RiotAPI/Objects/TeamBansDto.php b/src/RiotAPI/Objects/TeamBansDto.php
@@ -28,7 +28,7 @@
  *     @link https://developer.riotgames.com/api-methods/#match-v4/GET_getMatchIdsByTournamentCode
  *     @link https://developer.riotgames.com/api-methods/#match-v4/GET_getMatchByTournamentCode
  *
- * @linkable $championId (getStaticChampions)
+ * @linkable getStaticChampion($championId)
  *
  * @package RiotAPI\Objects
  */

diff --git a/tests/RiotAPI/EndpointObjectIntegrity/ApiObjectLinkableTest.php b/tests/RiotAPI/EndpointObjectIntegrity/ApiObjectLinkableTest.php
@@ -21,19 +21,19 @@
 
 use RiotAPI\Definitions\Region;
 use RiotAPI\Objects\ApiObjectLinkable;
+use RiotAPI\Objects\ChampionMasteryDto;
 use RiotAPI\RiotAPI;
 
 
 class ApiObjectLinkableTest extends RiotAPITestCase
 {
 	public function testInit()
 	{
-		$this->markTestSkipped("Static-data API endpoint has been deprecated.");
-
 		$api = new RiotAPI([
 			RiotAPI::SET_KEY                => getenv('API_KEY'),
 			RiotAPI::SET_REGION             => Region::EUROPE_EAST,
 			RiotAPI::SET_USE_DUMMY_DATA     => true,
+			RiotAPI::SET_DATADRAGON_INIT    => true,
 			RiotAPI::SET_STATICDATA_LINKING => true,
 			RiotAPI::SET_CACHE_CALLS        => true,
 		]);
@@ -48,14 +48,16 @@ public function testInit()
 	 *
 	 * @param RiotAPI $api
 	 */
-	public function testStaticDataLinking( RiotAPI $api )
+	public function testStaticDataLinking_ChampionMastery( RiotAPI $api )
 	{
-		$data = $api->getChampionMastery(30904166, 61);
+		/** @var ChampionMasteryDto $data */
+		$data = $api->getChampionMastery("KnNZNuEVZ5rZry3IyWwYSVuikRe0y3qTWSkr1wxcmV5CLJ8", 61);
 
 		$this->assertSame(61, $data->championId);
-		$this->assertSame($data->championId, $data->id);
+		$this->assertSame("61", $data->key);
+		$this->assertSame($data->key, $data->staticData->key);
 		$this->assertSame("Orianna", $data->name);
-		$this->assertSame("Orianna", $data->staticData->name);
+		$this->assertSame($data->name, $data->staticData->name);
 	}
 
 	public function testInvalidLinkableProperty()