Merge pull request #543 from jikan-me/feature/industry-news

Industry News

.gitignore

@@ -8,3 +8,4 @@ composer.phar
 .phpunit.result.cache
 .phpdoc
 .phive
+.phpunit.cache

phpunit.xml

@@ -6,6 +6,10 @@
          failOnWarning="true"
          colors="true"
          failOnEmptyTestSuite="true"
+         displayDetailsOnTestsThatTriggerDeprecations="true"
+         displayDetailsOnTestsThatTriggerErrors="true"
+         displayDetailsOnTestsThatTriggerNotices="true"
+         displayDetailsOnTestsThatTriggerWarnings="true"
 >
   <testsuites>
     <testsuite name="unit">

src/Helper/JString.php

@@ -78,4 +78,13 @@ public static function isStringFloat(string $string): bool
     {
         return is_numeric($string) && str_contains($string, '.');
     }
+
+    public static function ifEmptyStringReturnNull(string $string): ?string
+    {
+        if (empty($string)) {
+            return null;
+        }
+
+        return $string;
+    }
 }

src/Helper/Parser.php

@@ -51,6 +51,19 @@ public static function idFromUrl(string $url): int
         return (int) preg_replace('#https://myanimelist.net(/\w+/)(\d+).*#', '$2', $url);
     }
 
+    /**
+     * Extract a string id from a mal url
+     *
+     * @param string $url
+     *
+     * @return string
+     */
+    public static function stringIdFromUrl(string $url): string
+    {
+        $urlParts = explode("/", parse_url($url)['path']);
+        return $urlParts[array_key_last($urlParts)];
+    }
+
     /**
      * Extract club ID from MAL URl
      *

src/Model/Common/MalUrl.php

@@ -14,12 +14,12 @@ class MalUrl
     /**
      * @var string
      */
-    private $name;
+    private string $name;
 
     /**
      * @var string
      */
-    private $url;
+    private string $url;
 
     /**
      * Genre constructor.

src/Model/Common/NewsMeta.php

@@ -0,0 +1,160 @@
+<?php
+
+namespace Jikan\Model\Common;
+
+use Jikan\Model\Resource\NewsImageResource\NewsImageResource;
+use Jikan\Parser\Common\NewsMetaParser;
+
+/**
+ * Class NewsMeta
+ *
+ * @package Jikan\Model
+ */
+class NewsMeta
+{
+    /**
+     * @var int
+     */
+    private int $malId;
+
+    /**
+     * @var string
+     */
+    private string $url;
+
+    /**
+     * @var string
+     */
+    private string $title;
+
+    /**
+     * @var \DateTimeImmutable
+     */
+    private \DateTimeImmutable $date;
+
+    /**
+     * @var string
+     */
+    private string $authorUsername;
+
+    /**
+     * @var string
+     */
+    private string $authorUrl;
+
+    /**
+     * @var string
+     */
+    private string $forumUrl;
+
+    /**
+     * @var NewsImageResource
+     */
+    private NewsImageResource $images;
+
+    /**
+     * @var int
+     */
+    private int $comments;
+
+    /**
+     * @param NewsMetaParser $parser
+     * @return self
+     */
+    public static function fromParser(NewsMetaParser $parser): self
+    {
+        $instance = new self();
+
+        $instance->malId = $parser->getMalId();
+        $instance->url = $parser->getUrl();
+        $instance->title = $parser->getTitle();
+        $instance->comments = $parser->getComments();
+        $instance->authorUsername = $parser->getAuthor()->getName();
+        $instance->authorUrl = $parser->getAuthor()->getUrl();
+        $instance->forumUrl = $parser->getDiscussionLink();
+        $instance->images = NewsImageResource::factory($parser->getImageUrl());
+        $instance->date = $parser->getDate();
+
+        return $instance;
+    }
+
+    /**
+     * @return string
+     */
+    public function __toString()
+    {
+        return $this->title;
+    }
+
+    /**
+     * @return int
+     */
+    public function getMalId(): int
+    {
+        return $this->malId;
+    }
+
+    /**
+     * @return string
+     */
+    public function getUrl(): string
+    {
+        return $this->url;
+    }
+
+    /**
+     * @return string
+     */
+    public function getTitle(): string
+    {
+        return $this->title;
+    }
+
+    /**
+     * @return \DateTimeImmutable
+     */
+    public function getDate(): \DateTimeImmutable
+    {
+        return $this->date;
+    }
+
+    /**
+     * @return string
+     */
+    public function getAuthorUsername(): string
+    {
+        return $this->authorUsername;
+    }
+
+    /**
+     * @return string
+     */
+    public function getAuthorUrl(): string
+    {
+        return $this->authorUrl;
+    }
+
+    /**
+     * @return string
+     */
+    public function getForumUrl(): string
+    {
+        return $this->forumUrl;
+    }
+
+    /**
+     * @return NewsImageResource
+     */
+    public function getImages(): NewsImageResource
+    {
+        return $this->images;
+    }
+
+    /**
+     * @return int
+     */
+    public function getComments(): int
+    {
+        return $this->comments;
+    }
+}

src/Model/Common/TagMeta.php

@@ -0,0 +1,92 @@
+<?php
+
+namespace Jikan\Model\Common;
+
+use Jikan\Helper\Parser;
+use Jikan\Parser\Common\TagUrlParser;
+
+/**
+ * Class ItemMeta
+ *
+ * @package Jikan\Model
+ */
+class TagMeta
+{
+    /**
+     * @var string
+     */
+    private string $name;
+    /**
+     * @var string
+     */
+    private string $malId;
+    /**
+     * @var string
+     */
+    private string $url;
+    /**
+     * @var string
+     */
+    private string $type;
+    /**
+     * @var string|null
+     */
+    private ?string $description;
+
+
+    /**
+     * @param string $name
+     * @param string $url
+     * @param string $type
+     * @param string|null $description
+     */
+    public function __construct(string $name, string $url, string $type, ?string $description)
+    {
+        $this->url = $url;
+        $this->name = $name;
+        $this->type = $type;
+        $this->description = $description;
+        $this->malId = Parser::stringIdFromUrl($this->url);
+    }
+
+    /**
+     * @return string
+     */
+    public function getName(): string
+    {
+        return $this->name;
+    }
+
+    /**
+     * @return string
+     */
+    public function getMalId(): string
+    {
+        return $this->malId;
+    }
+
+    /**
+     * @return string
+     */
+    public function getUrl(): string
+    {
+        return $this->url;
+    }
+
+    /**
+     * @return string
+     */
+    public function getType(): string
+    {
+        return $this->type;
+    }
+
+    /**
+     * @return string|null
+     */
+    public function getDescription(): ?string
+    {
+        return $this->description;
+    }
+
+}

src/Model/Common/TagUrl.php

@@ -0,0 +1,71 @@
+<?php
+
+namespace Jikan\Model\Common;
+
+/**
+ * Class Url
+ *
+ * @package Jikan\Model
+ */
+class TagUrl
+{
+    /**
+     * @var string
+     */
+    private string $malId;
+
+    /**
+     * @var string
+     */
+    private string $name;
+
+    /**
+     * @var string
+     */
+    private string $url;
+
+    /**
+     * Genre constructor.
+     *
+     * @param string $name
+     * @param string $url
+     */
+    public function __construct(string $malId, string $name, string $url)
+    {
+        $this->malId = $malId;
+        $this->name = $name;
+        $this->url = $url;
+    }
+
+    /**
+     * @return string
+     */
+    public function __toString(): string
+    {
+        return $this->name;
+    }
+
+    /**
+     * @return string
+     */
+    public function getMalId(): string
+    {
+        return $this->malId;
+    }
+
+    /**
+     * @return string
+     */
+    public function getName(): string
+    {
+        return $this->name;
+    }
+
+    /**
+     * @return string
+     */
+    public function getUrl(): string
+    {
+        return $this->url;
+    }
+}