option to return multiple plans (#31)

* VSLIV30-2578 option for multiple matches. requires update of asseco-voice/laravel-inbox * Apply fixes from StyleCI --------- Co-authored-by: ngasparic <Nikola.Gasparic@asseco-see.hr> Co-authored-by: StyleCI Bot <bot@styleci.io>
asseco-voice · Feb 15, 2024 · 6431ff1 · 6431ff1
1 parent a77d3ab
commit 6431ff1
Show file tree

Hide file tree

Showing 13 changed files with 67 additions and 45 deletions.
diff --git a/config/asseco-plan-router.php b/config/asseco-plan-router.php
@@ -14,8 +14,8 @@
      * Model bindings.
      */
     'models' => [
-        'rule'             => Rule::class,
-        'plan'             => Plan::class,
+        'rule' => Rule::class,
+        'plan' => Plan::class,
         'plan_model_value' => PlanModelValue::class,
     ],
 
@@ -30,7 +30,7 @@
         /**
          * UUIDs as primary keys.
          */
-        'uuid'       => false,
+        'uuid' => false,
 
         /**
          * Timestamp types.
@@ -43,13 +43,13 @@
          * Should the package run the migrations. Set to false if you're publishing
          * and changing default migrations.
          */
-        'run'        => true,
+        'run' => true,
     ],
 
     'plan_event_topic' => env('PLAN_EVENT_TOPIC', 'plan_changed'),
 
     'routes' => [
-        'prefix'     => 'api',
+        'prefix' => 'api',
         'middleware' => ['api'],
     ],
 ];
diff --git a/src/App/Http/Requests/PlanRuleDeleteRequest.php b/src/App/Http/Requests/PlanRuleDeleteRequest.php
@@ -24,7 +24,7 @@ public function authorize()
     public function rules()
     {
         return [
-            'rule_ids'   => 'required|array',
+            'rule_ids' => 'required|array',
             'rule_ids.*' => 'exists:rules,id',
         ];
     }

diff --git a/src/App/Http/Requests/PlanRuleRequest.php b/src/App/Http/Requests/PlanRuleRequest.php
@@ -24,9 +24,9 @@ public function authorize()
     public function rules()
     {
         return [
-            'rules'           => 'array|required',
+            'rules' => 'array|required',
             'rules.*.rule_id' => 'required_with:rules|exists:rules,id',
-            'rules.*.regex'   => 'string|required_with:rules',
+            'rules.*.regex' => 'string|required_with:rules',
         ];
     }
 }
diff --git a/src/App/Models/Plan.php b/src/App/Models/Plan.php
@@ -18,7 +18,7 @@ class Plan extends Model implements \Asseco\PlanRouter\App\Contracts\Plan
     protected $fillable = ['name', 'description', 'order', 'match_either', 'priority'];
 
     protected $casts = [
-        'match_either'    => 'boolean',
+        'match_either' => 'boolean',
     ];
 
     protected static function newFactory()
@@ -62,9 +62,9 @@ public static function getWithRelations(): Collection
     public static function getValidationRules(): array
     {
         return [
-            'name'         => 'required|string',
-            'description'  => 'nullable|string',
-            'priority'     => 'integer',
+            'name' => 'required|string',
+            'description' => 'nullable|string',
+            'priority' => 'integer',
             'match_either' => 'boolean',
         ];
     }

diff --git a/src/App/Models/PlanModelValue.php b/src/App/Models/PlanModelValue.php
@@ -48,9 +48,9 @@ public function model(): MorphTo
     public static function getValidationRules(): array
     {
         return [
-            'plan_id'   => 'required|exists:plans,id',
+            'plan_id' => 'required|exists:plans,id',
             'attribute' => 'required|string',
-            'value'     => 'required|string',
+            'value' => 'required|string',
         ];
     }
 }
diff --git a/src/App/Models/Rule.php b/src/App/Models/Rule.php
@@ -27,7 +27,7 @@ public function plans(): BelongsToMany
     public static function getValidationRules(): array
     {
         return [
-            'name'  => 'required|string',
+            'name' => 'required|string',
             'label' => 'required|string',
         ];
     }

diff --git a/src/App/Services/InboxService.php b/src/App/Services/InboxService.php
@@ -24,29 +24,51 @@ public function __construct(Plan $plan)
 
     /**
      * @param  CanMatch  $canMatch
-     * @return Plan|null
+     * @param  bool|null  $multipleMatches
+     * @return Plan|array|Plan[]|null
      *
      * @throws Exception
      */
-    public function match(CanMatch $canMatch): ?Plan
+    public function match(CanMatch $canMatch, ?bool $multipleMatches = false)
     {
         $this->canMatch = $canMatch;
 
         $this->registerInboxes();
-
         $this->registerFallback();
 
-        /** @var Inbox $matchedInbox */
-        // Interested in first match only as we're not utilizing
-        // continuous matching from Inbox package.
-        $matchedInbox = Arr::get(InboxGroup::run($canMatch), '0');
-
-        $planId = Arr::get($matchedInbox->getMeta(), 'plan_id');
-
-        /** @var Plan $plan */
-        $plan = $this->plan::query()->find($planId);
-
-        return $plan;
+        if (!$multipleMatches) {
+            // Interested in first match only as we're not utilizing
+            // continuous matching from Inbox package.
+            /** @var Inbox $matchedInbox */
+            $matchedInbox = Arr::get(InboxGroup::run($canMatch), '0');
+            $planId = Arr::get($matchedInbox->getMeta(), 'plan_id');
+
+            /** @var Plan $plan */
+            $plan = $this->plan::query()->find($planId);
+
+            return $plan;
+        } else {
+            // MOD: VSLIV30-2578
+            // multiple plans could be matched
+            $plans = [];
+            $matchedInboxes = InboxGroup::run($canMatch, $multipleMatches);
+
+            if (!empty($matchedInboxes)) {
+                /** @var Inbox $inbox */
+                foreach ($matchedInboxes as $inbox) {
+                    $planId = Arr::get($inbox->getMeta(), 'plan_id');
+                    if ($planId) {
+                        /** @var Plan $plan */
+                        $plan = $this->plan::query()->find($planId);
+                        if ($plan) {
+                            $plans[$plan->id] = $plan;
+                        }
+                    }
+                }
+            }
+
+            return $plans;
+        }
     }
 
     /**

diff --git a/src/Database/Factories/PlanFactory.php b/src/Database/Factories/PlanFactory.php
@@ -23,12 +23,12 @@ class PlanFactory extends Factory
     public function definition()
     {
         $data = [
-            'name'         => $this->faker->word,
-            'description'  => $this->faker->word,
-            'priority'     => $this->faker->numberBetween(0, 100),
+            'name' => $this->faker->word,
+            'description' => $this->faker->word,
+            'priority' => $this->faker->numberBetween(0, 100),
             'match_either' => $this->faker->boolean,
-            'created_at'   => now(),
-            'updated_at'   => now(),
+            'created_at' => now(),
+            'updated_at' => now(),
         ];
 
         if (config('asseco-plan-router.migrations.uuid')) {

diff --git a/src/Database/Factories/PlanModelValueFactory.php b/src/Database/Factories/PlanModelValueFactory.php
@@ -24,9 +24,9 @@ class PlanModelValueFactory extends Factory
     public function definition()
     {
         $data = [
-            'plan_id'    => Plan::factory(),
-            'attribute'  => $this->faker->word,
-            'value'      => $this->faker->word,
+            'plan_id' => Plan::factory(),
+            'attribute' => $this->faker->word,
+            'value' => $this->faker->word,
             'created_at' => now(),
             'updated_at' => now(),
         ];

diff --git a/src/Database/Factories/RuleFactory.php b/src/Database/Factories/RuleFactory.php
@@ -23,7 +23,7 @@ class RuleFactory extends Factory
     public function definition()
     {
         $data = [
-            'name'  => $this->faker->unique()->word,
+            'name' => $this->faker->unique()->word,
             'label' => $this->faker->word,
         ];
 

diff --git a/src/Database/Seeders/RuleSeeder.php b/src/Database/Seeders/RuleSeeder.php
@@ -18,23 +18,23 @@ public function run()
     {
         $data = [
             [
-                'name'  => 'from',
+                'name' => 'from',
                 'label' => 'From',
             ],
             [
-                'name'  => 'to',
+                'name' => 'to',
                 'label' => 'To',
             ],
             [
-                'name'  => 'cc',
+                'name' => 'cc',
                 'label' => 'Cc',
             ],
             [
-                'name'  => 'bcc',
+                'name' => 'bcc',
                 'label' => 'Bcc',
             ],
             [
-                'name'  => 'subject',
+                'name' => 'subject',
                 'label' => 'Subject', ],
         ];
 

diff --git a/tests/Feature/Http/Controllers/PlanControllerTest.php b/tests/Feature/Http/Controllers/PlanControllerTest.php
@@ -65,7 +65,7 @@ public function can_create_a_new_plan_if_it_doesnt_exist()
     public function can_update_an_existing_plan()
     {
         $data = [
-            'name'        => 'test',
+            'name' => 'test',
             'description' => 'test',
         ];
 

diff --git a/tests/Feature/Http/Controllers/PlanModelValueControllerTest.php b/tests/Feature/Http/Controllers/PlanModelValueControllerTest.php
@@ -61,7 +61,7 @@ public function can_update_an_existing_plan_model_value()
 
         $data = [
             'attribute' => 'test',
-            'value'     => 'test',
+            'value' => 'test',
         ];
 
         $this