Add model fields to lesson model (#318)

* Add model fields to lesson model --------- Co-authored-by: Tomasz Smolarek <tomasz.smolarek@escolasoft.com>
EscolaLMS · Mar 7, 2024 · 76928e6 · 76928e6
1 parent bc01c5d
commit 76928e6
Show file tree

Hide file tree

Showing 17 changed files with 150 additions and 51 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -110,15 +110,6 @@ jobs:
  - name: Run tests
  run: vendor/bin/phpunit
 
- - name: Clear config
- run: vendor/bin/testbench config:clear
-
- - name: Publish things
- run: vendor/bin/testbench migrate:fresh
-
- - name: Run tests
- run: vendor/bin/phpunit
-
  php81-laravel-latest-phpunit-postgres:
  runs-on: ubuntu-latest
  container:
@@ -140,7 +131,7 @@ jobs:
  uses: actions/checkout@v2
 
  - name: Update composer
- run: COMPOSER_ROOT_VERSION=0.9.9 composer update
+ run: composer update
 
  - name: Setup environment
  run: cp env/postgres/* .
@@ -153,4 +144,5 @@ jobs:
 
  - name: Run tests
  run: vendor/bin/phpunit
+
 ### TODO add behat tests here
diff --git a/composer.json b/composer.json
@@ -5,14 +5,15 @@
  "require": {
  "php": ">=7.4",
  "davidbadura/faker-markdown-generator": "^1.1",
- "devianl2/laravel-scorm": "^2.0",
+ "devianl2/laravel-scorm": "^4.0",
  "escolalms/auth": "^0",
  "escolalms/categories": "^0",
  "escolalms/core": "^1",
  "escolalms/files": "^0",
  "escolalms/scorm": "^0",
  "escolalms/settings": "^0",
  "escolalms/tags": "^0",
+ "escolalms/model-fields": "^0",
  "laravel/framework": ">=8.0",
  "spatie/laravel-responsecache": "^7.4"
  },

diff --git a/env/codecov/testbench.yaml b/env/codecov/testbench.yaml
@@ -7,12 +7,15 @@ env:
  - DB_PASSWORD=password
 
 providers:
- - Spatie\Permission\PermissionServiceProvider
  - Laravel\Passport\PassportServiceProvider
+ - Spatie\Permission\PermissionServiceProvider
  - EscolaLms\Categories\EscolaLmsCategoriesServiceProvider
  - EscolaLms\Core\EscolaLmsServiceProvider
  - EscolaLms\Auth\EscolaLmsAuthServiceProvider
  - EscolaLms\Scorm\EscolaLmsScormServiceProvider
  - EscolaLms\Courses\EscolaLmsCourseServiceProvider
  - EscolaLms\Tags\EscolaLmsTagsServiceProvider
+ - EscolaLms\Settings\EscolaLmsSettingsServiceProvider
  - EscolaLms\Courses\Tests\EscolaLmsTopicTypeTestServiceProvider
+ - EscolaLms\Files\EscolaLmsFilesServiceProvider
+ - EscolaLms\ModelFields\ModelFieldsServiceProvider
diff --git a/env/mysql/testbench.yaml b/env/mysql/testbench.yaml
@@ -8,12 +8,15 @@ env:
  - APP_DEBUG=true
 
 providers:
- - Spatie\Permission\PermissionServiceProvider
  - Laravel\Passport\PassportServiceProvider
+ - Spatie\Permission\PermissionServiceProvider
  - EscolaLms\Categories\EscolaLmsCategoriesServiceProvider
  - EscolaLms\Core\EscolaLmsServiceProvider
  - EscolaLms\Auth\EscolaLmsAuthServiceProvider
  - EscolaLms\Scorm\EscolaLmsScormServiceProvider
  - EscolaLms\Courses\EscolaLmsCourseServiceProvider
  - EscolaLms\Tags\EscolaLmsTagsServiceProvider
+ - EscolaLms\Settings\EscolaLmsSettingsServiceProvider
  - EscolaLms\Courses\Tests\EscolaLmsTopicTypeTestServiceProvider
+ - EscolaLms\Files\EscolaLmsFilesServiceProvider
+ - EscolaLms\ModelFields\ModelFieldsServiceProvider
diff --git a/env/postgres/testbench.yaml b/env/postgres/testbench.yaml
@@ -7,12 +7,15 @@ env:
  - DB_PASSWORD=postgres
 
 providers:
- - Spatie\Permission\PermissionServiceProvider
  - Laravel\Passport\PassportServiceProvider
+ - Spatie\Permission\PermissionServiceProvider
  - EscolaLms\Categories\EscolaLmsCategoriesServiceProvider
  - EscolaLms\Core\EscolaLmsServiceProvider
  - EscolaLms\Auth\EscolaLmsAuthServiceProvider
  - EscolaLms\Scorm\EscolaLmsScormServiceProvider
  - EscolaLms\Courses\EscolaLmsCourseServiceProvider
  - EscolaLms\Tags\EscolaLmsTagsServiceProvider
+ - EscolaLms\Settings\EscolaLmsSettingsServiceProvider
  - EscolaLms\Courses\Tests\EscolaLmsTopicTypeTestServiceProvider
+ - EscolaLms\Files\EscolaLmsFilesServiceProvider
+ - EscolaLms\ModelFields\ModelFieldsServiceProvider
diff --git a/src/EscolaLmsCourseServiceProvider.php b/src/EscolaLmsCourseServiceProvider.php
@@ -2,7 +2,9 @@
 
 namespace EscolaLms\Courses;
 
+use EscolaLms\Courses\Models\Lesson;
 use EscolaLms\Courses\Models\Topic;
+use EscolaLms\Courses\Observers\LessonObserver;
 use EscolaLms\Courses\Observers\TopicObserver;
 use EscolaLms\Courses\Providers\EventServiceProvider;
 use EscolaLms\Courses\Providers\SettingsServiceProvider;
@@ -26,6 +28,7 @@
 use EscolaLms\Courses\Services\LessonService;
 use EscolaLms\Courses\Services\ProgressService;
 use EscolaLms\Courses\Services\TopicService;
+use EscolaLms\ModelFields\ModelFieldsServiceProvider;
 use EscolaLms\Scorm\EscolaLmsScormServiceProvider;
 use EscolaLms\Tags\EscolaLmsTagsServiceProvider;
 use Illuminate\Support\ServiceProvider;
@@ -61,6 +64,7 @@ public function boot()
  $router->aliasMiddleware('cacheResponse', CacheResponse::class);
 
  Topic::observe(TopicObserver::class);
+ Lesson::observe(LessonObserver::class);
  }
 
  protected function bootForConsole(): void
@@ -82,5 +86,6 @@ public function register()
  $this->app->register(EventServiceProvider::class);
  $this->app->register(EscolaLmsScormServiceProvider::class);
  $this->app->register(EscolaLmsTagsServiceProvider::class);
+ $this->app->register(ModelFieldsServiceProvider::class);
  }
 }
diff --git a/src/Http/Requests/CreateLessonAPIRequest.php b/src/Http/Requests/CreateLessonAPIRequest.php
@@ -5,6 +5,7 @@
 use EscolaLms\Courses\Models\Course;
 use EscolaLms\Courses\Models\Lesson;
 use EscolaLms\Courses\Rules\ValidParentLesson;
+use EscolaLms\ModelFields\Facades\ModelFields;
 use Illuminate\Foundation\Http\FormRequest;
 
 class CreateLessonAPIRequest extends FormRequest
@@ -21,6 +22,6 @@ public function rules(): array
  {
  return array_merge(Lesson::$rules, [
  'parent_lesson_id' => ['nullable', new ValidParentLesson($this->get('course_id'))],
- ]);
+ ], ModelFields::getFieldsMetadataRules(Lesson::class));
  }
 }
diff --git a/src/Http/Requests/UpdateLessonAPIRequest.php b/src/Http/Requests/UpdateLessonAPIRequest.php
@@ -4,6 +4,7 @@
 
 use EscolaLms\Courses\Models\Lesson;
 use EscolaLms\Courses\Rules\ValidParentLesson;
+use EscolaLms\ModelFields\Facades\ModelFields;
 use Illuminate\Foundation\Http\FormRequest;
 
 class UpdateLessonAPIRequest extends FormRequest
@@ -20,6 +21,6 @@ public function rules(): array
  {
  return array_merge(Lesson::$rules, [
  'parent_lesson_id' => ['nullable', new ValidParentLesson($this->get('course_id'))],
- ]);
+ ], ModelFields::getFieldsMetadataRules(Lesson::class));
  }
 }
diff --git a/src/Http/Resources/Admin/LessonWithTopicsAdminResource.php b/src/Http/Resources/Admin/LessonWithTopicsAdminResource.php
@@ -3,6 +3,8 @@
 namespace EscolaLms\Courses\Http\Resources\Admin;
 
 use EscolaLms\Courses\Models\Lesson;
+use EscolaLms\ModelFields\Enum\MetaFieldVisibilityEnum;
+use EscolaLms\ModelFields\Facades\ModelFields;
 use Illuminate\Http\Resources\Json\JsonResource;
 
 /**
@@ -39,6 +41,7 @@ public function toArray($request): array
  'lessons' => LessonWithTopicsAdminResource::collection($lesson->lessons->sortBy('order')),
  'active_from' => $this->active_from,
  'active_to' => $this->active_to,
+ ...ModelFields::getExtraAttributesValues($this->resource, MetaFieldVisibilityEnum::PUBLIC)
  ];
  }
 }
diff --git a/src/Http/Resources/LessonResource.php b/src/Http/Resources/LessonResource.php
@@ -3,6 +3,8 @@
 namespace EscolaLms\Courses\Http\Resources;
 
 use EscolaLms\Courses\Models\Lesson;
+use EscolaLms\ModelFields\Enum\MetaFieldVisibilityEnum;
+use EscolaLms\ModelFields\Facades\ModelFields;
 use Illuminate\Http\Resources\Json\JsonResource;
 
 /**
@@ -23,6 +25,7 @@ public function toArray($request): array
  'active_from' => $this->active_from,
  'active_to' => $this->active_to,
  'lessons' => LessonSimpleResource::collection($this->lessons->filter(fn (Lesson $lesson) => $lesson->active)->sortBy('order')),
+ ...ModelFields::getExtraAttributesValues($this->resource, MetaFieldVisibilityEnum::PUBLIC)
  ];
  }
 }
diff --git a/src/Http/Resources/LessonWithTopicsResource.php b/src/Http/Resources/LessonWithTopicsResource.php
@@ -4,6 +4,8 @@
 
 use EscolaLms\Courses\Models\Lesson;
 use EscolaLms\Courses\Models\Topic;
+use EscolaLms\ModelFields\Enum\MetaFieldVisibilityEnum;
+use EscolaLms\ModelFields\Facades\ModelFields;
 use Illuminate\Http\Resources\Json\JsonResource;
 
 class LessonWithTopicsResource extends JsonResource
@@ -39,6 +41,7 @@ public function toArray($request): array
  'active_from' => $this->active_from,
  'active_to' => $this->active_to,
  'lessons' => LessonWithTopicsResource::collection($lessons),
+ ...ModelFields::getExtraAttributesValues($this->resource, MetaFieldVisibilityEnum::PUBLIC)
  ];
  }
 }
diff --git a/src/Models/Lesson.php b/src/Models/Lesson.php
@@ -4,6 +4,7 @@
 
 use EscolaLms\Core\Models\Traits\QueryCacheable;
 use EscolaLms\Courses\Database\Factories\LessonFactory;
+use EscolaLms\ModelFields\Traits\ModelFields;
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Model;
@@ -73,7 +74,9 @@
  */
 class Lesson extends Model
 {
- use HasFactory, QueryCacheable;
+ use HasFactory;
+ use QueryCacheable;
+ use ModelFields;
 
  public $table = 'lessons';
 
@@ -174,19 +177,4 @@ public function isActive(): bool
 
  return true;
  }
-
- protected static function booted()
- {
- static::creating(function (Lesson $lesson) {
- if (!$lesson->order) {
- $lesson->order = 1 + (int)Lesson::when($lesson->course_id, function (Builder $query, int $courseId) {
- $query->where('course_id', $courseId);
- })
- ->when($lesson->parent_lesson_id, function (Builder $query, int $parentId) {
- $query->where('parent_lesson_id', $parentId);
- })
- ->max('order');
- }
- });
- }
 }
diff --git a/src/Models/Topic.php b/src/Models/Topic.php
@@ -2,7 +2,6 @@
 
 namespace EscolaLms\Courses\Models;
 
-use Chelout\RelationshipEvents\Concerns\HasMorphToManyEvents;
 use EscolaLms\Core\Models\Traits\QueryCacheable;
 use EscolaLms\Courses\Database\Factories\TopicFactory;
 use EscolaLms\Courses\Facades\Topic as TopicFacade;

diff --git a/src/Observers/LessonObserver.php b/src/Observers/LessonObserver.php
@@ -0,0 +1,24 @@
+<?php
+
+namespace EscolaLms\Courses\Observers;
+
+use EscolaLms\Courses\Models\Lesson;
+use Illuminate\Database\Eloquent\Builder;
+
+class LessonObserver
+{
+ public function creating(Lesson $lesson): void
+ {
+ if (!$lesson->order) {
+ $lesson->order = 1 +
+ (int)Lesson::query()
+ ->when($lesson->course_id, function (Builder $query, int $courseId) {
+ $query->where('course_id', $courseId);
+ })
+ ->when($lesson->parent_lesson_id, function (Builder $query, int $parentId) {
+ $query->where('parent_lesson_id', $parentId);
+ })
+ ->max('order');
+ }
+ }
+}
diff --git a/testbench.yaml b/testbench.yaml
@@ -18,3 +18,4 @@ providers:
  - EscolaLms\Settings\EscolaLmsSettingsServiceProvider
  - EscolaLms\Courses\Tests\EscolaLmsTopicTypeTestServiceProvider
  - EscolaLms\Files\EscolaLmsFilesServiceProvider
+ - EscolaLms\ModelFields\ModelFieldsServiceProvider