Compare commits

...

7 commits

20 changed files with 150 additions and 2 deletions

View file

@ -35,6 +35,15 @@ intentionally omitted here - update this section as entities land.
`new Set(...)`) instead of creating them through their fake `new Set(...)`) instead of creating them through their fake
repositories repositories
## Migrations
- This project is not in production. By default, schema changes should update
the relevant create-table migration so migrations describe the current desired
schema from scratch.
- Do not add alter-table or data-backfill migrations unless the user explicitly
asks for production-style migration safety.
- Put seed data in seeders, not migrations.
## PHP rules ## PHP rules
- Imports: always put `use` statements at the top of the file, never use - Imports: always put `use` statements at the top of the file, never use

View file

@ -36,6 +36,7 @@ class ElementController
$childElements[] = [ $childElements[] = [
'id' => $childElement->getId(), 'id' => $childElement->getId(),
'title' => $childElement->getTitle(), 'title' => $childElement->getTitle(),
'description' => $childElement->getDescription(),
]; ];
} }
@ -44,6 +45,7 @@ class ElementController
'element' => [ 'element' => [
'id' => $element->getId(), 'id' => $element->getId(),
'title' => $element->getTitle(), 'title' => $element->getTitle(),
'description' => $element->getDescription(),
], ],
], 200); ], 200);
} }

View file

@ -9,6 +9,7 @@ class CreateElementDto
public function __construct( public function __construct(
public Set $set, public Set $set,
public string $title, public string $title,
public string $description,
public ?Element $parentElement, public ?Element $parentElement,
) { ) {
} }

View file

@ -9,6 +9,7 @@ class Element
public function __construct( public function __construct(
private int $id, private int $id,
private string $title, private string $title,
private string $description,
private Set $set, private Set $set,
private ?Element $parentElement, private ?Element $parentElement,
) { ) {
@ -24,6 +25,11 @@ class Element
return $this->title; return $this->title;
} }
public function getDescription(): string
{
return $this->description;
}
public function getSet(): Set public function getSet(): Set
{ {
return $this->set; return $this->set;

View file

@ -9,6 +9,7 @@ use Illuminate\Database\Eloquent\Model;
* @property int $id * @property int $id
* @property int $set_id * @property int $set_id
* @property string $title * @property string $title
* @property string $description
* @property int|null $parent_element_id * @property int|null $parent_element_id
* *
* @method static Builder<static>|ElementModel newModelQuery() * @method static Builder<static>|ElementModel newModelQuery()
@ -18,6 +19,7 @@ use Illuminate\Database\Eloquent\Model;
* @method static Builder<static>|ElementModel whereParentElementId($value) * @method static Builder<static>|ElementModel whereParentElementId($value)
* @method static Builder<static>|ElementModel whereSetId($value) * @method static Builder<static>|ElementModel whereSetId($value)
* @method static Builder<static>|ElementModel whereTitle($value) * @method static Builder<static>|ElementModel whereTitle($value)
* @method static Builder<static>|ElementModel whereDescription($value)
* *
* @mixin \Eloquent * @mixin \Eloquent
*/ */
@ -30,6 +32,7 @@ class ElementModel extends Model
protected $fillable = [ protected $fillable = [
'set_id', 'set_id',
'title', 'title',
'description',
'parent_element_id', 'parent_element_id',
]; ];

View file

@ -17,12 +17,14 @@ class EloquentElementRepository implements ElementRepository
$model = ElementModel::create([ $model = ElementModel::create([
'set_id' => $dto->set->getId(), 'set_id' => $dto->set->getId(),
'title' => $dto->title, 'title' => $dto->title,
'description' => $dto->description,
'parent_element_id' => $dto->parentElement?->getId(), 'parent_element_id' => $dto->parentElement?->getId(),
]); ]);
return new Element( return new Element(
id: $model->id, id: $model->id,
title: $dto->title, title: $dto->title,
description: $dto->description,
set: $dto->set, set: $dto->set,
parentElement: $dto->parentElement, parentElement: $dto->parentElement,
); );
@ -102,6 +104,7 @@ class EloquentElementRepository implements ElementRepository
return new Element( return new Element(
id: $model->id, id: $model->id,
title: $model->title, title: $model->title,
description: $model->description,
set: $set, set: $set,
parentElement: $parentElement, parentElement: $parentElement,
); );

View file

@ -30,6 +30,7 @@ class CreateElement
if ($request->title === null || $request->title === '') { if ($request->title === null || $request->title === '') {
throw new BadRequestException('title is required'); throw new BadRequestException('title is required');
} }
$description = $request->description ?? '';
$set = $this->setRepo->find($request->setId); $set = $this->setRepo->find($request->setId);
if ($set === null) { if ($set === null) {
@ -44,6 +45,7 @@ class CreateElement
return $this->elementRepo->create(new CreateElementDto( return $this->elementRepo->create(new CreateElementDto(
set: $set, set: $set,
title: $request->title, title: $request->title,
description: $description,
parentElement: null, parentElement: null,
)); ));
} }
@ -65,6 +67,7 @@ class CreateElement
return $this->elementRepo->create(new CreateElementDto( return $this->elementRepo->create(new CreateElementDto(
set: $set, set: $set,
title: $request->title, title: $request->title,
description: $description,
parentElement: $parentElement, parentElement: $parentElement,
)); ));
} }

View file

@ -7,6 +7,7 @@ class CreateElementRequest
public function __construct( public function __construct(
public ?int $setId, public ?int $setId,
public ?string $title, public ?string $title,
public ?string $description,
public ?int $parentElementId, public ?int $parentElementId,
) { ) {
} }

View file

@ -12,6 +12,7 @@ return new class extends Migration
$table->id(); $table->id();
$table->foreignId('set_id')->constrained('sets'); $table->foreignId('set_id')->constrained('sets');
$table->string('title'); $table->string('title');
$table->text('description')->default('');
$table->foreignId('parent_element_id') $table->foreignId('parent_element_id')
->nullable() ->nullable()
->constrained('elements'); ->constrained('elements');

View file

@ -17,16 +17,20 @@ class ElementSeeder extends Seeder
$rootElement = $elementRepository->create(new CreateElementDto( $rootElement = $elementRepository->create(new CreateElementDto(
set: $baderechSet, set: $baderechSet,
title: $baderechSet->getName(), title: $baderechSet->getName(),
description: $baderechSet->getDescription(),
parentElement: null, parentElement: null,
)); ));
$elementRepository->create(new CreateElementDto( $elementRepository->create(new CreateElementDto(
set: $baderechSet, set: $baderechSet,
title: 'Avodah Foundations', title: 'Avodah Foundations',
description: 'Core foundations for building a steady '
. 'avodah practice.',
parentElement: $rootElement, parentElement: $rootElement,
)); ));
$elementRepository->create(new CreateElementDto( $elementRepository->create(new CreateElementDto(
set: $baderechSet, set: $baderechSet,
title: 'Daily Practice', title: 'Daily Practice',
description: 'Practical steps for consistent daily growth.',
parentElement: $rootElement, parentElement: $rootElement,
)); ));
} }

View file

@ -20,6 +20,7 @@ class FakeElementRepository implements ElementRepository
$element = new Element( $element = new Element(
id: $id, id: $id,
title: $dto->title, title: $dto->title,
description: $dto->description,
set: $dto->set, set: $dto->set,
parentElement: $dto->parentElement, parentElement: $dto->parentElement,
); );
@ -95,6 +96,7 @@ class FakeElementRepository implements ElementRepository
return new Element( return new Element(
id: $element->getId(), id: $element->getId(),
title: $element->getTitle(), title: $element->getTitle(),
description: $element->getDescription(),
set: $element->getSet(), set: $element->getSet(),
parentElement: $parentElement, parentElement: $parentElement,
); );

View file

@ -25,16 +25,19 @@ class ElementsEndpointTest extends TestCase
$element = $elementRepository->create(new CreateElementDto( $element = $elementRepository->create(new CreateElementDto(
set: $set, set: $set,
title: 'Baderech HaAvodah', title: 'Baderech HaAvodah',
description: 'A structured path for growth',
parentElement: null, parentElement: null,
)); ));
$firstChildElement = $elementRepository->create(new CreateElementDto( $firstChildElement = $elementRepository->create(new CreateElementDto(
set: $set, set: $set,
title: 'Avodah Foundations', title: 'Avodah Foundations',
description: 'Foundations for steady avodah',
parentElement: $element, parentElement: $element,
)); ));
$secondChildElement = $elementRepository->create(new CreateElementDto( $secondChildElement = $elementRepository->create(new CreateElementDto(
set: $set, set: $set,
title: 'Daily Practice', title: 'Daily Practice',
description: 'Daily practices for growth',
parentElement: $element, parentElement: $element,
)); ));
@ -46,15 +49,18 @@ class ElementsEndpointTest extends TestCase
[ [
'id' => $firstChildElement->getId(), 'id' => $firstChildElement->getId(),
'title' => 'Avodah Foundations', 'title' => 'Avodah Foundations',
'description' => 'Foundations for steady avodah',
], ],
[ [
'id' => $secondChildElement->getId(), 'id' => $secondChildElement->getId(),
'title' => 'Daily Practice', 'title' => 'Daily Practice',
'description' => 'Daily practices for growth',
], ],
], ],
'element' => [ 'element' => [
'id' => $element->getId(), 'id' => $element->getId(),
'title' => 'Baderech HaAvodah', 'title' => 'Baderech HaAvodah',
'description' => 'A structured path for growth',
], ],
]); ]);
} }

View file

@ -31,6 +31,7 @@ class SetsEndpointTest extends TestCase
new CreateElementDto( new CreateElementDto(
set: $baderechSet, set: $baderechSet,
title: $baderechSet->getName(), title: $baderechSet->getName(),
description: $baderechSet->getDescription(),
parentElement: null, parentElement: null,
) )
); );

View file

@ -26,15 +26,22 @@ class ElementControllerTest extends TestCase
public function testShowReturnsElementPayload(): void public function testShowReturnsElementPayload(): void
{ {
$set = $this->createSet(1, 'Baderech'); $set = $this->createSet(1, 'Baderech');
$element = $this->createElement($set, 'Baderech HaAvodah', null); $element = $this->createElement(
$set,
'Baderech HaAvodah',
'A structured path for growth',
null,
);
$firstChildElement = $this->createElement( $firstChildElement = $this->createElement(
$set, $set,
'Avodah Foundations', 'Avodah Foundations',
'Foundations for steady avodah',
$element, $element,
); );
$secondChildElement = $this->createElement( $secondChildElement = $this->createElement(
$set, $set,
'Daily Practice', 'Daily Practice',
'Daily practices for growth',
$element, $element,
); );
@ -44,14 +51,20 @@ class ElementControllerTest extends TestCase
$body = json_decode($response->getContent(), true); $body = json_decode($response->getContent(), true);
$this->assertSame($element->getId(), $body['element']['id']); $this->assertSame($element->getId(), $body['element']['id']);
$this->assertSame('Baderech HaAvodah', $body['element']['title']); $this->assertSame('Baderech HaAvodah', $body['element']['title']);
$this->assertSame(
'A structured path for growth',
$body['element']['description'],
);
$this->assertSame([ $this->assertSame([
[ [
'id' => $firstChildElement->getId(), 'id' => $firstChildElement->getId(),
'title' => 'Avodah Foundations', 'title' => 'Avodah Foundations',
'description' => 'Foundations for steady avodah',
], ],
[ [
'id' => $secondChildElement->getId(), 'id' => $secondChildElement->getId(),
'title' => 'Daily Practice', 'title' => 'Daily Practice',
'description' => 'Daily practices for growth',
], ],
], $body['childElements']); ], $body['childElements']);
} }
@ -91,11 +104,13 @@ class ElementControllerTest extends TestCase
private function createElement( private function createElement(
DomainSet $set, DomainSet $set,
string $title, string $title,
string $description,
?Element $parentElement, ?Element $parentElement,
): Element { ): Element {
return $this->elementRepo->create(new CreateElementDto( return $this->elementRepo->create(new CreateElementDto(
set: $set, set: $set,
title: $title, title: $title,
description: $description,
parentElement: $parentElement, parentElement: $parentElement,
)); ));
} }

View file

@ -19,18 +19,24 @@ class ElementTest extends TestCase
$rootElement = new Element( $rootElement = new Element(
id: 1, id: 1,
title: 'Root', title: 'Root',
description: 'Root description',
set: $set, set: $set,
parentElement: null, parentElement: null,
); );
$childElement = new Element( $childElement = new Element(
id: 2, id: 2,
title: 'Child', title: 'Child',
description: 'Child description',
set: $set, set: $set,
parentElement: $rootElement, parentElement: $rootElement,
); );
$this->assertSame(2, $childElement->getId()); $this->assertSame(2, $childElement->getId());
$this->assertSame('Child', $childElement->getTitle()); $this->assertSame('Child', $childElement->getTitle());
$this->assertSame(
'Child description',
$childElement->getDescription(),
);
$this->assertSame($set, $childElement->getSet()); $this->assertSame($set, $childElement->getSet());
$this->assertSame($rootElement, $childElement->getParentElement()); $this->assertSame($rootElement, $childElement->getParentElement());
$this->assertNull($rootElement->getParentElement()); $this->assertNull($rootElement->getParentElement());

View file

@ -47,11 +47,13 @@ class CreateElementTest extends TestCase
$element = $this->createElement->execute(new CreateElementRequest( $element = $this->createElement->execute(new CreateElementRequest(
setId: $set->getId(), setId: $set->getId(),
title: 'Root', title: 'Root',
description: 'Root description',
parentElementId: null, parentElementId: null,
)); ));
$this->assertInstanceOf(Element::class, $element); $this->assertInstanceOf(Element::class, $element);
$this->assertSame('Root', $element->getTitle()); $this->assertSame('Root', $element->getTitle());
$this->assertSame('Root description', $element->getDescription());
$this->assertSame($set->getId(), $element->getSet()->getId()); $this->assertSame($set->getId(), $element->getSet()->getId());
$this->assertNull($element->getParentElement()); $this->assertNull($element->getParentElement());
} }
@ -63,6 +65,7 @@ class CreateElementTest extends TestCase
new CreateElementRequest( new CreateElementRequest(
setId: $set->getId(), setId: $set->getId(),
title: 'Root', title: 'Root',
description: 'Root description',
parentElementId: null, parentElementId: null,
) )
); );
@ -71,17 +74,36 @@ class CreateElementTest extends TestCase
new CreateElementRequest( new CreateElementRequest(
setId: $set->getId(), setId: $set->getId(),
title: 'Child', title: 'Child',
description: 'Child description',
parentElementId: $rootElement->getId(), parentElementId: $rootElement->getId(),
) )
); );
$this->assertSame('Child', $childElement->getTitle()); $this->assertSame('Child', $childElement->getTitle());
$this->assertSame(
'Child description',
$childElement->getDescription(),
);
$this->assertSame( $this->assertSame(
$rootElement->getId(), $rootElement->getId(),
$childElement->getParentElement()->getId(), $childElement->getParentElement()->getId(),
); );
} }
public function testCreatesElementWithBlankDescriptionWhenMissing(): void
{
$set = $this->createSet('Daily learning');
$element = $this->createElement->execute(new CreateElementRequest(
setId: $set->getId(),
title: 'Root',
description: null,
parentElementId: null,
));
$this->assertSame('', $element->getDescription());
}
public function testThrowsWhenSetIdMissing(): void public function testThrowsWhenSetIdMissing(): void
{ {
$this->expectException(BadRequestException::class); $this->expectException(BadRequestException::class);
@ -90,6 +112,7 @@ class CreateElementTest extends TestCase
$this->createElement->execute(new CreateElementRequest( $this->createElement->execute(new CreateElementRequest(
setId: null, setId: null,
title: 'Root', title: 'Root',
description: 'Root description',
parentElementId: null, parentElementId: null,
)); ));
} }
@ -102,6 +125,7 @@ class CreateElementTest extends TestCase
$this->createElement->execute(new CreateElementRequest( $this->createElement->execute(new CreateElementRequest(
setId: 1, setId: 1,
title: null, title: null,
description: 'Root description',
parentElementId: null, parentElementId: null,
)); ));
} }
@ -114,6 +138,7 @@ class CreateElementTest extends TestCase
$this->createElement->execute(new CreateElementRequest( $this->createElement->execute(new CreateElementRequest(
setId: 99, setId: 99,
title: 'Root', title: 'Root',
description: 'Root description',
parentElementId: null, parentElementId: null,
)); ));
} }
@ -130,6 +155,7 @@ class CreateElementTest extends TestCase
$this->createElement->execute(new CreateElementRequest( $this->createElement->execute(new CreateElementRequest(
setId: $set->getId(), setId: $set->getId(),
title: 'Child', title: 'Child',
description: 'Child description',
parentElementId: 99, parentElementId: 99,
)); ));
} }
@ -140,6 +166,7 @@ class CreateElementTest extends TestCase
$this->createElement->execute(new CreateElementRequest( $this->createElement->execute(new CreateElementRequest(
setId: $set->getId(), setId: $set->getId(),
title: 'Root', title: 'Root',
description: 'Root description',
parentElementId: null, parentElementId: null,
)); ));
@ -151,6 +178,7 @@ class CreateElementTest extends TestCase
$this->createElement->execute(new CreateElementRequest( $this->createElement->execute(new CreateElementRequest(
setId: $set->getId(), setId: $set->getId(),
title: 'Another root', title: 'Another root',
description: 'Another root description',
parentElementId: null, parentElementId: null,
)); ));
} }
@ -163,6 +191,7 @@ class CreateElementTest extends TestCase
new CreateElementRequest( new CreateElementRequest(
setId: $parentSet->getId(), setId: $parentSet->getId(),
title: 'Parent root', title: 'Parent root',
description: 'Parent root description',
parentElementId: null, parentElementId: null,
) )
); );
@ -175,6 +204,7 @@ class CreateElementTest extends TestCase
$this->createElement->execute(new CreateElementRequest( $this->createElement->execute(new CreateElementRequest(
setId: $childSet->getId(), setId: $childSet->getId(),
title: 'Invalid child', title: 'Invalid child',
description: 'Invalid child description',
parentElementId: $parentElement->getId(), parentElementId: $parentElement->getId(),
)); ));
} }

View file

@ -30,6 +30,7 @@ class GetElementTest extends TestCase
$element = $this->createElement( $element = $this->createElement(
$set, $set,
'Baderech HaAvodah', 'Baderech HaAvodah',
'A structured path for growth',
null, null,
); );
@ -41,6 +42,10 @@ class GetElementTest extends TestCase
$this->assertInstanceOf(Element::class, $foundElement); $this->assertInstanceOf(Element::class, $foundElement);
$this->assertSame($element->getId(), $foundElement->getId()); $this->assertSame($element->getId(), $foundElement->getId());
$this->assertSame('Baderech HaAvodah', $foundElement->getTitle()); $this->assertSame('Baderech HaAvodah', $foundElement->getTitle());
$this->assertSame(
'A structured path for growth',
$foundElement->getDescription(),
);
} }
public function testReturnsDirectChildElements(): void public function testReturnsDirectChildElements(): void
@ -49,32 +54,38 @@ class GetElementTest extends TestCase
$parentElement = $this->createElement( $parentElement = $this->createElement(
$set, $set,
'Baderech HaAvodah', 'Baderech HaAvodah',
'A structured path for growth',
null, null,
); );
$firstChildElement = $this->createElement( $firstChildElement = $this->createElement(
$set, $set,
'Avodah Foundations', 'Avodah Foundations',
'Foundations for steady avodah',
$parentElement, $parentElement,
); );
$secondChildElement = $this->createElement( $secondChildElement = $this->createElement(
$set, $set,
'Daily Practice', 'Daily Practice',
'Daily practices for growth',
$parentElement, $parentElement,
); );
$this->createElement( $this->createElement(
$set, $set,
'Nested Practice', 'Nested Practice',
'Nested description',
$firstChildElement, $firstChildElement,
); );
$otherSet = $this->createSet(2, 'Daily Learning'); $otherSet = $this->createSet(2, 'Daily Learning');
$otherParentElement = $this->createElement( $otherParentElement = $this->createElement(
$otherSet, $otherSet,
'Other Parent', 'Other Parent',
'Other parent description',
null, null,
); );
$this->createElement( $this->createElement(
$otherSet, $otherSet,
'Other Child', 'Other Child',
'Other child description',
$otherParentElement, $otherParentElement,
); );
@ -89,11 +100,19 @@ class GetElementTest extends TestCase
$childElements[0]->getId(), $childElements[0]->getId(),
); );
$this->assertSame('Avodah Foundations', $childElements[0]->getTitle()); $this->assertSame('Avodah Foundations', $childElements[0]->getTitle());
$this->assertSame(
'Foundations for steady avodah',
$childElements[0]->getDescription(),
);
$this->assertSame( $this->assertSame(
$secondChildElement->getId(), $secondChildElement->getId(),
$childElements[1]->getId(), $childElements[1]->getId(),
); );
$this->assertSame('Daily Practice', $childElements[1]->getTitle()); $this->assertSame('Daily Practice', $childElements[1]->getTitle());
$this->assertSame(
'Daily practices for growth',
$childElements[1]->getDescription(),
);
} }
public function testThrowsWhenIdMissing(): void public function testThrowsWhenIdMissing(): void
@ -125,11 +144,13 @@ class GetElementTest extends TestCase
private function createElement( private function createElement(
DomainSet $set, DomainSet $set,
string $title, string $title,
string $description,
?Element $parentElement, ?Element $parentElement,
): Element { ): Element {
return $this->elementRepo->create(new CreateElementDto( return $this->elementRepo->create(new CreateElementDto(
set: $set, set: $set,
title: $title, title: $title,
description: $description,
parentElement: $parentElement, parentElement: $parentElement,
)); ));
} }

View file

@ -43,9 +43,21 @@ describe('media page sets', () => {
cy.contains('h1', 'Baderech HaAvodah').should('be.visible') cy.contains('h1', 'Baderech HaAvodah').should('be.visible')
cy.get('[data-cy="child-element-list"]').should('be.visible') cy.get('[data-cy="child-element-list"]').should('be.visible')
cy.contains('[data-cy="child-element-link"]', 'Avodah Foundations') cy.contains('[data-cy="child-element-link"]', 'Avodah Foundations')
.as('avodahFoundationsLink')
.should('have.attr', 'href', '/element/2') .should('have.attr', 'href', '/element/2')
cy.get('@avodahFoundationsLink')
.should(
'contain.text',
'Core foundations for building a steady avodah practice.',
)
cy.contains('[data-cy="child-element-link"]', 'Daily Practice') cy.contains('[data-cy="child-element-link"]', 'Daily Practice')
.as('dailyPracticeLink')
.should('have.attr', 'href', '/element/3') .should('have.attr', 'href', '/element/3')
cy.get('@dailyPracticeLink')
.should(
'contain.text',
'Practical steps for consistent daily growth.',
)
cy.contains('[data-cy="child-element-link"]', 'Avodah Foundations') cy.contains('[data-cy="child-element-link"]', 'Avodah Foundations')
.click() .click()

View file

@ -4,6 +4,7 @@ import { defineStore } from 'pinia'
export interface Element { export interface Element {
id: number id: number
title: string title: string
description: string
} }
interface ElementResponse { interface ElementResponse {

View file

@ -65,7 +65,15 @@ watch(
class="element-page__child-link" class="element-page__child-link"
data-cy="child-element-link" data-cy="child-element-link"
> >
<span class="element-page__child-title">
{{ childElement.title }} {{ childElement.title }}
</span>
<span
v-if="childElement.description !== ''"
class="element-page__child-description"
>
{{ childElement.description }}
</span>
</RouterLink> </RouterLink>
</li> </li>
</ul> </ul>
@ -131,6 +139,19 @@ watch(
transform 180ms ease; transform 180ms ease;
} }
.element-page__child-title {
display: block;
}
.element-page__child-description {
display: block;
margin-top: 0.4rem;
color: var(--color-text-muted);
font-family: var(--font-sans);
font-size: 0.95rem;
line-height: 1.45;
}
.element-page__child-link:hover, .element-page__child-link:hover,
.element-page__child-link:focus-visible { .element-page__child-link:focus-visible {
border-color: #d4ad5f; border-color: #d4ad5f;