Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions src/Events/ProjectGradabilityChangedEvent.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
<?php

namespace EscolaLms\TopicTypeProject\Events;

use EscolaLms\TopicTypeProject\Models\Project;
use Illuminate\Foundation\Events\Dispatchable;
use Illuminate\Queue\SerializesModels;

/**
* Emitted whenever a project's counts_to_grade flag flips, in either direction.
* Consumed (in pcg-grades) to regenerate or delete the journal partial grade(s)
* derived from this project.
*/
class ProjectGradabilityChangedEvent
{
use Dispatchable, SerializesModels;

public Project $project;

public function __construct(Project $project)
{
$this->project = $project;
}

public function getProject(): Project
{
return $this->project;
}

public function countsToGrade(): bool
{
return (bool) $this->project->counts_to_grade;
}
}
12 changes: 12 additions & 0 deletions src/Models/Project.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
namespace EscolaLms\TopicTypeProject\Models;

use EscolaLms\TopicTypeProject\Database\Factories\ProjectFactory;
use EscolaLms\TopicTypeProject\Events\ProjectGradabilityChangedEvent;
use EscolaLms\TopicTypes\Facades\Markdown;
use EscolaLms\TopicTypes\Models\TopicContent\AbstractTopicContent;
use Illuminate\Database\Eloquent\Factories\HasFactory;
Expand Down Expand Up @@ -104,4 +105,15 @@ public function getMorphClass()
{
return self::class;
}

protected static function booted(): void
{
parent::booted();

static::updated(function (Project $project) {
if ($project->wasChanged('counts_to_grade')) {
event(new ProjectGradabilityChangedEvent($project));
}
});
}
}
96 changes: 96 additions & 0 deletions tests/Models/ProjectGradabilityChangedEventTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
<?php

namespace EscolaLms\TopicTypeProject\Tests\Models;

use EscolaLms\Core\Tests\CreatesUsers;
use EscolaLms\Courses\Database\Seeders\CoursesPermissionSeeder;
use EscolaLms\Courses\Models\Course;
use EscolaLms\Courses\Models\Lesson;
use EscolaLms\Courses\Models\Topic;
use EscolaLms\TopicTypeProject\Events\ProjectGradabilityChangedEvent;
use EscolaLms\TopicTypeProject\Models\Project;
use EscolaLms\TopicTypeProject\Tests\TestCase;
use Illuminate\Support\Facades\Event;

class ProjectGradabilityChangedEventTest extends TestCase
{
use CreatesUsers;

public function testEmitsWhenCountsToGradeEnabled(): void
{
$project = Project::factory()->create(['counts_to_grade' => false]);

Event::fake([ProjectGradabilityChangedEvent::class]);

$project->update(['counts_to_grade' => true]);

Event::assertDispatched(
ProjectGradabilityChangedEvent::class,
fn (ProjectGradabilityChangedEvent $event) => $event->getProject()->is($project) && $event->countsToGrade() === true
);
}

public function testEmitsWhenCountsToGradeDisabled(): void
{
$project = Project::factory()->create(['counts_to_grade' => true]);

Event::fake([ProjectGradabilityChangedEvent::class]);

$project->update(['counts_to_grade' => false]);

Event::assertDispatched(
ProjectGradabilityChangedEvent::class,
fn (ProjectGradabilityChangedEvent $event) => $event->getProject()->is($project) && $event->countsToGrade() === false
);
}

public function testDoesNotEmitWhenCountsToGradeIsUnchanged(): void
{
$project = Project::factory()->create(['counts_to_grade' => true]);

Event::fake([ProjectGradabilityChangedEvent::class]);

$project->update(['value' => 'a different value', 'counts_to_grade' => true]);

Event::assertNotDispatched(ProjectGradabilityChangedEvent::class);
}

public function testDoesNotEmitOnCreate(): void
{
Event::fake([ProjectGradabilityChangedEvent::class]);

Project::factory()->create(['counts_to_grade' => true]);

Event::assertNotDispatched(ProjectGradabilityChangedEvent::class);
}

public function testEmitsViaGenericTopicUpdateEndpoint(): void
{
$this->seed(CoursesPermissionSeeder::class);
$project = Project::factory()->create(['counts_to_grade' => false]);
$topic = Topic::factory()
->for(Lesson::factory()->for(Course::factory()))
->create([
'topicable_type' => Project::class,
'topicable_id' => $project->getKey(),
]);

Event::fake([ProjectGradabilityChangedEvent::class]);

$this
->actingAs($this->makeAdmin(), 'api')
->postJson('/api/admin/topics/' . $topic->getKey(), [
'title' => $topic->title,
'lesson_id' => $topic->lesson_id,
'topicable_type' => Project::class,
'value' => $project->value,
'counts_to_grade' => true,
])
->assertOk();

Event::assertDispatched(
ProjectGradabilityChangedEvent::class,
fn (ProjectGradabilityChangedEvent $event) => $event->getProject()->is($project) && $event->countsToGrade() === true
);
}
}
Loading