kenmirrors/firefly-iii
1
0
Fork 0
mirror of https://github.com/firefly-iii/firefly-iii.git synced 2025-10-15 00:27:30 +00:00
Code Issues Projects Releases Wiki Activity

Fix actions and associated tests.

Browse Source
This commit is contained in:
James Cole
2020-08-23 16:12:16 +02:00
parent 139b3ffab4
commit fecc9f7659
8 changed files with 286 additions and 318 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
app/TransactionRules/Actions/SetDescription.php
View File

@@ -22,6 +22,7 @@ declare(strict_types=1);
namespace FireflyIII\TransactionRules\Actions;
use DB;
use FireflyIII\Models\RuleAction;
use FireflyIII\Models\TransactionJournal;
use Log;
@@ -31,8 +32,7 @@ use Log;
*/
class SetDescription implements ActionInterface
{
/** @var RuleAction The rule action */
private $action;
private RuleAction $action;
/**
* TriggerInterface constructor.
@@ -46,10 +46,11 @@ class SetDescription implements ActionInterface
/**
* Set description to X
*
* @param TransactionJournal $journal
*
* @return bool
* @deprecated
* @codeCoverageIgnore
*/
public function act(TransactionJournal $journal): bool
{
@@ -75,6 +76,18 @@ class SetDescription implements ActionInterface
*/
public function actOnArray(array $journal): bool
{
// TODO: Implement actOnArray() method.
DB::table('transaction_journals')
->where('id', '=', $journal['transaction_journal_id'])
->update(['description' => $this->action->action_value]);
Log::debug(
sprintf(
'RuleAction SetDescription changed the description of journal #%d from "%s" to "%s".',
$journal['transaction_journal_id'],
$journal['description'],
$this->action->action_value
)
);
return true;
}
}

160
app/TransactionRules/Actions/SetDestinationAccount.php
View File

@@ -22,12 +22,13 @@ declare(strict_types=1);
namespace FireflyIII\TransactionRules\Actions;
use DB;
use FireflyIII\Models\Account;
use FireflyIII\Models\AccountType;
use FireflyIII\Models\RuleAction;
use FireflyIII\Models\Transaction;
use FireflyIII\Models\TransactionJournal;
use FireflyIII\Repositories\Account\AccountRepositoryInterface;
use FireflyIII\User;
use Log;
/**
@@ -35,17 +36,8 @@ use Log;
*/
class SetDestinationAccount implements ActionInterface
{
/** @var RuleAction The rule action */
private $action;
/** @var TransactionJournal The journal */
private $journal;
/** @var Account The new account */
private $newDestinationAccount;
/** @var AccountRepositoryInterface Account repository */
private $repository;
private RuleAction $action;
private AccountRepositoryInterface $repository;
/**
* TriggerInterface constructor.
@@ -59,99 +51,21 @@ class SetDestinationAccount implements ActionInterface
/**
* Set destination account to X
*
* @param TransactionJournal $journal
*
* @return bool
* @deprecated
* @codeCoverageIgnore
*/
public function act(TransactionJournal $journal): bool
{
$this->journal = $journal;
$this->repository = app(AccountRepositoryInterface::class);
$this->repository->setUser($journal->user);
// journal type:
$type = $journal->transactionType->type;
// source and destination:
/** @var Transaction $source */
$source = $journal->transactions()->where('amount', '<', 0)->first();
/** @var Transaction $destination */
$destination = $journal->transactions()->where('amount', '>', 0)->first();
// sanity check:
if (null === $source || null === $destination) {
Log::error(sprintf('Cannot run rule on journal #%d because no source or dest.', $journal->id));
return false;
}
// it depends on the type what kind of destination account is expected.
$expectedDestinationTypes = config(sprintf('firefly.source_dests.%s.%s', $type, $source->account->accountType->type));
if (null === $expectedDestinationTypes) {
Log::error(
sprintf(
'Configuration line "%s" is unexpectedly empty. Stopped.', sprintf('firefly.source_dests.%s.%s', $type, $source->account->accountType->type)
)
);
return false;
}
// try to find an account with the destination name and these types:
$newDestination = $this->findAccount($expectedDestinationTypes);
if (true === $newDestination) {
// update account.
$destination->account_id = $this->newDestinationAccount->id;
$destination->save();
$journal->touch();
Log::debug(sprintf('Updated transaction #%d and gave it new account ID.', $destination->id));
return true;
}
Log::info(sprintf('Expected destination account "%s" not found.', $this->action->action_value));
if (AccountType::EXPENSE === $expectedDestinationTypes[0]) {
Log::debug('Expected type is expense, lets create it.');
$this->findExpenseAccount();
// update account.
$destination->account_id = $this->newDestinationAccount->id;
$destination->save();
$journal->touch();
Log::debug(sprintf('Updated transaction #%d and gave it new account ID.', $destination->id));
}
return true;
return false;
}
/**
* @param array $types
*
* @return bool
* @return Account|null
*/
private function findAccount(array $types): bool
{
$account = $this->repository->findByName($this->action->action_value, $types);
if (null === $account) {
Log::debug(sprintf('There is NO account called "%s" of type', $this->action->action_value), $types);
return false;
}
Log::debug(
sprintf(
'There exists an account called "%s". ID is #%d. Type is "%s"',
$this->action->action_value, $account->id, $account->accountType->type
)
);
$this->newDestinationAccount = $account;
return true;
}
/**
*
*/
private function findExpenseAccount(): void
private function findExpenseAccount(): ?Account
{
$account = $this->repository->findByName($this->action->action_value, [AccountType::EXPENSE]);
if (null === $account) {
@@ -166,7 +80,7 @@ class SetDestinationAccount implements ActionInterface
$account = $this->repository->store($data);
}
Log::debug(sprintf('Found or created expense account #%d ("%s")', $account->id, $account->name));
$this->newDestinationAccount = $account;
return $account;
}
/**
@@ -174,6 +88,58 @@ class SetDestinationAccount implements ActionInterface
*/
public function actOnArray(array $journal): bool
{
// TODO: Implement actOnArray() method.
$user = User::find($journal['user_id']);
$type = $journal['transaction_type_type'];
$this->repository = app(AccountRepositoryInterface::class);
$this->repository->setUser($user);
// it depends on the type what kind of destination account is expected.
$expectedTypes = config(sprintf('firefly.source_dests.%s.%s', $type, $journal['source_account_type']));
if (null === $expectedTypes) {
Log::error(sprintf('Configuration line "%s" is unexpectedly empty. Stopped.', sprintf('firefly.source_dests.%s.%s', $type, $journal['source_account_type'])));
return false;
}
// try to find an account with the destination name and these types:
$destination = $this->findAccount($expectedTypes);
if (null !== $destination) {
// update account of destination transaction.
DB::table('transactions')
->where('transaction_journal_id', '=', $journal['transaction_journal_id'])
->where('amount', '>', 0)
->update(['account_id' => $destination->id]);
Log::debug(sprintf('Updated journal #%d and gave it new account ID.', $journal['transaction_journal_id']));
return true;
}
Log::info(sprintf('Expected destination account "%s" not found.', $this->action->action_value));
if (in_array(AccountType::EXPENSE, $expectedTypes)) {
// does not exist, but can be created.
Log::debug('Expected type is expense, lets create it.');
$expense = $this->findExpenseAccount();
if (null === $expense) {
Log::error('Could not create expense account.');
return false;
}
DB::table('transactions')
->where('transaction_journal_id', '=', $journal['transaction_journal_id'])
->where('amount', '>', 0)
->update(['account_id' => $expense->id]);
Log::debug(sprintf('Updated journal #%d and gave it new account ID.', $journal['transaction_journal_id']));
return true;
}
return false;
}
/**
* @param array $types
* @return Account|null
*/
private function findAccount(array $types): ?Account
{
return $this->repository->findByName($this->action->action_value, $types);
}
}

22
app/TransactionRules/Actions/SetNotes.php
View File

@@ -32,8 +32,7 @@ use Log;
*/
class SetNotes implements ActionInterface
{
/** @var RuleAction The rule action */
private $action;
private RuleACtion $action;
/**
* TriggerInterface constructor.
@@ -49,8 +48,9 @@ class SetNotes implements ActionInterface
* Set notes to X
*
* @param TransactionJournal $journal
*
* @return bool
* @deprecated
* @codeCoverageIgnore
*/
public function act(TransactionJournal $journal): bool
{
@@ -74,6 +74,20 @@ class SetNotes implements ActionInterface
*/
public function actOnArray(array $journal): bool
{
// TODO: Implement actOnArray() method.
$dbNote = Note::where('noteable_id', $journal['transaction_journal_id'])
->where('noteable_type', TransactionJournal::class)->first();
if (null === $dbNote) {
$dbNote = new Note;
$dbNote->noteable_id = $journal['transaction_journal_id'];
$dbNote->noteable_type = TransactionJournal::class;
$dbNote->text = '';
}
$oldNotes = $dbNote->text;
$dbNote->text = $this->action->action_value;
$dbNote->save();
Log::debug(sprintf('RuleAction SetNotes changed the notes of journal #%d from "%s" to "%s".', $journal['transaction_journal_id'], $oldNotes, $this->action->action_value));
return true;
}
}

120
app/TransactionRules/Actions/SetSourceAccount.php
View File

@@ -22,12 +22,13 @@ declare(strict_types=1);
namespace FireflyIII\TransactionRules\Actions;
use DB;
use FireflyIII\Models\Account;
use FireflyIII\Models\AccountType;
use FireflyIII\Models\RuleAction;
use FireflyIII\Models\TransactionJournal;
use FireflyIII\Models\TransactionType;
use FireflyIII\Repositories\Account\AccountRepositoryInterface;
use FireflyIII\User;
use Log;
/**
@@ -35,17 +36,8 @@ use Log;
*/
class SetSourceAccount implements ActionInterface
{
/** @var RuleAction The rule action */
private $action;
/** @var TransactionJournal The journal */
private $journal;
/** @var Account The new source account */
private $newSourceAccount;
/** @var AccountRepositoryInterface Account repository */
private $repository;
private RuleAction $action;
private AccountRepositoryInterface $repository;
/**
* TriggerInterface constructor.
@@ -61,85 +53,34 @@ class SetSourceAccount implements ActionInterface
* Set source account to X
*
* @param TransactionJournal $journal
*
* @return bool
* @deprecated
* @codeCoverageIgnore
*/
public function act(TransactionJournal $journal): bool
{
$this->journal = $journal;
$this->repository = app(AccountRepositoryInterface::class);
$this->repository->setUser($journal->user);
// journal type:
$type = $journal->transactionType->type;
// if this is a transfer or a withdrawal, the new source account must be an asset account or a default account, and it MUST exist:
if ((TransactionType::WITHDRAWAL === $type || TransactionType::TRANSFER === $type) && !$this->findAssetAccount($type)) {
Log::error(
sprintf(
'Cannot change source account of journal #%d because no asset account with name "%s" exists.',
$journal->id,
$this->action->action_value
)
);
return false;
}
// if this is a deposit, the new source account must be a revenue account and may be created:
if (TransactionType::DEPOSIT === $type) {
$this->findRevenueAccount();
}
Log::debug(sprintf('New source account is #%d ("%s").', $this->newSourceAccount->id, $this->newSourceAccount->name));
// update source transaction with new source account:
// get source transaction:
$transaction = $journal->transactions()->where('amount', '<', 0)->first();
if (null === $transaction) {
// @codeCoverageIgnoreStart
Log::error(sprintf('Cannot change source account of journal #%d because no source transaction exists.', $journal->id));
return false;
// @codeCoverageIgnoreEnd
}
$transaction->account_id = $this->newSourceAccount->id;
$transaction->save();
$journal->touch();
Log::debug(sprintf('Updated transaction #%d and gave it new account ID.', $transaction->id));
return true;
return false;
}
/**
* @param string $type
*
* @return bool
* @return Account|null
*/
private function findAssetAccount(string $type): bool
private function findAssetAccount(string $type): ?Account
{
// switch on type:
$allowed = config(sprintf('firefly.expected_source_types.source.%s', $type));
$allowed = is_array($allowed) ? $allowed : [];
Log::debug(sprintf('Check config for expected_source_types.source.%s, result is', $type), $allowed);
$account = $this->repository->findByName($this->action->action_value, $allowed);
if (null === $account) {
Log::debug(sprintf('There is NO valid source account called "%s".', $this->action->action_value));
return false;
}
Log::debug(sprintf('There exists a valid source account called "%s". ID is #%d', $this->action->action_value, $account->id));
$this->newSourceAccount = $account;
return true;
return $this->repository->findByName($this->action->action_value, $allowed);
}
/**
*
* @return Account|null
*/
private function findRevenueAccount(): void
private function findRevenueAccount(): ?Account
{
$allowed = config('firefly.expected_source_types.source.Deposit');
$account = $this->repository->findByName($this->action->action_value, $allowed);
@@ -156,7 +97,7 @@ class SetSourceAccount implements ActionInterface
$account = $this->repository->store($data);
}
Log::debug(sprintf('Found or created revenue account #%d ("%s")', $account->id, $account->name));
$this->newSourceAccount = $account;
return $account;
}
/**
@@ -164,6 +105,39 @@ class SetSourceAccount implements ActionInterface
*/
public function actOnArray(array $journal): bool
{
// TODO: Implement actOnArray() method.
$user = User::find($journal['user_id']);
$type = $journal['transaction_type_type'];
$this->repository = app(AccountRepositoryInterface::class);
$this->repository->setUser($user);
// if this is a transfer or a withdrawal, the new source account must be an asset account or a default account, and it MUST exist:
$newAccount = $this->findAssetAccount($type);
if ((TransactionType::WITHDRAWAL === $type || TransactionType::TRANSFER === $type) && null === $newAccount) {
Log::error(sprintf('Cannot change source account of journal #%d because no asset account with name "%s" exists.', $journal['transaction_journal_id'], $this->action->action_value));
return false;
}
// if this is a deposit, the new source account must be a revenue account and may be created:
if (TransactionType::DEPOSIT === $type) {
$newAccount = $this->findRevenueAccount();
}
if (null === $newAccount) {
Log::error('New account is NULL');
return false;
}
Log::debug(sprintf('New source account is #%d ("%s").', $newAccount->id, $newAccount->name));
// update source transaction with new source account:
// get source transaction:
DB::table('transactions')
->where('transaction_journal_id', '=', $journal['transaction_journal_id'])
->where('amount', '<', 0)
->update(['account_id' => $newAccount->id]);
Log::debug(sprintf('Updated journal #%d and gave it new source account ID.', $journal['transaction_journal_id']));
return true;
}
}