From baefd4f93b6ece0a16cb1e1fe31586aee5d5b6e9 Mon Sep 17 00:00:00 2001
From: James Cole <thegrumpydictator@gmail.com>
Date: Sun, 22 Jan 2017 11:23:40 +0100
Subject: [PATCH] Two new rule triggers

---
 app/Rules/Triggers/BudgetIs.php      |  95 ++++++++++++++++++++++
 app/Rules/Triggers/CategoryIs.php    |  95 ++++++++++++++++++++++
 config/firefly.php                   |   2 +
 tests/acceptance/NaughtyListTest.php | 115 ---------------------------
 4 files changed, 192 insertions(+), 115 deletions(-)
 create mode 100644 app/Rules/Triggers/BudgetIs.php
 create mode 100644 app/Rules/Triggers/CategoryIs.php
 delete mode 100644 tests/acceptance/NaughtyListTest.php

diff --git a/app/Rules/Triggers/BudgetIs.php b/app/Rules/Triggers/BudgetIs.php
new file mode 100644
index 0000000000..fa444f3ffc
--- /dev/null
+++ b/app/Rules/Triggers/BudgetIs.php
@@ -0,0 +1,95 @@
+<?php
+/**
+ * BudgetIs.php
+ * Copyright (c) 2017 thegrumpydictator@gmail.com
+ * This software may be modified and distributed under the terms of the Creative Commons Attribution-ShareAlike 4.0 International License.
+ *
+ * See the LICENSE file for details.
+ */
+
+declare(strict_types = 1);
+
+namespace FireflyIII\Rules\Triggers;
+
+use FireflyIII\Models\Transaction;
+use FireflyIII\Models\TransactionJournal;
+use Log;
+
+/**
+ * Class BudgetIs
+ *
+ * @package FireflyIII\Rules\Triggers
+ */
+final class BudgetIs extends AbstractTrigger implements TriggerInterface
+{
+
+    /**
+     * A trigger is said to "match anything", or match any given transaction,
+     * when the trigger value is very vague or has no restrictions. Easy examples
+     * are the "AmountMore"-trigger combined with an amount of 0: any given transaction
+     * has an amount of more than zero! Other examples are all the "Description"-triggers
+     * which have hard time handling empty trigger values such as "" or "*" (wild cards).
+     *
+     * If the user tries to create such a trigger, this method MUST return true so Firefly III
+     * can stop the storing / updating the trigger. If the trigger is in any way restrictive
+     * (even if it will still include 99.9% of the users transactions), this method MUST return
+     * false.
+     *
+     * @param null $value
+     *
+     * @return bool
+     */
+    public static function willMatchEverything($value = null)
+    {
+        if (!is_null($value)) {
+            return false;
+        }
+        Log::error(sprintf('Cannot use %s with a null value.', self::class));
+
+        return true;
+    }
+
+    /**
+     * @param TransactionJournal $journal
+     *
+     * @return bool
+     */
+    public function triggered(TransactionJournal $journal): bool
+    {
+        $budget = $journal->budgets()->first();
+        if (!is_null($budget)) {
+            $name = strtolower($budget->name);
+            // match on journal:
+            if ($name === strtolower($this->triggerValue)) {
+                Log::debug(sprintf('RuleTrigger BudgetIs for journal #%d: "%s" is "%s", return true.', $journal->id, $name, $this->triggerValue));
+
+                return true;
+            }
+        }
+
+        if (is_null($budget)) {
+            // perhaps transactions have this budget?
+            /** @var Transaction $transaction */
+            foreach ($journal->transactions as $transaction) {
+                $budget = $transaction->budgets()->first();
+                if (!is_null($budget)) {
+                    $name = strtolower($budget->name);
+                    if ($name === strtolower($this->triggerValue)) {
+                        Log::debug(
+                            sprintf(
+                                'RuleTrigger BudgetIs for journal #%d (transaction #%d): "%s" is "%s", return true.',
+                                $journal->id, $transaction->id, $name, $this->triggerValue
+                            )
+                        );
+
+                        return true;
+                    }
+                }
+            }
+        }
+
+        Log::debug(sprintf('RuleTrigger BudgetIs for journal #%d: does not have budget "%s", return false.', $journal->id, $this->triggerValue));
+
+        return false;
+    }
+}
diff --git a/app/Rules/Triggers/CategoryIs.php b/app/Rules/Triggers/CategoryIs.php
new file mode 100644
index 0000000000..28dcddb086
--- /dev/null
+++ b/app/Rules/Triggers/CategoryIs.php
@@ -0,0 +1,95 @@
+<?php
+/**
+ * CategoryIs.php
+ * Copyright (c) 2017 thegrumpydictator@gmail.com
+ * This software may be modified and distributed under the terms of the Creative Commons Attribution-ShareAlike 4.0 International License.
+ *
+ * See the LICENSE file for details.
+ */
+
+declare(strict_types = 1);
+
+namespace FireflyIII\Rules\Triggers;
+
+use FireflyIII\Models\Transaction;
+use FireflyIII\Models\TransactionJournal;
+use Log;
+
+/**
+ * Class CategoryIs
+ *
+ * @package FireflyIII\Rules\Triggers
+ */
+final class CategoryIs extends AbstractTrigger implements TriggerInterface
+{
+
+    /**
+     * A trigger is said to "match anything", or match any given transaction,
+     * when the trigger value is very vague or has no restrictions. Easy examples
+     * are the "AmountMore"-trigger combined with an amount of 0: any given transaction
+     * has an amount of more than zero! Other examples are all the "Description"-triggers
+     * which have hard time handling empty trigger values such as "" or "*" (wild cards).
+     *
+     * If the user tries to create such a trigger, this method MUST return true so Firefly III
+     * can stop the storing / updating the trigger. If the trigger is in any way restrictive
+     * (even if it will still include 99.9% of the users transactions), this method MUST return
+     * false.
+     *
+     * @param null $value
+     *
+     * @return bool
+     */
+    public static function willMatchEverything($value = null)
+    {
+        if (!is_null($value)) {
+            return false;
+        }
+        Log::error(sprintf('Cannot use %s with a null value.', self::class));
+
+        return true;
+    }
+
+    /**
+     * @param TransactionJournal $journal
+     *
+     * @return bool
+     */
+    public function triggered(TransactionJournal $journal): bool
+    {
+        $category = $journal->categories()->first();
+        if (!is_null($category)) {
+            $name = strtolower($category->name);
+            // match on journal:
+            if ($name === strtolower($this->triggerValue)) {
+                Log::debug(sprintf('RuleTrigger CategoryIs for journal #%d: "%s" is "%s", return true.', $journal->id, $name, $this->triggerValue));
+
+                return true;
+            }
+        }
+
+        if (is_null($category)) {
+            // perhaps transactions have this category?
+            /** @var Transaction $transaction */
+            foreach ($journal->transactions as $transaction) {
+                $category = $transaction->categories()->first();
+                if (!is_null($category)) {
+                    $name = strtolower($category->name);
+                    if ($name === strtolower($this->triggerValue)) {
+                        Log::debug(
+                            sprintf(
+                                'RuleTrigger CategoryIs for journal #%d (transaction #%d): "%s" is "%s", return true.',
+                                $journal->id, $transaction->id, $name, $this->triggerValue
+                            )
+                        );
+
+                        return true;
+                    }
+                }
+            }
+        }
+
+        Log::debug(sprintf('RuleTrigger CategoryIs for journal #%d: does not have category "%s", return false.', $journal->id, $this->triggerValue));
+
+        return false;
+    }
+}
diff --git a/config/firefly.php b/config/firefly.php
index 8c4f2a4085..a68e72bb74 100644
--- a/config/firefly.php
+++ b/config/firefly.php
@@ -174,6 +174,8 @@ return [
         'description_ends'      => 'FireflyIII\Rules\Triggers\DescriptionEnds',
         'description_contains'  => 'FireflyIII\Rules\Triggers\DescriptionContains',
         'description_is'        => 'FireflyIII\Rules\Triggers\DescriptionIs',
+        'category_is'           => 'FireflyIII\Rules\Triggers\CategoryIs',
+        'budget_is'             => 'FireflyIII\Rules\Triggers\BudgetIs',
     ],
     'rule-actions'             => [
         'set_category'        => 'FireflyIII\Rules\Actions\SetCategory',
diff --git a/tests/acceptance/NaughtyListTest.php b/tests/acceptance/NaughtyListTest.php
deleted file mode 100644
index 60a80ff11d..0000000000
--- a/tests/acceptance/NaughtyListTest.php
+++ /dev/null
@@ -1,115 +0,0 @@
-<?php
-/**
- * NaughtyListTest.php
- * Copyright (c) 2017 thegrumpydictator@gmail.com
- * This software may be modified and distributed under the terms of the Creative Commons Attribution-ShareAlike 4.0 International License.
- *
- * See the LICENSE file for details.
- */
-declare(strict_types = 1);
-
-use FireflyIII\Models\TransactionJournal;
-
-/**
- * Class NaughtyListTest
- */
-class NaughtyListTest extends TestCase
-{
-    /**
-     * Sets up the fixture, for example, opens a network connection.
-     * This method is called before a test is executed.
-     */
-    public function setUp()
-    {
-        parent::setUp();
-
-    }
-
-    /**
-     * @covers       \FireflyIII\Http\Controllers\Transaction\MassController::update
-     * @dataProvider naughtyStringProvider
-     *
-     * @param string $description
-     */
-    public function testMassUpdate(string $description)
-    {
-        $deposit = TransactionJournal::where('transaction_type_id', 2)->where('user_id', $this->user()->id)
-                                     ->whereNull('deleted_at')
-                                     ->first();
-        $this->session(['transactions.mass-edit.url' => 'http://localhost']);
-
-        $data = [
-            'journals'                                  => [$deposit->id],
-            'description'                               => [$deposit->id => $description],
-            'amount'                                    => [$deposit->id => 1600],
-            'amount_currency_id_amount_' . $deposit->id => 1,
-            'date'                                      => [$deposit->id => '2014-07-24'],
-            'source_account_name'                       => [$deposit->id => 'Job'],
-            'destination_account_id'                    => [$deposit->id => 1],
-            'category'                                  => [$deposit->id => 'Salary'],
-        ];
-
-        $this->be($this->user());
-        $response = $this->call('post', route('transactions.mass.update', [$deposit->id]), $data);
-        $this->assertNotEquals($response->getStatusCode(), 500);
-
-        // visit them should show updated content
-        $this->call('get', route('transactions.show', [$deposit->id]));
-        $this->assertResponseOk();
-        $this->see($description);
-    }
-
-    /**
-     * @covers       \FireflyIII\Http\Controllers\Transaction\SingleController::store
-     * @dataProvider naughtyStringProvider
-     *
-     * @param string $description
-     */
-    public function testSingleStore(string $description)
-    {
-        $this->session(['transactions.create.url' => 'http://localhost']);
-        $this->be($this->user());
-
-        $data     = [
-            'what'                      => 'withdrawal',
-            'amount'                    => '10',
-            'amount_currency_id_amount' => 1,
-            'source_account_id'         => 1,
-            'destination_account_name'  => 'Some destination',
-            'date'                      => '2016-01-01',
-            'description'               => $description,
-        ];
-        $response = $this->call('post', route('transactions.store', ['withdrawal']), $data);
-        $this->assertNotEquals($response->getStatusCode(), 500);
-
-    }
-
-    /**
-     * @covers       \FireflyIII\Http\Controllers\Transaction\SingleController::update
-     * @dataProvider naughtyStringProvider
-     *
-     * @param string $description
-     */
-    public function testSingleUpdate(string $description)
-    {
-        $this->session(['transactions.edit.url' => 'http://localhost']);
-        $this->be($this->user());
-        $data = [
-            'id'                        => 123,
-            'what'                      => 'withdrawal',
-            'description'               => $description,
-            'source_account_id'         => 1,
-            'destination_account_name'  => 'PLUS',
-            'amount'                    => '123',
-            'amount_currency_id_amount' => 1,
-            'budget_id'                 => 1,
-            'category'                  => 'Daily groceries',
-            'tags'                      => '',
-            'date'                      => '2016-01-01',
-        ];
-
-        $response = $this->call('post', route('transactions.update', [123]), $data);
-        $this->assertNotEquals($response->getStatusCode(), 500);
-    }
-
-}
\ No newline at end of file