Merge pull request #17 from aledeg/release/1.1.2

Release 1.1.2

Author: aledeg

.github/workflows/tests.yml

@@ -0,0 +1,14 @@
+name: Automated tests
+
+on: [push, pull_request]
+
+jobs:
+  tests:
+    runs-on: ubuntu-22.04
+
+    steps:
+      - uses: actions/checkout@v3
+      - run: make install
+      - run: make coding-style
+      - run: make static-analysis
+      - run: make test-default

.gitignore

@@ -5,3 +5,4 @@ vendor/
 var/
 .phpunit.cache/
 phpunit.xml
+.php-cs-fixer.cache

.php-cs-fixer.dist.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+$finder = PhpCsFixer\Finder::create()
+    ->in(__DIR__)
+;
+
+$config = new PhpCsFixer\Config();
+return $config->setRules([
+        '@PSR12' => true,
+        'strict_param' => true,
+        'array_syntax' => ['syntax' => 'short'],
+    ])
+    ->setFinder($finder)
+;

Client/Client.php

@@ -6,14 +6,23 @@
 
 use RedditImage\Exception\ClientException;
 
-class Client {
+class Client
+{
     private string $userAgent;
 
-    public function __construct(string $userAgent) {
+    public function __construct(string $userAgent)
+    {
         $this->userAgent = $userAgent;
     }
 
-    public function jsonGet(string $url, array $headers = [], callable $payloadModifier = null): array {
+    /**
+     * @param string $url
+     * @param string[] $headers
+     * @param callable $payloadModifier
+     * @return array<mixed, mixed>
+     */
+    public function jsonGet(string $url, array $headers = [], callable $payloadModifier = null): array
+    {
         $ch = curl_init();
         curl_setopt_array($ch, [
             CURLOPT_URL => $url,
@@ -37,7 +46,13 @@ public function jsonGet(string $url, array $headers = [], callable $payloadModif
         return json_decode($jsonString, true, 512, JSON_THROW_ON_ERROR);
     }
 
-    public function isAccessible(string $url, array $headers = []): bool {
+    /**
+     * @param string $url
+     * @param string[] $headers
+     * @return bool
+     */
+    public function isAccessible(string $url, array $headers = []): bool
+    {
         $ch = curl_init();
         curl_setopt_array($ch, [
             CURLOPT_URL => $url,

Content.php

@@ -6,17 +6,17 @@
 
 use RedditImage\Exception\InvalidContentException;
 
-class Content {
-    private string $content;
+class Content
+{
     private string $preprocessed = '';
     private string $metadata = '';
     private ?string $contentLink = null;
     private ?string $commentsLink = null;
     private string $raw;
     private string $real = '';
 
-    public function __construct(string $content) {
-        $this->content = $content;
+    public function __construct(string $content)
+    {
         $this->raw = $content;
 
         $this->splitContent($content);
@@ -29,7 +29,8 @@ public function __construct(string $content) {
         }
     }
 
-    private function isValid(): bool {
+    private function isValid(): bool
+    {
         if ($this->metadata === '') {
             return false;
         }
@@ -42,35 +43,43 @@ private function isValid(): bool {
         return true;
     }
 
-    public function getContentLink(): ?string {
+    public function getContentLink(): ?string
+    {
         return $this->contentLink;
     }
 
-    public function getCommentsLink(): ?string {
+    public function getCommentsLink(): ?string
+    {
         return $this->commentsLink;
     }
 
-    public function getPreprocessed(): string {
+    public function getPreprocessed(): string
+    {
         return $this->preprocessed;
     }
 
-    public function getMetadata(): string {
+    public function getMetadata(): string
+    {
         return $this->metadata;
     }
 
-    public function getRaw(): string {
+    public function getRaw(): string
+    {
         return $this->raw;
     }
 
-    public function getReal(): string {
+    public function getReal(): string
+    {
         return $this->real;
     }
 
-    public function hasBeenPreprocessed(): bool {
+    public function hasBeenPreprocessed(): bool
+    {
         return '' !== $this->preprocessed;
     }
 
-    public function hasReal(): bool {
+    public function hasReal(): bool
+    {
         return '' !== $this->real;
     }
 
@@ -81,7 +90,8 @@ public function hasReal(): bool {
      * fetch quickly. For instance when API calls are involved. Thus we need to
      * separate the feed raw content from the preprocessed content.
      */
-    private function splitContent(string $content): void {
+    private function splitContent(string $content): void
+    {
         $dom = new \DomDocument('1.0', 'UTF-8');
         $dom->loadHTML(
             htmlspecialchars_decode(htmlentities(html_entity_decode($content))),
@@ -91,10 +101,10 @@ private function splitContent(string $content): void {
         $xpath = new \DOMXpath($dom);
         $redditImage = $xpath->query("//div[contains(@class,'reddit-image')]");
 
-        if (1 === $redditImage->length) {
+        if ($redditImage !== false && $redditImage->length === 1) {
             $node = $redditImage->item(0);
-            $this->preprocessed = $dom->saveHTML($node->parentNode->firstChild);
-            $this->raw = $dom->saveHTML($node->parentNode->lastChild);
+            $this->preprocessed = $dom->saveHTML($node->parentNode->firstChild) ?: '';
+            $this->raw = $dom->saveHTML($node->parentNode->lastChild) ?: '';
         }
     }
 
@@ -106,7 +116,8 @@ private function splitContent(string $content): void {
      * to the author page, the link to the current message, and the link to the
      * current message comment section.
      */
-    private function extractMetadata(): void {
+    private function extractMetadata(): void
+    {
         if (preg_match('#(?P<metadata>\s*?submitted.*</span>)#', $this->raw, $matches)) {
             $this->metadata = $matches['metadata'];
         }
@@ -119,7 +130,8 @@ private function extractMetadata(): void {
      *   - content link.
      *   - comments link.
      */
-    private function extractLinks(): void {
+    private function extractLinks(): void
+    {
         $dom = new \DomDocument('1.0', 'UTF-8');
         $dom->loadHTML(
             htmlspecialchars_decode(htmlentities(html_entity_decode($this->raw))),
@@ -134,6 +146,7 @@ private function extractLinks(): void {
                     break;
                 case '[comments]':
                     $this->commentsLink = $link->getAttribute('href');
+                    // no break
                 default:
                     break;
             }
@@ -147,7 +160,8 @@ private function extractLinks(): void {
      * class attribute is sanitized to data-sanitized-class attribute when
      * processed by SimplePie.
      */
-    private function extractReal(): void {
+    private function extractReal(): void
+    {
         $dom = new \DomDocument('1.0', 'UTF-8');
         $dom->loadHTML(
             htmlspecialchars_decode(htmlentities(html_entity_decode($this->raw))),
@@ -156,9 +170,9 @@ private function extractReal(): void {
 
         $xpath = new \DOMXpath($dom);
         $mdNode = $xpath->query("//div[contains(@data-sanitized-class,'md')]");
-        if (1 === $mdNode->length) {
+        if ($mdNode !== false && $mdNode->length === 1) {
             $node = $mdNode->item(0);
-            $this->real = $dom->saveHTML($node);
+            $this->real = $dom->saveHTML($node) ?: '';
         }
     }
 }

Exception/ClientException.php

@@ -4,7 +4,8 @@
 
 namespace RedditImage\Exception;
 
-use \Exception;
+use Exception;
 
-class ClientException extends Exception {
+class ClientException extends Exception
+{
 }

Exception/InvalidContentException.php

@@ -4,7 +4,8 @@
 
 namespace RedditImage\Exception;
 
-use \Exception;
+use Exception;
 
-class InvalidContentException extends Exception {
+class InvalidContentException extends Exception
+{
 }

Makefile

@@ -0,0 +1,35 @@
+##@ General
+
+.PHONY: help
+help: ## Display this help.
+	@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n  make \033[36m<target>\033[0m\n"} /^[a-zA-Z_0-9-]+:.*?##/ { printf "  \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
+
+##@ Setting environment
+.PHONY: install
+install: ## Install the dev environment (phpunit, phpstan, ...)
+	@docker-compose run composer install
+
+.PHONY: classmap
+classmap: ## Refresh classmap for autoloading
+	@docker-compose run composer dump-autoload
+
+##@ Testing
+.PHONY: coding-style
+coding-style: classmap ## Run the coding style fixer on all PHP files
+	@docker-compose run phpcsfixer fix --allow-risky yes
+
+.PHONY: static-analysis
+static-analysis: classmap ## Run the static analysis on all PHP files
+	@docker-compose run phpstan analyse --memory-limit 512M
+
+.PHONY: test-testsuite
+test-testsuite: classmap
+	@docker-compose run phpunit --testsuite $(TESTSUITE)
+
+.PHONY: test-default
+test-default: TESTSUITE=default
+test-default: test-testsuite ## Run the default testsuite
+
+.PHONY: test-canary
+test-canary: TESTSUITE=canary
+test-canary: test-testsuite ## Run the canary testsuite

Media/DomElementInterface.php

@@ -4,6 +4,7 @@
 
 namespace RedditImage\Media;
 
-interface DomElementInterface {
+interface DomElementInterface
+{
     public function toDomElement(\DomDocument $domDocument): \DomElement;
 }

Media/Image.php

@@ -4,14 +4,17 @@
 
 namespace RedditImage\Media;
 
-class Image implements DomElementInterface {
+class Image implements DomElementInterface
+{
     private string $url;
 
-    public function __construct(string $url) {
+    public function __construct(string $url)
+    {
         $this->url = $url;
     }
 
-    public function toDomElement(\DomDocument $domDocument): \DomElement {
+    public function toDomElement(\DomDocument $domDocument): \DomElement
+    {
         $image = $domDocument->createElement('img');
         $image->setAttribute('src', $this->url);
         $image->setAttribute('class', 'reddit-image');

Media/Link.php

@@ -4,18 +4,22 @@
 
 namespace RedditImage\Media;
 
-class Link implements DomElementInterface {
+class Link implements DomElementInterface
+{
     private string $url;
 
-    public function __construct(string $url) {
+    public function __construct(string $url)
+    {
         $this->url = $url;
     }
 
-    public function toDomElement(\DomDocument $domDocument): \DomElement {
+    public function toDomElement(\DomDocument $domDocument): \DomElement
+    {
         $p = $domDocument->createElement('p');
-        $a = $p->appendChild($domDocument->createElement('a'));
+        $a = $domDocument->createElement('a');
         $a->setAttribute('href', $this->url);
         $a->appendChild($domDocument->createTextNode($this->url));
+        $p->appendChild($a);
 
         return $p;
     }