Test more rule actions.

This commit is contained in:
James Cole 2020-08-23 09:21:50 +02:00
parent febe60b3d1
commit 139b3ffab4
No known key found for this signature in database
GPG Key ID: B5669F9493CDE38D
19 changed files with 184 additions and 276 deletions

View File

@ -25,6 +25,7 @@ namespace FireflyIII\TransactionRules\Actions;
use FireflyIII\Models\RuleAction;
use FireflyIII\Models\TransactionJournal;
use Log;
use DB;
/**
* Class PrependDescription.
@ -46,6 +47,8 @@ class PrependDescription implements ActionInterface
/**
* Prepend description with X
* @codeCoverageIgnore
* @deprecated
*
* @param TransactionJournal $journal
*
@ -65,6 +68,8 @@ class PrependDescription implements ActionInterface
*/
public function actOnArray(array $journal): bool
{
// TODO: Implement actOnArray() method.
$description = sprintf('%s%s', $this->action->action_value, $journal['description']);
DB::table('transaction_journals')->where('id', $journal['transaction_journal_id'])->limit(1)->update(['description' => $description]);
return true;
}
}

View File

@ -74,6 +74,21 @@ class PrependNotes implements ActionInterface
*/
public function actOnArray(array $journal): bool
{
// TODO: Implement actOnArray() method.
$dbNote = Note
::
where('noteable_id', (int) $journal['transaction_journal_id'])
->where('noteable_type', TransactionJournal::class)
->first(['notes.*']);
if (null === $dbNote) {
$dbNote = new Note;
$dbNote->noteable_id = (int) $journal['transaction_journal_id'];
$dbNote->noteable_type = TransactionJournal::class;
$dbNote->text = '';
}
Log::debug(sprintf('RuleAction PrependNotes prepended "%s" to "%s".', $this->action->action_value, $dbNote->text));
$text = sprintf('%s%s', $this->action->action_value, $dbNote->text);
$dbNote->text = $text;
$dbNote->save();
return true;
}
}

View File

@ -25,6 +25,8 @@ namespace FireflyIII\TransactionRules\Actions;
use FireflyIII\Models\RuleAction;
use FireflyIII\Models\TransactionJournal;
use Log;
use DB;
/**
* Class RemoveAllTags.
@ -44,7 +46,8 @@ class RemoveAllTags implements ActionInterface
* Remove all tags
*
* @param TransactionJournal $journal
*
* @deprecated
* @codeCoverageIgnore
* @return bool
*/
public function act(TransactionJournal $journal): bool
@ -61,6 +64,9 @@ class RemoveAllTags implements ActionInterface
*/
public function actOnArray(array $journal): bool
{
// TODO: Implement actOnArray() method.
Log::debug(sprintf('RuleAction ClearCategory removed all tags from journal %d.', $journal['transaction_journal_id']));
DB::table('tag_transaction_journal')->where('transaction_journal_id', $journal['transaction_journal_id'])->delete();
return true;
}
}

View File

@ -24,15 +24,15 @@ namespace FireflyIII\TransactionRules\Actions;
use FireflyIII\Models\RuleAction;
use FireflyIII\Models\TransactionJournal;
use FireflyIII\User;
use Log;
use DB;
/**
* Class RemoveTag.
*/
class RemoveTag implements ActionInterface
{
/** @var RuleAction The rule action */
private $action;
private RuleAction $action;
/**
* TriggerInterface constructor.
@ -46,7 +46,8 @@ class RemoveTag implements ActionInterface
/**
* Remove tag X
*
* @deprecated
* @codeCoverageIgnore
* @param TransactionJournal $journal
*
* @return bool
@ -74,6 +75,22 @@ class RemoveTag implements ActionInterface
*/
public function actOnArray(array $journal): bool
{
// TODO: Implement actOnArray() method.
// if tag does not exist, no need to continue:
$name = $this->action->action_value;
$user = User::find($journal['user_id']);
$tag = $user->tags()->where('tag', $name)->first();
if (null !== $tag) {
Log::debug(sprintf('RuleAction RemoveTag removed tag #%d ("%s") from journal #%d.', $tag->id, $tag->tag, $journal['transaction_journal_id']));
DB::table('tag_transaction_journal')
->where('transaction_journal_id', $journal['transaction_journal_id'])
->where('tag_id', $tag->id)
->delete();
return true;
}
Log::debug(sprintf('RuleAction RemoveTag tried to remove tag "%s" from journal #%d but no such tag exists.', $name, $journal['transaction_journal_id']));
return true;
}
}

View File

@ -25,15 +25,16 @@ namespace FireflyIII\TransactionRules\Actions;
use FireflyIII\Models\RuleAction;
use FireflyIII\Models\TransactionJournal;
use FireflyIII\Models\TransactionType;
use FireflyIII\User;
use Log;
use DB;
/**
* Class SetBudget.
*/
class SetBudget implements ActionInterface
{
/** @var RuleAction The rule action */
private $action;
private RuleAction $action;
/**
* TriggerInterface constructor.
@ -49,7 +50,8 @@ class SetBudget implements ActionInterface
* Set budget.
*
* @param TransactionJournal $journal
*
* @deprecated
* @codeCoverageIgnore
* @return bool
*/
public function act(TransactionJournal $journal): bool
@ -89,6 +91,34 @@ class SetBudget implements ActionInterface
*/
public function actOnArray(array $journal): bool
{
// TODO: Implement actOnArray() method.
$user = User::find($journal['user_id']);
$search = $this->action->action_value;
$budget = $user->budgets()->where('name', $search)->first();
if (null === $budget) {
Log::debug(sprintf('RuleAction SetBudget could not set budget of journal #%d to "%s" because no such budget exists.', $journal['transaction_journal_id'], $search));
return false;
}
if (TransactionType::WITHDRAWAL !== $journal['transaction_type_type']) {
Log::debug(
sprintf(
'RuleAction SetBudget could not set budget of journal #%d to "%s" because journal is a %s.',
$journal['transaction_journal_id'],
$search,
$journal['transaction_type_type']
)
);
return true;
}
Log::debug(sprintf('RuleAction SetBudget set the budget of journal #%d to budget #%d ("%s").', $journal['transaction_journal_id'], $budget->id, $budget->name));
DB::table('budget_transaction_journal')->where('transaction_journal_id', '=', $journal['transaction_journal_id'])->delete();
DB::table('budget_transaction_journal')->insert(['transaction_journal_id' => $journal['transaction_journal_id'], 'budget_id' => $budget->id]);
return true;
}
}

View File

@ -25,15 +25,17 @@ namespace FireflyIII\TransactionRules\Actions;
use FireflyIII\Factory\CategoryFactory;
use FireflyIII\Models\RuleAction;
use FireflyIII\Models\TransactionJournal;
use FireflyIII\Models\TransactionType;
use FireflyIII\User;
use Log;
use DB;
/**
* Class SetCategory.
*/
class SetCategory implements ActionInterface
{
/** @var RuleAction The rule action */
private $action;
private RuleAction $action;
/**
* TriggerInterface constructor.
@ -49,7 +51,8 @@ class SetCategory implements ActionInterface
* Set category X
*
* @param TransactionJournal $journal
*
* @deprecated
* @codeCoverageIgnore
* @return bool
*/
public function act(TransactionJournal $journal): bool
@ -78,6 +81,21 @@ class SetCategory implements ActionInterface
*/
public function actOnArray(array $journal): bool
{
// TODO: Implement actOnArray() method.
$user = User::find($journal['user_id']);
$search = $this->action->action_value;
$category = $user->categories()->where('name', $search)->first();
if (null === $category) {
Log::debug(sprintf('RuleAction SetCategory could not set category of journal #%d to "%s" because no such category exists.', $journal['transaction_journal_id'], $search));
return false;
}
Log::debug(sprintf('RuleAction SetCategory set the category of journal #%d to category #%d ("%s").', $journal['transaction_journal_id'], $category->id, $category->name));
DB::table('category_transaction_journal')->where('transaction_journal_id', '=', $journal['transaction_journal_id'])->delete();
DB::table('category_transaction_journal')->insert(['transaction_journal_id' => $journal['transaction_journal_id'], 'category_id' => $category->id]);
return true;
}
}

View File

@ -45,7 +45,7 @@ class AppendDescriptionTest extends TestCase
/**
* @covers \FireflyIII\TransactionRules\Actions\AppendDescription
*/
public function testActExistingTag(): void
public function testAct(): void
{
/** @var TransactionJournal $journal */
$journal = $this->user()->transactionJournals()->where('description', 'Rule action test transaction.')->first();

View File

@ -37,9 +37,6 @@ use Tests\TestCase;
/**
*
* Class ConvertToTransferTest
* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
* @SuppressWarnings(PHPMD.ExcessiveMethodLength)
* @SuppressWarnings(PHPMD.TooManyPublicMethods)
*/
class ConvertToTransferTest extends TestCase
{

View File

@ -38,9 +38,6 @@ use Tests\TestCase;
/**
*
* Class ConvertToWithdrawalTest
* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
* @SuppressWarnings(PHPMD.ExcessiveMethodLength)
* @SuppressWarnings(PHPMD.TooManyPublicMethods)
*/
class ConvertToWithdrawalTest extends TestCase
{

View File

@ -24,47 +24,40 @@ namespace Tests\Unit\TransactionRules\Actions;
use FireflyIII\Models\RuleAction;
use FireflyIII\Models\TransactionJournal;
use FireflyIII\TransactionRules\Actions\AppendDescription;
use FireflyIII\TransactionRules\Actions\PrependDescription;
use Tests\TestCase;
/**
* Class PrependDescriptionTest
* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
* @SuppressWarnings(PHPMD.ExcessiveMethodLength)
* @SuppressWarnings(PHPMD.TooManyPublicMethods)
*/
class PrependDescriptionTest extends TestCase
{
/**
* Set up test
*/
public function setUp(): void
{
self::markTestIncomplete('Incomplete for refactor.');
return;
}
/**
* @covers \FireflyIII\TransactionRules\Actions\PrependDescription
*/
public function testAct(): void
{
// get journal, give fixed description
$description = 'text' . $this->randomInt();
$prepend = 'prepend' . $this->randomInt();
$journal = $this->getRandomWithdrawal();
$journal->description = $description;
$journal->save();
/** @var TransactionJournal $journal */
$journal = $this->user()->transactionJournals()->where('description', 'Rule action test transaction.')->first();
$original = $journal->description;
$array = [
'transaction_journal_id' => $journal->id,
'description' => $original,
];
// fire the action:
$ruleAction = new RuleAction;
$ruleAction->action_value = $prepend;
$ruleAction->action_value = 'PREPEND';
$action = new PrependDescription($ruleAction);
$result = $action->act($journal);
$result = $action->actOnArray($array);
$this->assertTrue($result);
$journal = TransactionJournal::find($journal->id);
// assert result
$this->assertEquals($prepend . $description, $journal->description);
$journal = TransactionJournal::find($journal->id);
$this->assertEquals(sprintf('%s%s', $ruleAction->action_value, $original), $journal->description);
$journal->description = $original;
$journal->save();
}
}

View File

@ -27,74 +27,40 @@ use FireflyIII\Models\RuleAction;
use FireflyIII\Models\TransactionJournal;
use FireflyIII\TransactionRules\Actions\PrependNotes;
use Tests\TestCase;
use DB;
/**
* Class PrependNotesTest
* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
* @SuppressWarnings(PHPMD.ExcessiveMethodLength)
* @SuppressWarnings(PHPMD.TooManyPublicMethods)
* TODO doesnt test if prepends or appends.
*/
class PrependNotesTest extends TestCase
{
/**
* Set up test
*/
public function setUp(): void
{
self::markTestIncomplete('Incomplete for refactor.');
return;
}
/**
* @covers \FireflyIII\TransactionRules\Actions\PrependNotes
*/
public function testAct(): void
{
// give journal some notes.
$journal = $this->getRandomWithdrawal();
$note = $journal->notes()->first();
$start = 'Default note text';
$toPrepend = 'This is prepended';
if (null === $note) {
$note = new Note();
$note->noteable()->associate($journal);
}
$note->text = $start;
$note->save();
$journal = $this->user()->transactionJournals()->where('description','Rule action note test transaction.')->first();
// make sure all notes deleted:
DB::table('notes')->where('noteable_id', $journal->id)->where('noteable_type', TransactionJournal::class)->delete();
// array for action:
$array = [
'transaction_journal_id' => $journal->id
];
$toAppend = 'Text to append to note.';
// fire the action:
$ruleAction = new RuleAction;
$ruleAction->action_value = $toPrepend;
$ruleAction->action_value = $toAppend;
$action = new PrependNotes($ruleAction);
$result = $action->act($journal);
$result = $action->actOnArray($array);
$this->assertTrue($result);
$newNote = $journal->notes()->first();
$this->assertEquals($toPrepend . $start, $newNote->text);
$this->assertEquals($toAppend, $newNote->text);
}
/**
* @covers \FireflyIII\TransactionRules\Actions\PrependNotes
*/
public function testActNewNote(): void
{
// give journal some notes.
$journal = $this->getRandomWithdrawal();
$note = $journal->notes()->first();
if (null !== $note) {
$note->forceDelete();
}
$toPrepend = 'This is appended';
// fire the action:
$ruleAction = new RuleAction;
$ruleAction->action_value = $toPrepend;
$action = new PrependNotes($ruleAction);
$result = $action->act($journal);
$this->assertTrue($result);
$newNote = $journal->notes()->first();
$this->assertEquals($toPrepend, $newNote->text);
}
}

View File

@ -22,48 +22,37 @@ declare(strict_types=1);
namespace Tests\Unit\TransactionRules\Actions;
use DB;
use FireflyIII\Models\RuleAction;
use FireflyIII\Models\TransactionJournal;
use FireflyIII\TransactionRules\Actions\RemoveAllTags;
use Tests\TestCase;
/**
* Class RemoveAllTagsTest
* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
* @SuppressWarnings(PHPMD.ExcessiveMethodLength)
* @SuppressWarnings(PHPMD.TooManyPublicMethods)
*/
class RemoveAllTagsTest extends TestCase
{
/**
* Set up test
*/
public function setUp(): void
{
self::markTestIncomplete('Incomplete for refactor.');
return;
}
/**
* @covers \FireflyIII\TransactionRules\Actions\RemoveAllTags
*/
public function testAct(): void
{
// find journal with at least one tag
$journalIds = DB::table('tag_transaction_journal')->get(['transaction_journal_id'])->pluck('transaction_journal_id')->toArray();
$journalId = (int)$journalIds[0];
/** @var TransactionJournal $journal */
$journal = TransactionJournal::find($journalId);
// find journal
$withdrawal = $this->getRandomWithdrawal();
$tag = $this->getRandomTag();
$withdrawal->tags()->sync([$tag->id]);
$array = [
'transaction_journal_id' => $withdrawal->id,
];
// fire the action:
$ruleAction = new RuleAction;
$ruleAction->action_value = null;
$action = new RemoveAllTags($ruleAction);
$result = $action->act($journal);
$result = $action->actOnArray($array);
$this->assertTrue($result);
$this->assertEquals(0, $journal->tags()->count());
$this->assertEquals(0, $withdrawal->tags()->count());
}
}

View File

@ -22,74 +22,39 @@ declare(strict_types=1);
namespace Tests\Unit\TransactionRules\Actions;
use DB;
use FireflyIII\Models\RuleAction;
use FireflyIII\Models\TransactionJournal;
use FireflyIII\TransactionRules\Actions\RemoveTag;
use Tests\TestCase;
/**
* Class RemoveTagTest
* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
* @SuppressWarnings(PHPMD.ExcessiveMethodLength)
* @SuppressWarnings(PHPMD.TooManyPublicMethods)
*/
class RemoveTagTest extends TestCase
{
/**
* Set up test
*/
public function setUp(): void
{
self::markTestIncomplete('Incomplete for refactor.');
return;
}
/**
* @covers \FireflyIII\TransactionRules\Actions\RemoveTag
*/
public function testAct(): void
{
{ // find journal
$withdrawal = $this->getRandomWithdrawal();
$tag = $this->getRandomTag();
$withdrawal->tags()->sync([$tag->id]);
$array = [
'transaction_journal_id' => $withdrawal->id,
'user_id' => 1,
];
// find journal with at least one tag
$journalIds = DB::table('tag_transaction_journal')->get(['transaction_journal_id'])->pluck('transaction_journal_id')->toArray();
$journalId = (int)$journalIds[0];
/** @var TransactionJournal $journal */
$journal = TransactionJournal::find($journalId);
$originalCount = $journal->tags()->count();
$firstTag = $journal->tags()->first();
// fire the action:
$ruleAction = new RuleAction;
$ruleAction->action_value = $firstTag->tag;
$ruleAction->action_value = $tag->tag;
$action = new RemoveTag($ruleAction);
$result = $action->act($journal);
$result = $action->actOnArray($array);
$this->assertTrue($result);
foreach ($journal->tags()->get() as $tag) {
$this->assertNotEquals($firstTag->id, $tag->id);
}
$this->assertEquals($originalCount - 1, $journal->tags()->count());
$this->assertEquals(0, $withdrawal->tags()->count());
}
/**
* @covers \FireflyIII\TransactionRules\Actions\RemoveTag
*/
public function testActNoTag(): void
{
// get journal, link al tags:
/** @var TransactionJournal $journal */
$journal = $this->getRandomWithdrawal();
$tags = $journal->user->tags()->get();
$journal->tags()->sync($tags->pluck('id')->toArray());
$this->assertEquals($tags->count(), $journal->tags()->get()->count());
// fire the action:
$ruleAction = new RuleAction;
$ruleAction->action_value = $this->randomInt() . 'nosuchtag';
$action = new RemoveTag($ruleAction);
$result = $action->act($journal);
$this->assertTrue($result);
$this->assertEquals($tags->count(), $journal->tags()->count());
}
}

View File

@ -30,21 +30,9 @@ use Tests\TestCase;
/**
* Class SetBudgetTest
* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
* @SuppressWarnings(PHPMD.ExcessiveMethodLength)
* @SuppressWarnings(PHPMD.TooManyPublicMethods)
*/
class SetBudgetTest extends TestCase
{
/**
* Set up test
*/
public function setUp(): void
{
self::markTestIncomplete('Incomplete for refactor.');
return;
}
/**
* @covers \FireflyIII\TransactionRules\Actions\SetBudget
@ -52,9 +40,15 @@ class SetBudgetTest extends TestCase
public function testAct(): void
{
// get journal, remove all budgets
$journal = $this->getRandomWithdrawal();
$journal = $this->user()->transactionJournals()->where('description','Groceries with no budget')->first();
$budget = $this->getRandomBudget();
$array = [
'user_id' => $this->user()->id,
'transaction_journal_id' => $journal->id,
'transaction_type_type' => $journal->transactionType->type,
];
$journal->budgets()->sync([]);
$this->assertEquals(0, $journal->budgets()->count());
@ -62,50 +56,12 @@ class SetBudgetTest extends TestCase
$ruleAction = new RuleAction;
$ruleAction->action_value = $budget->name;
$action = new SetBudget($ruleAction);
$result = $action->act($journal);
$result = $action->actOnArray($array);
$this->assertTrue($result);
$this->assertEquals(1, $journal->budgets()->count());
}
/**
* @covers \FireflyIII\TransactionRules\Actions\SetBudget
*/
public function testActNull(): void
{
// get journal, remove all budgets
$journal = $this->getRandomWithdrawal();
$journal->budgets()->sync([]);
$this->assertEquals(0, $journal->budgets()->count());
// fire the action:
$ruleAction = new RuleAction;
$ruleAction->action_value = 'non-existing budget #' . $this->randomInt();
$action = new SetBudget($ruleAction);
$result = $action->act($journal);
$this->assertFalse($result);
$this->assertEquals(0, $journal->budgets()->count());
}
/**
* @covers \FireflyIII\TransactionRules\Actions\SetBudget
*/
public function testActDeposit(): void
{
// get journal, remove all budgets
$journal = $this->getRandomDeposit();
$budget = $this->getRandomBudget();
$journal->budgets()->detach();
$this->assertEquals(0, $journal->budgets()->count());
// fire the action:
$ruleAction = new RuleAction;
$ruleAction->action_value = $budget->name;
$action = new SetBudget($ruleAction);
$result = $action->act($journal);
$this->assertTrue($result);
$this->assertEquals(0, $journal->budgets()->count());
}
}

View File

@ -29,70 +29,36 @@ use Tests\TestCase;
/**
* Class SetCategoryTest
* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
* @SuppressWarnings(PHPMD.ExcessiveMethodLength)
* @SuppressWarnings(PHPMD.TooManyPublicMethods)
*/
class SetCategoryTest extends TestCase
{
/**
* Set up test
*/
public function setUp(): void
{
self::markTestIncomplete('Incomplete for refactor.');
return;
}
/**
* @covers \FireflyIII\TransactionRules\Actions\SetCategory
*/
public function testAct(): void
{
// get journal, remove all budgets
$journal = $this->getRandomWithdrawal();
$category = $this->getRandomCategory();
$journal = $this->user()->transactionJournals()->where('description','Groceries with no category')->first();
$category = $this->getRandomCategory();
$factory = $this->mock(CategoryFactory::class);
$factory->shouldReceive('setUser');
$factory->shouldReceive('findOrCreate')->andReturn($category);
$array = [
'user_id' => $this->user()->id,
'transaction_journal_id' => $journal->id,
'transaction_type_type' => $journal->transactionType->type,
];
$journal->categories()->detach();
$journal->budgets()->sync([]);
$this->assertEquals(0, $journal->categories()->count());
// fire the action:
$ruleAction = new RuleAction;
$ruleAction->action_value = $category->name;
$action = new SetCategory($ruleAction);
$result = $action->act($journal);
$result = $action->actOnArray($array);
$this->assertTrue($result);
$this->assertEquals(1, $journal->categories()->count());
}
/**
* @covers \FireflyIII\TransactionRules\Actions\SetCategory
*/
public function testActNull(): void
{
$factory = $this->mock(CategoryFactory::class);
$factory->shouldReceive('setUser');
$factory->shouldReceive('findOrCreate')->andReturnNull();
// get journal, remove all budgets
$journal = $this->getRandomWithdrawal();
$category = $this->getRandomCategory();
$journal->categories()->detach();
$this->assertEquals(0, $journal->categories()->count());
// fire the action:
$ruleAction = new RuleAction;
$ruleAction->action_value = $category->name;
$action = new SetCategory($ruleAction);
$result = $action->act($journal);
$this->assertFalse($result);
$journal->categories()->sync([]);
$this->assertEquals(0, $journal->categories()->count());
}
}

View File

@ -29,9 +29,6 @@ use Tests\TestCase;
/**
* Class SetDescriptionTest
* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
* @SuppressWarnings(PHPMD.ExcessiveMethodLength)
* @SuppressWarnings(PHPMD.TooManyPublicMethods)
*/
class SetDescriptionTest extends TestCase
{

View File

@ -35,9 +35,6 @@ use Tests\TestCase;
* Try split journal
*
* Class SetDestinationAccountTest
* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
* @SuppressWarnings(PHPMD.ExcessiveMethodLength)
* @SuppressWarnings(PHPMD.TooManyPublicMethods)
*/
class SetDestinationAccountTest extends TestCase
{

View File

@ -30,9 +30,6 @@ use Tests\TestCase;
/**
* Class SetNotesTest
* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
* @SuppressWarnings(PHPMD.ExcessiveMethodLength)
* @SuppressWarnings(PHPMD.TooManyPublicMethods)
*/
class SetNotesTest extends TestCase
{

View File

@ -33,9 +33,6 @@ use Tests\TestCase;
/**
* Class SetSourceAccountTest
* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
* @SuppressWarnings(PHPMD.ExcessiveMethodLength)
* @SuppressWarnings(PHPMD.TooManyPublicMethods)
*/
class SetSourceAccountTest extends TestCase
{