Refactor and cleanup.

This commit is contained in:
James Cole
2020-10-27 16:26:10 +01:00
parent 141436aebb
commit 31a9b03c1a
7 changed files with 131 additions and 99 deletions

View File

@@ -58,7 +58,6 @@ class BillController extends Controller
} }
/** /**
* TODO add limit
* @param AutocompleteRequest $request * @param AutocompleteRequest $request
* *
* @return JsonResponse * @return JsonResponse

View File

@@ -58,7 +58,6 @@ class BudgetController extends Controller
} }
/** /**
* TODO add limit
* @param AutocompleteRequest $request * @param AutocompleteRequest $request
* *
* @return JsonResponse * @return JsonResponse

View File

@@ -24,7 +24,8 @@ declare(strict_types=1);
namespace FireflyIII\Api\V1\Controllers; namespace FireflyIII\Api\V1\Controllers;
use FireflyIII\Api\V1\Requests\BillRequest; use FireflyIII\Api\V1\Requests\BillUpdateRequest;
use FireflyIII\Api\V1\Requests\BillStoreRequest;
use FireflyIII\Exceptions\FireflyException; use FireflyIII\Exceptions\FireflyException;
use FireflyIII\Helpers\Collector\GroupCollectorInterface; use FireflyIII\Helpers\Collector\GroupCollectorInterface;
use FireflyIII\Models\Bill; use FireflyIII\Models\Bill;
@@ -49,8 +50,7 @@ class BillController extends Controller
{ {
use TransactionFilter; use TransactionFilter;
/** @var BillRepositoryInterface The bill repository */ private BillRepositoryInterface $repository;
private $repository;
/** /**
@@ -205,12 +205,12 @@ class BillController extends Controller
/** /**
* Store a bill. * Store a bill.
* *
* @param BillRequest $request * @param BillStoreRequest $request
* *
* @return JsonResponse * @return JsonResponse
* @throws FireflyException * @throws FireflyException
*/ */
public function store(BillRequest $request): JsonResponse public function store(BillStoreRequest $request): JsonResponse
{ {
$bill = $this->repository->store($request->getAll()); $bill = $this->repository->store($request->getAll());
$manager = $this->getManager(); $manager = $this->getManager();
@@ -285,12 +285,12 @@ class BillController extends Controller
/** /**
* Update a bill. * Update a bill.
* *
* @param BillRequest $request * @param BillUpdateRequest $request
* @param Bill $bill * @param Bill $bill
* *
* @return JsonResponse * @return JsonResponse
*/ */
public function update(BillRequest $request, Bill $bill): JsonResponse public function update(BillUpdateRequest $request, Bill $bill): JsonResponse
{ {
$data = $request->getAll(); $data = $request->getAll();
$bill = $this->repository->update($bill, $data); $bill = $this->repository->update($bill, $data);

View File

@@ -1,7 +1,7 @@
<?php <?php
/** /**
* BillRequest.php * BillStoreRequest.php
* Copyright (c) 2019 james@firefly-iii.org * Copyright (c) 2019 james@firefly-iii.org
* *
* This file is part of Firefly III (https://github.com/firefly-iii). * This file is part of Firefly III (https://github.com/firefly-iii).
@@ -25,31 +25,19 @@ declare(strict_types=1);
namespace FireflyIII\Api\V1\Requests; namespace FireflyIII\Api\V1\Requests;
use FireflyIII\Rules\IsBoolean; use FireflyIII\Rules\IsBoolean;
use FireflyIII\Support\Request\ChecksLogin;
use FireflyIII\Support\Request\ConvertsDataTypes; use FireflyIII\Support\Request\ConvertsDataTypes;
use Illuminate\Foundation\Http\FormRequest; use Illuminate\Foundation\Http\FormRequest;
use Illuminate\Validation\Validator; use Illuminate\Validation\Validator;
/** /**
* Class BillRequest * Class BillStoreRequest
*
* TODO AFTER 4.8,0: split this into two request classes.
* *
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
class BillRequest extends FormRequest class BillStoreRequest extends FormRequest
{ {
use ConvertsDataTypes; use ConvertsDataTypes, ChecksLogin;
/**
* Authorize logged in users.
*
* @return bool
*/
public function authorize(): bool
{
// Only allow authenticated users
return auth()->check();
}
/** /**
* Get all data from the request. * Get all data from the request.
@@ -85,7 +73,7 @@ class BillRequest extends FormRequest
*/ */
public function rules(): array public function rules(): array
{ {
$rules = [ return [
'name' => 'between:1,255|uniqueObjectForUser:bills,name', 'name' => 'between:1,255|uniqueObjectForUser:bills,name',
'amount_min' => 'numeric|gt:0', 'amount_min' => 'numeric|gt:0',
'amount_max' => 'numeric|gt:0', 'amount_max' => 'numeric|gt:0',
@@ -97,17 +85,6 @@ class BillRequest extends FormRequest
'active' => [new IsBoolean], 'active' => [new IsBoolean],
'notes' => 'between:1,65536', 'notes' => 'between:1,65536',
]; ];
switch ($this->method()) {
default:
break;
case 'PUT':
case 'PATCH':
$bill = $this->route()->parameter('bill');
$rules['name'] .= ',' . $bill->id;
break;
}
return $rules;
} }
/** /**

View File

@@ -0,0 +1,111 @@
<?php
/**
* BillUpdateRequest.php
* Copyright (c) 2019 james@firefly-iii.org
*
* This file is part of Firefly III (https://github.com/firefly-iii).
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
declare(strict_types=1);
namespace FireflyIII\Api\V1\Requests;
use FireflyIII\Rules\IsBoolean;
use FireflyIII\Support\Request\ChecksLogin;
use FireflyIII\Support\Request\ConvertsDataTypes;
use Illuminate\Foundation\Http\FormRequest;
use Illuminate\Validation\Validator;
/**
* Class BillUpdateRequest
*
* @codeCoverageIgnore
*/
class BillUpdateRequest extends FormRequest
{
use ConvertsDataTypes, ChecksLogin;
/**
* Get all data from the request.
*
* @return array
*/
public function getAll(): array
{
$active = true;
if (null !== $this->get('active')) {
$active = $this->boolean('active');
}
return [
'name' => $this->string('name'),
'amount_min' => $this->string('amount_min'),
'amount_max' => $this->string('amount_max'),
'currency_id' => $this->integer('currency_id'),
'currency_code' => $this->string('currency_code'),
'date' => $this->date('date'),
'repeat_freq' => $this->string('repeat_freq'),
'skip' => $this->integer('skip'),
'active' => $active,
'order' => $this->integer('order'),
'notes' => $this->nlString('notes'),
];
}
/**
* The rules that the incoming request must be matched against.
*
* @return array
*/
public function rules(): array
{
$bill = $this->route()->parameter('bill');
return [
'name' => sprintf('between:1,255|uniqueObjectForUser:bills,name,%d', $bill->id),
'amount_min' => 'numeric|gt:0',
'amount_max' => 'numeric|gt:0',
'currency_id' => 'numeric|exists:transaction_currencies,id',
'currency_code' => 'min:3|max:3|exists:transaction_currencies,code',
'date' => 'date',
'repeat_freq' => 'in:weekly,monthly,quarterly,half-year,yearly',
'skip' => 'between:0,31',
'active' => [new IsBoolean],
'notes' => 'between:1,65536',
];
}
/**
* Configure the validator instance.
*
* @param Validator $validator
*
* @return void
*/
public function withValidator(Validator $validator): void
{
$validator->after(
static function (Validator $validator) {
$data = $validator->getData();
$min = (float) ($data['amount_min'] ?? 0);
$max = (float) ($data['amount_max'] ?? 0);
if ($min > $max) {
$validator->errors()->add('amount_min', (string) trans('validation.amount_min_over_max'));
}
}
);
}
}

View File

@@ -115,33 +115,6 @@ class AccountRepository implements AccountRepositoryInterface
} }
/**
* @param string $number
* @param array $types
*
* @return Account|null
*/
public function findByAccountNumber(string $number, array $types): ?Account
{
$query = $this->user->accounts()
->leftJoin('account_meta', 'account_meta.account_id', '=', 'accounts.id')
->where('account_meta.name', 'account_number')
->where('account_meta.data', json_encode($number));
if (!empty($types)) {
$query->leftJoin('account_types', 'accounts.account_type_id', '=', 'account_types.id');
$query->whereIn('account_types.type', $types);
}
/** @var Collection $accounts */
$accounts = $query->get(['accounts.*']);
if ($accounts->count() > 0) {
return $accounts->first();
}
return null;
}
/** /**
* @param string $iban * @param string $iban
* @param array $types * @param array $types
@@ -228,16 +201,6 @@ class AccountRepository implements AccountRepositoryInterface
return null; return null;
} }
/**
* @param Account $account
*
* @return string
*/
public function getAccountType(Account $account): string
{
return $account->accountType->type;
}
/** /**
* Return account type or null if not found. * Return account type or null if not found.
* *

View File

@@ -80,7 +80,7 @@ interface AccountRepositoryInterface
/** /**
* Moved here from account CRUD. * Moved here from account CRUD.
* *
* @param Account $account * @param Account $account
* @param Account|null $moveTo * @param Account|null $moveTo
* *
* @return bool * @return bool
@@ -96,19 +96,9 @@ interface AccountRepositoryInterface
*/ */
public function expandWithDoubles(Collection $accounts): Collection; public function expandWithDoubles(Collection $accounts): Collection;
/**
* Find by account number. Is used.
*
* @param string $number
* @param array $types
*
* @return Account|null
*/
public function findByAccountNumber(string $number, array $types): ?Account;
/** /**
* @param string $iban * @param string $iban
* @param array $types * @param array $types
* *
* @return Account|null * @return Account|null
*/ */
@@ -116,7 +106,7 @@ interface AccountRepositoryInterface
/** /**
* @param string $name * @param string $name
* @param array $types * @param array $types
* *
* @return Account|null * @return Account|null
*/ */
@@ -136,13 +126,6 @@ interface AccountRepositoryInterface
*/ */
public function getAccountCurrency(Account $account): ?TransactionCurrency; public function getAccountCurrency(Account $account): ?TransactionCurrency;
/**
* @param Account $account
*
* @return string
*/
public function getAccountType(Account $account): string;
/** /**
* Return account type or null if not found. * Return account type or null if not found.
* *
@@ -189,7 +172,7 @@ interface AccountRepositoryInterface
* Return meta value for account. Null if not found. * Return meta value for account. Null if not found.
* *
* @param Account $account * @param Account $account
* @param string $field * @param string $field
* *
* @return null|string * @return null|string
*/ */
@@ -282,7 +265,7 @@ interface AccountRepositoryInterface
/** /**
* @param string $query * @param string $query
* @param array $types * @param array $types
* @param int $limit * @param int $limit
* *
* @return Collection * @return Collection
@@ -291,7 +274,7 @@ interface AccountRepositoryInterface
/** /**
* @param string $query * @param string $query
* @param array $types * @param array $types
* @param int $limit * @param int $limit
* *
* @return Collection * @return Collection
@@ -312,7 +295,7 @@ interface AccountRepositoryInterface
/** /**
* @param Account $account * @param Account $account
* @param array $data * @param array $data
* *
* @return Account * @return Account
*/ */