refactor user anime/manga reviews + update schema [ci skip]

jikan-me · Aug 1, 2020 · 732dcbf · 732dcbf
1 parent 01d6357
commit 732dcbf
Show file tree

Hide file tree

Showing 18 changed files with 171 additions and 116 deletions.
diff --git a/src/Model/Anime/AnimeReview.php b/src/Model/Anime/AnimeReview.php
@@ -7,7 +7,7 @@
 use Jikan\Parser\Reviews\AnimeReviewParser;
 
 /**
- * Class AnimeReview
+ * Class UserAnimeReview
  *
  * @package Jikan\Model
  */

diff --git a/src/Model/Manga/MangaReview.php b/src/Model/Manga/MangaReview.php
@@ -7,7 +7,7 @@
 use Jikan\Parser\Reviews\MangaReviewParser;
 
 /**
- * Class MangaReview
+ * Class UserMangaReview
  *
  * @package Jikan\Model
  */

diff --git a/src/Model/Recommendations/RecentRecommendations.php b/src/Model/Recommendations/RecentRecommendations.php
@@ -4,13 +4,13 @@
 
 use Jikan\Model\Common\Collection\Pagination;
 use Jikan\Model\Common\Collection\Results;
-use Jikan\Model\User\Reviews;
+use Jikan\Model\User\UserReviews;
 use Jikan\Parser;
 
 /**
  * Class RecentRecommendations
  *
- * @package Jikan\Model\ReviewsParser\RecentReviews
+ * @package Jikan\Model\UserReviewsParser\RecentReviews
  */
 class RecentRecommendations extends Results implements Pagination
 {

diff --git a/src/Model/Recommendations/UserRecommendations.php b/src/Model/Recommendations/UserRecommendations.php
@@ -9,7 +9,7 @@
 /**
  * Class UserRecommendations
  *
- * @package Jikan\Model\ReviewsParser\RecentReviews
+ * @package Jikan\Model\UserReviewsParser\RecentReviews
  */
 class UserRecommendations extends Results implements Pagination
 {

diff --git a/src/Model/Reviews/AnimeReview.php b/src/Model/Reviews/AnimeReview.php
@@ -5,7 +5,7 @@
 use Jikan\Model\Anime\AnimeReviewScores;
 
 /**
- * Class AnimeReview
+ * Class UserAnimeReview
  *
  * @package Jikan\Model
  */

diff --git a/src/Model/Reviews/MangaReview.php b/src/Model/Reviews/MangaReview.php
@@ -5,7 +5,7 @@
 use Jikan\Model\Manga\MangaReviewScores;
 
 /**
- * Class AnimeReview
+ * Class UserAnimeReview
  *
  * @package Jikan\Model
  */

diff --git a/src/Model/Reviews/Recent/RecentAnimeReview.php b/src/Model/Reviews/Recent/RecentAnimeReview.php
@@ -8,7 +8,7 @@
 use Jikan\Parser\Reviews\AnimeReviewParser;
 
 /**
- * Class AnimeReview
+ * Class UserAnimeReview
  *
  * @package Jikan\Model
  */

diff --git a/src/Model/Reviews/Recent/RecentMangaReview.php b/src/Model/Reviews/Recent/RecentMangaReview.php
@@ -8,7 +8,7 @@
 use Jikan\Parser\Reviews\MangaReviewParser;
 
 /**
- * Class MangaReview
+ * Class UserMangaReview
  *
  * @package Jikan\Model
  */

diff --git a/src/Model/Reviews/RecentReviews.php b/src/Model/Reviews/RecentReviews.php
@@ -10,7 +10,7 @@
 /**
  * Class RecentReviews
  *
- * @package Jikan\Model\ReviewsParser\RecentReviews
+ * @package Jikan\Model\UserReviewsParser\RecentReviews
  */
 class RecentReviews extends Results implements Pagination
 {

diff --git a/src/Model/User/Reviews/MangaReview.php b/src/Model/User/Reviews/MangaReview.php
diff --git a/src/Model/User/Reviews/AnimeReview.php → src/Model/User/Reviews/UserAnimeReview.php b/src/Model/User/Reviews/AnimeReview.php → src/Model/User/Reviews/UserAnimeReview.php
@@ -3,49 +3,42 @@
 namespace Jikan\Model\User\Reviews;
 
 use Jikan\Model\Common\AnimeMeta;
-use Jikan\Model\Resource\CommonImageResource\CommonImageResource;
-use Jikan\Parser\Anime\AnimeReviewParser;
+use Jikan\Model\Reviews\AnimeReview;
+use Jikan\Model\Reviews\Reviewer;
+use Jikan\Parser\Reviews\AnimeReviewParser;
 
 /**
- * Class AnimeReview
+ * Class UserAnimeReview
  *
  * @package Jikan\Model
  */
-class AnimeReview extends \Jikan\Model\Reviews\AnimeReview
+class UserAnimeReview extends AnimeReview
 {
 
     /**
-     * @var string
+     * @var AnimeMeta
      */
-    private $title;
-    /**
-     * @var CommonImageResource
-     */
-    private $images;
+    private $anime;
+
 
     /**
-     * Create an instance from an AnimeReviewParser parser
-     *
      * @param AnimeReviewParser $parser
-     *
-     * @return AnimeReview
+     * @return UserAnimeReview
      * @throws \Exception
-     * @throws \RuntimeException
-     * @throws \InvalidArgumentException
      */
-    public static function fromParser(AnimeReviewParser $parser): AnimeReview
+    public static function fromParser(AnimeReviewParser $parser): UserAnimeReview
     {
         $instance = new self();
 
+        $instance->anime = $parser->getAnime();
         $instance->malId = $parser->getId();
         $instance->url = $parser->getUrl();
-        $instance->title = $parser->getTitle();
-        $instance->images = CommonImageResource::factory($parser->getImageUrl());
         $instance->type = $parser->getType();
         $instance->votes = $parser->getHelpfulCount();
         $instance->date = $parser->getDate();
         $instance->scores = $parser->getAnimeScores();
         $instance->review = $parser->getContent();
+        $instance->episodesWatched = $parser->getEpisodesWatched();
 
         return $instance;
     }

diff --git a/src/Model/User/Reviews/UserMangaReview.php b/src/Model/User/Reviews/UserMangaReview.php
@@ -0,0 +1,116 @@
+<?php
+
+namespace Jikan\Model\User\Reviews;
+
+
+use Jikan\Model\Common\MangaMeta;
+use Jikan\Model\Manga\MangaReviewScores;
+use Jikan\Model\Reviews\MangaReview;
+use Jikan\Parser\Reviews\MangaReviewParser;
+
+/**
+ * Class UserAnimeReview
+ *
+ * @package Jikan\Model
+ */
+class UserMangaReview extends MangaReview
+{
+    /**
+     * @return string
+     */
+    public function getChaptersRead(): string
+    {
+        return $this->chaptersRead;
+    }
+
+    /**
+     * @return MangaReviewScores
+     */
+    public function getScores(): MangaReviewScores
+    {
+        return $this->scores;
+    }
+
+    /**
+     * @return int
+     */
+    public function getMalId(): int
+    {
+        return $this->malId;
+    }
+
+    /**
+     * @return string
+     */
+    public function getUrl(): string
+    {
+        return $this->url;
+    }
+
+    /**
+     * @return string
+     */
+    public function getType(): string
+    {
+        return $this->type;
+    }
+
+    /**
+     * @return int
+     */
+    public function getVotes(): int
+    {
+        return $this->votes;
+    }
+
+    /**
+     * @return \DateTimeImmutable
+     */
+    public function getDate(): \DateTimeImmutable
+    {
+        return $this->date;
+    }
+
+    /**
+     * @return string
+     */
+    public function getReview(): string
+    {
+        return $this->review;
+    }
+
+    /**
+     * @return MangaMeta
+     */
+    public function getManga(): MangaMeta
+    {
+        return $this->manga;
+    }
+
+    /**
+     * @var MangaMeta
+     */
+    private $manga;
+
+    /**
+     * @param MangaReviewParser $parser
+     * @return UserAnimeReview
+     * @throws \Exception
+     */
+    public static function fromParser(MangaReviewParser $parser): UserMangaReview
+    {
+        $instance = new self();
+
+        $instance->manga = $parser->getManga();
+        $instance->malId = $parser->getId();
+        $instance->url = $parser->getUrl();
+        $instance->type = $parser->getType();
+        $instance->votes = $parser->getHelpfulCount();
+        $instance->date = $parser->getDate();
+        $instance->scores = $parser->getMangaScores();
+        $instance->review = $parser->getContent();
+        $instance->chaptersRead = $parser->getChaptersRead();
+
+        return $instance;
+    }
+}
diff --git a/src/Model/User/Reviews.php → src/Model/User/Reviews/UserReviews.php b/src/Model/User/Reviews.php → src/Model/User/Reviews/UserReviews.php
@@ -1,19 +1,17 @@
 <?php
 
-namespace Jikan\Model\User;
+namespace Jikan\Model\User\Reviews;
 
 use Jikan\Model\Common\Collection\Pagination;
 use Jikan\Model\Common\Collection\Results;
-use Jikan\Model\Reviews\RecentReviews;
-use Jikan\Parser\Reviews\RecentReviewsParser;
-use Jikan\Parser\User\ReviewsParser;
+use Jikan\Parser\User\Reviews\UserReviewsParser;
 
 /**
- * Class ReviewsParser
+ * Class UserReviewsParser
  *
  * @package Jikan\Model
  */
-class Reviews extends Results implements Pagination
+class UserReviews extends Results implements Pagination
 {
 
     /**
@@ -27,10 +25,10 @@ class Reviews extends Results implements Pagination
     private $lastVisiblePage = 1;
 
     /**
-     * @param ReviewsParser $parser
-     * @return Reviews
+     * @param UserReviewsParser $parser
+     * @return UserReviews
      */
-    public static function fromParser(ReviewsParser $parser): Reviews
+    public static function fromParser(UserReviewsParser $parser): UserReviews
     {
         $instance = new self();
         $instance->results = $parser->getReviews();

diff --git a/src/MyAnimeList/MalClient.php b/src/MyAnimeList/MalClient.php
@@ -1168,16 +1168,15 @@ public function getUsernameById(Request\User\UsernameByIdRequest $request) : Mod
 
     /**
      * @param Request\User\UserReviewsRequest $request
-     * @return Model\User\Reviews
+     * @return Model\User\Reviews\UserReviews
      * @throws BadResponseException
      * @throws ParserException
      */
-    public function getUserReviews(Request\User\UserReviewsRequest $request) : Model\User\Reviews
+    public function getUserReviews(Request\User\UserReviewsRequest $request) : Model\User\Reviews\UserReviews
     {
         $crawler = $this->ghoutte->request('GET', $request->getPath());
         try {
-            $parser = new Parser\User\ReviewsParser($crawler);
-
+            $parser = new Parser\User\Reviews\UserReviewsParser($crawler);
             return $parser->getModel();
         } catch (\Exception $e) {
             throw ParserException::fromRequest($request, $e);