Add support for arrays in actions

CHANGELOG.md

@@ -7,6 +7,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+- Add support for arrays in actions
+
 ## [5.2.0] - (30/11/2021)
 
 ### Changed

composer.json

@@ -72,5 +72,10 @@
         "fix-code-style": "vendor/bin/php-cs-fixer fix --config .php_cs --verbose --using-cache=no",
         "phpstan":  "vendor/bristol-su/portal-code-style/src/PHPStan/phpstan.sh",
         "coverage": "vendor/bin/phpunit --colors=always --process-isolation --verbose --configuration phpunit.xml --coverage-html coverage"
+    },
+    "config": {
+        "allow-plugins": {
+            "composer/package-versions-deprecated": true
+        }
     }
 }

database/migrations/2021_12_06_154208_alter_table_action_instance_fields_make_action_value_nullable.php

@@ -0,0 +1,30 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+class AlterTableActionInstanceFieldsMakeActionValueNullable extends Migration
+{
+    /**
+     * Run the migrations.
+     *
+     */
+    public function up()
+    {
+        Schema::table('action_instance_fields', function(Blueprint $table) {
+            $table->text('action_value')->nullable()->change();
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     */
+    public function down()
+    {
+        Schema::table('action_instance_fields', function(Blueprint $table) {
+            $table->string('action_value')->change();
+        });
+    }
+}

database/migrations/2022_03_24_000808_add_indexes_to_logic_results_table.php

@@ -0,0 +1,53 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+class AddIndexesToLogicResultsTable extends Migration
+{
+    /**
+     * Run the migrations.
+     *
+     */
+    public function up()
+    {
+        Schema::table('logic_results', function (Blueprint $table) {
+//            $table->index(['logic_id']);
+//            $table->index(['user_id']);
+//            $table->index(['group_id']);
+//            $table->index(['role_id']);
+//            $table->index(['result']);
+//            $table->index(['logic_id', 'user_id']);
+//            $table->index(['logic_id', 'user_id', 'group_id']);
+//            $table->index(['logic_id', 'result']);
+//            $table->index(['logic_id', 'user_id', 'result']);
+//            $table->index(['logic_id', 'user_id', 'group_id', 'result']);
+//            $table->index(['logic_id', 'user_id', 'group_id', 'role_id', 'result'], 'logic_results_lugr_results_index');
+        });
+
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     */
+    public function down()
+    {
+        Schema::table('logic_results', function(Blueprint $table) {
+//            $table->dropIndex(['logic_id']);
+//            $table->dropIndex(['user_id']);
+//            $table->dropIndex(['group_id']);
+//            $table->dropIndex(['role_id']);
+//            $table->dropIndex(['result']);
+//
+//            $table->dropIndex(['logic_id', 'user_id']);
+//            $table->dropIndex(['logic_id', 'user_id', 'group_id']);
+//            $table->dropIndex(['logic_id', 'result']);
+//
+//            $table->dropIndex(['logic_id', 'user_id', 'result']);
+//            $table->dropIndex(['logic_id', 'user_id', 'group_id', 'result']);
+//            $table->dropIndex(['logic_id', 'user_id', 'group_id', 'role_id', 'result']);
+        });
+    }
+}

database/migrations/2022_03_29_000808_add_indexes_to_logic_results_again_table.php

@@ -0,0 +1,37 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+class AddIndexesToLogicResultsAgainTable extends Migration
+{
+    /**
+     * Run the migrations.
+     *
+     */
+    public function up()
+    {
+        Schema::table('logic_results', function (Blueprint $table) {
+            $table->index(['logic_id', 'result'], 'log_res_logic_res_index');
+            $table->index(['logic_id', 'user_id', 'result'], 'log_res_logic_res_user_index');
+            $table->index(['logic_id', 'user_id', 'group_id', 'result'], 'log_res_logic_res_user_grp_index');
+            $table->index(['logic_id', 'user_id', 'group_id', 'role_id', 'result'], 'logic_results_lugr_results_index');
+        });
+
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     */
+    public function down()
+    {
+        Schema::table('logic_results', function(Blueprint $table) {
+            $table->dropIndex('log_res_logic_res_index');
+            $table->dropIndex('log_res_logic_res_user_index');
+            $table->dropIndex('log_res_logic_res_user_grp_index');
+            $table->dropIndex('logic_results_lugr_results_index');
+        });
+    }
+}

database/migrations/2022_05_23_000808_add_single_indexes_to_logic_results_table.php

@@ -0,0 +1,35 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+class AddSingleIndexesToLogicResultsTable extends Migration
+{
+    /**
+     * Run the migrations.
+     *
+     */
+    public function up()
+    {
+        Schema::table('logic_results', function (Blueprint $table) {
+            $table->index(['user_id'], 'log_res_user_index');
+            $table->index(['group_id'], 'log_res_grp_index');
+            $table->index(['role_id'], 'log_res_role_index');
+        });
+
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     */
+    public function down()
+    {
+        Schema::table('logic_results', function(Blueprint $table) {
+            $table->dropIndex('log_res_user_index');
+            $table->dropIndex('log_res_grp_index');
+            $table->dropIndex('log_res_role_index');
+        });
+    }
+}

resources/views/base.blade.php

@@ -14,6 +14,7 @@
     @componentFirst(['partials.components.head', 'bristolsu::partials.components.head'])
         @stack('meta-tags')
         @includeFirst(['partials.javascript', 'bristolsu::partials.javascript'])
+        @includeFirst(['partials.analytics', 'bristolsu::partials.analytics'])
         <title>@yield('title-prefix', '')@yield('title', 'Portal')</title>
         @stack('fonts')
         @stack('styles')

src/Action/ActionBuilder.php

@@ -71,11 +71,20 @@ private function mapFields($fields, array $data)
         foreach ($fields as $field) {
             $actionValue = $field->action_value;
             foreach ($data as $key => $value) {
-                $actionValue = str_replace(sprintf('{{event:%s}}', $key), $value, $actionValue);
+                $actionValue = $this->replaceField($actionValue, $key, $value);
             }
             $actionFields[$field->action_field] = $actionValue;
         }
 
         return $actionFields;
     }
+
+    private function replaceField(string|array $data, string $key, ?string $value)
+    {
+        if (is_string($data)) {
+            return str_replace(sprintf('{{event:%s}}', $key), $value ?? '', $data);
+        }
+
+        return array_map(fn ($dataElement) => $this->replaceField($dataElement, $key, $value), $data);
+    }
 }

src/Action/ActionInstance.php

@@ -5,9 +5,9 @@
 use BristolSU\ControlDB\Contracts\Repositories\User;
 use BristolSU\Support\Action\History\ActionHistory;
 use BristolSU\Support\Authentication\Contracts\Authentication;
+use BristolSU\Support\Eloquent\CascadeRestoreDeletes;
 use BristolSU\Support\ModuleInstance\ModuleInstance;
 use BristolSU\Support\Revision\HasRevisions;
-use BristolSU\Support\Eloquent\CascadeRestoreDeletes;
 use Database\Factories\ActionInstanceFactory;
 use Dyrynda\Database\Support\CascadeSoftDeletes;
 use FormSchema\Transformers\Transformer;

src/Action/ActionInstanceField.php

@@ -24,6 +24,24 @@ class ActionInstanceField extends Model
         'action_value', 'action_field', 'action_instance_id'
     ];
 
+    public function getActionValueAttribute($value)
+    {
+        $json = json_decode($value, true);
+        if (json_last_error() === JSON_ERROR_NONE) {
+            return $json;
+        }
+
+        return $value;
+    }
+
+    public function setActionValueAttribute($value)
+    {
+        if (is_array($value)) {
+            $value = json_encode($value);
+        }
+        $this->attributes['action_value'] = $value;
+    }
+
     /**
      * The action instance relationship.
      *

src/Activity/Activity.php

@@ -5,11 +5,11 @@
 use BristolSU\ControlDB\Contracts\Repositories\User;
 use BristolSU\Support\ActivityInstance\ActivityInstance;
 use BristolSU\Support\Authentication\Contracts\Authentication;
+use BristolSU\Support\Eloquent\CascadeRestoreDeletes;
 use BristolSU\Support\Logic\Logic;
 use BristolSU\Support\ModuleInstance\ModuleInstance;
 use BristolSU\Support\ModuleInstance\ModuleInstanceGrouping;
 use BristolSU\Support\Revision\HasRevisions;
-use BristolSU\Support\Eloquent\CascadeRestoreDeletes;
 use Carbon\Carbon;
 use Database\Factories\ActivityFactory;
 use Dyrynda\Database\Support\CascadeSoftDeletes;

src/ActivityInstance/ActivityInstance.php

@@ -5,6 +5,9 @@
 use BristolSU\ControlDB\Contracts\Repositories\Group as GroupRepository;
 use BristolSU\ControlDB\Contracts\Repositories\Role as RoleRepository;
 use BristolSU\ControlDB\Contracts\Repositories\User as UserRepository;
+use BristolSU\ControlDB\Models\Dummy\GroupDummy;
+use BristolSU\ControlDB\Models\Dummy\RoleDummy;
+use BristolSU\ControlDB\Models\Dummy\UserDummy;
 use BristolSU\ControlDB\Models\Group;
 use BristolSU\ControlDB\Models\Role;
 use BristolSU\ControlDB\Models\User;
@@ -17,9 +20,6 @@
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\ModelNotFoundException;
-use BristolSU\ControlDB\Models\Dummy\UserDummy;
-use BristolSU\ControlDB\Models\Dummy\GroupDummy;
-use BristolSU\ControlDB\Models\Dummy\RoleDummy;
 use Illuminate\Database\Eloquent\SoftDeletes;
 
 /**

src/Connection/Client/CachedClientDecorator.php

@@ -51,7 +51,7 @@ public function request($method, $uri, array $options = [])
                 $this->cache->remember(
                     $this->getKey($method, $uri, $options),
                     7200,
-                    fn() => $this->toCacheArray(
+                    fn () => $this->toCacheArray(
                         $this->forwardCall($method, $uri, $options)
                     )
                 )

src/Eloquent/CascadeRestoreDeletes.php

@@ -5,11 +5,11 @@
 use BristolSU\Support\Eloquent\Exceptions\CascadeRestoreDeletesException;
 use Illuminate\Database\Eloquent\Relations\Relation;
 
-trait CascadeRestoreDeletes {
-
+trait CascadeRestoreDeletes
+{
     protected static function bootCascadeRestoreDeletes()
     {
-        static::restoring(function($model) {
+        static::restoring(function ($model) {
             $model->validateRestoringRelationships();
 
             $model->runCascadingRestores();
@@ -22,7 +22,7 @@ protected function validateRestoringRelationships()
             throw CascadeRestoreDeletesException::softDeleteNotImplemented(get_called_class());
         }
 
-        if($invalidCascadingRelationships = $this->hasInvalidCascadingRestoreRelationships()) {
+        if ($invalidCascadingRelationships = $this->hasInvalidCascadingRestoreRelationships()) {
             throw CascadeRestoreDeletesException::invalidRelationships($invalidCascadingRelationships);
         }
     }
@@ -55,7 +55,7 @@ protected function runCascadingRestores()
 
     protected function cascadeRestore($relationship)
     {
-        foreach($this->{$relationship}()->withTrashed()->where('deleted_at', '>=', $this->deleted_at)->get() as $model) {
+        foreach ($this->{$relationship}()->withTrashed()->where('deleted_at', '>=', $this->deleted_at)->get() as $model) {
             $model->restore();
         }
     }

src/Eloquent/Exceptions/CascadeRestoreDeletesException.php

@@ -12,7 +12,6 @@ public static function softDeleteNotImplemented($class)
         return new static(sprintf('%s does not implement Illuminate\Database\Eloquent\SoftDeletes', $class));
     }
 
-
     public static function invalidRelationships($relationships)
     {
         return new static(sprintf(

src/Filters/Events/AudienceChanged.php

@@ -2,9 +2,9 @@
 
 namespace BristolSU\Support\Filters\Events;
 
+use BristolSU\ControlDB\Contracts\Models\Group;
 use BristolSU\ControlDB\Contracts\Models\Role;
 use BristolSU\ControlDB\Contracts\Models\User;
-use BristolSU\ControlDB\Contracts\Models\Group;
 use BristolSU\Support\Filters\FilterInstance;
 use Illuminate\Foundation\Events\Dispatchable;
 use Illuminate\Queue\SerializesModels;
@@ -17,6 +17,7 @@ class AudienceChanged
      * @var array|FilterInstance[]
      */
     public array $filterInstances;
+
     public User|Group|Role|null $model;
 
     /**
@@ -30,5 +31,4 @@ public function __construct(array $filterInstances, User|Group|Role|null $model
         $this->filterInstances = $filterInstances;
         $this->model = $model;
     }
-
 }

src/Filters/FilterInstance.php

@@ -16,7 +16,6 @@
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
 use Illuminate\Database\Eloquent\SoftDeletes;
-use function Illuminate\Events\queueable;
 
 /**
  * Represents a filter instance.
@@ -58,12 +57,12 @@ protected static function booted()
             AudienceChanged::dispatch([$filterInstance]);
         });
         static::created(function (FilterInstance $filterInstance) {
-            if($filterInstance->logic_id) {
+            if ($filterInstance->logic_id) {
                 AudienceChanged::dispatch([$filterInstance]);
             }
         });
         static::updated(function (FilterInstance $filterInstance) {
-            if($filterInstance->isDirty(['settings', 'logic_id', 'logic_type'])) {
+            if ($filterInstance->isDirty(['settings', 'logic_id', 'logic_type'])) {
                 AudienceChanged::dispatch([$filterInstance]);
             }
         });

src/Filters/FilterManagerEventRegistrationDecorator.php

@@ -11,15 +11,13 @@
  */
 class FilterManagerEventRegistrationDecorator implements FilterManagerContract
 {
-
     private FilterManagerContract $baseFilterManager;
 
     public function __construct(FilterManagerContract $baseFilterManager)
     {
         $this->baseFilterManager = $baseFilterManager;
     }
 
-
     /**
      * Register a new filter.
      *