Cleanup expected and unexpected bugs in the factories.

This commit is contained in:
James Cole
2019-06-16 13:15:32 +02:00
parent 4a1e56671b
commit 23d7abd55f
16 changed files with 173 additions and 160 deletions

View File

@@ -20,9 +20,6 @@
* along with Firefly III. If not, see <http://www.gnu.org/licenses/>.
*/
/** @noinspection PhpDynamicAsStaticMethodCallInspection */
/** @noinspection PhpUndefinedMethodInspection */
declare(strict_types=1);
namespace FireflyIII\Factory;
@@ -31,6 +28,7 @@ use FireflyIII\Exceptions\FireflyException;
use FireflyIII\Models\Account;
use FireflyIII\Models\AccountType;
use FireflyIII\Models\TransactionCurrency;
use FireflyIII\Repositories\Account\AccountRepositoryInterface;
use FireflyIII\Services\Internal\Support\AccountServiceTrait;
use FireflyIII\User;
use Log;
@@ -42,10 +40,14 @@ use Log;
*/
class AccountFactory
{
/** @var AccountRepositoryInterface */
protected $accountRepository;
/** @var User */
private $user;
use AccountServiceTrait;
/** @var array */
private $canHaveVirtual;
/**
* AccountFactory constructor.
@@ -57,6 +59,8 @@ class AccountFactory
if ('testing' === config('app.env')) {
Log::warning(sprintf('%s should not be instantiated in the TEST environment!', get_class($this)));
}
$this->canHaveVirtual = [AccountType::ASSET, AccountType::DEBT, AccountType::LOAN, AccountType::MORTGAGE, AccountType::CREDITCARD];
$this->accountRepository = app(AccountRepositoryInterface::class);
}
/**
@@ -64,20 +68,18 @@ class AccountFactory
*
* @return Account
* @throws FireflyException
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
* @SuppressWarnings(PHPMD.ExcessiveMethodLength)
*/
public function create(array $data): Account
{
$type = $this->getAccountType($data['account_type_id'], $data['accountType']);
$type = $this->getAccountType($data['account_type_id'], $data['account_type']);
if (null === $type) {
throw new FireflyException(
sprintf('AccountFactory::create() was unable to find account type #%d ("%s").', $data['account_type_id'], $data['accountType'])
sprintf('AccountFactory::create() was unable to find account type #%d ("%s").', $data['account_type_id'], $data['account_type'])
);
}
$data['iban'] = $this->filterIban($data['iban']);
$data['iban'] = $this->filterIban($data['iban'] ?? null);
// account may exist already:
Log::debug('Data array is as follows', $data);
@@ -90,29 +92,17 @@ class AccountFactory
'user_id' => $this->user->id,
'account_type_id' => $type->id,
'name' => $data['name'],
'virtual_balance' => $data['virtualBalance'] ?? '0',
'virtual_balance' => $data['virtual_balance'] ?? '0',
'active' => true === $data['active'],
'iban' => $data['iban'],
];
// find currency, or use default currency instead.
/** @var TransactionCurrencyFactory $factory */
$factory = app(TransactionCurrencyFactory::class);
/** @var TransactionCurrency $currency */
$currency = $factory->find((int)($data['currency_id'] ?? null), (string)($data['currency_code'] ?? null));
if (null === $currency) {
// use default currency:
$currency = app('amount')->getDefaultCurrencyByUser($this->user);
}
$currency->enabled = true;
$currency->save();
$currency = $this->getCurrency((int)($data['currency_id'] ?? null), (string)($data['currency_code'] ?? null));
unset($data['currency_code']);
$data['currency_id'] = $currency->id;
// remove virtual balance when not an asset account or a liability
$canHaveVirtual = [AccountType::ASSET, AccountType::DEBT, AccountType::LOAN, AccountType::MORTGAGE, AccountType::CREDITCARD];
if (!in_array($type->type, $canHaveVirtual, true)) {
if (!in_array($type->type, $this->canHaveVirtual, true)) {
$databaseData['virtual_balance'] = '0';
}
@@ -124,12 +114,13 @@ class AccountFactory
$return = Account::create($databaseData);
$this->updateMetaData($return, $data);
if (in_array($type->type, $canHaveVirtual, true)) {
if ($this->validIBData($data)) {
$this->updateIB($return, $data);
// if it can have a virtual balance, it can also have an opening balance.
if (in_array($type->type, $this->canHaveVirtual, true)) {
if ($this->validOBData($data)) {
$this->updateOBGroup($return, $data);
}
if (!$this->validIBData($data)) {
$this->deleteIB($return);
if (!$this->validOBData($data)) {
$this->deleteOBGroup($return);
}
}
$this->updateNote($return, $data['notes'] ?? '');
@@ -146,18 +137,9 @@ class AccountFactory
*/
public function find(string $accountName, string $accountType): ?Account
{
$type = AccountType::whereType($accountType)->first();
$accounts = $this->user->accounts()->where('account_type_id', $type->id)->get(['accounts.*']);
$return = null;
/** @var Account $object */
foreach ($accounts as $object) {
if ($object->name === $accountName) {
$return = $object;
break;
}
}
$type = AccountType::whereType($accountType)->first();
return $return;
return $this->user->accounts()->where('account_type_id', $type->id)->where('name', $accountName)->first();
}
/**
@@ -171,20 +153,11 @@ class AccountFactory
public function findOrCreate(string $accountName, string $accountType): Account
{
Log::debug(sprintf('Searching for "%s" of type "%s"', $accountName, $accountType));
$type = AccountType::whereType($accountType)->first();
$accounts = $this->user->accounts()->where('account_type_id', $type->id)->get(['accounts.*']);
$return = null;
/** @var AccountType $type */
$type = AccountType::whereType($accountType)->first();
$return = $this->user->accounts->where('account_type_id', $type->id)
->where('name', $accountName)->first();
Log::debug(sprintf('Account type is #%d', $type->id));
/** @var Account $object */
foreach ($accounts as $object) {
if ($object->name === $accountName) {
Log::debug(sprintf('Found account #%d "%s".', $object->id, $object->name));
$return = $object;
break;
}
}
if (null === $return) {
Log::debug('Found nothing. Will create a new one.');
$return = $this->create(
@@ -192,8 +165,8 @@ class AccountFactory
'user_id' => $this->user->id,
'name' => $accountName,
'account_type_id' => $type->id,
'accountType' => null,
'virtualBalance' => '0',
'account_type' => null,
'virtual_balance' => '0',
'iban' => null,
'active' => true,
]
@@ -212,7 +185,7 @@ class AccountFactory
}
/**
* @param int|null $accountTypeId
* @param int|null $accountTypeId
* @param null|string $accountType
*
* @return AccountType|null
@@ -250,4 +223,27 @@ class AccountFactory
}
/**
* @param int $currencyId
* @param string $currencyCode
* @return TransactionCurrency
*/
protected function getCurrency(int $currencyId, string $currencyCode): TransactionCurrency
{
// find currency, or use default currency instead.
/** @var TransactionCurrencyFactory $factory */
$factory = app(TransactionCurrencyFactory::class);
/** @var TransactionCurrency $currency */
$currency = $factory->find($currencyId, $currencyCode);
if (null === $currency) {
// use default currency:
$currency = app('amount')->getDefaultCurrencyByUser($this->user);
}
$currency->enabled = true;
$currency->save();
return $currency;
}
}