Fixing helper classes (except for mail notifications and stuff related to exercise/pipeline configs).

Author: krulis-martin

app/commands/PlagiarismDetectionAccessToken.php

@@ -38,7 +38,7 @@ public function __construct(AccessManager $accessManager, Users $users)
     protected function configure()
     {
         $this->setName(self::$defaultName)
-            ->setDescription('Generate token restricted for plagiarsim scope (for 3rd party tools).');
+            ->setDescription('Generate token restricted for plagiarism scope (for 3rd party tools).');
         $this->addArgument('userId', InputArgument::REQUIRED, 'ID of the admin owning the token.');
         $this->addOption(
             'expiration',

app/config/config.neon

@@ -114,7 +114,7 @@ parameters:
     exerciseUrl: "%webapp.address%/app/exercises/{id}"
     shadowAssignmentUrl: "%webapp.address%/app/shadow-assignment/{id}"
     solutionUrl: "%webapp.address%/app/assignment/{assignmentId}/solution/{solutionId}"
-    referenceSolutiontUrl: "%webapp.address%/app/exercises/{exerciseId}/reference-solution/{solutionId}"
+    referenceSolutionUrl: "%webapp.address%/app/exercises/{exerciseId}/reference-solution/{solutionId}"
     forgottenPasswordUrl: "%webapp.address%/forgotten-password/change?{token}"  # URL of web application where the password can be changed
     emailVerificationUrl: "%webapp.address%/email-verification?{token}"
     invitationUrl: "%webapp.address%/accept-invitation?{token}"

app/helpers/AnnotationsParser.php

@@ -4,8 +4,10 @@
  * This file is part of the Nette Framework (https://nette.org)
  * Copyright (c) 2004 David Grudl (https://davidgrudl.com)
  *
- * We have copied this form abanndoned Nette/Reflection module, so we can use the parse and extend it in the future.
+ * We have copied this form abanndoned Nette/Reflection module, so we can use the parser and extend it in the future.
  * For the original code, visit https://github.com/nette/reflection/blob/master/src/Reflection/AnnotationsParser.php
+ * 
+ * News: After the great endpoint parameter specification refactoring, this may no longer be required.
  */
 
 namespace App\Helpers;

app/helpers/AnonymizationHelper.php

@@ -4,7 +4,6 @@
 
 use Nette;
 use Nette\Utils\Arrays;
-use App\Model\Entity\Login;
 use App\Model\Entity\User;
 use App\Model\Repository\Users;
 use App\Model\Repository\Logins;
@@ -34,7 +33,7 @@ class AnonymizationHelper
     protected $anonymizedName;
 
     /**
-     * @var string Suffix appended to an email addres of deleted user.
+     * @var string Suffix appended to an email address of deleted user.
      */
     protected $deletedEmailSuffix;
 

app/helpers/BasicAuthHelper.php

@@ -21,7 +21,9 @@ public static function getCredentials(IRequest $req)
     {
         $auth = $req->getHeader("Authorization");
         if ($auth === null || str_starts_with($auth, "Basic ") === false) {
-            throw new HttpBasicAuthException("The request from backend-service must contain HTTP Basic authentication.");
+            throw new HttpBasicAuthException(
+                "The request from backend-service must contain HTTP Basic authentication."
+            );
         }
 
         $encodedCredentials = Strings::substring($auth, strlen("Basic "));

app/helpers/BrokerProxy.php

@@ -6,7 +6,6 @@
 use App\Exceptions\SubmissionFailedException;
 use ZMQ;
 use ZMQContext;
-use ZMQException;
 use ZMQPoll;
 use ZMQPollException;
 use ZMQSocket;
@@ -52,7 +51,7 @@ public function __construct(array $config)
 
     /**
      * Start evaluation of new job. This means sending proper message to broker that we want this new
-     * job to be evaluated, receive confirmation that the message was successfuly received and finally
+     * job to be evaluated, receive confirmation that the message was successfully received and finally
      * receive confirmation if the evaluation can be processed or not (for example if there is worker
      * for that hwgroup available).
      * @param string $jobId Unique identifier of the new job

app/helpers/Emails/EmailLatteExtension.php

@@ -22,7 +22,7 @@ class EmailLatteExtension extends Latte\Extension
     private static $subject = null;
 
     /**
-     * Used both by the extension and to re-set the subjec before rendering.
+     * Used both by the extension and to re-set the subject before rendering.
      * @param string|null $subject
      */
     public static function setSubject(?string $subject): void

app/helpers/Emails/EmailLatteFactory.php

@@ -2,7 +2,6 @@
 
 namespace App\Helpers\Emails;
 
-use Latte;
 use Latte\Engine;
 use Latte\Essential\Filters;
 use League\CommonMark\CommonMarkConverter;
@@ -13,7 +12,6 @@
  */
 class EmailLatteFactory
 {
-
     /**
      * Create latte engine for email templates with helper filters.
      * @return EmailLatteWrapper

app/helpers/Emails/EmailLatteWrapper.php

@@ -9,7 +9,6 @@
  */
 class EmailLatteWrapper
 {
-
     private $latte;
 
     public function __construct(Engine $latte)

app/helpers/Emails/EmailLocalizationHelper.php

@@ -121,20 +121,20 @@ function (User $user) {
     private static $localizations = [
         EmailLocalizationHelper::CZECH_LOCALE => [
             // this is actually not perfect, but it will do for now
-            'y' => [ 1 => "rok", 2 => "roky", 5 => "let" ],
-            'm' => [ 1 => "měsíc", 2 => "měsíce", 5 => "měsíců" ],
-            'd' => [ 1 => "den", 2 => "dny", 5 => 'dní' ],
-            'h' => [ 1 => "hodina", 2 => "hodiny", 5 => "hodin" ],
-            'i' => [ 1 => "minuta", 2 => "minuty", 5 => "minut" ],
-            's' => [ 1 => "vteřina", 2 => "vteřiny", 5 => "vteřin" ],
+            'y' => [1 => "rok", 2 => "roky", 5 => "let"],
+            'm' => [1 => "měsíc", 2 => "měsíce", 5 => "měsíců"],
+            'd' => [1 => "den", 2 => "dny", 5 => 'dní'],
+            'h' => [1 => "hodina", 2 => "hodiny", 5 => "hodin"],
+            'i' => [1 => "minuta", 2 => "minuty", 5 => "minut"],
+            's' => [1 => "vteřina", 2 => "vteřiny", 5 => "vteřin"],
         ],
         EmailLocalizationHelper::DEFAULT_LOCALE => [ // default (English)
-            'y' => [ 1 => "year", 2 => "years" ],
-            'm' => [ 1 => "month", 2 => "months" ],
-            'd' => [ 1 => "day", 2 => "days" ],
-            'h' => [ 1 => "hour", 2 => "hours" ],
-            'i' => [ 1 => "minute", 2 => "minutes" ],
-            's' => [ 1 => "second", 2 => "seconds" ],
+            'y' => [1 => "year", 2 => "years"],
+            'm' => [1 => "month", 2 => "months"],
+            'd' => [1 => "day", 2 => "days"],
+            'h' => [1 => "hour", 2 => "hours"],
+            'i' => [1 => "minute", 2 => "minutes"],
+            's' => [1 => "second", 2 => "seconds"],
         ]
     ];
 
@@ -158,7 +158,7 @@ private static function getDateIntervalLocalizationSuffix(int $value, array $suf
     /**
      * Return localized string with an informal description of relative time (date interval).
      * It writes out up to two the most significant values, so it is brief yet it scales from seconds to years.
-     * The interval is treated as absoluted value (ignoring the sign).
+     * The interval is treated as absolute value (ignoring the sign).
      * @param DateInterval $dateDiff interval to be displayed
      * @param string $locale identification of the language
      * @return string formatted relative time