Merge branch 'master' of https://github.com/ekmungai/eloquent-ifrs

src/Exceptions/InvalidTransactionDate.php

@@ -0,0 +1,41 @@
+<?php
+
+/**
+ * Eloquent IFRS Accounting
+ *
+ * @author    Edward Mungai
+ * @copyright Edward Mungai, 2021, Germany
+ * @license   MIT
+ */
+
+namespace IFRS\Exceptions;
+
+use Carbon\Carbon;
+
+use Illuminate\Support\Facades\Log;
+use Illuminate\Support\Facades\Auth;
+
+class InvalidTransactionDate extends IFRSException
+{
+
+    /**
+     * Invalid Transaction Date Exception
+     *
+     * @param string $message
+     * @param int    $code
+     */
+    public function __construct(string $message = null, int $code = null)
+    {
+        $error = "Transaction date cannot be at the beginning of the first day of the Reporting Period. Use a Balance object instead ";
+
+        Log::notice(
+            $error . $message,
+            [
+                'user_id' => Auth::user()->id,
+                'time' => Carbon::now(),
+            ]
+        );
+
+        parent::__construct($error . ' ' . $message, $code);
+    }
+}

src/Models/Account.php

@@ -370,6 +370,7 @@ public function transactionsQuery(Carbon $startDate, Carbon $endDate)
                 $transactionTable . '.transaction_no',
                 $transactionTable . '.reference',
                 $transactionTable . '.transaction_type',
+                $transactionTable . '.credited',
                 $transactionTable . '.narration'
             )->distinct();
 
@@ -404,7 +405,7 @@ public function getTransactions(string $startDate = null, string $endDate = null
             $transaction->type = Transaction::getType($transaction->transaction_type);
             $transaction->date = Carbon::parse($transaction->transaction_date)->toFormattedDateString();
             $transactions['transactions'][] = $transaction;
-            $transactions['total'] += $transaction->amount;
+            $transactions['total'] += $transaction->credited ? $transaction->amount * -1 : $transaction->amount;
         }
         return $transactions;
     }

src/Models/Transaction.php

@@ -33,6 +33,7 @@
 use IFRS\Exceptions\UnpostedAssignment;
 use IFRS\Exceptions\RedundantTransaction;
 use IFRS\Exceptions\ClosedReportingPeriod;
+use IFRS\Exceptions\InvalidTransactionDate;
 use IFRS\Exceptions\AdjustingReportingPeriod;
 
 /**
@@ -586,6 +587,10 @@ public function save(array $options = []): bool
     {
         $period = ReportingPeriod::getPeriod(Carbon::parse($this->transaction_date));
 
+        if (ReportingPeriod::periodStart($this->transaction_date)->eq(Carbon::parse($this->transaction_date))) {
+            throw new InvalidTransactionDate();
+        }
+
         if ($period->status == ReportingPeriod::CLOSED) {
             throw new ClosedReportingPeriod($period->calendar_year);
         }

tests/Unit/AccountTest.php

@@ -831,13 +831,13 @@ public function testAccountsTransactions()
         $endDate = Carbon::now()->addWeeks(4)->toDateString();
 
         $clientTransactions = $account1->getTransactions($startDate, $endDate);
-        $this->assertEquals($clientTransactions['total'], 195);
+        $this->assertEquals($clientTransactions['total'], -195);
 
         $incomeTransactions = $account5->getTransactions($startDate, $endDate);
-        $this->assertEquals($incomeTransactions['total'], 125);
+        $this->assertEquals($incomeTransactions['total'], -125);
 
         $vatTransactions = $account6->getTransactions($startDate, $endDate);
-        $this->assertEquals($vatTransactions['total'], 70);
+        $this->assertEquals($vatTransactions['total'], -70);
     }
 
     /**

tests/Unit/TransactionTest.php

@@ -4,13 +4,16 @@
 
 use Carbon\Carbon;
 use IFRS\User;
+
 use IFRS\Exceptions\AdjustingReportingPeriod;
 use IFRS\Exceptions\ClosedReportingPeriod;
 use IFRS\Exceptions\HangingClearances;
 use IFRS\Exceptions\MissingLineItem;
 use IFRS\Exceptions\PostedTransaction;
 use IFRS\Exceptions\RedundantTransaction;
 use IFRS\Exceptions\UnpostedAssignment;
+use IFRS\Exceptions\InvalidTransactionDate;
+
 use IFRS\Models\Account;
 use IFRS\Models\Assignment;
 use IFRS\Models\Currency;
@@ -21,9 +24,11 @@
 use IFRS\Models\ReportingPeriod;
 use IFRS\Models\Transaction;
 use IFRS\Models\Vat;
+
 use IFRS\Tests\TestCase;
 use IFRS\Transactions\ClientInvoice;
 use IFRS\Transactions\JournalEntry;
+
 use Illuminate\Support\Facades\DB;
 
 class TransactionTest extends TestCase
@@ -1004,4 +1009,20 @@ public function testTransactionPredicates()
         $this->assertFalse($cleared->assignable);
         $this->assertTrue($cleared->clearable);
     }
+
+    /**
+     * Test Invalid Transaction Date.
+     *
+     * @return void
+     */
+    public function testInvalidTransactionDate()
+    {
+
+        $this->expectException(InvalidTransactionDate::class);
+        $this->expectExceptionMessage('Transaction date cannot be at the beginning of the first day of the Reporting Period. Use a Balance object instead');
+
+        Transaction::create([
+            'transaction_date' => Carbon::parse(date('Y').'-01-01'),
+        ]);
+    }
 }