malhuda/jikan-rest
1
0
Fork 0
mirror of https://github.com/jikan-me/jikan-rest.git synced 2025-02-20 11:23:35 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #528 from jikan-me/bugfix/517

Browse Source 
✅ Fixed filtering by producer/magazine on anime/manga search endpoints
This commit is contained in:
Irfan (Nekomata) 2024-05-29 11:28:17 +05:00 committed by GitHub
commit ce4bb92596
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
7 changed files with 149 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
app/Anime.php
View File

@ -103,7 +103,6 @@ class Anime extends JikanApiSearchableModel
|| !is_string($premiered)
|| !preg_match('~(Winter|Spring|Summer|Fall|)\s([\d+]{4})~', $premiered)
) {
Log::warning("Invalid premiered value in Anime model[$this->mal_id]: " . $premiered);
return null;
}
@ -182,14 +181,11 @@ class Anime extends JikanApiSearchableModel
}
$producer = (int)$value;
/** @noinspection PhpParamsInspection */
return $query->whereRaw([
'$or' => [
['producers.mal_id' => $producer],
['licensors.mal_id' => $producer],
['studios.mal_id' => $producer]
]
]);
return $query->where(function (\Jenssegers\Mongodb\Eloquent\Builder $query) use ($producer) {
return $query->where('producers.mal_id', $producer)
->orWhere('licensors.mal_id', $producer)
->orWhere('studios.mal_id', $producer);
});
}
/** @noinspection PhpUnused */
@ -199,16 +195,24 @@ class Anime extends JikanApiSearchableModel
return $query;
}
$producers = collect(explode(',', $value))->filter()->toArray();
$orFilters = [];
foreach ($producers as $producer) {
$producer = (int)$producer;
$orFilters[] = ['producers.mal_id' => $producer];
$orFilters[] = ['licensors.mal_id' => $producer];
$orFilters[] = ['studios.mal_id' => $producer];
}
/** @noinspection PhpParamsInspection */
return $query->whereRaw(['$or' => $orFilters]);
/* @var \Illuminate\Support\Collection $producers */
$producers = collect(explode(',', $value))->filter();
return $query->where(function (\Jenssegers\Mongodb\Eloquent\Builder $query) use ($producers) {
$firstProducer = (int)$producers->first();
$query = $query->where('producers.mal_id', $firstProducer)
->orWhere('licensors.mal_id', $firstProducer)
->orWhere('studios.mal_id', $firstProducer);
foreach ($producers->skip(1) as $producer) {
$producer = (int)$producer;
$query = $query->orWhere('producers.mal_id', $producer)
->orWhere('licensors.mal_id', $producer)
->orWhere('studios.mal_id', $producer);
}
return $query;
});
}
/** @noinspection PhpUnused */

8
app/Manga.php
View File

@ -111,14 +111,10 @@ class Manga extends JikanApiSearchableModel
return $query;
}
/** @var \Illuminate\Support\Collection $magazines */
$magazines = collect(explode(',', $value))->filter()->map(fn($x) => (int)$x)->toArray();
/** @noinspection PhpParamsInspection */
return $query->whereRaw([
"serializations.mal_id" => [
'$in' => $magazines
]
]);
return $query->whereIn("serializations.mal_id", $magazines);
}
/** @noinspection PhpUnused */

44
database/factories/AnimeFactory.php
View File

@ -4,6 +4,7 @@ namespace Database\Factories;
use App\CarbonDateRange;
use App\Anime;
use App\Testing\JikanDataGenerator;
use Illuminate\Support\Collection;
use MongoDB\BSON\UTCDateTime;
@ -139,4 +140,47 @@ class AnimeFactory extends JikanMediaModelFactory
"request_hash" => sprintf("request:%s:%s", "v4", $this->getItemTestUrl("anime", $mal_id))
];
}
protected function getOverridesFromQueryStringParameters(Collection $additionalParams): array
{
$overrides = parent::getOverridesFromQueryStringParameters($additionalParams);
if ($additionalParams->has("producers")) {
$overrides["producers"] = [];
$producerIds = explode(",", $additionalParams["producers"]);
foreach ($producerIds as $producerId) {
$overrides["producers"][] = [
"mal_id" => (int)$producerId,
"type" => "anime",
"name" => "Producer ${producerId}",
"url" => "https://myanimelist.net/anime/producer/${producerId}/x"
];
}
}
return $overrides;
}
protected function getOppositeOverridesFromQueryStringParameters(Collection $additionalParams): array
{
$overrides = parent::getOppositeOverridesFromQueryStringParameters($additionalParams);
if ($additionalParams->has("producers")) {
$overrides["producers"] = [];
$producerIds = explode(",", $additionalParams["producers"]);
do {
$randomEls = $this->faker->randomElements([11, 60, 89, 54, 32, 22, 108, 65], $this->faker->numberBetween(1, 3));
} while (count(array_intersect($randomEls, $producerIds)) > 0);
foreach ($randomEls as $producerId) {
$overrides["produces"][] = [
"mal_id" => (int)$producerId,
"type" => "anime",
"name" => "Producer ${producerId}",
"url" => "https://myanimelist.net/anime/producer/${producerId}/x"
];
}
}
return $overrides;
}
}

28
database/factories/JikanMediaModelFactory.php
View File

@ -7,6 +7,7 @@ use App\Enums\AnimeRatingEnum;
use App\Enums\AnimeTypeEnum;
use App\Enums\MangaTypeEnum;
use App\Testing\JikanDataGenerator;
use Illuminate\Database\Eloquent\Factories\Sequence;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\Carbon;
use Illuminate\Support\Collection;
@ -56,6 +57,18 @@ abstract class JikanMediaModelFactory extends JikanModelFactory implements Media
* @return self
*/
public function overrideFromQueryStringParameters(array $additionalParams, bool $doOpposite = false): self
{
if ($this->count === 1) {
return $this->state($this->serializeStateDefinition($this->getStateOverrides($additionalParams, $doOpposite)));
}
// we want to generate overrides for each manufactured item, so all of them will call the faker for values,
// and they should have their own values, increasing the randomness of the generated data
/** @noinspection PhpParamsInspection */
return $this->state(new Sequence(fn(Sequence $_) => $this->serializeStateDefinition($this->getStateOverrides($additionalParams, $doOpposite))));
}
private function getStateOverrides(array $additionalParams, bool $doOpposite = false): array
{
$additionalParams = collect($additionalParams);
@ -66,7 +79,7 @@ abstract class JikanMediaModelFactory extends JikanModelFactory implements Media
$overrides = $this->getOverridesFromQueryStringParameters($additionalParams);
}
return $this->state($this->serializeStateDefinition($overrides));
return $overrides;
}
/**
@ -158,6 +171,10 @@ abstract class JikanMediaModelFactory extends JikanModelFactory implements Media
$overrides = [...$overrides, ...$a];
}
if ($additionalParams->has("score")) {
$overrides["score"] = floatval($additionalParams["score"]);
}
if ($additionalParams->has("min_score") && !$additionalParams->has("max_score")) {
$min_score = floatval($additionalParams["min_score"]);
if ($this->isScoreValueValid($min_score)) {
@ -283,6 +300,15 @@ abstract class JikanMediaModelFactory extends JikanModelFactory implements Media
$overrides = [...$overrides, ...$a];
}
if ($additionalParams->has("score")) {
$specifiedScore = floatval($additionalParams["score"]);
do {
$randomScore = $this->faker->randomFloat(2, 1.00, 9.99);
} while ($randomScore === $specifiedScore);
$overrides["score"] = $randomScore;
}
if ($additionalParams->has("min_score") && !$additionalParams->has("max_score")) {
$min_score = floatval($additionalParams["min_score"]);
if ($this->isScoreValueValid($min_score)) {

45
database/factories/MangaFactory.php
View File

@ -4,6 +4,7 @@ namespace Database\Factories;
use App\CarbonDateRange;
use App\Testing\JikanDataGenerator;
use App\Manga;
use Illuminate\Support\Collection;
use MongoDB\BSON\UTCDateTime;
class MangaFactory extends JikanMediaModelFactory
@ -98,4 +99,48 @@ class MangaFactory extends JikanMediaModelFactory
"request_hash" => sprintf("request:%s:%s", "v4", $this->getItemTestUrl("manga", $mal_id))
];
}
protected function getOverridesFromQueryStringParameters(Collection $additionalParams): array
{
$overrides = parent::getOverridesFromQueryStringParameters($additionalParams);
if ($additionalParams->has("magazines")) {
$overrides["serializations"] = [];
$magazineIds = explode(",", $additionalParams["magazines"]);
foreach ($magazineIds as $magazineId) {
$overrides["serializations"][] = [
"mal_id" => (int)$magazineId,
"type" => "manga",
"name" => "Magazine {$magazineId}",
"url" => "https://myanimelist.net/manga/magazine/{$magazineId}/x"
];
}
}
return $overrides;
}
protected function getOppositeOverridesFromQueryStringParameters(Collection $additionalParams): array
{
$overrides = parent::getOppositeOverridesFromQueryStringParameters($additionalParams);
if ($additionalParams->has("magazines")) {
$overrides["serializations"] = [];
$magazineIds = explode(",", $additionalParams["magazines"]);
do {
$randomEls = $this->faker->randomElements([11, 60, 89, 54, 32, 22, 108, 65], $this->faker->numberBetween(1, 3));
} while (count(array_intersect($randomEls, $magazineIds)) > 0);
foreach ($randomEls as $magazineId) {
$overrides["serializations"][] = [
"mal_id" => (int)$magazineId,
"type" => "manga",
"name" => "Magazine {$magazineId}",
"url" => "https://myanimelist.net/manga/magazine/{$magazineId}/x"
];
}
}
return $overrides;
}
}

7
tests/Integration/AnimeSearchEndpointTest.php
View File

@ -138,6 +138,7 @@ class AnimeSearchEndpointTest extends TestCase
"type = movie" => [["type" => "movie"]],
"type = ova" => [["type" => "ova"]],
"type = special" => [["type" => "special"]],
"score = 8 and producers = 11" => [["score" => "8", "producers" => "11"]],
];
}
@ -260,16 +261,16 @@ class AnimeSearchEndpointTest extends TestCase
*/
public function testSearchByEndDate($params)
{
$overrides = $this->generateFiveSpecificAndTenRandomElementsInDb($params);
$this->generateFiveSpecificAndTenRandomElementsInDb($params);
$content = $this->getJsonResponse($params);
$actualEndDate = Carbon::parse(data_get($content, "data.0.aired.to"));
$paramEndDate = Carbon::parse($overrides["aired"]["to"]);
$paramEndDate = Carbon::parse($params['end_date']);
$this->seeStatusCode(200);
$this->assertPaginationData(5);
$this->assertLessThanOrEqual(0, $actualEndDate->diff($paramEndDate)->days);
$this->assertGreaterThanOrEqual(1, $actualEndDate->diff($paramEndDate)->days);
// we created 5 elements according to parameters, so we expect 5 of them.
$this->assertCount(5, $content["data"]);
}

7
tests/Integration/MangaSearchEndpointTest.php
View File

@ -128,6 +128,7 @@ class MangaSearchEndpointTest extends TestCase
[["type" => "novel"]],
[["type" => "lightnovel"]],
[["type" => "oneshot"]],
[["score" => "8", "magazines" => "83"]]
];
}
@ -242,16 +243,16 @@ class MangaSearchEndpointTest extends TestCase
*/
public function testSearchByEndDate($params)
{
$overrides = $this->generateFiveSpecificAndTenRandomElementsInDb($params);
$this->generateFiveSpecificAndTenRandomElementsInDb($params);
$content = $this->getJsonResponse($params);
$actualEndDate = Carbon::parse(data_get($content, "data.0.published.to"));
$paramEndDate = Carbon::parse($overrides["published"]["to"]);
$paramEndDate = Carbon::parse($params["end_date"]);
$this->seeStatusCode(200);
$this->assertPaginationData(5);
$this->assertLessThanOrEqual(0, $actualEndDate->diff($paramEndDate)->days);
$this->assertGreaterThanOrEqual(1, $actualEndDate->diff($paramEndDate)->days);
// we created 5 elements according to parameters, so we expect 5 of them.
$this->assertCount(5, $content["data"]);
}