Various improvements.

This commit is contained in:
James Cole
2019-03-08 05:47:51 +01:00
parent e6d7c0ddbd
commit 431cf08401
11 changed files with 813 additions and 430 deletions

View File

@@ -24,12 +24,11 @@ declare(strict_types=1);
namespace FireflyIII\Factory;
use FireflyIII\Exceptions\FireflyException;
use FireflyIII\Models\TransactionCurrency;
use FireflyIII\Models\TransactionGroup;
use Carbon\Carbon;
use Exception;
use FireflyIII\Models\TransactionJournal;
use FireflyIII\Services\Internal\Support\JournalServiceTrait;
use FireflyIII\Services\Internal\Support\TransactionTypeTrait;
use FireflyIII\Repositories\Currency\CurrencyRepositoryInterface;
use FireflyIII\Repositories\TransactionType\TransactionTypeRepositoryInterface;
use FireflyIII\User;
use Illuminate\Support\Collection;
use Log;
@@ -39,23 +38,36 @@ use Log;
*/
class TransactionJournalFactory
{
private $fields;
/** @var CurrencyRepositoryInterface */
private $currencyRepository;
/** @var TransactionFactory */
private $transactionFactory;
/** @var TransactionTypeRepositoryInterface */
private $typeRepository;
// private $fields;
/** @var User The user */
private $user;
use JournalServiceTrait, TransactionTypeTrait;
//
// use JournalServiceTrait, TransactionTypeTrait;
/**
* Constructor.
*/
public function __construct()
{
$this->fields = ['sepa-cc', 'sepa-ct-op', 'sepa-ct-id', 'sepa-db', 'sepa-country', 'sepa-ep', 'sepa-ci', 'interest_date', 'book_date', 'process_date',
'due_date', 'recurrence_id', 'payment_date', 'invoice_date', 'internal_reference', 'bunq_payment_id', 'importHash', 'importHashV2',
'external_id', 'sepa-batch-id', 'original-source'];
// $this->fields = ['sepa-cc', 'sepa-ct-op', 'sepa-ct-id', 'sepa-db', 'sepa-country', 'sepa-ep', 'sepa-ci', 'interest_date', 'book_date', 'process_date',
// 'due_date', 'recurrence_id', 'payment_date', 'invoice_date', 'internal_reference', 'bunq_payment_id', 'importHash', 'importHashV2',
// 'external_id', 'sepa-batch-id', 'original-source'];
if ('testing' === config('app.env')) {
Log::warning(sprintf('%s should not be instantiated in the TEST environment!', \get_class($this)));
}
$this->currencyRepository = app(CurrencyRepositoryInterface::class);
$this->typeRepository = app(TransactionTypeRepositoryInterface::class);
$this->transactionFactory = app(TransactionFactory::class);
}
/**
@@ -64,46 +76,31 @@ class TransactionJournalFactory
* @param array $data
*
* @return Collection
* @throws FireflyException
* @throws Exception
*/
public function create(array $data): Collection
{
Log::debug('Start of TransactionJournalFactory::create()');
$factory = app(TransactionFactory::class);
$journals = new Collection;
$carbon = $data['date'];
$type = $this->findTransactionType($data['type']);
$description = app('steam')->cleanString($data['description']);
$collection = new Collection;
$transactions = $data['transactions'] ?? [];
$type = $this->typeRepository->findTransactionType(null, $data['type']);
$description = app('steam')->cleanString($data['description']);
$carbon = $data['date'] ?? new Carbon;
$carbon->setTimezone(config('app.timezone'));
$factory->setUser($this->user);
Log::debug(sprintf('New journal(group): %s with description "%s"', $type->type, $description));
/** @var array $transaction */
foreach ($transactions as $transaction) {
// loop each transaction.
/**
* @var int $index
* @var array $transactionData
*/
foreach ($data['transactions'] as $index => $transactionData) {
Log::debug(sprintf('Now at journal #%d from %d', $index + 1, count($data['transactions'])));
/** Get basic fields */
$currency = $this->currencyRepository->findCurrency($transaction['currency'], $transaction['currency_id'], $transaction['currency_code']);
// catch to stop empty amounts:
if ('' === (string)$transactionData['amount'] || 0.0 === (float)$transactionData['amount']) {
continue;
}
// currency & foreign currency
$transactionData['currency'] = $this->getCurrency($data, $index);
$transactionData['foreign_currency'] = $this->getForeignCurrency($data, $index);
// store basic journal first.
/** Create a basic journal. */
$journal = TransactionJournal::create(
[
'user_id' => $data['user'],
'user_id' => $this->user->id,
'transaction_type_id' => $type->id,
'bill_id' => null,
'transaction_currency_id' => $transactionData['currency']->id,
'transaction_currency_id' => $currency->id,
'description' => $description,
'date' => $carbon->format('Y-m-d H:i:s'),
'order' => 0,
@@ -111,65 +108,128 @@ class TransactionJournalFactory
'completed' => 0,
]
);
Log::debug(sprintf('Stored journal under ID #%d', $journal->id));
// store transactions for this journal:
$factory->createPair($journal, $transactionData);
/** Create two transactions. */
$this->transactionFactory->setJournal($journal);
$children = $this->transactionFactory->createPair($currency, $transaction);
// save journal:
$journal->completed = true;
$journal->save();
// // link bill TODO
// $this->connectBill($journal, $data);
//
// // link piggy bank (if transfer) TODO
// $this->connectPiggyBank($journal, $data);
//
// // link tags: TODO
// $this->connectTags($journal, $transactionData);
//
// // store note: TODO
// $this->storeNote($journal, $transactionData['notes']);
//
// if ($journal->transactionType->type !== TransactionType::WITHDRAWAL) {
// $transactionData['budget_id'] = null;
// $transactionData['budget_name'] = null;
// }
// // save budget TODO
// $budget = $this->findBudget($data['budget_id'], $data['budget_name']);
// $this->setBudget($journal, $budget);
//
// // set category TODO
// $category = $this->findCategory($data['category_id'], $data['category_name']);
// $this->setCategory($journal, $category);
//
// // store meta data TODO
// foreach ($this->fields as $field) {
// $this->storeMeta($journal, $data, $field);
// }
// add to array
$journals->push($journal);
}
// create group if necessary
if ($journals->count() > 1) {
$group = new TransactionGroup;
$group->user()->associate($this->user);
$group->title = $description;
$group->save();
$group->transactionJournals()->saveMany($journals);
$collection->push($journal);
Log::debug(sprintf('Created journal #%d', $journal->id));
Log::debug(sprintf('More than one journal, created group #%d.', $group->id));
return $collection;
/** Create two basic transactions */
}
Log::debug('End of TransactionJournalFactory::create()');
// invalidate cache.
app('preferences')->mark();
return $journals;
// /** @var TransactionFactory $factory */
// $factory = app(TransactionFactory::class);
// $journals = new Collection;
// ;
// $type = $this->findTransactionType($data['type']);
//
//
//
// $factory->setUser($this->user);
//
// Log::debug(sprintf('New journal(group): %s with description "%s"', $type->type, $description));
//
// // loop each transaction.
// /**
// * @var int $index
// * @var array $transactionData
// */
// foreach ($data['transactions'] as $index => $transactionData) {
// Log::debug(sprintf('Now at journal #%d from %d', $index + 1, count($data['transactions'])));
//
// // catch to stop empty amounts:
// if ('' === (string)$transactionData['amount'] || 0.0 === (float)$transactionData['amount']) {
// continue;
// }
// // currency & foreign currency
// $transactionData['currency'] = $this->getCurrency($transactionData, $index);
// $transactionData['foreign_currency'] = $this->getForeignCurrency($transactionData, $index);
//
// // store basic journal first.
// $journal = TransactionJournal::create(
// [
// 'user_id' => $data['user'],
// 'transaction_type_id' => $type->id,
// 'bill_id' => null,
// 'transaction_currency_id' => $transactionData['currency']->id,
// 'description' => $description,
// 'date' => $carbon->format('Y-m-d H:i:s'),
// 'order' => 0,
// 'tag_count' => 0,
// 'completed' => 0,
// ]
// );
// Log::debug(sprintf('Stored journal under ID #%d', $journal->id));
//
// // store transactions for this journal:
// $factory->createPair($journal, $transactionData);
//
// // link bill
// Log::debug('Connect bill');
// $this->connectBill($journal, $transactionData);
//
// // link piggy bank (if transfer)
// $this->connectPiggyBank($journal, $transactionData);
//
// // link tags
// $this->connectTags($journal, $transactionData);
//
// // store note
// $this->storeNote($journal, $transactionData['notes']);
//
// // save journal:
// $journal->completed = true;
// $journal->save();
//
//
//
// // if ($journal->transactionType->type !== TransactionType::WITHDRAWAL) {
// // $transactionData['budget_id'] = null;
// // $transactionData['budget_name'] = null;
// // }
// // // save budget TODO
// // $budget = $this->findBudget($data['budget_id'], $data['budget_name']);
// // $this->setBudget($journal, $budget);
// //
// // // set category TODO
// // $category = $this->findCategory($data['category_id'], $data['category_name']);
// // $this->setCategory($journal, $category);
// //
// // // store meta data TODO
// // foreach ($this->fields as $field) {
// // $this->storeMeta($journal, $data, $field);
// // }
//
// // add to array
// $journals->push($journal);
// }
//
// // create group if necessary
// if ($journals->count() > 1) {
// $group = new TransactionGroup;
// $group->user()->associate($this->user);
// $group->title = $description;
// $group->save();
// $group->transactionJournals()->saveMany($journals);
//
// Log::debug(sprintf('More than one journal, created group #%d.', $group->id));
// }
//
//
// Log::debug('End of TransactionJournalFactory::create()');
// // invalidate cache.
// app('preferences')->mark();
//
// return $journals;
}
@@ -181,148 +241,167 @@ class TransactionJournalFactory
public function setUser(User $user): void
{
$this->user = $user;
$this->currencyRepository->setUser($this->user);
$this->transactionFactory->setUser($this->user);
}
/**
* Link a piggy bank to this journal.
*
* @param TransactionJournal $journal
* @param array $data
*/
protected function connectPiggyBank(TransactionJournal $journal, array $data): void
{
/** @var PiggyBankFactory $factory */
$factory = app(PiggyBankFactory::class);
$factory->setUser($this->user);
$piggyBank = $factory->find($data['piggy_bank_id'], $data['piggy_bank_name']);
if (null !== $piggyBank) {
/** @var PiggyBankEventFactory $factory */
$factory = app(PiggyBankEventFactory::class);
$factory->create($journal, $piggyBank);
}
}
/**
* @param array $data
* @param int $index
*
* @return TransactionCurrency
*/
private function getCurrency(array $data, int $index): TransactionCurrency
{
// first check the transaction row itself.
$row = $data['transactions'][$index];
$currency = null;
// check currency object:
if (null === $currency && isset($row['currency']) && $row['currency'] instanceof TransactionCurrency) {
$currency = $row['currency'];
}
// check currency ID:
if (null === $currency && isset($row['currency_id']) && (int)$row['currency_id'] > 0) {
$currencyId = (int)$row['currency_id'];
$currency = TransactionCurrency::find($currencyId);
}
// check currency code
if (null === $currency && isset($row['currency_code']) && 3 === \strlen($row['currency_code'])) {
$currency = TransactionCurrency::whereCode($row['currency_code'])->first();
}
// continue with journal itself.
// check currency object:
if (null === $currency && isset($data['currency']) && $data['currency'] instanceof TransactionCurrency) {
$currency = $data['currency'];
}
// check currency ID:
if (null === $currency && isset($data['currency_id']) && (int)$data['currency_id'] > 0) {
$currencyId = (int)$data['currency_id'];
$currency = TransactionCurrency::find($currencyId);
}
// check currency code
if (null === $currency && isset($data['currency_code']) && 3 === \strlen($data['currency_code'])) {
$currency = TransactionCurrency::whereCode($data['currency_code'])->first();
}
if (null === $currency) {
// return user's default currency:
$currency = app('amount')->getDefaultCurrencyByUser($this->user);
}
// enable currency:
if (false === $currency->enabled) {
$currency->enabled = true;
$currency->save();
}
Log::debug(sprintf('Journal currency will be #%d (%s)', $currency->id, $currency->code));
return $currency;
}
/**
* @param array $data
* @param int $index
*
* @return TransactionCurrency|null
*/
private function getForeignCurrency(array $data, int $index): ?TransactionCurrency
{
// first check the transaction row itself.
$row = $data['transactions'][$index];
$currency = null;
// check currency object:
if (null === $currency && isset($row['foreign_currency']) && $row['foreign_currency'] instanceof TransactionCurrency) {
$currency = $row['foreign_currency'];
}
// check currency ID:
if (null === $currency && isset($row['foreign_currency_id']) && (int)$row['foreign_currency_id'] > 0) {
$currencyId = (int)$row['foreign_currency_id'];
$currency = TransactionCurrency::find($currencyId);
}
// check currency code
if (null === $currency && isset($row['foreign_currency_code']) && 3 === \strlen($row['foreign_currency_code'])) {
$currency = TransactionCurrency::whereCode($row['foreign_currency_code'])->first();
}
// continue with journal itself.
// check currency object:
if (null === $currency && isset($data['foreign_currency']) && $data['foreign_currency'] instanceof TransactionCurrency) {
$currency = $data['foreign_currency'];
}
// check currency ID:
if (null === $currency && isset($data['foreign_currency_id']) && (int)$data['foreign_currency_id'] > 0) {
$currencyId = (int)$data['foreign_currency_id'];
$currency = TransactionCurrency::find($currencyId);
}
// check currency code
if (null === $currency && isset($data['foreign_currency_code']) && 3 === \strlen($data['foreign_currency_code'])) {
$currency = TransactionCurrency::whereCode($data['foreign_currency_code'])->first();
}
// enable currency:
if (null !== $currency && false === $currency->enabled) {
$currency->enabled = true;
$currency->save();
}
if (null !== $currency) {
Log::debug(sprintf('Journal foreign currency will be #%d (%s)', $currency->id, $currency->code));
}
if (null === $currency) {
Log::debug('Journal foreign currency will be NULL');
}
return $currency;
}
// /**
// * Connect bill if present.
// *
// * @param TransactionJournal $journal
// * @param array $data
// */
// protected function connectBill(TransactionJournal $journal, array $data): void
// {
// if (!$journal->isWithdrawal()) {
// Log::debug(sprintf('Journal #%d is not a withdrawal', $journal->id));
//
// return;
// }
// /** @var BillFactory $factory */
// $factory = app(BillFactory::class);
// $factory->setUser($journal->user);
//
// $bill = null;
//
// if (isset($data['bill']) && $data['bill'] instanceof Bill && $data['bill']->user_id === $this->user->id) {
// Log::debug('Bill object found and belongs to user');
// $bill = $data['bill'];
// }
// if (null === $data['bill']) {
// Log::debug('Bill object not found, search by bill data.');
// $bill = $factory->find((int)$data['bill_id'], $data['bill_name']);
// }
//
// if (null !== $bill) {
// Log::debug(sprintf('Connected bill #%d (%s) to journal #%d', $bill->id, $bill->name, $journal->id));
// $journal->bill_id = $bill->id;
// $journal->save();
//
// return;
// }
// Log::debug('Bill data is NULL.');
// $journal->bill_id = null;
// $journal->save();
//
// }
//
// /**
// * Link a piggy bank to this journal.
// *
// * @param TransactionJournal $journal
// * @param array $data
// */
// protected function connectPiggyBank(TransactionJournal $journal, array $data): void
// {
// if (!$journal->isTransfer()) {
//
// return;
// }
// /** @var PiggyBankFactory $factory */
// $factory = app(PiggyBankFactory::class);
// $factory->setUser($this->user);
// $piggyBank = null;
//
// if (isset($data['piggy_bank']) && $data['piggy_bank'] instanceof PiggyBank && $data['piggy_bank']->account->user_id === $this->user->id) {
// Log::debug('Piggy found and belongs to user');
// $piggyBank = $data['piggy_bank'];
// }
// if (null === $data['piggy_bank']) {
// Log::debug('Piggy not found, search by piggy data.');
// $piggyBank = $factory->find($data['piggy_bank_id'], $data['piggy_bank_name']);
// }
//
// if (null !== $piggyBank) {
// /** @var PiggyBankEventFactory $factory */
// $factory = app(PiggyBankEventFactory::class);
// $factory->create($journal, $piggyBank);
// Log::debug('Create piggy event.');
//
// return;
// }
// Log::debug('Create no piggy event');
// }
//
// /**
// * @param array $data
// * @param int $index
// *
// * @return TransactionCurrency
// */
// private function getCurrency(array $data, int $index): TransactionCurrency
// {
// $currency = null;
// // check currency object:
// if (null === $currency && isset($data['currency']) && $data['currency'] instanceof TransactionCurrency) {
// $currency = $data['currency'];
// }
//
// // check currency ID:
// if (null === $currency && isset($data['currency_id']) && (int)$data['currency_id'] > 0) {
// $currencyId = (int)$data['currency_id'];
// $currency = TransactionCurrency::find($currencyId);
// }
//
// // check currency code
// if (null === $currency && isset($data['currency_code']) && 3 === \strlen($data['currency_code'])) {
// $currency = TransactionCurrency::whereCode($data['currency_code'])->first();
// }
// if (null === $currency) {
// // return user's default currency:
// $currency = app('amount')->getDefaultCurrencyByUser($this->user);
// }
//
// // enable currency:
// if (false === $currency->enabled) {
// $currency->enabled = true;
// $currency->save();
// }
// Log::debug(sprintf('Journal currency will be #%d (%s)', $currency->id, $currency->code));
//
// return $currency;
//
// }
//
// /**
// * @param array $data
// * @param int $index
// *
// * @return TransactionCurrency|null
// */
// private function getForeignCurrency(array $data, int $index): ?TransactionCurrency
// {
// $currency = null;
//
// // check currency object:
// if (null === $currency && isset($data['foreign_currency']) && $data['foreign_currency'] instanceof TransactionCurrency) {
// $currency = $data['foreign_currency'];
// }
//
// // check currency ID:
// if (null === $currency && isset($data['foreign_currency_id']) && (int)$data['foreign_currency_id'] > 0) {
// $currencyId = (int)$data['foreign_currency_id'];
// $currency = TransactionCurrency::find($currencyId);
// }
//
// // check currency code
// if (null === $currency && isset($data['foreign_currency_code']) && 3 === \strlen($data['foreign_currency_code'])) {
// $currency = TransactionCurrency::whereCode($data['foreign_currency_code'])->first();
// }
//
// // enable currency:
// if (null !== $currency && false === $currency->enabled) {
// $currency->enabled = true;
// $currency->save();
// }
// if (null !== $currency) {
// Log::debug(sprintf('Journal foreign currency will be #%d (%s)', $currency->id, $currency->code));
// }
// if (null === $currency) {
// Log::debug('Journal foreign currency will be NULL');
// }
//
// return $currency;
// }
}