GH-791 Continue refactoring

Wunderbyte-GmbH · Feb 10, 2025 · 5136943 · 5136943
1 parent d3fd88f
commit 5136943
Show file tree

Hide file tree

Showing 33 changed files with 215 additions and 225 deletions.
diff --git a/classes/local/none.php → classes/local/fail.php b/classes/local/none.php → classes/local/fail.php
@@ -15,36 +15,49 @@
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * Сlass status.
+ * Сlass fail.
  *
  * @package    local_catquiz
- * @copyright  2023 Wunderbyte GmbH <[email protected]>
+ * @copyright  2025 Wunderbyte GmbH <[email protected]>
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 namespace local_catquiz\local;
 
 use Exception;
-use local_catquiz\local\status;
 
 /**
- * Provides methods to obtain results.
- *
+ * Overrides abstract methods from result
  *
  * @package    local_catquiz
- * @copyright  2023 Wunderbyte GmbH <[email protected]>
+ * @copyright  2025 Wunderbyte GmbH <[email protected]>
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
-class none extends result {
+class fail extends result {
+    /**
+     * Just returns the current result
+     *
+     * @return result
+     */
     public function and_then(callable $op): result {
         return $this;
     }
 
+    /**
+     * Calls the given callable
+     *
+     * @return result
+     */
     public function or_else(callable $op): result {
         return $op($this);
     }
 
-    public function expect() {
+    /**
+     * Throws an exception
+     *
+     * @throws Exception
+     */
+    public function expect(): result {
         throw new Exception($this->geterrormessage());
     }
 }
diff --git a/classes/local/result.php b/classes/local/result.php
@@ -15,10 +15,10 @@
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * Сlass status.
+ * Сlass result.
  *
  * @package    local_catquiz
- * @copyright  2023 Wunderbyte GmbH <[email protected]>
+ * @copyright  2025 Wunderbyte GmbH <[email protected]>
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
@@ -30,9 +30,8 @@
 /**
  * Provides methods to obtain results.
  *
- *
  * @package    local_catquiz
- * @copyright  2023 Wunderbyte GmbH <[email protected]>
+ * @copyright  2025 Wunderbyte GmbH <[email protected]>
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 abstract class result {
@@ -63,33 +62,43 @@ public function __construct($value = null, string $status = status::OK) {
      * @param string $status
      * @param mixed|null $value
      *
-     * @return none
-     *
+     * @return fail
      */
-    public static function err(string $status = status::ERROR_GENERAL, $value = null) {
-        return new none($value, $status);
+    public static function err(string $status = status::ERROR_GENERAL, $value = null): fail {
+        return new fail($value, $status);
     }
 
     /**
      * Returns OK result.
      *
      * @param mixed|null $value
      *
-     * @return some
-     *
+     * @return success
      */
-    public static function ok($value = null) {
-        return new some($value, status::OK);
+    public static function ok($value = null): success {
+        return new success($value, status::OK);
     }
 
+    /**
+     * Calls the given callable if successful
+     *
+     * @return result
+     */
     abstract public function and_then(callable $op): result;
 
+    /**
+     * Calls the given callable if not successful
+     *
+     * @return result
+     */
     abstract public function or_else(callable $op): result;
 
     /**
+     * Throws an exception if not successful
+     *
      * @throws Exception
      */
-    abstract public function expect();
+    abstract public function expect(): result;
 
     /**
      * Returns status.

diff --git a/classes/local/some.php → classes/local/success.php b/classes/local/some.php → classes/local/success.php
@@ -15,36 +15,45 @@
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * Сlass status.
+ * Сlass success.
  *
  * @package    local_catquiz
- * @copyright  2023 Wunderbyte GmbH <[email protected]>
+ * @copyright  2025 Wunderbyte GmbH <[email protected]>
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 namespace local_catquiz\local;
 
-use local_catquiz\local\status;
-
 /**
- * Provides methods to obtain results.
- *
+ * Overrides abstract methods from result
  *
  * @package    local_catquiz
- * @copyright  2023 Wunderbyte GmbH <[email protected]>
+ * @copyright  2025 Wunderbyte GmbH <[email protected]>
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
-class some extends result {
-
+class success extends result {
+    /**
+     * Calls the given callable
+     *
+     * @return result
+     */
     public function and_then(callable $op): result {
         return $op($this);
     }
 
+    /**
+     * Just returns the current result
+     *
+     * @return result
+     */
     public function or_else(callable $op): result {
         return $this;
     }
 
-    public function expect() {
+    /**
+     * Just returns the current result
+     */
+    public function expect(): result {
         return $this;
     }
 }
diff --git a/classes/teststrategy/preselect_task.php b/classes/teststrategy/preselect_task.php
@@ -89,7 +89,7 @@ public function process(array &$context, callable $nexttask): result {
      * @param callable $next Callable that calls the next middleware
      * @return result
      */
-    abstract public function run(array &$context, callable $next): result;
+    abstract public function run(array &$context): result;
 
     /**
      * If a middleware requires a specific key to be available in the $context

diff --git a/classes/teststrategy/preselect_task/addscalestandarderror.php b/classes/teststrategy/preselect_task/addscalestandarderror.php
@@ -58,11 +58,11 @@ class addscalestandarderror extends preselect_task {
      * @return result
      *
      */
-    public function run(array &$context, callable $next): result {
+    public function run(array &$context): result {
         $this->progress = $context['progress'];
         $responses = $this->progress->get_user_responses();
         if (! $responses) {
-            return $next($context);
+            return result::ok($context);
         }
 
         $userresponses = model_responses::create_from_array([$context['userid'] => ['component' => $responses]]);
@@ -72,7 +72,7 @@ public function run(array &$context, callable $next): result {
             $context['se'][$catscaleid] = $se;
         }
 
-        return $next($context);
+        return result::ok($context);
     }
 
     /**

diff --git a/classes/teststrategy/preselect_task/checkpagereload.php b/classes/teststrategy/preselect_task/checkpagereload.php
@@ -36,7 +36,6 @@
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 final class checkpagereload extends preselect_task {
-
     /**
      * @var progress $progress
      */
@@ -51,13 +50,14 @@ final class checkpagereload extends preselect_task {
      * @return result
      *
      */
-    public function run(array &$context, callable $next): result {
+    public function run(array &$context): result {
         $this->progress = $context['progress'];
-        if (($this->progress->is_first_question() && !$this->progress->get_last_question())
+        if (
+            ($this->progress->is_first_question() && !$this->progress->get_last_question())
             || $this->progress->has_new_response()
             || $this->progress->get_force_new_question()
         ) {
-            return $next($context);
+            return result::ok($context);
         }
 
         return result::ok($this->progress->get_last_question());

diff --git a/classes/teststrategy/preselect_task/filterbyquestionsperscale.php b/classes/teststrategy/preselect_task/filterbyquestionsperscale.php
@@ -58,11 +58,11 @@ class filterbyquestionsperscale extends preselect_task {
      * @return result
      *
      */
-    public function run(array &$context, callable $next): result {
+    public function run(array &$context): result {
         $this->progress = $context['progress'];
 
         if (!in_array($context['teststrategy'], [LOCAL_CATQUIZ_STRATEGY_ALLSUBS])) {
-            return $next($context);
+            return result::ok($context);
         }
 
         $minquestionsperscale = $context['min_attempts_per_scale'];
@@ -88,7 +88,7 @@ public function run(array &$context, callable $next): result {
                     PHP_EOL
                 );
             }
-            return $next($context);
+            return result::ok($context);
         }
 
         // If we are here, not all scales have the minimum questions.
@@ -104,7 +104,7 @@ public function run(array &$context, callable $next): result {
                 );
             }
         }
-        return $next($context);
+        return result::ok($context);
     }
 
     /**

diff --git a/classes/teststrategy/preselect_task/filterbystandarderror.php b/classes/teststrategy/preselect_task/filterbystandarderror.php
@@ -44,17 +44,11 @@
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class filterbystandarderror extends preselect_task {
-
     /**
      * @var progress
      */
     private progress $progress;
 
-    /**
-     * @var callable $next
-     */
-    private $next;
-
     /**
      * Run method.
      *
@@ -64,21 +58,20 @@ class filterbystandarderror extends preselect_task {
      * @return result
      *
      */
-    public function run(array &$context, callable $next): result {
+    public function run(array &$context): result {
         $this->context = $context;
-        $this->next = $next;
         $this->progress = $context['progress'];
 
         if ($this->progress->is_first_question()) {
-            return $next($context);
+            return result::ok($context);
         }
 
         if (!$this->progress->has_new_response()) {
-            return $next($context);
+            return result::ok($context);
         }
 
         if ($this->progress->get_last_question()->is_pilot) {
-            return $next($context);
+            return result::ok($context);
         }
 
         $lastquestion = $this->progress->get_last_question();
@@ -98,7 +91,8 @@ public function run(array &$context, callable $next): result {
                 getenv('CATQUIZ_CREATE_TESTOUTPUT') && printf(
                     "%d: [SE] drop %s%s",
                     count($this->progress->get_playedquestions()),
-                    (catscale::return_catscale_object($scaleid))->name, PHP_EOL
+                    (catscale::return_catscale_object($scaleid))->name,
+                    PHP_EOL
                 );
                 $this->progress->drop_scale($scaleid);
                 $inheritscales = $this->get_scale_heirs($scaleid);
@@ -144,7 +138,7 @@ public function run(array &$context, callable $next): result {
             }
         }
 
-        return $next($context);
+        return result::ok($context);
     }
 
     /**
@@ -210,7 +204,7 @@ private function filter_for_cat(array $updatedscales): result {
         if ($drop) {
             return result::err(status::ERROR_NO_REMAINING_QUESTIONS);
         }
-        return ($this->next)($this->context);
+        return result::ok($this->context);
     }
 
     /**

diff --git a/classes/teststrategy/preselect_task/filterbytestinfo.php b/classes/teststrategy/preselect_task/filterbytestinfo.php
@@ -40,7 +40,6 @@
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class filterbytestinfo extends preselect_task {
-
     /**
      * @var progress
      */
@@ -55,17 +54,18 @@ class filterbytestinfo extends preselect_task {
      * @return result
      *
      */
-    public function run(array &$context, callable $next): result {
+    public function run(array &$context): result {
         $this->context = $context;
         $this->progress = $context['progress'];
 
-        if (!in_array($context['teststrategy'], [ // TODO: use something like strategy::supports_dynamic_scales()!
+        if (!in_array($context['teststrategy'], [
             LOCAL_CATQUIZ_STRATEGY_LOWESTSUB,
             LOCAL_CATQUIZ_STRATEGY_HIGHESTSUB,
             LOCAL_CATQUIZ_STRATEGY_RELSUBS,
             LOCAL_CATQUIZ_STRATEGY_ALLSUBS,
-            ])) {
-            return $next($context);
+            ])
+        ) {
+            return result::ok($context);
         }
 
         foreach ($this->progress->get_abilities() as $scaleid => $ability) {
@@ -146,7 +146,7 @@ public function run(array &$context, callable $next): result {
             }
         }
 
-        return $next($context);
+        return result::ok($context);
     }
 
     /**