From 41250ea97d799ef91228ca6fbdf027b655907c06 Mon Sep 17 00:00:00 2001
From: Michel Roux <xefir@crystalyx.net>
Date: Sat, 24 Jun 2023 18:37:25 +0200
Subject: [PATCH] Add stubs for gpodder (maybe it'll be useless)

---
 .php-cs-fixer.dist.php                        | 11 ++++-
 composer.json                                 |  6 +++
 composer.lock                                 | 12 ++---
 lib/AppInfo/Application.php                   |  3 +-
 lib/Controller/PageController.php             |  3 +-
 psalm.xml                                     |  1 +
 src/App.vue                                   |  2 +-
 .../Core/EpisodeAction/EpisodeAction.php      | 31 ++++++++++++
 .../EpisodeAction/EpisodeActionReader.php     | 17 +++++++
 .../Core/EpisodeAction/EpisodeActionSaver.php | 10 ++++
 .../Core/PodcastData/PodcastActionCounts.php  | 22 +++++++++
 .../Core/PodcastData/PodcastData.php          | 47 +++++++++++++++++++
 .../Core/PodcastData/PodcastDataReader.php    | 16 +++++++
 .../Core/PodcastData/PodcastMetrics.php       | 28 +++++++++++
 .../Core/PodcastData/PodcastMetricsReader.php | 15 ++++++
 .../SubscriptionChange/SubscriptionChange.php | 14 ++++++
 .../SubscriptionChangeRequestParser.php       | 13 +++++
 .../SubscriptionChangeSaver.php               | 10 ++++
 .../SubscriptionChangesReader.php             | 13 +++++
 19 files changed, 264 insertions(+), 10 deletions(-)
 create mode 100644 stubs/OCA/GPodderSync/Core/EpisodeAction/EpisodeAction.php
 create mode 100644 stubs/OCA/GPodderSync/Core/EpisodeAction/EpisodeActionReader.php
 create mode 100644 stubs/OCA/GPodderSync/Core/EpisodeAction/EpisodeActionSaver.php
 create mode 100644 stubs/OCA/GPodderSync/Core/PodcastData/PodcastActionCounts.php
 create mode 100644 stubs/OCA/GPodderSync/Core/PodcastData/PodcastData.php
 create mode 100644 stubs/OCA/GPodderSync/Core/PodcastData/PodcastDataReader.php
 create mode 100644 stubs/OCA/GPodderSync/Core/PodcastData/PodcastMetrics.php
 create mode 100644 stubs/OCA/GPodderSync/Core/PodcastData/PodcastMetricsReader.php
 create mode 100644 stubs/OCA/GPodderSync/Core/SubscriptionChange/SubscriptionChange.php
 create mode 100644 stubs/OCA/GPodderSync/Core/SubscriptionChange/SubscriptionChangeRequestParser.php
 create mode 100644 stubs/OCA/GPodderSync/Core/SubscriptionChange/SubscriptionChangeSaver.php
 create mode 100644 stubs/OCA/GPodderSync/Core/SubscriptionChange/SubscriptionChangesReader.php

diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
index f7bbdd8..3087b82 100644
--- a/.php-cs-fixer.dist.php
+++ b/.php-cs-fixer.dist.php
@@ -6,7 +6,16 @@ require_once './vendor/autoload.php';
 
 use Nextcloud\CodingStandard\Config;
 
-$config = new Config();
+class MyConfig extends Config {
+	public function getRules(): array
+	{
+		$rules = parent::getRules();
+		$rules['curly_braces_position']['classes_opening_brace'] = 'next_line_unless_newline_at_signature_end';
+		return $rules;
+	}
+}
+
+$config = new MyConfig();
 $config
 	->getFinder()
 	->ignoreVCSIgnored(true)
diff --git a/composer.json b/composer.json
index eec5845..3bb2907 100644
--- a/composer.json
+++ b/composer.json
@@ -15,6 +15,12 @@
 		"psalm:check": "psalm.phar --threads=1 --no-cache --show-info=true",
 		"psalm:fix": "psalm.phar --no-cache --alter --issues=InvalidReturnType,InvalidNullableReturnType,MissingParamType,InvalidFalsableReturnType"
 	},
+	"autoload": {
+		"psr-4": {
+			"OCA\\RePod\\": "lib/",
+			"OCA\\GPodderSync\\": "stubs/OCA/GPodderSync/"
+		}
+	},
 	"config": {
 		"platform": {
 			"php": "8.0"
diff --git a/composer.lock b/composer.lock
index f9caed9..8a55e84 100644
--- a/composer.lock
+++ b/composer.lock
@@ -94,16 +94,16 @@
         },
         {
             "name": "php-cs-fixer/shim",
-            "version": "v3.18.0",
+            "version": "v3.19.0",
             "source": {
                 "type": "git",
                 "url": "https://github.com/PHP-CS-Fixer/shim.git",
-                "reference": "a517e03dd0727336e502e071cc08e406ac878dba"
+                "reference": "80586ec0e69fb4216edf4e8f830869a3e28d962d"
             },
             "dist": {
                 "type": "zip",
-                "url": "https://api.github.com/repos/PHP-CS-Fixer/shim/zipball/a517e03dd0727336e502e071cc08e406ac878dba",
-                "reference": "a517e03dd0727336e502e071cc08e406ac878dba",
+                "url": "https://api.github.com/repos/PHP-CS-Fixer/shim/zipball/80586ec0e69fb4216edf4e8f830869a3e28d962d",
+                "reference": "80586ec0e69fb4216edf4e8f830869a3e28d962d",
                 "shasum": ""
             },
             "require": {
@@ -140,9 +140,9 @@
             "description": "A tool to automatically fix PHP code style",
             "support": {
                 "issues": "https://github.com/PHP-CS-Fixer/shim/issues",
-                "source": "https://github.com/PHP-CS-Fixer/shim/tree/v3.18.0"
+                "source": "https://github.com/PHP-CS-Fixer/shim/tree/v3.19.0"
             },
-            "time": "2023-06-18T22:26:36+00:00"
+            "time": "2023-06-24T11:07:33+00:00"
         },
         {
             "name": "psalm/phar",
diff --git a/lib/AppInfo/Application.php b/lib/AppInfo/Application.php
index e3713ad..cbf10a1 100644
--- a/lib/AppInfo/Application.php
+++ b/lib/AppInfo/Application.php
@@ -6,7 +6,8 @@ namespace OCA\RePod\AppInfo;
 
 use OCP\AppFramework\App;
 
-class Application extends App {
+class Application extends App
+{
 	public const APP_ID = 'repod';
 
 	public function __construct() {
diff --git a/lib/Controller/PageController.php b/lib/Controller/PageController.php
index d95623d..5dcce06 100644
--- a/lib/Controller/PageController.php
+++ b/lib/Controller/PageController.php
@@ -10,7 +10,8 @@ use OCP\AppFramework\Http\TemplateResponse;
 use OCP\IRequest;
 use OCP\Util;
 
-class PageController extends Controller {
+class PageController extends Controller
+{
 	public function __construct(IRequest $request) {
 		parent::__construct(Application::APP_ID, $request);
 	}
diff --git a/psalm.xml b/psalm.xml
index 1005f1b..6584df1 100644
--- a/psalm.xml
+++ b/psalm.xml
@@ -10,6 +10,7 @@
 >
 	<projectFiles>
 		<directory name="lib" />
+		<directory name="stubs" />
 		<ignoreFiles>
 			<directory name="vendor" />
 		</ignoreFiles>
diff --git a/src/App.vue b/src/App.vue
index 29a328d..e0501e9 100644
--- a/src/App.vue
+++ b/src/App.vue
@@ -1,7 +1,7 @@
 <template>
 	<NcContent app-name="repod">
 		<NcAppNavigation>
-			<NcAppNavigationNew :text="t('repod', 'New note')"
+			<NcAppNavigationNew :text="t('repod', 'Add a podcast')"
 				@click="discover" />
 			<ul>
 				<NcAppNavigationItem v-for="note in notes"
diff --git a/stubs/OCA/GPodderSync/Core/EpisodeAction/EpisodeAction.php b/stubs/OCA/GPodderSync/Core/EpisodeAction/EpisodeAction.php
new file mode 100644
index 0000000..b0d6de8
--- /dev/null
+++ b/stubs/OCA/GPodderSync/Core/EpisodeAction/EpisodeAction.php
@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OCA\GPodderSync\Core\EpisodeAction;
+
+interface EpisodeAction
+{
+	public function getPodcast(): string;
+
+	public function getEpisode(): string;
+
+	public function getAction(): string;
+
+	public function getTimestamp(): string;
+
+	public function getStarted(): int;
+
+	public function getPosition(): int;
+
+	public function getTotal(): int;
+
+	public function getGuid() : ?string;
+
+	public function getId(): int;
+
+	/**
+	 * @return array<string,mixed>
+	 */
+	public function toArray(): array;
+}
diff --git a/stubs/OCA/GPodderSync/Core/EpisodeAction/EpisodeActionReader.php b/stubs/OCA/GPodderSync/Core/EpisodeAction/EpisodeActionReader.php
new file mode 100644
index 0000000..a169996
--- /dev/null
+++ b/stubs/OCA/GPodderSync/Core/EpisodeAction/EpisodeActionReader.php
@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OCA\GPodderSync\Core\EpisodeAction;
+
+use InvalidArgumentException;
+
+interface EpisodeActionReader
+{
+	/**
+	 * @param array $episodeActionsArray []
+	 * @return EpisodeAction[]
+	 * @throws InvalidArgumentException
+	 */
+	public function fromArray(array $episodeActionsArray): array;
+}
diff --git a/stubs/OCA/GPodderSync/Core/EpisodeAction/EpisodeActionSaver.php b/stubs/OCA/GPodderSync/Core/EpisodeAction/EpisodeActionSaver.php
new file mode 100644
index 0000000..b0da7a6
--- /dev/null
+++ b/stubs/OCA/GPodderSync/Core/EpisodeAction/EpisodeActionSaver.php
@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OCA\GPodderSync\Core\EpisodeAction;
+
+interface EpisodeActionSaver
+{
+	public function saveEpisodeActions(array $episodeActionsArray, string $userId): array;
+}
diff --git a/stubs/OCA/GPodderSync/Core/PodcastData/PodcastActionCounts.php b/stubs/OCA/GPodderSync/Core/PodcastData/PodcastActionCounts.php
new file mode 100644
index 0000000..aed1c0d
--- /dev/null
+++ b/stubs/OCA/GPodderSync/Core/PodcastData/PodcastActionCounts.php
@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OCA\GPodderSync\Core\PodcastData;
+
+use JsonSerializable;
+
+interface PodcastActionCounts extends JsonSerializable
+{
+	public function incrementAction(string $action): void;
+
+	/**
+	 * @return array<string, int>
+	 */
+	public function toArray(): array;
+
+	/**
+	 * @return array<string, int>
+	 */
+	public function jsonSerialize(): array;
+}
diff --git a/stubs/OCA/GPodderSync/Core/PodcastData/PodcastData.php b/stubs/OCA/GPodderSync/Core/PodcastData/PodcastData.php
new file mode 100644
index 0000000..0aa1fd2
--- /dev/null
+++ b/stubs/OCA/GPodderSync/Core/PodcastData/PodcastData.php
@@ -0,0 +1,47 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OCA\GPodderSync\Core\PodcastData;
+
+use Exception;
+use JsonSerializable;
+
+interface PodcastData extends JsonSerializable
+{
+	/**
+	 * @return PodcastData
+	 * @throws Exception if the XML data could not be parsed.
+	 */
+	public static function parseRssXml(string $xmlString, ?int $fetchedAtUnix = null): PodcastData;
+
+	public function getTitle(): ?string;
+
+	public function getAuthor(): ?string;
+
+	public function getLink(): ?string;
+
+	public function getDescription(): ?string;
+
+	public function getImageUrl(): ?string;
+
+	public function getFetchedAtUnix(): ?int;
+
+	public function getImageBlob(): ?string;
+
+	public function setImageBlob(?string $blob): void;
+
+	public function __toString() : string;
+
+	/**
+	 * @return array<string,mixed>
+	 */
+	public function toArray(): array;
+
+	/**
+	 * @return array<string,mixed>
+	 */
+	public function jsonSerialize(): array;
+
+	public static function fromArray(array $data): PodcastData;
+}
diff --git a/stubs/OCA/GPodderSync/Core/PodcastData/PodcastDataReader.php b/stubs/OCA/GPodderSync/Core/PodcastData/PodcastDataReader.php
new file mode 100644
index 0000000..06f6dbf
--- /dev/null
+++ b/stubs/OCA/GPodderSync/Core/PodcastData/PodcastDataReader.php
@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OCA\GPodderSync\Core\PodcastData;
+
+interface PodcastDataReader
+{
+	public function getCachedOrFetchPodcastData(string $url, string $userId): ?PodcastData;
+
+	public function fetchPodcastData(string $url, string $userId): ?PodcastData;
+
+	public function tryGetCachedPodcastData(string $url): ?PodcastData;
+
+	public function trySetCachedPodcastData(string $url, PodcastData $data): bool;
+}
diff --git a/stubs/OCA/GPodderSync/Core/PodcastData/PodcastMetrics.php b/stubs/OCA/GPodderSync/Core/PodcastData/PodcastMetrics.php
new file mode 100644
index 0000000..84d1702
--- /dev/null
+++ b/stubs/OCA/GPodderSync/Core/PodcastData/PodcastMetrics.php
@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OCA\GPodderSync\Core\PodcastData;
+
+use JsonSerializable;
+
+interface PodcastMetrics extends JsonSerializable
+{
+	public function getUrl(): string;
+
+	public function getActionCounts(): PodcastActionCounts;
+
+	public function getListenedSeconds(): int;
+
+	public function addListenedSeconds(int $seconds): void;
+
+	/**
+	 * @return array<string,mixed>
+	 */
+	public function toArray(): array;
+
+	/**
+	 * @return array<string,mixed>
+	 */
+	public function jsonSerialize(): array;
+}
diff --git a/stubs/OCA/GPodderSync/Core/PodcastData/PodcastMetricsReader.php b/stubs/OCA/GPodderSync/Core/PodcastData/PodcastMetricsReader.php
new file mode 100644
index 0000000..784abe3
--- /dev/null
+++ b/stubs/OCA/GPodderSync/Core/PodcastData/PodcastMetricsReader.php
@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OCA\NextPod\Core\PodcastData;
+
+use OCA\GPodderSync\Core\PodcastData\PodcastMetrics;
+
+interface PodcastMetricsReader
+{
+	/**
+	 * @return PodcastMetrics[]
+	 */
+	public function metrics(string $userId): array;
+}
diff --git a/stubs/OCA/GPodderSync/Core/SubscriptionChange/SubscriptionChange.php b/stubs/OCA/GPodderSync/Core/SubscriptionChange/SubscriptionChange.php
new file mode 100644
index 0000000..2437139
--- /dev/null
+++ b/stubs/OCA/GPodderSync/Core/SubscriptionChange/SubscriptionChange.php
@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OCA\NextPod\Core\SubscriptionChange;
+
+interface SubscriptionChange
+{
+	public function isSubscribed(): bool;
+
+	public function getUrl(): string;
+
+	public function __toString() : string;
+}
diff --git a/stubs/OCA/GPodderSync/Core/SubscriptionChange/SubscriptionChangeRequestParser.php b/stubs/OCA/GPodderSync/Core/SubscriptionChange/SubscriptionChangeRequestParser.php
new file mode 100644
index 0000000..346bb97
--- /dev/null
+++ b/stubs/OCA/GPodderSync/Core/SubscriptionChange/SubscriptionChangeRequestParser.php
@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OCA\NextPod\Core\SubscriptionChange;
+
+interface SubscriptionChangeRequestParser
+{
+	/**
+	 * @return SubscriptionChange[]
+	 */
+	public function createSubscriptionChangeList(array $urlsSubscribed, array $urlsUnsubscribed): array;
+}
diff --git a/stubs/OCA/GPodderSync/Core/SubscriptionChange/SubscriptionChangeSaver.php b/stubs/OCA/GPodderSync/Core/SubscriptionChange/SubscriptionChangeSaver.php
new file mode 100644
index 0000000..0f689e7
--- /dev/null
+++ b/stubs/OCA/GPodderSync/Core/SubscriptionChange/SubscriptionChangeSaver.php
@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OCA\NextPod\Core\SubscriptionChange;
+
+interface SubscriptionChangeSaver
+{
+	public function saveSubscriptionChanges(array $urlsSubscribed, array $urlsUnsubscribed, string $userId): void;
+}
diff --git a/stubs/OCA/GPodderSync/Core/SubscriptionChange/SubscriptionChangesReader.php b/stubs/OCA/GPodderSync/Core/SubscriptionChange/SubscriptionChangesReader.php
new file mode 100644
index 0000000..9250544
--- /dev/null
+++ b/stubs/OCA/GPodderSync/Core/SubscriptionChange/SubscriptionChangesReader.php
@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OCA\NextPod\Core\SubscriptionChange;
+
+interface SubscriptionChangesReader
+{
+	/**
+	 * @return SubscriptionChange[]
+	 */
+	public static function mapToSubscriptionsChanges(array $urls, bool $subscribed): array;
+}