Work-Related/TYPO3ContentElements
1
0
mirror of https://github.com/SkillDisplay/TYPO3ContentElements.git synced 2024-11-21 19:16:08 +01:00
Code Releases Activity

Handle unavailable skills and skillsets in backend and frontend

Browse source 
Show an error message in backend, to allow editors to spot the issue.
Hide issues in frontend to not break frontend.

Relates: #1, #2
This commit is contained in:
Daniel Siepmann 2020-10-05 09:40:54 +02:00
parent 101d2fb3e4
commit a1dda725a0
Signed by: Daniel Siepmann
GPG key ID: 33D6629915560EF4
8 changed files with 210 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
Classes/Backend/Preview.php
View file

@ -74,7 +74,11 @@ class Preview implements PageLayoutViewDrawItemHookInterface
$skills = GeneralUtility::intExplode(',', $row['skilldisplay_skills'], true);
foreach ($skills as $skillId) {
$row['skills'][] = $this->skillApi->getById($skillId);
try {
$row['skills'][] = $this->skillApi->getById($skillId);
} catch (\Exception $e) {
$row['skills'][]['error'] = $e->getMessage();
}
}
return $row;
@ -85,7 +89,11 @@ class Preview implements PageLayoutViewDrawItemHookInterface
$skillSets = GeneralUtility::intExplode(',', $row['skilldisplay_skillset'], true);
foreach ($skillSets as $skillSetId) {
$row['skillSets'][] = $this->skillSetApi->getById($skillSetId);
try {
$row['skillSets'][] = $this->skillSetApi->getById($skillSetId);
} catch (\Exception $e) {
$row['skillSets'][]['error'] = $e->getMessage();
}
}
return $row;

6
Classes/Frontend/DataProcessing/SkillSets.php
View file

@ -54,7 +54,11 @@ class SkillSets implements DataProcessorInterface
$skillSets = [];
foreach ($skillSetIds as $skillSetId) {
$skillSets[] = $this->skillSetApi->getById($skillSetId);
try {
$skillSets[] = $this->skillSetApi->getById($skillSetId);
} catch (\Exception $e) {
continue;
}
}
$processedData[$as] = $skillSets;

6
Classes/Frontend/DataProcessing/Skills.php
View file

@ -54,7 +54,11 @@ class Skills implements DataProcessorInterface
$skills = [];
foreach ($skillIds as $skillId) {
$skills[] = $this->skillApi->getById($skillId);
try {
$skills[] = $this->skillApi->getById($skillId);
} catch (\Exception $e) {
continue;
}
}
$processedData[$as] = $skills;

11
Resources/Private/Templates/Backend/ContentElements/Skills.html
View file

@ -10,8 +10,15 @@
<ol>
<f:for each="{skills}" as="skill">
<li>
<strong>{skill.title}</strong><br>
{sd:verification.url(skill: skill.id)}
<f:if condition="{skill.error}">
<f:then>
<f:be.infobox state="2">{skill.error}</f:be.infobox>
</f:then>
<f:else>
<strong>{skill.title}</strong><br>
{sd:verification.url(skill: skill.id)}
</f:else>
</f:if>
</li>
</f:for>
</ol>

10
Resources/Private/Templates/Backend/ContentElements/Skillset.html
View file

@ -10,7 +10,15 @@
<ol>
<f:for each="{skillSets}" as="skillSet">
<li>
<strong>{skillSet.name}</strong><br>
<f:if condition="{skillSet.error}">
<f:then>
<f:be.infobox state="2">{skillSet.error}</f:be.infobox>
</f:then>
<f:else>
<strong>{skillSet.title}</strong><br>
{sd:verification.url(skillSet: skillSet.id)}
</f:else>
</f:if>
</li>
</f:for>
</ol>

102
Tests/Unit/Backend/PreviewTest.php
View file

@ -188,4 +188,106 @@ class PreviewTest extends TestCase
],
], $row);
}
/**
* @test
*/
public function addsExceptionMessageForSkills(): void
{
$skillApi = $this->prophesize(Skill::class);
$skillSetApi = $this->prophesize(SkillSet::class);
$pageLayoutView = $this->prophesize(PageLayoutView::class);
$exception = new \Exception('Some helpfull message');
$skill10 = $this->prophesize(SkillEntity::class);
$skillApi->getById(10)->willThrow($exception);
$skill20 = $this->prophesize(SkillEntity::class);
$skillApi->getById(20)->willReturn($skill20->reveal());
$subject = new Preview(
$skillApi->reveal(),
$skillSetApi->reveal()
);
$revealedPageLayoutView = $pageLayoutView->reveal();
$drawItem = false;
$headerContent = '';
$itemContent = '';
$row = [
'skilldisplay_skills' => '10, 20,,',
'skilldisplay_skillset' => '0',
];
$subject->preProcess(
$revealedPageLayoutView,
$drawItem,
$headerContent,
$itemContent,
$row
);
static::assertFalse($drawItem);
static::assertEmpty($headerContent);
static::assertEmpty($itemContent);
static::assertSame([
'skilldisplay_skills' => '10, 20,,',
'skilldisplay_skillset' => '0',
'skills' => [
[
'error' => 'Some helpfull message',
],
$skill20->reveal(),
],
'skillSets' => [],
], $row);
}
/**
* @test
*/
public function addsExceptionMessageForSkillSets(): void
{
$skillApi = $this->prophesize(Skill::class);
$skillSetApi = $this->prophesize(SkillSet::class);
$pageLayoutView = $this->prophesize(PageLayoutView::class);
$exception = new \Exception('Some helpfull message');
$skillSetApi->getById(10)->willThrow($exception);
$subject = new Preview(
$skillApi->reveal(),
$skillSetApi->reveal()
);
$revealedPageLayoutView = $pageLayoutView->reveal();
$drawItem = false;
$headerContent = '';
$itemContent = '';
$row = [
'skilldisplay_skills' => '',
'skilldisplay_skillset' => '10',
];
$subject->preProcess(
$revealedPageLayoutView,
$drawItem,
$headerContent,
$itemContent,
$row
);
static::assertFalse($drawItem);
static::assertEmpty($headerContent);
static::assertEmpty($itemContent);
static::assertSame([
'skilldisplay_skills' => '',
'skilldisplay_skillset' => '10',
'skills' => [],
'skillSets' => [
[
'error' => 'Some helpfull message',
],
],
], $row);
}
}

35
Tests/Unit/Frontend/DataProcessing/SkillSetsTest.php
View file

@ -106,4 +106,39 @@ class SkillSetsTest extends TestCase
],
], $processedData);
}
/**
* @test
*/
public function skillsSkillSetInCaseOfException(): void
{
$skillApi = $this->prophesize(SkillSet::class);
$skillSet10 = $this->prophesize(SkillSetEntity::class);
$skillApi->getById(10)->willReturn($skillSet10->reveal());
$skillSet20 = $this->prophesize(SkillSetEntity::class);
$skillApi->getById(20)->willThrow(new \Exception());
$cObj = $this->prophesize(ContentObjectRenderer::class);
$cObj->stdWrapValue('as', [], 'skillSets')->willReturn('skillSets');
$cObj->stdWrapValue('skillSets', [], '')->willReturn('10, 20,,');
$subject = new SkillSets(
$skillApi->reveal()
);
$processedData = $subject->process(
$cObj->reveal(),
[],
[],
[
'skillSets' => '10, 20,,',
]
);
static::assertEquals([
'skillSets' => [
$skillSet10->reveal(),
],
], $processedData);
}
}

35
Tests/Unit/Frontend/DataProcessing/SkillsTest.php
View file

@ -106,4 +106,39 @@ class SkillsTest extends TestCase
],
], $processedData);
}
/**
* @test
*/
public function skillsSkillSetInCaseOfException(): void
{
$skillApi = $this->prophesize(Skill::class);
$skill10 = $this->prophesize(SkillEntity::class);
$skillApi->getById(10)->willReturn($skill10->reveal());
$skill20 = $this->prophesize(SkillEntity::class);
$skillApi->getById(20)->willThrow(new \Exception());
$cObj = $this->prophesize(ContentObjectRenderer::class);
$cObj->stdWrapValue('as', [], 'skills')->willReturn('skills');
$cObj->stdWrapValue('skills', [], '')->willReturn('10, 20,,');
$subject = new Skills(
$skillApi->reveal()
);
$processedData = $subject->process(
$cObj->reveal(),
[],
[],
[
'skills' => '10, 20,,',
]
);
static::assertEquals([
'skills' => [
$skill10->reveal(),
],
], $processedData);
}
}