Migrate to new rule engine.

app/Http/Controllers/Rule/SelectController.php

@@ -26,16 +26,14 @@ namespace FireflyIII\Http\Controllers\Rule;
 
 use Carbon\Carbon;
 use FireflyIII\Exceptions\FireflyException;
-use FireflyIII\Helpers\Collector\GroupCollectorInterface;
 use FireflyIII\Http\Controllers\Controller;
 use FireflyIII\Http\Requests\SelectTransactionsRequest;
 use FireflyIII\Http\Requests\TestRuleFormRequest;
-use FireflyIII\Jobs\ExecuteRuleOnExistingTransactions;
 use FireflyIII\Models\Rule;
-use FireflyIII\Repositories\Account\AccountRepositoryInterface;
+use FireflyIII\Models\RuleTrigger;
 use FireflyIII\Support\Http\Controllers\RequestInformation;
 use FireflyIII\Support\Http\Controllers\RuleManagement;
-use FireflyIII\TransactionRules\Engine\RuleEngine;
+use FireflyIII\TransactionRules\Engine\RuleEngineInterface;
 use FireflyIII\TransactionRules\TransactionMatcher;
 use FireflyIII\User;
 use Illuminate\Contracts\View\Factory;
@@ -53,8 +51,6 @@ use Throwable;
 class SelectController extends Controller
 {
     use RuleManagement, RequestInformation;
-    /** @var AccountRepositoryInterface The account repository */
-    private $accountRepos;
 
     /**
      * RuleController constructor.
@@ -68,8 +64,6 @@ class SelectController extends Controller
                 app('view')->share('title', (string) trans('firefly.rules'));
                 app('view')->share('mainTitleIcon', 'fa-random');
 
-                $this->accountRepos = app(AccountRepositoryInterface::class);
-
                 return $next($request);
             }
         );
@@ -88,29 +82,22 @@ class SelectController extends Controller
         // Get parameters specified by the user
         /** @var User $user */
         $user      = auth()->user();
-        $accounts  = $this->accountRepos->getAccountsById($request->get('accounts'));
-        $startDate = new Carbon($request->get('start_date'));
-        $endDate   = new Carbon($request->get('end_date'));
-        $rules     = [$rule->id];
+        $accounts  = implode(',', $request->get('accounts'));
+        $startDate = new Carbon($request->get('start'));
+        $endDate   = new Carbon($request->get('end'));
 
-        /** @var RuleEngine $ruleEngine */
-        $ruleEngine = app(RuleEngine::class);
-        $ruleEngine->setUser(auth()->user());
-        $ruleEngine->setRulesToApply($rules);
-        $ruleEngine->setTriggerMode(RuleEngine::TRIGGER_BOTH);
+        // create new rule engine:
+        $newRuleEngine = app(RuleEngineInterface::class);
+        $newRuleEngine->setUser($user);
 
-        /** @var GroupCollectorInterface $collector */
-        $collector = app(GroupCollectorInterface::class);
-        $collector->setAccounts($accounts);
-        $collector->setRange($startDate, $endDate);
-        $journals = $collector->getExtractedJournals();
+        // add extra operators:
+        $newRuleEngine->addOperator(['type' => 'date_after', 'value' => $startDate->format('Y-m-d')]);
+        $newRuleEngine->addOperator(['type' => 'date_before', 'value' => $endDate->format('Y-m-d')]);
+        $newRuleEngine->addOperator(['type' => 'account_id', 'value' => $accounts]);
 
-        /** @var array $journal */
-        foreach ($journals as $journal) {
-            Log::debug('Start of new journal.');
-            $ruleEngine->processJournalArray($journal);
-            Log::debug('Done with all rules for this group + done with journal.');
-        }
+        // set rules:
+        $newRuleEngine->setRules(new Collection([$rule]));
+        $newRuleEngine->fire();
 
         // Tell the user that the job is queued
         session()->flash('success', (string) trans('firefly.applied_rule_selection', ['title' => $rule->title]));
@@ -128,8 +115,8 @@ class SelectController extends Controller
      */
     public function selectTransactions(Rule $rule)
     {
-        if(false===$rule->active) {
-            session()->flash('warning',trans('firefly.cannot_fire_inactive_rules'));
+        if (false === $rule->active) {
+            session()->flash('warning', trans('firefly.cannot_fire_inactive_rules'));
             return redirect(route('rules.index'));
         }
         // does the user have shared accounts?
@@ -155,46 +142,46 @@ class SelectController extends Controller
      */
     public function testTriggers(TestRuleFormRequest $request): JsonResponse
     {
-        // build trigger array from response
-        $triggers = $this->getValidTriggerList($request);
+        // build fake rule
+        $rule         = new Rule;
+        $triggers     = new Collection;
+        $rule->strict = '1' === $request->get('strict');
 
-        if (0 === count($triggers)) {
+        // build trigger array from response
+        $textTriggers = $this->getValidTriggerList($request);
+
+        // warn if nothing.
+        if (0 === count($textTriggers)) {
             return response()->json(['html' => '', 'warning' => (string) trans('firefly.warning_no_valid_triggers')]); // @codeCoverageIgnore
         }
 
-        $limit                = (int) config('firefly.test-triggers.limit');
-        $range                = (int) config('firefly.test-triggers.range');
-        $matchingTransactions = new Collection;
-        $strict               = '1' === $request->get('strict');
-        /** @var TransactionMatcher $matcher */
-        $matcher = app(TransactionMatcher::class);
-        $matcher->setSearchLimit($range);
-        $matcher->setTriggeredLimit($limit);
-        $matcher->setTriggers($triggers);
-        $matcher->setStrict($strict);
-        try {
-            $matchingTransactions = $matcher->findTransactionsByTriggers();
-            // @codeCoverageIgnoreStart
-        } catch (FireflyException $exception) {
-            Log::error(sprintf('Could not grab transactions in testTriggers(): %s', $exception->getMessage()));
-            Log::error($exception->getTraceAsString());
+        foreach ($textTriggers as $textTrigger) {
+            $trigger                = new RuleTrigger;
+            $trigger->trigger_type  = $textTrigger['type'];
+            $trigger->trigger_value = $textTrigger['value'];
+            $triggers->push($trigger);
         }
-        // @codeCoverageIgnoreStart
 
+        $rule->ruleTriggers = $triggers;
+
+        // create new rule engine:
+        $newRuleEngine = app(RuleEngineInterface::class);
+
+        // set rules:
+        $newRuleEngine->setRules(new Collection([$rule]));
+        $collection = $newRuleEngine->find();
+        $collection = $collection->slice(0,20);
 
         // Warn the user if only a subset of transactions is returned
         $warning = '';
-        if (count($matchingTransactions) === $limit) {
-            $warning = (string) trans('firefly.warning_transaction_subset', ['max_num_transactions' => $limit]); // @codeCoverageIgnore
-        }
-        if (0 === count($matchingTransactions)) {
-            $warning = (string) trans('firefly.warning_no_matching_transactions', ['num_transactions' => $range]); // @codeCoverageIgnore
+        if (0 === count($collection)) {
+            $warning = (string) trans('firefly.warning_no_matching_transactions'); // @codeCoverageIgnore
         }
 
         // Return json response
         $view = 'ERROR, see logs.';
         try {
-            $view = view('list.journals-array-tiny', ['journals' => $matchingTransactions])->render();
+            $view = view('list.journals-array-tiny', ['groups' => $collection])->render();
             // @codeCoverageIgnoreStart
         } catch (Throwable $exception) {
             Log::error(sprintf('Could not render view in testTriggers(): %s', $exception->getMessage()));

app/Http/Controllers/RuleGroup/ExecutionController.php

@@ -26,29 +26,22 @@ namespace FireflyIII\Http\Controllers\RuleGroup;
 
 use Carbon\Carbon;
 use Exception;
-use FireflyIII\Helpers\Collector\GroupCollectorInterface;
 use FireflyIII\Http\Controllers\Controller;
 use FireflyIII\Http\Requests\SelectTransactionsRequest;
-use FireflyIII\Models\Rule;
 use FireflyIII\Models\RuleGroup;
-use FireflyIII\Repositories\Account\AccountRepositoryInterface;
 use FireflyIII\Repositories\RuleGroup\RuleGroupRepositoryInterface;
-use FireflyIII\TransactionRules\Engine\RuleEngine;
+use FireflyIII\TransactionRules\Engine\RuleEngineInterface;
+use FireflyIII\User;
 use Illuminate\Contracts\View\Factory;
 use Illuminate\Http\RedirectResponse;
 use Illuminate\View\View;
-use Log;
 
 /**
  * Class ExecutionController
  */
 class ExecutionController extends Controller
 {
-    /** @var AccountRepositoryInterface */
-    private $repository;
-
-    /** @var RuleGroupRepositoryInterface */
-    private $ruleGroupRepository;
+    private RuleGroupRepositoryInterface $ruleGroupRepository;
 
     /**
      * ExecutionController constructor.
@@ -64,7 +57,6 @@ class ExecutionController extends Controller
                 app('view')->share('title', (string) trans('firefly.rules'));
                 app('view')->share('mainTitleIcon', 'fa-random');
 
-                $this->repository          = app(AccountRepositoryInterface::class);
                 $this->ruleGroupRepository = app(RuleGroupRepositoryInterface::class);
 
                 return $next($request);
@@ -79,42 +71,30 @@ class ExecutionController extends Controller
      * @param SelectTransactionsRequest $request
      * @param RuleGroup                 $ruleGroup
      *
-     * @throws Exception
      * @return RedirectResponse
+     * @throws Exception
      */
     public function execute(SelectTransactionsRequest $request, RuleGroup $ruleGroup): RedirectResponse
     {
         // Get parameters specified by the user
-        $accounts  = $this->repository->getAccountsById($request->get('accounts'));
-        $startDate = new Carbon($request->get('start_date'));
-        $endDate   = new Carbon($request->get('end_date'));
+        /** @var User $user */
+        $user      = auth()->user();
+        $accounts  = implode(',', $request->get('accounts'));
+        $startDate = new Carbon($request->get('start'));
+        $endDate   = new Carbon($request->get('end'));
+        $rules     = $this->ruleGroupRepository->getActiveRules($ruleGroup);
+        // create new rule engine:
+        $newRuleEngine = app(RuleEngineInterface::class);
+        $newRuleEngine->setUser($user);
 
-        // start looping.
-        /** @var RuleEngine $ruleEngine */
-        $ruleEngine = app(RuleEngine::class);
-        $ruleEngine->setUser(auth()->user());
+        // add extra operators:
+        $newRuleEngine->addOperator(['type' => 'date_after', 'value' => $startDate->format('Y-m-d')]);
+        $newRuleEngine->addOperator(['type' => 'date_before', 'value' => $endDate->format('Y-m-d')]);
+        $newRuleEngine->addOperator(['type' => 'account_id', 'value' => $accounts]);
 
-        $rules = [];
-        /** @var Rule $rule */
-        foreach ($this->ruleGroupRepository->getActiveRules($ruleGroup) as $rule) {
-            $rules[] = $rule->id;
-        }
-
-        $ruleEngine->setRulesToApply($rules);
-        $ruleEngine->setTriggerMode(RuleEngine::TRIGGER_STORE);
-
-        /** @var GroupCollectorInterface $collector */
-        $collector = app(GroupCollectorInterface::class);
-        $collector->setAccounts($accounts);
-        $collector->setRange($startDate, $endDate);
-        $journals = $collector->getExtractedJournals();
-
-        /** @var array $journal */
-        foreach ($journals as $journal) {
-            Log::debug('Start of new journal.');
-            $ruleEngine->processJournalArray($journal);
-            Log::debug('Done with all rules for this group + done with journal.');
-        }
+        // set rules:
+        $newRuleEngine->setRules($rules);
+        $newRuleEngine->fire();
 
         // Tell the user that the job is queued
         session()->flash('success', (string) trans('firefly.applied_rule_group_selection', ['title' => $ruleGroup->title]));

app/Http/Requests/SelectTransactionsRequest.php

@@ -57,8 +57,8 @@ class SelectTransactionsRequest extends FormRequest
         $today        = Carbon::now()->addDay()->format('Y-m-d');
 
         return [
-            'start_date' => 'required|date|after:' . $first,
-            'end_date'   => 'required|date|before:' . $today,
+            'start'      => 'required|date|after:' . $first,
+            'end'        => 'required|date|before:' . $today,
             'accounts'   => 'required',
             'accounts.*' => 'required|exists:accounts,id|belongsToUser:accounts',
         ];

app/TransactionRules/Engine/RuleEngineInterface.php

@@ -59,4 +59,9 @@ interface RuleEngineInterface
      */
     public function fire(): void;
 
+    /**
+     * Find all transactions only, dont apply anything.
+     */
+    public function find(): Collection;
+
 }

app/TransactionRules/Engine/SearchRuleEngine.php

@@ -98,6 +98,28 @@ class SearchRuleEngine implements RuleEngineInterface
         Log::debug('SearchRuleEngine:: done processing all rules!');
     }
 
+    /**
+     *
+     */
+    public function find(): Collection
+    {
+        Log::debug('SearchRuleEngine::find()');
+        $collection = new Collection;
+        foreach ($this->rules as $rule) {
+            $found = new Collection;
+            if (true === $rule->strict) {
+                $found = $this->findStrictRule($rule);
+            }
+            if (false === $rule->strict) {
+                $found = $this->findNonStrictRule($rule);
+            }
+            $collection = $collection->merge($found);
+        }
+        $collection = $collection->unique();
+
+        return $collection;
+    }
+
     /**
      * @param Rule $rule
      * @throws FireflyException
@@ -105,10 +127,10 @@ class SearchRuleEngine implements RuleEngineInterface
     private function fireRule(Rule $rule): void
     {
         if (true === $rule->strict) {
-            $this->fileStrictRule($rule);
+            $this->fireStrictRule($rule);
             return;
         }
-        $this->fileNonStrictRule($rule);
+        $this->fireNonStrictRule($rule);
     }
 
     /**
@@ -178,9 +200,34 @@ class SearchRuleEngine implements RuleEngineInterface
      * @param Rule $rule
      * @throws FireflyException
      */
-    private function fileStrictRule(Rule $rule): void
+    private function fireStrictRule(Rule $rule): void
+    {
+        Log::debug(sprintf('SearchRuleEngine::fireStrictRule(%d)!', $rule->id));
+        $collection = $this->findStrictRule($rule);
+
+        $this->processResults($rule, $collection);
+        Log::debug(sprintf('SearchRuleEngine:: done processing strict rule #%d', $rule->id));
+    }
+
+    /**
+     * @param Rule $rule
+     * @throws FireflyException
+     */
+    private function fireNonStrictRule(Rule $rule): void
+    {
+        Log::debug(sprintf('SearchRuleEngine::fireNonStrictRule(%d)!', $rule->id));
+        $collection = $this->findNonStrictRule($rule);
+
+        $this->processResults($rule, $collection);
+        Log::debug(sprintf('SearchRuleEngine:: done processing non-strict rule #%d', $rule->id));
+    }
+
+    /**
+     * @param Rule $rule
+     * @return Collection
+     */
+    private function findStrictRule(Rule $rule): Collection
     {
-        Log::debug(sprintf('SearchRuleEngine::fileStrictRule(%d)!', $rule->id));
         $searchArray = [];
         /** @var RuleTrigger $ruleTrigger */
         foreach ($rule->ruleTriggers as $ruleTrigger) {
@@ -212,18 +259,15 @@ class SearchRuleEngine implements RuleEngineInterface
         $collection = $result->getCollection();
         Log::debug(sprintf('SearchRuleEngine:: Found %d transactions using search engine with query "%s".', $collection->count(), $searchQuery));
 
-        $this->processResults($rule, $collection);
-        Log::debug(sprintf('SearchRuleEngine:: done processing strict rule #%d', $rule->id));
+        return $collection;
     }
 
     /**
      * @param Rule $rule
-     * @throws FireflyException
+     * @return Collection
      */
-    private function fileNonStrictRule(Rule $rule): void
+    private function findNonStrictRule(Rule $rule): Collection
     {
-        Log::debug(sprintf('SearchRuleEngine::fileNonStrictRule(%d)!', $rule->id));
-
         // start a search query for individual each trigger:
         $total = new Collection;
         $count = 0;
@@ -280,8 +324,6 @@ class SearchRuleEngine implements RuleEngineInterface
         });
 
         Log::debug(sprintf('SearchRuleEngine:: Found %d transactions using search engine.', $unique->count()));
-
-        $this->processResults($rule, $unique);
-        Log::debug(sprintf('SearchRuleEngine:: done processing non-strict rule #%d', $rule->id));
+        return $unique;
     }
 }

app/TransactionRules/TransactionMatcher.php

@@ -35,6 +35,7 @@ use Log;
 /**
  * Class TransactionMatcher is used to find a list of
  * transaction matching a set of triggers.
+ * @deprecated
  */
 class TransactionMatcher
 {