Importer::getRemarks() - Code Metrics - Inspection of "Use shorter syntax #8832" - Ecodev/my-ichtus - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( e3c27b...b957a6 )

by Adrien
created 2022-05-17 16:24 UTC
Importer::getRemarks() A

↳ Parent: Importer
Complexity

Conditions	2
Paths	2
Size

Total Lines	13
Code Lines	7
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	8
CRAP Score	2
Importance

Changes
Metric	Value
eloc	7
dl	0
loc	13
rs	10
c	0
b	0
f	0
ccs	8
cts	8
cp	1
cc	2
nc	2
nop	2
crap	2
<?php

declare(strict_types=1);

namespace Application\Service;

use Application\Model\Account;
use Application\Model\Transaction;
use Application\Model\TransactionLine;
use Application\Model\User;
use Application\Repository\AccountRepository;
use Application\Repository\TransactionLineRepository;
use Application\Repository\UserRepository;
use Cake\Chronos\Chronos;
use Ecodev\Felix\Api\Exception;
use Ecodev\Felix\Service\Bvr;
use Genkgo\Camt\Camt054\MessageFormat\V02;
use Genkgo\Camt\Camt054\MessageFormat\V04;
use Genkgo\Camt\Config;
use Genkgo\Camt\DTO\Address;
use Genkgo\Camt\DTO\Entry;
use Genkgo\Camt\DTO\EntryTransactionDetail;
use Genkgo\Camt\DTO\Message;
use Genkgo\Camt\DTO\Record;
use Genkgo\Camt\DTO\RelatedPartyTypeInterface;
use Genkgo\Camt\Exception\ReaderException;
use Genkgo\Camt\Reader;

/**
 * This service allows to import a CAMT file as Transaction and TransactionLine.
 *
 * @see https://www.six-group.com/interbank-clearing/dam/downloads/en/standardization/iso/swiss-recommendations/archives/implementation-guidelines-cm/standardization_isopayments_iso_20022_ch_implementation_guidelines_camt.pdf
 */
class Importer
{
    private Message $message;

    /**
     * @var Transaction[]
     */
    private array $transactions = [];

    private Account $bankAccount;

    private readonly AccountRepository $accountRepository;

    private readonly UserRepository $userRepository;

    private readonly TransactionLineRepository $transactionLineRepository;

    public function __construct()
    {
        $this->accountRepository = _em()->getRepository(Account::class);

        $this->userRepository = _em()->getRepository(User::class);

        $this->transactionLineRepository = _em()->getRepository(TransactionLine::class);

    }

    /**
     * Import all transactions from a CAMT file.
     *
     * @return Transaction[]
     */
    public function import(string $file): array
    {
        $this->transactions = [];
        $reader = new Reader(Config::getDefault());

        try {
            $this->message = $reader->readFile($file);
        } catch (ReaderException $exception) {
            throw new Exception($exception->getMessage(), 0, $exception);
        }

        $this->validateFormat($reader);

        $this->userRepository->getAclFilter()->runWithoutAcl(function (): void {
            $records = $this->message->getRecords();
            foreach ($records as $record) {
                $this->bankAccount = $this->loadAccount($record);

                foreach ($record->getEntries() as $entry) {
                    $this->importTransaction($entry);
                }
            }
        });

        return $this->transactions;
    }

    private function validateFormat(Reader $reader): void
    {
        $messageFormat = $reader->getMessageFormat();
        if (!$messageFormat) {
            // This should actually never happen, because the reader would throw an exception before here
            throw new Exception('Unknown XML format');
        }

        $expected = [
            V02::class,
            V04::class,
        ];

        if (!in_array($messageFormat::class, $expected, true)) {
            throw new Exception('The format CAMT 054 is expected, but instead we got: ' . $messageFormat->getMsgId());
        }
    }

    private function importTransaction(Entry $entry): void
    {
        $nativeDate = $entry->getValueDate();
        $date = Chronos::instance($nativeDate);
        $date = Chronos::instance(/** @scrutinizer ignore-type */ $nativeDate);

        $transaction = new Transaction();
        $transaction->setName('Versement BVR');
        $transaction->setTransactionDate($date);

        $internalRemarks = [];
        $mustUseSuffix = $this->mustUseSuffix($entry->getTransactionDetails());
        foreach ($entry->getTransactionDetails() as $i => $detail) {
            $suffix = $mustUseSuffix ? '-epicerio-' . ($i + 1) : '';
            $internalRemarks[] = $this->importTransactionLine($transaction, $detail, $suffix);
        }
        $transaction->setInternalRemarks(implode(PHP_EOL . PHP_EOL, $internalRemarks));

        // Don't persist transaction that may not have any lines
        $transactionLines = $transaction->getTransactionLines();
        if ($transactionLines->count()) {
            // Use same owner for line and transaction
            $transaction->setOwner($transactionLines->first()->getOwner());

            _em()->persist($transaction);
            $this->transactions[] = $transaction;
        }
    }

    private function importTransactionLine(Transaction $transaction, EntryTransactionDetail $detail, string $suffix): string
    {
        $importedId = $this->getImportedId($detail, $suffix);
        $transactionDate = $transaction->getTransactionDate();
        if ($this->transactionLineRepository->importedExists($importedId, $transactionDate)) {
            return '';
        }

        $referenceNumber = $detail->getRemittanceInformation()->getStructuredBlock()->getCreditorReferenceInformation()->getRef();
        $user = $this->loadUser($referenceNumber);
        $user = $this->loadUser(/** @scrutinizer ignore-type */ $referenceNumber);
        $userAccount = $this->accountRepository->getOrCreate($user);
        $remarks = $this->getRemarks($detail, $referenceNumber);
        $amount = $detail->getAmount();

        $line = new TransactionLine();
        $line->setTransaction($transaction);
        $line->setOwner($user);
        $line->setName('Versement BVR');
        $line->setTransactionDate($transactionDate);
        $line->setBalance($amount);
        $line->setBalance(/** @scrutinizer ignore-type */ $amount);
        $line->setCredit($userAccount);
        $line->setDebit($this->bankAccount);
        $line->setImportedId($importedId);

        _em()->persist($line);

        return $remarks;
    }

    private function partyToString(RelatedPartyTypeInterface $party): string
    {
        $parts = [];
        $parts[] = $this->partyLabel($party);
        $parts[] = $party->getName();

        $address = $party->getAddress();
        if ($address) {
            $parts[] = $this->addressToString($address);
        }

        return implode(PHP_EOL, $parts);
    }

    private function partyLabel(RelatedPartyTypeInterface $party): string
    {
        $class = $party::class;

        return match ($class) {
            \Genkgo\Camt\DTO\Recipient::class => 'Récipient',
            \Genkgo\Camt\DTO\Debtor::class => 'Débiteur',
            \Genkgo\Camt\DTO\Creditor::class => 'Créancier',
            \Genkgo\Camt\DTO\UltimateDebtor::class => 'Débiteur final',
            \Genkgo\Camt\DTO\UltimateCreditor::class => 'Créancier final',
            default => throw new Exception('Non supported related party type: ' . $class),
        };
    }

    private function addressToString(Address $a): string
    {
        $lines = [];
        $lines[] = trim($a->getStreetName() . ' ' . $a->getBuildingNumber());
        $lines[] = trim($a->getPostCode() . ' ' . $a->getTownName());
        $lines[] = $a->getCountry();
        $lines = array_merge($lines, $a->getAddressLines());

        $nonEmptyLines = array_filter($lines);

        return implode(PHP_EOL, $nonEmptyLines);
    }

    private function getRemarks(EntryTransactionDetail $detail, string $referenceNumber): string
    {
        $parts = [];
        $parts[] = 'Numéro de référence: ' . $referenceNumber;

        foreach ($detail->getRelatedParties() as $party) {
            $partyDetail = $party->getRelatedPartyType();
            $parts[] = $this->partyToString($partyDetail);
        }

        $remarks = implode(PHP_EOL . PHP_EOL, $parts);

        return $remarks;
    }

    private function loadAccount(Record $record): Account
    {
        $accountFromFile = $record->getAccount();
        $iban = $accountFromFile->getIdentification();
        $account = $this->accountRepository->findOneByIban($iban);
        $account = $this->accountRepository->findOneByIban($iban);

        if (!$account) {
            throw new Exception('The CAMT file contains a statement for account with IBAN `' . $iban . '`, but no account exist for that IBAN in the database. Either create/update a corresponding account, or import a different CAMT file.');
        }

        return $account;
    }

    private function loadUser(string $referenceNumber): User
    {
        $userId = (int) Bvr::extractCustomId($referenceNumber);
        $user = $this->userRepository->getOneById($userId);

        if (!$user) {
            throw new Exception('Could not find a matching user for reference number `' . $referenceNumber . '` and user ID `' . $userId . '`.');
        }

        return $user;
    }

    /**
     * This must return a non-empty universally unique identifier for one detail.
     */
    private function getImportedId(EntryTransactionDetail $detail, string $suffix): string
    {
        $reference = $detail->getReference();

        $endToEndId = $reference?->getEndToEndId();
        if ($endToEndId === 'NOTPROVIDED') {
            $endToEndId = null;
        }

        if (!$endToEndId) {
            $accountServicerReference = $reference?->getAccountServicerReference();
            if ($accountServicerReference) {
                $endToEndId = $accountServicerReference . $suffix;
            }
        }

        if (!$endToEndId) {
            $endToEndId = $reference?->getMessageId();
        }

        if (!$endToEndId) {
            throw new Exception('Cannot import a transaction without unique universal identifier (<EndToEndId>, <AcctSvcrRef> or <MsgId>).');
        }

        return $endToEndId;
    }

    /**
     * If at least two details have the same AccountServicerReference, then we must use suffix.
     *
     * @param EntryTransactionDetail[] $transactionDetails
     */
    private function mustUseSuffix(array $transactionDetails): bool
    {
        if (count($transactionDetails) <= 1) {
            return false;
        }

        $seenValues = [];
        foreach ($transactionDetails as $transactionDetail) {
            $value = $transactionDetail->getReference()?->getAccountServicerReference();
            if (!$value) {
                continue;
            }

            if (in_array($value, $seenValues, true)) {
                return true;
            }

            $seenValues[] = $value;
        }

        return false;
    }
}

Ecodev / my-ichtus

Push — master ( e3c27b...b957a6 )

Importer::getRemarks() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
