refactor: Run rector on project

Signed-off-by: Carl Schwan <carlschwan@kde.org>

Author: CarlSchwan

.github/workflows/psalm.yml

@@ -56,7 +56,7 @@ jobs:
         run: composer require --dev roave/security-advisories:dev-latest
 
       - name: Install nextcloud/ocp
-        run: composer require --dev nextcloud/ocp:dev-${{ steps.versions.outputs.branches-max }} --ignore-platform-reqs --with-dependencies
+        run: composer require --dev nextcloud/ocp:dev-${{ steps.versions.outputs.branches-min }} --ignore-platform-reqs --with-dependencies
 
       - name: Run coding standards check
         run: composer run psalm -- --threads=1 --monochrome --no-progress --output-format=github

composer.json

@@ -19,6 +19,7 @@
 		"test:integration:dev": "phpunit -c tests/phpunit.integration.xml --no-coverage --order-by=defects --stop-on-defect --fail-on-warning --stop-on-error --stop-on-failure",
 		"test:unit": "phpunit -c tests/phpunit.unit.xml --fail-on-warning",
 		"test:unit:dev": "phpunit -c tests/phpunit.unit.xml --no-coverage --order-by=defects --stop-on-defect --fail-on-warning --stop-on-error --stop-on-failure",
+		"rector": "rector && composer cs:fix",
 		"post-install-cmd": [
 			"[ $COMPOSER_DEV_MODE -eq 0 ] || composer bin all install --ansi"
 		],

lib/AppInfo/Application.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 /**
  * ownCloud - maps
  *
@@ -9,7 +11,6 @@
  * @author Sander Brand <brantje@gmail.com>, Vinzenz Rosenkranz <vinzenz.rosenkranz@gmail.com>
  * @copyright Sander Brand 2014, Vinzenz Rosenkranz 2016, 2017
  */
-
 namespace OCA\Maps\AppInfo;
 
 use OCA\DAV\Events\CardCreatedEvent;
@@ -76,9 +77,10 @@ public function boot(IBootContext $context): void {
 	private function registerFeaturePolicy(): void {
 		$dispatcher = $this->getContainer()->get(IEventDispatcher::class);
 
-		$dispatcher->addListener(AddFeaturePolicyEvent::class, function (AddFeaturePolicyEvent $e) {
+		$dispatcher->addListener(AddFeaturePolicyEvent::class, function (AddFeaturePolicyEvent $e): void {
 			$fp = new EmptyFeaturePolicy();
-			$fp->addAllowedGeoLocationDomain('\'self\'');
+			$fp->addAllowedGeoLocationDomain("'self'");
+
 			$e->addPolicy($fp);
 		});
 	}

lib/BackgroundJob/AddPhotoJob.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 /**
  * Nextcloud - maps
  *
@@ -9,7 +11,6 @@
  * @author Julien Veyssier
  * @copyright Julien Veyssier 2019
  */
-
 namespace OCA\Maps\BackgroundJob;
 
 use OCA\Maps\Service\PhotofilesService;
@@ -22,45 +23,36 @@
 
 class AddPhotoJob extends QueuedJob {
 
-	/** @var PhotofilesService */
-	private PhotofilesService $photofilesService;
-
-	/** @var IRootFolder */
-	private IRootFolder $root;
+	private readonly IRootFolder $root;
 
-	/** @var ICacheFactory */
-	private ICacheFactory $cacheFactory;
+	private readonly ICacheFactory $cacheFactory;
 
-	/** @var ICache */
-	private ICache $backgroundJobCache;
+	private readonly ICache $backgroundJobCache;
 
 	/**
 	 * UserInstallScanJob constructor.
 	 *
 	 * A QueuedJob to scan user storage for photos and tracks
-	 *
-	 * @param ITimeFactory $timeFactory
-	 * @param PhotofilesService $photofilesService
 	 */
 	public function __construct(
 		ITimeFactory $timeFactory,
 		IRootFolder $root,
-		PhotofilesService $photofilesService,
+		private readonly PhotofilesService $photofilesService,
 		ICacheFactory $cacheFactory,
 	) {
 		parent::__construct($timeFactory);
-		$this->photofilesService = $photofilesService;
 		$this->root = $root;
 		$this->cacheFactory = $cacheFactory;
 		$this->backgroundJobCache = $this->cacheFactory->createDistributed('maps:background-jobs');
 	}
 
-	public function run($argument) {
+	public function run($argument): void {
 		$userFolder = $this->root->getUserFolder($argument['userId']);
 		$files = $userFolder->getById($argument['photoId']);
 		if (empty($files)) {
 			return;
 		}
+
 		$file = array_shift($files);
 		$this->photofilesService->addPhotoNow($file, $argument['userId']);
 

lib/BackgroundJob/LaunchUsersInstallScanJob.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 /**
  * Nextcloud - maps
  *
@@ -9,14 +11,14 @@
  * @author Julien Veyssier
  * @copyright Julien Veyssier 2019
  */
-
 namespace OCA\Maps\BackgroundJob;
 
 use OCP\AppFramework\Utility\ITimeFactory;
 use OCP\BackgroundJob\IJobList;
 use OCP\BackgroundJob\QueuedJob;
 use OCP\IUser;
 use OCP\IUserManager;
+use OCP\Server;
 use Psr\Log\LoggerInterface;
 
 class LaunchUsersInstallScanJob extends QueuedJob {
@@ -25,20 +27,18 @@ class LaunchUsersInstallScanJob extends QueuedJob {
 	 * LaunchUsersInstallScanJob constructor.
 	 *
 	 * A QueuedJob to launch a scan job for each user
-	 *
-	 * @param IJobList $jobList
 	 */
 	public function __construct(
 		ITimeFactory $timeFactory,
-		private IJobList $jobList,
-		private IUserManager $userManager,
+		private readonly IJobList $jobList,
+		private readonly IUserManager $userManager,
 	) {
 		parent::__construct($timeFactory);
 	}
 
-	public function run($argument) {
-		\OCP\Server::get(LoggerInterface::class)->debug('Launch users install scan jobs cronjob executed');
-		$this->userManager->callForSeenUsers(function (IUser $user) {
+	public function run($argument): void {
+		Server::get(LoggerInterface::class)->debug('Launch users install scan jobs cronjob executed');
+		$this->userManager->callForSeenUsers(function (IUser $user): void {
 			$this->jobList->add(UserInstallScanJob::class, ['userId' => $user->getUID()]);
 		});
 	}

lib/BackgroundJob/LookupMissingGeoJob.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 /**
  * Nextcloud - maps
  *
@@ -9,13 +11,13 @@
  * @author Arne Hamann
  * @copyright Arne Hamann 2019
  */
-
 namespace OCA\Maps\BackgroundJob;
 
 use OCA\Maps\Service\AddressService;
 use OCP\AppFramework\Utility\ITimeFactory;
 use OCP\BackgroundJob\IJobList;
 use OCP\BackgroundJob\QueuedJob;
+use OCP\Server;
 use Psr\Log\LoggerInterface;
 
 class LookupMissingGeoJob extends QueuedJob {
@@ -27,14 +29,14 @@ class LookupMissingGeoJob extends QueuedJob {
 	 */
 	public function __construct(
 		ITimeFactory $timeFactory,
-		private AddressService $addressService,
-		private IJobList $jobList,
+		private readonly AddressService $addressService,
+		private readonly IJobList $jobList,
 	) {
 		parent::__construct($timeFactory);
 	}
 
-	public function run($argument) {
-		\OCP\Server::get(LoggerInterface::class)->debug('Maps address lookup cronjob executed');
+	public function run($argument): void {
+		Server::get(LoggerInterface::class)->debug('Maps address lookup cronjob executed');
 		// lookup at most 200 addresses
 		if (!$this->addressService->lookupMissingGeo(200)) {
 			// if not all addresses where looked up successfully add a new job for next time

lib/BackgroundJob/UpdatePhotoByFileJob.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 /**
  * Nextcloud - maps
  *
@@ -9,7 +11,6 @@
  * @author Julien Veyssier
  * @copyright Julien Veyssier 2019
  */
-
 namespace OCA\Maps\BackgroundJob;
 
 use OCA\Maps\Service\PhotofilesService;
@@ -22,7 +23,7 @@
 use OCP\ICacheFactory;
 
 class UpdatePhotoByFileJob extends QueuedJob {
-	private ICache $backgroundJobCache;
+	private readonly ICache $backgroundJobCache;
 
 	/**
 	 * UserInstallScanJob constructor.
@@ -31,9 +32,9 @@ class UpdatePhotoByFileJob extends QueuedJob {
 	 */
 	public function __construct(
 		ITimeFactory $timeFactory,
-		private IRootFolder $root,
-		private PhotofilesService $photofilesService,
-		private ICacheFactory $cacheFactory,
+		private readonly IRootFolder $root,
+		private readonly PhotofilesService $photofilesService,
+		private readonly ICacheFactory $cacheFactory,
 	) {
 		parent::__construct($timeFactory);
 		$this->backgroundJobCache = $this->cacheFactory->createDistributed('maps:background-jobs');
@@ -45,6 +46,7 @@ public function run($argument): void {
 		if (!$file instanceof File) {
 			return;
 		}
+
 		$this->photofilesService->updateByFileNow($file);
 
 		$counter = $this->backgroundJobCache->get('recentlyUpdated:' . $argument['userId']) ?? 0;

lib/BackgroundJob/UserInstallScanJob.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 /**
  * Nextcloud - maps
  *
@@ -9,71 +11,65 @@
  * @author Julien Veyssier
  * @copyright Julien Veyssier 2019
  */
-
 namespace OCA\Maps\BackgroundJob;
 
 use OCA\Maps\Service\PhotofilesService;
 use OCA\Maps\Service\TracksService;
 use OCP\AppFramework\Utility\ITimeFactory;
 use OCP\BackgroundJob\IJobList;
 use OCP\BackgroundJob\QueuedJob;
-
 use OCP\IConfig;
+
 use OCP\IUserManager;
+use OCP\Server;
 use Psr\Log\LoggerInterface;
 
 class UserInstallScanJob extends QueuedJob {
 
-	private IJobList $jobList;
-	private IConfig $config;
-	private IUserManager $userManager;
-	private PhotofilesService $photofilesService;
-	private TracksService $tracksService;
+	private readonly IConfig $config;
+
 
 	/**
 	 * UserInstallScanJob constructor.
 	 *
 	 * A QueuedJob to scan user storage for photos and tracks
-	 *
-	 * @param IJobList $jobList
 	 */
-	public function __construct(ITimeFactory $timeFactory, IJobList $jobList,
+	public function __construct(
+		ITimeFactory $timeFactory,
+		IJobList $jobList,
 		IUserManager $userManager,
 		IConfig $config,
-		PhotofilesService $photofilesService,
-		TracksService $tracksService) {
+		private readonly PhotofilesService $photofilesService,
+		private readonly TracksService $tracksService,
+	) {
 		parent::__construct($timeFactory);
 		$this->config = $config;
-		$this->jobList = $jobList;
-		$this->userManager = $userManager;
-		$this->photofilesService = $photofilesService;
-		$this->tracksService = $tracksService;
 	}
 
-	public function run($argument) {
+	public function run($argument): void {
 		$userId = $argument['userId'];
-		\OCP\Server::get(LoggerInterface::class)->debug('Launch user install scan job for ' . $userId . ' cronjob executed');
+		Server::get(LoggerInterface::class)->debug('Launch user install scan job for ' . $userId . ' cronjob executed');
 		// scan photos and tracks for given user
 		$this->rescanUserPhotos($userId);
 		$this->rescanUserTracks($userId);
 		$this->config->setUserValue($userId, 'maps', 'installScanDone', 'yes');
 	}
 
-	private function rescanUserPhotos($userId) {
+	private function rescanUserPhotos($userId): void {
 		//$this->output->info('======== User '.$userId.' ========'."\n");
 		$c = 1;
 		foreach ($this->photofilesService->rescan($userId) as $path) {
 			//$this->output->info('['.$c.'] Photo "'.$path.'" added'."\n");
-			$c++;
+			++$c;
 		}
 	}
 
-	private function rescanUserTracks($userId) {
+	private function rescanUserTracks($userId): void {
 		//$this->output->info('======== User '.$userId.' ========'."\n");
 		$c = 1;
 		foreach ($this->tracksService->rescan($userId) as $path) {
 			//$this->output->info('['.$c.'] Track "'.$path.'" added'."\n");
-			$c++;
+			++$c;
 		}
 	}
 

lib/Command/RegisterMimetypes.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 /**
  * Nextcloud - maps
  *
@@ -9,7 +11,6 @@
  * @author Piotr Bator <prbator@gmail.com>
  * @copyright Piotr Bator 2017
  */
-
 namespace OCA\Maps\Command;
 
 use OCA\Maps\Service\MimetypeService;
@@ -19,11 +20,10 @@
 
 class RegisterMimetypes extends Command {
 
-	protected MimetypeService $mimetypeService;
-
-	public function __construct(MimetypeService $mimetypeService) {
+	public function __construct(
+		protected MimetypeService $mimetypeService,
+	) {
 		parent::__construct();
-		$this->mimetypeService = $mimetypeService;
 	}
 
 	/**
@@ -34,11 +34,6 @@ protected function configure() {
 			->setDescription('Registers the maps mimetypes for existing and new files.');
 	}
 
-	/**
-	 * @param InputInterface $input
-	 * @param OutputInterface $output
-	 * @return int
-	 */
 	protected function execute(InputInterface $input, OutputInterface $output): int {
 		$output->writeln('Register mimetypes for existing files');
 		$this->mimetypeService->registerForExistingFiles();