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

Code cleanup.

Browse Source
This commit is contained in:
James Cole
2023-12-20 19:35:52 +01:00
parent c4f6366642
commit 64ec0cf62e
997 changed files with 12908 additions and 28136 deletions
Download Patch File Download Diff File Expand all files Collapse all files

298
app/Repositories/Rule/RuleRepository.php
View File

@@ -23,7 +23,6 @@ declare(strict_types=1);
namespace FireflyIII\Repositories\Rule;
use Exception;
use FireflyIII\Exceptions\FireflyException;
use FireflyIII\Models\Rule;
use FireflyIII\Models\RuleAction;
@@ -37,7 +36,6 @@ use Illuminate\Support\Collection;
/**
* Class RuleRepository.
*
*/
class RuleRepository implements RuleRepositoryInterface
{
@@ -45,10 +43,7 @@ class RuleRepository implements RuleRepositoryInterface
private $user;
/**
* @param Rule $rule
*
* @return bool
* @throws Exception
* @throws \Exception
*/
public function destroy(Rule $rule): bool
{
@@ -63,9 +58,6 @@ class RuleRepository implements RuleRepositoryInterface
return true;
}
/**
* @inheritDoc
*/
public function duplicate(Rule $rule): Rule
{
$newRule = $rule->replicate();
@@ -93,8 +85,6 @@ class RuleRepository implements RuleRepositoryInterface
/**
* Get all the users rules.
*
* @return Collection
*/
public function getAll(): Collection
{
@@ -103,75 +93,49 @@ class RuleRepository implements RuleRepositoryInterface
/**
* FIxXME can return null.
*
* @return RuleGroup
*/
public function getFirstRuleGroup(): RuleGroup
{
return $this->user->ruleGroups()->first();
}
/**
* @param RuleGroup $ruleGroup
*
* @return int
*/
public function getHighestOrderInRuleGroup(RuleGroup $ruleGroup): int
{
return (int)$ruleGroup->rules()->max('order');
}
/**
* @param Rule $rule
*
* @return string
*
* @throws FireflyException
*/
public function getPrimaryTrigger(Rule $rule): string
{
$count = $rule->ruleTriggers()->count();
if (0 === $count) {
throw new FireflyException('Rules should have more than zero triggers, rule #' . $rule->id . ' has none!');
throw new FireflyException('Rules should have more than zero triggers, rule #'.$rule->id.' has none!');
}
return $rule->ruleTriggers()->where('trigger_type', 'user_action')->first()->trigger_value;
}
/**
* @return int
*/
public function count(): int
{
return $this->user->rules()->count();
}
/**
* @param Rule $rule
*
* @return Collection
*/
public function getRuleActions(Rule $rule): Collection
{
return $rule->ruleActions()->orderBy('order', 'ASC')->get();
}
/**
* @param Rule $rule
*
* @return Collection
*/
public function getRuleTriggers(Rule $rule): Collection
{
return $rule->ruleTriggers()->orderBy('order', 'ASC')->get();
}
/**
* @inheritDoc
*/
public function getSearchQuery(Rule $rule): string
{
$params = [];
/** @var RuleTrigger $trigger */
foreach ($rule->ruleTriggers as $trigger) {
if ('user_action' === $trigger->trigger_type) {
@@ -189,20 +153,19 @@ class RuleRepository implements RuleRepositoryInterface
return implode(' ', $params);
}
/**
* @inheritDoc
*/
public function getStoreRules(): Collection
{
$collection = $this->user->rules()
->leftJoin('rule_groups', 'rule_groups.id', '=', 'rules.rule_group_id')
->where('rules.active', true)
->where('rule_groups.active', true)
->orderBy('rule_groups.order', 'ASC')
->orderBy('rules.order', 'ASC')
->orderBy('rules.id', 'ASC')
->with(['ruleGroup', 'ruleTriggers'])->get(['rules.*']);
->leftJoin('rule_groups', 'rule_groups.id', '=', 'rules.rule_group_id')
->where('rules.active', true)
->where('rule_groups.active', true)
->orderBy('rule_groups.order', 'ASC')
->orderBy('rules.order', 'ASC')
->orderBy('rules.id', 'ASC')
->with(['ruleGroup', 'ruleTriggers'])->get(['rules.*'])
;
$filtered = new Collection();
/** @var Rule $rule */
foreach ($collection as $rule) {
/** @var RuleTrigger $ruleTrigger */
@@ -216,20 +179,19 @@ class RuleRepository implements RuleRepositoryInterface
return $filtered;
}
/**
* @inheritDoc
*/
public function getUpdateRules(): Collection
{
$collection = $this->user->rules()
->leftJoin('rule_groups', 'rule_groups.id', '=', 'rules.rule_group_id')
->where('rules.active', true)
->where('rule_groups.active', true)
->orderBy('rule_groups.order', 'ASC')
->orderBy('rules.order', 'ASC')
->orderBy('rules.id', 'ASC')
->with(['ruleGroup', 'ruleTriggers'])->get();
->leftJoin('rule_groups', 'rule_groups.id', '=', 'rules.rule_group_id')
->where('rules.active', true)
->where('rule_groups.active', true)
->orderBy('rule_groups.order', 'ASC')
->orderBy('rules.order', 'ASC')
->orderBy('rules.id', 'ASC')
->with(['ruleGroup', 'ruleTriggers'])->get()
;
$filtered = new Collection();
/** @var Rule $rule */
foreach ($collection as $rule) {
/** @var RuleTrigger $ruleTrigger */
@@ -243,9 +205,6 @@ class RuleRepository implements RuleRepositoryInterface
return $filtered;
}
/**
* @inheritDoc
*/
public function searchRule(string $query, int $limit): Collection
{
$search = $this->user->rules();
@@ -253,15 +212,13 @@ class RuleRepository implements RuleRepositoryInterface
$search->where('rules.title', 'LIKE', sprintf('%%%s%%', $query));
}
$search->orderBy('rules.order', 'ASC')
->orderBy('rules.title', 'ASC');
->orderBy('rules.title', 'ASC')
;
return $search->take($limit)->get(['id', 'title', 'description']);
}
/**
* @param array $data
*
* @return Rule
* @throws FireflyException
*/
public function store(array $data): Rule
@@ -313,45 +270,11 @@ class RuleRepository implements RuleRepositoryInterface
return $rule;
}
/**
* @param int $ruleId
*
* @return Rule|null
*/
public function find(int $ruleId): ?Rule
{
return $this->user->rules()->find($ruleId);
}
/**
* @param string $moment
* @param Rule $rule
*/
private function setRuleTrigger(string $moment, Rule $rule): void
{
/** @var RuleTrigger|null $trigger */
$trigger = $rule->ruleTriggers()->where('trigger_type', 'user_action')->first();
if (null !== $trigger) {
$trigger->trigger_value = $moment;
$trigger->save();
return;
}
$trigger = new RuleTrigger();
$trigger->order = 0;
$trigger->trigger_type = 'user_action';
$trigger->trigger_value = $moment;
$trigger->rule_id = $rule->id;
$trigger->active = true;
$trigger->stop_processing = false;
$trigger->save();
}
/**
* @param RuleGroup $ruleGroup
*
* @return bool
*/
public function resetRuleOrder(RuleGroup $ruleGroup): bool
{
$groupRepository = app(RuleGroupRepositoryInterface::class);
@@ -361,19 +284,13 @@ class RuleRepository implements RuleRepositoryInterface
return true;
}
/**
* @param User|Authenticatable|null $user
*/
public function setUser(User | Authenticatable | null $user): void
public function setUser(null|Authenticatable|User $user): void
{
if ($user instanceof User) {
$this->user = $user;
}
}
/**
* @inheritDoc
*/
public function setOrder(Rule $rule, int $newOrder): void
{
$oldOrder = $rule->order;
@@ -384,11 +301,12 @@ class RuleRepository implements RuleRepositoryInterface
if ($newOrder > $oldOrder) {
$this->user->rules()
->where('rules.rule_group_id', $groupId)
->where('rules.order', '<=', $newOrder)
->where('rules.order', '>', $oldOrder)
->where('rules.id', '!=', $rule->id)
->decrement('rules.order');
->where('rules.rule_group_id', $groupId)
->where('rules.order', '<=', $newOrder)
->where('rules.order', '>', $oldOrder)
->where('rules.id', '!=', $rule->id)
->decrement('rules.order')
;
$rule->order = $newOrder;
app('log')->debug(sprintf('Order of rule #%d ("%s") is now %d', $rule->id, $rule->title, $newOrder));
$rule->save();
@@ -397,60 +315,22 @@ class RuleRepository implements RuleRepositoryInterface
}
$this->user->rules()
->where('rules.rule_group_id', $groupId)
->where('rules.order', '>=', $newOrder)
->where('rules.order', '<', $oldOrder)
->where('rules.id', '!=', $rule->id)
->increment('rules.order');
->where('rules.rule_group_id', $groupId)
->where('rules.order', '>=', $newOrder)
->where('rules.order', '<', $oldOrder)
->where('rules.id', '!=', $rule->id)
->increment('rules.order')
;
$rule->order = $newOrder;
app('log')->debug(sprintf('Order of rule #%d ("%s") is now %d', $rule->id, $rule->title, $newOrder));
$rule->save();
}
/**
* @inheritDoc
*/
public function maxOrder(RuleGroup $ruleGroup): int
{
return (int)$ruleGroup->rules()->max('order');
}
/**
* @param Rule $rule
* @param array $data
*
* @return void
*/
private function storeTriggers(Rule $rule, array $data): void
{
$order = 1;
foreach ($data['triggers'] as $trigger) {
$value = $trigger['value'] ?? '';
$stopProcessing = $trigger['stop_processing'] ?? false;
$active = $trigger['active'] ?? true;
$type = $trigger['type'];
if (true === ($trigger['prohibited'] ?? false) && !str_starts_with($type, '-')) {
$type = sprintf('-%s', $type);
}
$triggerValues = [
'action' => $type,
'value' => $value,
'stop_processing' => $stopProcessing,
'order' => $order,
'active' => $active,
];
$this->storeTrigger($rule, $triggerValues);
++$order;
}
}
/**
* @param Rule $rule
* @param array $values
*
* @return RuleTrigger
*/
public function storeTrigger(Rule $rule, array $values): RuleTrigger
{
$ruleTrigger = new RuleTrigger();
@@ -465,37 +345,6 @@ class RuleRepository implements RuleRepositoryInterface
return $ruleTrigger;
}
/**
* @param Rule $rule
* @param array $data
*
* @return void
*/
private function storeActions(Rule $rule, array $data): void
{
$order = 1;
foreach ($data['actions'] as $action) {
$value = $action['value'] ?? '';
$stopProcessing = $action['stop_processing'] ?? false;
$active = $action['active'] ?? true;
$actionValues = [
'action' => $action['type'],
'value' => $value,
'stop_processing' => $stopProcessing,
'order' => $order,
'active' => $active,
];
$this->storeAction($rule, $actionValues);
++$order;
}
}
/**
* @param Rule $rule
* @param array $values
*
* @return RuleAction
*/
public function storeAction(Rule $rule, array $values): RuleAction
{
$ruleAction = new RuleAction();
@@ -510,12 +359,6 @@ class RuleRepository implements RuleRepositoryInterface
return $ruleAction;
}
/**
* @param Rule $rule
* @param array $data
*
* @return Rule
*/
public function update(Rule $rule, array $data): Rule
{
// update rule:
@@ -529,7 +372,7 @@ class RuleRepository implements RuleRepositoryInterface
];
foreach ($fields as $field) {
if (array_key_exists($field, $data)) {
$rule->$field = $data[$field];
$rule->{$field} = $data[$field];
}
}
$rule->save();
@@ -541,7 +384,6 @@ class RuleRepository implements RuleRepositoryInterface
$this->moveRule($rule, $group, (int)$data['order']);
}
// update the triggers:
if (array_key_exists('trigger', $data) && 'update-journal' === $data['trigger']) {
$this->setRuleTrigger('update-journal', $rule);
@@ -568,9 +410,6 @@ class RuleRepository implements RuleRepositoryInterface
return $rule;
}
/**
* @inheritDoc
*/
public function moveRule(Rule $rule, RuleGroup $ruleGroup, int $order): Rule
{
if ($rule->rule_group_id !== $ruleGroup->id) {
@@ -582,4 +421,67 @@ class RuleRepository implements RuleRepositoryInterface
return $rule;
}
private function setRuleTrigger(string $moment, Rule $rule): void
{
/** @var null|RuleTrigger $trigger */
$trigger = $rule->ruleTriggers()->where('trigger_type', 'user_action')->first();
if (null !== $trigger) {
$trigger->trigger_value = $moment;
$trigger->save();
return;
}
$trigger = new RuleTrigger();
$trigger->order = 0;
$trigger->trigger_type = 'user_action';
$trigger->trigger_value = $moment;
$trigger->rule_id = $rule->id;
$trigger->active = true;
$trigger->stop_processing = false;
$trigger->save();
}
private function storeTriggers(Rule $rule, array $data): void
{
$order = 1;
foreach ($data['triggers'] as $trigger) {
$value = $trigger['value'] ?? '';
$stopProcessing = $trigger['stop_processing'] ?? false;
$active = $trigger['active'] ?? true;
$type = $trigger['type'];
if (true === ($trigger['prohibited'] ?? false) && !str_starts_with($type, '-')) {
$type = sprintf('-%s', $type);
}
$triggerValues = [
'action' => $type,
'value' => $value,
'stop_processing' => $stopProcessing,
'order' => $order,
'active' => $active,
];
$this->storeTrigger($rule, $triggerValues);
++$order;
}
}
private function storeActions(Rule $rule, array $data): void
{
$order = 1;
foreach ($data['actions'] as $action) {
$value = $action['value'] ?? '';
$stopProcessing = $action['stop_processing'] ?? false;
$active = $action['active'] ?? true;
$actionValues = [
'action' => $action['type'],
'value' => $value,
'stop_processing' => $stopProcessing,
'order' => $order,
'active' => $active,
];
$this->storeAction($rule, $actionValues);
++$order;
}
}
}

106
app/Repositories/Rule/RuleRepositoryInterface.php
View File

@@ -36,165 +36,61 @@ use Illuminate\Support\Collection;
*/
interface RuleRepositoryInterface
{
/**
* @return int
*/
public function count(): int;
/**
* @param Rule $rule
*
* @return bool
*/
public function destroy(Rule $rule): bool;
/**
* @param Rule $rule
*
* @return Rule
*/
public function duplicate(Rule $rule): Rule;
/**
* @param int $ruleId
*
* @return Rule|null
*/
public function find(int $ruleId): ?Rule;
/**
* Get all the users rules.
*
* @return Collection
*/
public function getAll(): Collection;
/**
* @return RuleGroup
*/
public function getFirstRuleGroup(): RuleGroup;
/**
* @param RuleGroup $ruleGroup
*
* @return int
*/
public function getHighestOrderInRuleGroup(RuleGroup $ruleGroup): int;
/**
* @param Rule $rule
*
* @return string
*/
public function getPrimaryTrigger(Rule $rule): string;
/**
* @param Rule $rule
*
* @return Collection
*/
public function getRuleActions(Rule $rule): Collection;
/**
* @param Rule $rule
*
* @return Collection
*/
public function getRuleTriggers(Rule $rule): Collection;
/**
* Return search query for rule.
*
* @param Rule $rule
*
* @return string
*/
public function getSearchQuery(Rule $rule): string;
/**
* Get all the users rules that trigger on storage.
*
* @return Collection
*/
public function getStoreRules(): Collection;
/**
* Get all the users rules that trigger on update.
*
* @return Collection
*/
public function getUpdateRules(): Collection;
/**
* @param RuleGroup $ruleGroup
*
* @return int
*/
public function maxOrder(RuleGroup $ruleGroup): int;
/**
* @param Rule $rule
* @param RuleGroup $ruleGroup
* @param int $order
*
* @return Rule
*/
public function moveRule(Rule $rule, RuleGroup $ruleGroup, int $order): Rule;
/**
* @param RuleGroup $ruleGroup
*
* @return bool
*/
public function resetRuleOrder(RuleGroup $ruleGroup): bool;
/**
* @param string $query
* @param int $limit
*
* @return Collection
*/
public function searchRule(string $query, int $limit): Collection;
/**
* @param Rule $rule
* @param int $newOrder
*/
public function setOrder(Rule $rule, int $newOrder): void;
/**
* @param User|Authenticatable|null $user
*/
public function setUser(User | Authenticatable | null $user): void;
public function setUser(null|Authenticatable|User $user): void;
/**
* @param array $data
*
* @return Rule
*/
public function store(array $data): Rule;
/**
* @param Rule $rule
* @param array $values
*
* @return RuleAction
*/
public function storeAction(Rule $rule, array $values): RuleAction;
/**
* @param Rule $rule
* @param array $values
*
* @return RuleTrigger
*/
public function storeTrigger(Rule $rule, array $values): RuleTrigger;
/**
* @param Rule $rule
* @param array $data
*
* @return Rule
*/
public function update(Rule $rule, array $data): Rule;
}