Merge pull request #5238 from Catrobat/stormClean

Automatic Code Clean up from Phpstorm IDE
Catrobat · Sep 11, 2024 · 926b773 · 926b773
2 parents 2af75cc + b4f39f4
commit 926b773
Show file tree

Hide file tree

Showing 118 changed files with 890 additions and 429 deletions.
diff --git a/.gitignore b/.gitignore
@@ -97,8 +97,6 @@ yarn-error.log
 
 ###> symfony/phpunit-bridge ###
 .phpunit
-.phpunit.result.cache
-/phpunit.xml
 ###< symfony/phpunit-bridge ###
 
 ###> friends-of-behat/symfony-extension ###

diff --git a/bin/checkCatroidRepositoryForNewBricks b/bin/checkCatroidRepositoryForNewBricks
@@ -18,14 +18,12 @@ $url2 = 'https://raw.githubusercontent.com/Catrobat/Catroid/3204098b163b248cd0bb
 $catroid_data_set_1 = file_get_contents($url1);
 $catroid_data_set_2 = file_get_contents($url2);
 
-if (!$catroid_data_set_1)
-{
+if (!$catroid_data_set_1) {
   echo 'XstreamSerializer.java could not be downloaded';
   exit(1);
 }
 
-if (!$catroid_data_set_2)
-{
+if (!$catroid_data_set_2) {
   echo 'CategoryBricksFactory.java could not be downloaded';
   exit(1);
 }
@@ -49,8 +47,7 @@ asort($all_catroid_bricks_and_scripts);
 $path = './src/Project/CatrobatCode/Parser/Constants.php';
 $catroweb_data_set = file_get_contents($path);
 
-if (!$catroweb_data_set)
-{
+if (!$catroweb_data_set) {
   echo "Constants.php couldn't be read";
   exit(1);
 }
@@ -66,49 +63,47 @@ asort($all_catroweb_bricks_and_scripts);
 $diff_result_not_in_app_but_web = array_diff($all_catroweb_bricks_and_scripts, $all_catroid_bricks_and_scripts);
 $diff_result_not_in_web_but_app = array_diff($all_catroid_bricks_and_scripts, $all_catroweb_bricks_and_scripts);
 
-if (count($diff_result_not_in_web_but_app) > 0 || count($diff_result_not_in_app_but_web) > 0)
-{
-  $message = '';
+if (count($diff_result_not_in_web_but_app) > 0 || count($diff_result_not_in_app_but_web) > 0) {
 
-  $message .= count($diff_result_not_in_app_but_web) > 0 ?
-    "These blocks are only defined in catroweb but not in the app: \n".
-    print_r($diff_result_not_in_app_but_web, true)."\n".
+  $message = count($diff_result_not_in_app_but_web) > 0 ?
+    "These blocks are only defined in catroweb but not in the app: \n" .
+    print_r($diff_result_not_in_app_but_web, true) . "\n" .
 
-    '//'."\n".
-    '// For new deprecated bricks: '."\n".
-    '//'."\n".
-    "// 1) Set the correct Brick/Scripts classes image to 'Constants::DEPRECATED_SCRIPT_IMG'"."\n".
-    "//    The block should from now count to the 'other' category."."\n".
-    '//    E.g look at src/Catrobat/CatrobatCode/Parser/Scripts/CollisionScript.php'."\n".
-    '//'."\n".
-    '// 2) Finally add it in this test to the deprecated_bricks array'."\n".
-    '//'."\n\n" : '';
+    '//' . "\n" .
+    '// For new deprecated bricks: ' . "\n" .
+    '//' . "\n" .
+    "// 1) Set the correct Brick/Scripts classes image to 'Constants::DEPRECATED_SCRIPT_IMG'" . "\n" .
+    "//    The block should from now count to the 'other' category." . "\n" .
+    '//    E.g look at src/Catrobat/CatrobatCode/Parser/Scripts/CollisionScript.php' . "\n" .
+    '//' . "\n" .
+    '// 2) Finally add it in this test to the deprecated_bricks array' . "\n" .
+    '//' . "\n\n" : '';
 
   $message .= count($diff_result_not_in_web_but_app) > 0 ?
-    "These blocks are only defined in catroid but not in the web: \n".
-    print_r($diff_result_not_in_web_but_app, true)."\n".
-    '//'."\n".
-    '// For new bricks - Add the Brick/Script! '."\n".
-    '//'."\n".
-    '// 1) Create necessary Constants in src/Catrobat/CatrobatCode/Parser/Constants.php'."\n".
-    '//'."\n".
-    '// 2) Create the new brick/script class in src/Catrobat/CatrobatCode/Parser/(Scripts|Bricks)'."\n".
-    "//    Make sure to set the correct img Constant -> that's defining the category of this new block"."\n".
-    '//'."\n".
-    '// 3) If it is a NEW img_constant(=category) make sure to add the new case in'."\n".
-    '//    src/Catrobat/CatrobatCode/Parser/CodeStatistic.php  updateBrickStatistic(...)'."\n".
-    '//'."\n".
-    '// 4) Make sure to add the new case in'."\n".
-    '//    src/Catrobat/CatrobatCode/Parser/Bricks/BrickFactory.php generate(...) or'."\n".
-    '//    src/Catrobat/CatrobatCode/Parser/Scripts/ScriptFactory.php generate(...)'."\n".
-    '//'."\n".
-    '// 5) Write a test to check the code statistics of the new block script!!'."\n".
-    '//    -> Create project with app (E.g. upload & download it)'."\n".
-    '//    put project file into tests/testdata/DataFixtures/CodeStatistics/'."\n".
-    '//    write the test in tests/BehatFeatures/web/code_statistics.feature'."\n".
-    '//'."\n".
-    '// Now should not only this test case work, the new block is implemented and tested in catroweb'."\n".
-    '//'."\n\n" : '';
+    "These blocks are only defined in catroid but not in the web: \n" .
+    print_r($diff_result_not_in_web_but_app, true) . "\n" .
+    '//' . "\n" .
+    '// For new bricks - Add the Brick/Script! ' . "\n" .
+    '//' . "\n" .
+    '// 1) Create necessary Constants in src/Catrobat/CatrobatCode/Parser/Constants.php' . "\n" .
+    '//' . "\n" .
+    '// 2) Create the new brick/script class in src/Catrobat/CatrobatCode/Parser/(Scripts|Bricks)' . "\n" .
+    "//    Make sure to set the correct img Constant -> that's defining the category of this new block" . "\n" .
+    '//' . "\n" .
+    '// 3) If it is a NEW img_constant(=category) make sure to add the new case in' . "\n" .
+    '//    src/Catrobat/CatrobatCode/Parser/CodeStatistic.php  updateBrickStatistic(...)' . "\n" .
+    '//' . "\n" .
+    '// 4) Make sure to add the new case in' . "\n" .
+    '//    src/Catrobat/CatrobatCode/Parser/Bricks/BrickFactory.php generate(...) or' . "\n" .
+    '//    src/Catrobat/CatrobatCode/Parser/Scripts/ScriptFactory.php generate(...)' . "\n" .
+    '//' . "\n" .
+    '// 5) Write a test to check the code statistics of the new block script!!' . "\n" .
+    '//    -> Create project with app (E.g. upload & download it)' . "\n" .
+    '//    put project file into tests/testdata/DataFixtures/CodeStatistics/' . "\n" .
+    '//    write the test in tests/BehatFeatures/web/code_statistics.feature' . "\n" .
+    '//' . "\n" .
+    '// Now should not only this test case work, the new block is implemented and tested in catroweb' . "\n" .
+    '//' . "\n\n" : '';
 
   echo $message;
   exit(1);

diff --git a/docker-compose.override.yaml b/docker-compose.override.yaml
@@ -2,5 +2,5 @@ services:
   ###> symfony/mailer ###
   mailer:
     image: schickling/mailcatcher
-    ports: [1025, 1080]
+    ports: ['1025', '1080']
 ###< symfony/mailer ###
diff --git a/docker/docker-compose.dev.yaml b/docker/docker-compose.dev.yaml
@@ -16,7 +16,7 @@ services:
       - chrome.catroweb
       - elasticsearch
     ports:
-      - 8080:80
+      - '8080:80'
     volumes:
       #
       # Changes to the following files are shared between host and container.
@@ -100,7 +100,7 @@ services:
     container_name: db.catroweb.dev
     shm_size: '2gb'
     ports:
-      - 3306
+      - '3306'
     restart: always
     environment:
       - MYSQL_ROOT_PASSWORD=root
@@ -127,14 +127,14 @@ services:
         '--no-sandbox',
       ]
     ports:
-      - 9222
+      - '9222'
 
   db.catroweb.test:
     image: mariadb:10.11
     container_name: db.catroweb.test
     shm_size: '2gb'
     ports:
-      - 3306
+      - '3306'
     restart: always
     environment:
       - MYSQL_ROOT_PASSWORD=root
@@ -150,7 +150,7 @@ services:
       - PMA_ARBITRARY=1
     restart: always
     ports:
-      - 8081:80
+      - '8081:80'
     volumes:
       - /sessions
     external_links:
@@ -177,7 +177,7 @@ services:
     volumes:
       - esdata1:/usr/share/elasticsearch/data
     ports:
-      - 9200:9200
+      - '9200:9200'
 
 volumes:
   esdata1:

diff --git a/docker/docker-compose.test.yaml b/docker/docker-compose.test.yaml
@@ -19,7 +19,7 @@ services:
       - chrome.catroweb
       - elasticsearch
     ports:
-      - 8080:80
+      - '8080:80'
 
     # --- Tests:
 
@@ -41,14 +41,14 @@ services:
         '--no-sandbox',
       ]
     ports:
-      - 9222
+      - '9222'
 
   db.catroweb.test:
     image: mariadb:10.11
     container_name: db.catroweb.test
     shm_size: '2gb'
     ports:
-      - 3306
+      - '3306'
     restart: always
     environment:
       - MYSQL_ROOT_PASSWORD=root
@@ -71,7 +71,7 @@ services:
     volumes:
       - esdata1:/usr/share/elasticsearch/data
     ports:
-      - 9200:9200
+      - '9200:9200'
 
 volumes:
   esdata1:

diff --git a/src/Admin/ApkGeneration/ApkAdmin.php b/src/Admin/ApkGeneration/ApkAdmin.php
@@ -0,0 +1,48 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Admin\ApkGeneration;
+
+use App\DB\Entity\Project\Program;
+use App\Storage\ScreenshotRepository;
+use Sonata\AdminBundle\Admin\AbstractAdmin;
+use Sonata\AdminBundle\Datagrid\DatagridInterface;
+use Sonata\AdminBundle\Datagrid\ProxyQueryInterface;
+use Sonata\DoctrineORMAdminBundle\Datagrid\ProxyQuery;
+
+/**
+ * @phpstan-extends AbstractAdmin<Program>
+ */
+class ApkAdmin extends AbstractAdmin
+{
+  #[\Override]
+  protected function configureDefaultSortValues(array &$sortValues): void
+  {
+    $sortValues[DatagridInterface::SORT_BY] = 'apk_request_time';
+    $sortValues[DatagridInterface::SORT_ORDER] = 'DESC';
+  }
+
+  public function __construct(
+    private readonly ScreenshotRepository $screenshot_repository,
+  ) {
+  }
+
+  public function getThumbnailImageUrl(Program $object): string
+  {
+    return '/'.$this->screenshot_repository->getThumbnailWebPath($object->getId());
+  }
+
+  #[\Override]
+  protected function configureQuery(ProxyQueryInterface $query): ProxyQueryInterface
+  {
+    /** @var ProxyQuery $query */
+    $query = parent::configureQuery($query);
+    $qb = $query->getQueryBuilder();
+    $qb->andWhere(
+      $qb->expr()->eq($qb->getRootAliases()[0].'.apk_status', ':apk_status')
+    );
+
+    return $query;
+  }
+}
diff --git a/src/Admin/ApkGeneration/ApkController.php b/src/Admin/ApkGeneration/ApkController.php
@@ -10,6 +10,8 @@
 use App\Utils\TimeUtils;
 use Doctrine\ORM\EntityManagerInterface;
 use Sonata\AdminBundle\Controller\CRUDController;
+use Sonata\AdminBundle\Exception\LockException;
+use Sonata\AdminBundle\Exception\ModelManagerThrowable;
 use Symfony\Component\HttpFoundation\RedirectResponse;
 
 /**
@@ -24,19 +26,18 @@ public function __construct(
   ) {
   }
 
+  /**
+   * @throws LockException
+   * @throws ModelManagerThrowable
+   */
   public function resetApkBuildStatusAction(): RedirectResponse
   {
-    /** @var Program|null $project */
+    /** @var Program $project */
     $project = $this->admin->getSubject();
-
-    if (null === $project) {
-      $this->addFlash('sonata_flash_error', "Can't reset APK status");
-    } else {
-      $project->setApkStatus(Program::APK_NONE);
-      $project->setApkRequestTime(null);
-      $this->admin->update($project);
-      $this->addFlash('sonata_flash_success', 'Reset APK status of '.$project->getName().' successful');
-    }
+    $project->setApkStatus(Program::APK_NONE);
+    $project->setApkRequestTime(null);
+    $this->admin->update($project);
+    $this->addFlash('sonata_flash_success', 'Reset APK status of '.$project->getName().' successful');
 
     return new RedirectResponse($this->admin->generateUrl('list'));
   }
@@ -46,18 +47,13 @@ public function resetApkBuildStatusAction(): RedirectResponse
    */
   public function requestApkRebuildAction(): RedirectResponse
   {
-    /** @var Program|null $project */
+    /** @var Program $project */
     $project = $this->admin->getSubject();
-
-    if (null === $project) {
-      $this->addFlash('sonata_flash_error', "Can't trigger APK rebuild");
-    } else {
-      $this->jenkins_dispatcher->sendBuildRequest($project->getId());
-      $project->setApkRequestTime(TimeUtils::getDateTime());
-      $project->setApkStatus(Program::APK_PENDING);
-      $this->admin->update($project);
-      $this->addFlash('sonata_flash_success', 'Requested a rebuild of '.$project->getName());
-    }
+    $this->jenkins_dispatcher->sendBuildRequest($project->getId());
+    $project->setApkRequestTime(TimeUtils::getDateTime());
+    $project->setApkStatus(Program::APK_PENDING);
+    $this->admin->update($project);
+    $this->addFlash('sonata_flash_success', 'Requested a rebuild of '.$project->getName());
 
     return new RedirectResponse($this->admin->generateUrl('list'));
   }

diff --git a/src/Admin/ApkGeneration/ApkPendingAdmin.php b/src/Admin/ApkGeneration/ApkPendingAdmin.php
@@ -5,9 +5,6 @@
 namespace App\Admin\ApkGeneration;
 
 use App\DB\Entity\Project\Program;
-use App\Storage\ScreenshotRepository;
-use Sonata\AdminBundle\Admin\AbstractAdmin;
-use Sonata\AdminBundle\Datagrid\DatagridInterface;
 use Sonata\AdminBundle\Datagrid\DatagridMapper;
 use Sonata\AdminBundle\Datagrid\ListMapper;
 use Sonata\AdminBundle\Datagrid\ProxyQueryInterface;
@@ -17,10 +14,7 @@
 use Sonata\Form\Type\DateTimeRangePickerType;
 use Symfony\Component\Form\Extension\Core\Type\ChoiceType as SymfonyChoiceType;
 
-/**
- * @phpstan-extends AbstractAdmin<Program>
- */
-class ApkPendingAdmin extends AbstractAdmin
+class ApkPendingAdmin extends ApkAdmin
 {
   #[\Override]
   protected function generateBaseRouteName(bool $isChildAdmin = false): string
@@ -34,38 +28,12 @@ protected function generateBaseRoutePattern(bool $isChildAdmin = false): string
     return 'catrobat/apk/pending';
   }
 
-  #[\Override]
-  protected function configureDefaultSortValues(array &$sortValues): void
-  {
-    $sortValues[DatagridInterface::SORT_BY] = 'apk_request_time';
-    $sortValues[DatagridInterface::SORT_ORDER] = 'DESC';
-  }
-
-  public function __construct(
-    private readonly ScreenshotRepository $screenshot_repository,
-  ) {
-  }
-
-  /**
-   * @param Program $object
-   */
-  public function getThumbnailImageUrl($object): string
-  {
-    return '/'.$this->screenshot_repository->getThumbnailWebPath($object->getId());
-  }
-
   #[\Override]
   protected function configureQuery(ProxyQueryInterface $query): ProxyQueryInterface
   {
     /** @var ProxyQuery $query */
     $query = parent::configureQuery($query);
-
-    $qb = $query->getQueryBuilder();
-
-    $qb->andWhere(
-      $qb->expr()->eq($qb->getRootAliases()[0].'.apk_status', ':apk_status')
-    );
-    $qb->setParameter('apk_status', Program::APK_PENDING);
+    $query->getQueryBuilder()->setParameter('apk_status', Program::APK_PENDING);
 
     return $query;
   }