docgen normalization budget: fix budget when person is null

This commit is contained in:
Julien Fastré 2022-03-30 21:35:02 +02:00
parent bc43d8bae5
commit eb2bad0f47
5 changed files with 120 additions and 42 deletions

View File

@ -23,7 +23,7 @@ use function count;
/**
* Helps to find a summary of the budget: the sum of resources and charges.
*/
class SummaryBudget
class SummaryBudget implements SummaryBudgetInterface
{
private const QUERY_CHARGE_BY_HOUSEHOLD = 'select SUM(amount) AS sum, type FROM chill_budget.charge WHERE (person_id IN (_ids_) OR household_id = ?) AND NOW() BETWEEN startdate AND COALESCE(enddate, \'infinity\'::timestamp) GROUP BY type';
@ -52,26 +52,6 @@ class SummaryBudget
$this->translatableStringHelper = $translatableStringHelper;
}
public function getEmptyChargeArray(): array
{
$keys = $this->configRepository->getChargesKeys();
$labels = $this->chargeLabels;
return array_combine($keys, array_map(function ($i) use ($labels) {
return ['sum' => 0.0, 'label' => $this->translatableStringHelper->localize($labels[$i])];
}, $keys));
}
public function getEmptyResourceArray(): array
{
$keys = $this->configRepository->getResourcesKeys();
$labels = $this->resourcesLabels;
return array_combine($keys, array_map(function ($i) use ($labels) {
return ['sum' => 0.0, 'label' => $this->translatableStringHelper->localize($labels[$i])];
}, $keys));
}
public function getSummaryForHousehold(?Household $household): array
{
if (null === $household) {
@ -101,8 +81,15 @@ class SummaryBudget
];
}
public function getSummaryForPerson(Person $person): array
public function getSummaryForPerson(?Person $person): array
{
if (null === $person) {
return [
'resources' => $this->getEmptyResourceArray(),
'charges' => $this->getEmptyChargeArray(),
];
}
$rsm = $this->buildRsm();
$resources = $this->em->createNativeQuery(self::QUERY_RESOURCE_BY_PERSON, $rsm)
@ -128,6 +115,26 @@ class SummaryBudget
return $rsm;
}
private function getEmptyChargeArray(): array
{
$keys = $this->configRepository->getChargesKeys();
$labels = $this->chargeLabels;
return array_combine($keys, array_map(function ($i) use ($labels) {
return ['sum' => 0.0, 'label' => $this->translatableStringHelper->localize($labels[$i])];
}, $keys));
}
private function getEmptyResourceArray(): array
{
$keys = $this->configRepository->getResourcesKeys();
$labels = $this->resourcesLabels;
return array_combine($keys, array_map(function ($i) use ($labels) {
return ['sum' => 0.0, 'label' => $this->translatableStringHelper->localize($labels[$i])];
}, $keys));
}
private function rowToArray(array $rows, string $kind): array
{
switch ($kind) {

View File

@ -0,0 +1,25 @@
<?php
/**
* Chill is a software for social workers
*
* For the full copyright and license information, please view
* the LICENSE file that was distributed with this source code.
*/
declare(strict_types=1);
namespace Chill\BudgetBundle\Service\Summary;
use Chill\PersonBundle\Entity\Household\Household;
use Chill\PersonBundle\Entity\Person;
/**
* Helps to find a summary of the budget: the sum of resources and charges.
*/
interface SummaryBudgetInterface
{
public function getSummaryForHousehold(?Household $household): array;
public function getSummaryForPerson(?Person $person): array;
}

View File

@ -276,8 +276,6 @@ class Person implements HasCenterInterface, TrackCreationInterface, TrackUpdateI
/**
* The person's first name.
*
* @var string
*
* @ORM\Column(type="string", length=255)
* @Assert\NotBlank(message="The firstname cannot be empty")
* @Assert\Length(
@ -290,8 +288,6 @@ class Person implements HasCenterInterface, TrackCreationInterface, TrackUpdateI
* fullname canonical. Read-only field, which is calculated by
* the database.
*
* @var string
*
* @ORM\Column(type="text", nullable=true)
*/
private string $fullnameCanonical = '';
@ -345,8 +341,6 @@ class Person implements HasCenterInterface, TrackCreationInterface, TrackUpdateI
/**
* The person's last name.
*
* @var string
*
* @ORM\Column(type="string", length=255)
* @Assert\NotBlank(message="The lastname cannot be empty")
* @Assert\Length(

View File

@ -11,7 +11,7 @@ declare(strict_types=1);
namespace Chill\PersonBundle\Serializer\Normalizer;
use Chill\BudgetBundle\Service\Summary\SummaryBudget;
use Chill\BudgetBundle\Service\Summary\SummaryBudgetInterface;
use Chill\DocGeneratorBundle\Serializer\Helper\NormalizeNullValueHelper;
use Chill\MainBundle\Entity\Address;
use Chill\MainBundle\Entity\Civility;
@ -45,7 +45,7 @@ class PersonDocGenNormalizer implements
private RelationshipRepository $relationshipRepository;
private SummaryBudget $summaryBudget;
private SummaryBudgetInterface $summaryBudget;
private TranslatableStringHelper $translatableStringHelper;
@ -56,7 +56,7 @@ class PersonDocGenNormalizer implements
RelationshipRepository $relationshipRepository,
TranslatorInterface $translator,
TranslatableStringHelper $translatableStringHelper,
SummaryBudget $summaryBudget
SummaryBudgetInterface $summaryBudget
) {
$this->personRender = $personRender;
$this->relationshipRepository = $relationshipRepository;
@ -214,6 +214,14 @@ class PersonDocGenNormalizer implements
$data['relations'] = [];
}
if ($context['docgen:person:with-budget'] ?? false) {
$data['budget']['person'] = $this->summaryBudget->getSummaryForPerson(null);
if ($context['docgen:person:with-household'] ?? false) {
$data['budget']['household'] = $this->summaryBudget->getSummaryForHousehold(null);
}
}
return $data;
}
}

View File

@ -11,6 +11,7 @@ declare(strict_types=1);
namespace Serializer\Normalizer;
use Chill\BudgetBundle\Service\Summary\SummaryBudgetInterface;
use Chill\MainBundle\Templating\TranslatableStringHelper;
use Chill\MainBundle\Templating\TranslatableStringHelperInterface;
use Chill\PersonBundle\Entity\Household\Household;
@ -72,6 +73,17 @@ final class PersonDocGenNormalizerTest extends KernelTestCase
$this->normalizer = self::$container->get(NormalizerInterface::class);
}
public function dataGeneratorNormalizationNullOrNotNullHaveSameKeys(): iterable
{
yield [['docgen:expects' => Person::class, 'groups' => ['docgen:read']]];
yield [['docgen:expects' => Person::class, 'groups' => ['docgen:read'], 'docgen:person:with-household' => true]];
yield [['docgen:expects' => Person::class, 'groups' => ['docgen:read'], 'docgen:person:with-relations' => true]];
yield [['docgen:expects' => Person::class, 'groups' => ['docgen:read'], 'docgen:person:with-budget' => true]];
}
public function generateData()
{
$person = new Person();
@ -90,12 +102,16 @@ final class PersonDocGenNormalizerTest extends KernelTestCase
yield [null, self::BLANK, 'normalization for a null person'];
}
public function testNormalizationNullOrNotNullHaveSameKeys()
/**
* @dataProvider dataGeneratorNormalizationNullOrNotNullHaveSameKeys
*
* @param mixed $context
*/
public function testNormalizationNullOrNotNullHaveSameKeys($context)
{
$this->markTestSkipped();
$period = new Person();
$notNullData = $this->buildPersonNormalizer()->normalize($period, 'docgen', ['docgen:expects' => Person::class]);
$nullData = $this->buildPersonNormalizer()->normalize(null, 'docgen', ['docgen:expects' => Person::class]);
$notNullData = $this->buildPersonNormalizer()->normalize($period, 'docgen', $context);
$nullData = $this->buildPersonNormalizer()->normalize(null, 'docgen', $context);
$this->assertEqualsCanonicalizing(
array_keys($notNullData),
@ -131,7 +147,6 @@ final class PersonDocGenNormalizerTest extends KernelTestCase
public function testNormalizePersonWithHousehold()
{
$this->markTestSkipped();
$household = new Household();
$person = new Person();
$person
@ -172,7 +187,6 @@ final class PersonDocGenNormalizerTest extends KernelTestCase
public function testNormalizePersonWithRelationships()
{
$this->markTestSkipped();
$person = (new Person())->setFirstName('Renaud')->setLastName('megane');
$father = (new Person())->setFirstName('Clément')->setLastName('megane');
$mother = (new Person())->setFirstName('Mireille')->setLastName('Mathieu');
@ -235,13 +249,25 @@ final class PersonDocGenNormalizerTest extends KernelTestCase
?RelationshipRepository $relationshipRepository = null,
?TranslatorInterface $translator = null,
?TranslatableStringHelper $translatableStringHelper = null,
?NormalizerInterface $normalizer = null
?NormalizerInterface $normalizer = null,
?SummaryBudgetInterface $summaryBudget = null
): PersonDocGenNormalizer {
if (null === $summaryBudget) {
$summaryBudget = $this->prophesize(SummaryBudgetInterface::class);
$summaryBudget->getSummaryForHousehold(Argument::any())->willReturn(
['resources' => [], 'charges' => []]
);
$summaryBudget->getSummaryForPerson(Argument::any())->willReturn(
['resources' => [], 'charges' => []]
);
}
$personDocGenNormalizer = new PersonDocGenNormalizer(
$personRender ?? self::$container->get(PersonRender::class),
$relationshipRepository ?? self::$container->get(RelationshipRepository::class),
$translator ?? self::$container->get(TranslatorInterface::class),
$translatableStringHelper ?? self::$container->get(TranslatableStringHelperInterface::class)
$translatableStringHelper ?? self::$container->get(TranslatableStringHelperInterface::class),
$summaryBudget->reveal(),
);
if (null === $normalizer) {
@ -259,13 +285,31 @@ final class PersonDocGenNormalizerTest extends KernelTestCase
?PersonRender $personRender = null,
?RelationshipRepository $relationshipRepository = null,
?TranslatorInterface $translator = null,
?TranslatableStringHelper $translatableStringHelper = null
?TranslatableStringHelper $translatableStringHelper = null,
?SummaryBudgetInterface $summaryBudget = null
): PersonDocGenNormalizer {
if (null === $relationshipRepository) {
$relationshipRepository = $this->prophesize(RelationshipRepository::class);
$relationshipRepository->findByPerson(Argument::type(Person::class))->willReturn([]);
$relationshipRepository = $relationshipRepository->reveal();
}
if (null === $summaryBudget) {
$summaryBudget = $this->prophesize(SummaryBudgetInterface::class);
$summaryBudget->getSummaryForHousehold(Argument::any())->willReturn(
['resources' => [], 'charges' => []]
);
$summaryBudget->getSummaryForPerson(Argument::any())->willReturn(
['resources' => [], 'charges' => []]
);
}
$normalizer = new PersonDocGenNormalizer(
$personRender ?? self::$container->get(PersonRender::class),
$relationshipRepository ?? self::$container->get(RelationshipRepository::class),
$relationshipRepository,
$translator ?? self::$container->get(TranslatorInterface::class),
$translatableStringHelper ?? self::$container->get(TranslatableStringHelperInterface::class)
$translatableStringHelper ?? self::$container->get(TranslatableStringHelperInterface::class),
$summaryBudget->reveal()
);
$normalizerManager = $this->prophesize(NormalizerInterface::class);
$normalizerManager->supportsNormalization(Argument::any(), 'docgen', Argument::any())->willReturn(true);