Add config to show interpretation and failedConditions

Author: Kenneth Ocastro

src/Engine.php

@@ -10,6 +10,8 @@ class Engine
     private array $allRules = [];
     private ?Rule $targetRule = null;
     private Facts $facts;
+    private bool $showInterpretation = false;
+    private bool $showFailedConditions = false;
 
     public function __construct()
     {
@@ -61,26 +63,37 @@ public function evaluate(): array
         }
 
         $result = [];
-        $failedConditions = [];
-
-        // Evaluate the target rule
-        if ($this->targetRule->evaluate($this->facts, $this->allRules)) {
-            $result[] = array_merge(
-                $this->targetRule->triggerEvent($this->facts),
-                ['interpretation' => $this->targetRule->interpretRules()]
-            );
-        } else {
-            $failedConditions = $this->targetRule->getFailedConditions();
-
-            $result[] = array_merge(
-                $this->targetRule->triggerFailureEvent($this->facts),
-                [
-                    'interpretation' => $this->targetRule->interpretRules(),
-                    'failedConditions' => $failedConditions
-                ]
-            );
-        }
+        $evaluationResult = $this->targetRule->evaluate($this->facts, $this->allRules);
+
+        $extra = $this->getExtraData($evaluationResult);
+
+        $triggerMethod = $evaluationResult ? 'triggerEvent' : 'triggerFailureEvent';
+        $result[] = array_merge($this->targetRule->$triggerMethod($this->facts), $extra);
 
         return $result;
     }
+
+    private function getExtraData(bool $evaluationResult): array
+    {
+        $extra = [];
+
+        if ($this->showInterpretation) {
+            $extra['interpretation'] = $this->targetRule->interpretRules();
+        }
+
+        if (!$evaluationResult && $this->showFailedConditions) {
+            $extra['failedConditions'] = $this->targetRule->getFailedConditions();
+        }
+
+        return $extra;
+    }
+
+    public function showInterpretation(bool $showInterpretation): void
+    {
+        $this->showInterpretation = $showInterpretation;
+    }
+    public function showFailedConditions(bool $showFailedConditions): void
+    {
+        $this->showFailedConditions = $showFailedConditions;
+    }
 }

src/Rule.php

@@ -11,6 +11,7 @@ class Rule
     private array $failureEvent;
     private ?string $name;
     private array $failedConditions = [];
+    private array $dependencyRules = [];
 
     public function __construct(array $options)
     {
@@ -27,6 +28,11 @@ public function __construct(array $options)
         }
     }
 
+    public function getDependencyRules(): array
+    {
+        return $this->dependencyRules;
+    }
+
     public function getName(): ?string
     {
         return $this->name;
@@ -54,6 +60,7 @@ private function evaluateAll(array $conditions, Facts $facts, array $allRules):
                 $dependencyRuleName = $condition['condition'];
                 if (isset($allRules[$dependencyRuleName])) {
                     $dependencyRule = $allRules[$dependencyRuleName];
+                    $this->dependencyRules[] = $dependencyRule;
                     if (!$dependencyRule->evaluate($facts, $allRules)) {
                         $this->failedConditions[] = $condition;
                         return false;
@@ -93,6 +100,7 @@ private function evaluateAny(array $conditions, Facts $facts, array $allRules):
                 $dependencyRuleName = $condition['condition'];
                 if (isset($allRules[$dependencyRuleName])) {
                     $dependencyRule = $allRules[$dependencyRuleName];
+                    $this->dependencyRules[] = $dependencyRule;
                     if ($dependencyRule->evaluate($facts, $allRules)) {
                         return true;
                     } else {

tests/EngineTest.php

@@ -28,6 +28,7 @@ public function testPlayerIsFouledOut()
         $engine->addFact('gameDuration', 40);
 
         $engine->setTargetRule('rule.player.isFouledOut');
+        $engine->showInterpretation(true);
 
         $result = $engine->evaluate();
         $expectedResult = [
@@ -76,6 +77,8 @@ public function testProfileIsCompleted()
         ]);
 
         $engine->setTargetRule('rule.profile.isCompleted');
+        $engine->showInterpretation(true);
+        $engine->showFailedConditions(true);
 
         $result = $engine->evaluate();
 
@@ -181,6 +184,7 @@ public function testProfileIsSearchable()
 
         // Step 5: Set the target rule
         $engine->setTargetRule('profile.isSearchable');
+        $engine->showInterpretation(true);
 
         // Step 6: Evaluate the engine
         $result = $engine->evaluate();