kenmirrors/firefly-iii
1
0
Fork 0
mirror of https://github.com/firefly-iii/firefly-iii.git synced 2025-10-23 04:18:50 +00:00
Code Issues Projects Releases Wiki Activity

Improve transformer coverage.

Browse Source
This commit is contained in:
James Cole
2018-12-20 20:50:05 +01:00
parent 6f54f41946
commit 84b3195e9b
15 changed files with 423 additions and 196 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
app/Transformers/PreferenceTransformer.php
View File

@@ -38,6 +38,7 @@ class PreferenceTransformer extends AbstractTransformer
/**
* PreferenceTransformer constructor.
*
* @codeCoverageIgnore
*/
public function __construct()
{

57
app/Transformers/RecurrenceTransformer.php
View File

@@ -44,15 +44,30 @@ use Log;
*/
class RecurrenceTransformer extends AbstractTransformer
{
/** @var BillRepositoryInterface */
private $billRepos;
/** @var BudgetRepositoryInterface */
private $budgetRepos;
/** @var CategoryFactory */
private $factory;
/** @var PiggyBankRepositoryInterface */
private $piggyRepos;
/** @var RecurringRepositoryInterface */
protected $repository;
private $repository;
/**
* RecurrenceTransformer constructor.
*
* @codeCoverageIgnore
*/
public function __construct()
{
$this->repository = app(RecurringRepositoryInterface::class);
$this->repository = app(RecurringRepositoryInterface::class);
$this->billRepos = app(BillRepositoryInterface::class);
$this->piggyRepos = app(PiggyBankRepositoryInterface::class);
$this->factory = app(CategoryFactory::class);
$this->budgetRepos = app(BudgetRepositoryInterface::class);
if ('testing' === config('app.env')) {
Log::warning(sprintf('%s should not be instantiated in the TEST environment!', \get_class($this)));
}
@@ -68,7 +83,14 @@ class RecurrenceTransformer extends AbstractTransformer
*/
public function transform(Recurrence $recurrence): array
{
Log::debug('Now in Recurrence::transform()');
$this->repository->setUser($recurrence->user);
$this->billRepos->setUser($recurrence->user);
$this->piggyRepos->setUser($recurrence->user);
$this->factory->setUser($recurrence->user);
$this->budgetRepos->setUser($recurrence->user);
$shortType = (string)config(sprintf('firefly.transactionTypesToShort.%s', $recurrence->transactionType->type));
// basic data.
$return = [
@@ -76,7 +98,7 @@ class RecurrenceTransformer extends AbstractTransformer
'created_at' => $recurrence->created_at->toAtomString(),
'updated_at' => $recurrence->updated_at->toAtomString(),
'transaction_type_id' => $recurrence->transaction_type_id,
'transaction_type' => $recurrence->transactionType->type,
'transaction_type' => $shortType,
'title' => $recurrence->title,
'description' => $recurrence->description,
'first_date' => $recurrence->first_date->format('Y-m-d'),
@@ -109,34 +131,28 @@ class RecurrenceTransformer extends AbstractTransformer
*/
private function getMeta(Recurrence $recurrence): array
{
$return = [];
$return = [];
$collection = $recurrence->recurrenceMeta;
Log::debug(sprintf('Meta collection length = %d', $collection->count()));
/** @var RecurrenceMeta $recurrenceMeta */
foreach ($recurrence->recurrenceMeta as $recurrenceMeta) {
foreach ($collection as $recurrenceMeta) {
$recurrenceMetaArray = [
'name' => $recurrenceMeta->name,
'value' => $recurrenceMeta->value,
];
switch ($recurrenceMeta->name) {
default:
throw new FireflyException(sprintf('Recurrence transformer cannot handle meta-field "%s"', $recurrenceMeta->name));
case 'tags':
$recurrenceMetaArray['tags'] = explode(',', $recurrenceMeta->value);
break;
case 'notes':
break;
case 'bill_id':
/** @var BillRepositoryInterface $repository */
$repository = app(BillRepositoryInterface::class);
$bill = $repository->find((int)$recurrenceMeta->value);
$bill = $this->billRepos->find((int)$recurrenceMeta->value);
if (null !== $bill) {
$recurrenceMetaArray['bill_id'] = $bill->id;
$recurrenceMetaArray['bill_name'] = $bill->name;
}
break;
case 'piggy_bank_id':
/** @var PiggyBankRepositoryInterface $repository */
$repository = app(PiggyBankRepositoryInterface::class);
$piggy = $repository->findNull((int)$recurrenceMeta->value);
$piggy = $this->piggyRepos->findNull((int)$recurrenceMeta->value);
if (null !== $piggy) {
$recurrenceMetaArray['piggy_bank_id'] = $piggy->id;
$recurrenceMetaArray['piggy_bank_name'] = $piggy->name;
@@ -208,22 +224,15 @@ class RecurrenceTransformer extends AbstractTransformer
'value' => $transactionMeta->value,
];
switch ($transactionMeta->name) {
default:
throw new FireflyException(sprintf('Recurrence transformer cannot handle transaction meta-field "%s"', $transactionMeta->name));
case 'category_name':
/** @var CategoryFactory $factory */
$factory = app(CategoryFactory::class);
$factory->setUser($transaction->recurrence->user);
$category = $factory->findOrCreate(null, $transactionMeta->value);
$category = $this->factory->findOrCreate(null, $transactionMeta->value);
if (null !== $category) {
$transactionMetaArray['category_id'] = $category->id;
$transactionMetaArray['category_name'] = $category->name;
}
break;
case 'budget_id':
/** @var BudgetRepositoryInterface $repository */
$repository = app(BudgetRepositoryInterface::class);
$budget = $repository->findNull((int)$transactionMeta->value);
$budget = $this->budgetRepos->findNull((int)$transactionMeta->value);
if (null !== $budget) {
$transactionMetaArray['budget_id'] = $budget->id;
$transactionMetaArray['budget_name'] = $budget->name;

84
app/Transformers/RuleActionTransformer.php
View File

@@ -1,84 +0,0 @@
<?php
/**
* RuleActionTransformer.php
* Copyright (c) 2018 thegrumpydictator@gmail.com
*
* This file is part of Firefly III.
*
* Firefly III is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Firefly III 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Firefly III. If not, see <http://www.gnu.org/licenses/>.
*/
declare(strict_types=1);
namespace FireflyIII\Transformers;
use FireflyIII\Models\RuleAction;
use League\Fractal\TransformerAbstract;
use Log;
use Symfony\Component\HttpFoundation\ParameterBag;
/**
* Class RuleActionTransformer
*/
class RuleActionTransformer extends TransformerAbstract
{
/** @var ParameterBag */
protected $parameters;
/**
* CurrencyTransformer constructor.
*
* @codeCoverageIgnore
*
* @param ParameterBag $parameters
*/
public function __construct(ParameterBag $parameters)
{
$this->parameters = $parameters;
if ('testing' === config('app.env')) {
Log::warning(sprintf('%s should not be instantiated in the TEST environment!', \get_class($this)));
}
}
/**
* Transform the rule action.
*
* @param RuleAction $ruleAction
*
* @return array
*/
public function transform(RuleAction $ruleAction): array
{
$data = [
'id' => (int)$ruleAction->id,
'created_at' => $ruleAction->created_at->toAtomString(),
'updated_at' => $ruleAction->updated_at->toAtomString(),
'type' => $ruleAction->action_type,
'value' => $ruleAction->action_value,
'order' => $ruleAction->order,
'active' => $ruleAction->active,
'stop_processing' => $ruleAction->stop_processing,
'links' => [
[
'rel' => 'self',
'uri' => '/rule_triggers/' . $ruleAction->id,
],
],
];
return $data;
}
}

2
app/Transformers/RuleGroupTransformer.php
View File

@@ -34,7 +34,7 @@ use Symfony\Component\HttpFoundation\ParameterBag;
class RuleGroupTransformer extends AbstractTransformer
{
/**
* CurrencyTransformer constructor.
* RuleGroupTransformer constructor.
*
* @codeCoverageIgnore
*/

13
app/Transformers/RuleTransformer.php
View File

@@ -27,15 +27,17 @@ namespace FireflyIII\Transformers;
use FireflyIII\Models\Rule;
use FireflyIII\Models\RuleAction;
use FireflyIII\Models\RuleTrigger;
use League\Fractal\TransformerAbstract;
use FireflyIII\Repositories\Rule\RuleRepositoryInterface;
use Log;
use Symfony\Component\HttpFoundation\ParameterBag;
/**
* Class RuleTransformer
*/
class RuleTransformer extends AbstractTransformer
{
/** @var RuleRepositoryInterface */
private $ruleRepository;
/**
* CurrencyTransformer constructor.
*
@@ -43,6 +45,7 @@ class RuleTransformer extends AbstractTransformer
*/
public function __construct()
{
$this->ruleRepository = app(RuleRepositoryInterface::class);
if ('testing' === config('app.env')) {
Log::warning(sprintf('%s should not be instantiated in the TEST environment!', \get_class($this)));
}
@@ -57,6 +60,8 @@ class RuleTransformer extends AbstractTransformer
*/
public function transform(Rule $rule): array
{
$this->ruleRepository->setUser($rule->user);
$data = [
'id' => (int)$rule->id,
'created_at' => $rule->created_at->toAtomString(),
@@ -89,7 +94,7 @@ class RuleTransformer extends AbstractTransformer
private function actions(Rule $rule): array
{
$result = [];
$actions = $rule->ruleActions()->orderBy('order', 'ASC')->get();
$actions = $this->ruleRepository->getRuleActions($rule);
/** @var RuleAction $ruleAction */
foreach ($actions as $ruleAction) {
$result[] = [
@@ -115,7 +120,7 @@ class RuleTransformer extends AbstractTransformer
private function triggers(Rule $rule): array
{
$result = [];
$triggers = $rule->ruleTriggers()->orderBy('order', 'ASC')->get();
$triggers = $this->ruleRepository->getRuleTriggers($rule);
/** @var RuleTrigger $ruleTrigger */
foreach ($triggers as $ruleTrigger) {
$result[] = [

83
app/Transformers/RuleTriggerTransformer.php
View File

@@ -1,83 +0,0 @@
<?php
/**
* RuleTriggerTransformer.php
* Copyright (c) 2018 thegrumpydictator@gmail.com
*
* This file is part of Firefly III.
*
* Firefly III is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Firefly III 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Firefly III. If not, see <http://www.gnu.org/licenses/>.
*/
declare(strict_types=1);
namespace FireflyIII\Transformers;
use FireflyIII\Models\RuleTrigger;
use League\Fractal\TransformerAbstract;
use Log;
use Symfony\Component\HttpFoundation\ParameterBag;
/**
* Class RuleTriggerTransformer
*/
class RuleTriggerTransformer extends TransformerAbstract
{
/** @var ParameterBag */
protected $parameters;
/**
* CurrencyTransformer constructor.
*
* @codeCoverageIgnore
*
* @param ParameterBag $parameters
*/
public function __construct(ParameterBag $parameters)
{
$this->parameters = $parameters;
if ('testing' === config('app.env')) {
Log::warning(sprintf('%s should not be instantiated in the TEST environment!', \get_class($this)));
}
}
/**
* Transform the rule trigger.
*
* @param RuleTrigger $ruleTrigger
*
* @return array
*/
public function transform(RuleTrigger $ruleTrigger): array
{
$data = [
'id' => (int)$ruleTrigger->id,
'created_at' => $ruleTrigger->created_at->toAtomString(),
'updated_at' => $ruleTrigger->updated_at->toAtomString(),
'type' => $ruleTrigger->trigger_type,
'value' => $ruleTrigger->trigger_value,
'order' => $ruleTrigger->order,
'active' => $ruleTrigger->active,
'stop_processing' => $ruleTrigger->stop_processing,
'links' => [
[
'rel' => 'self',
'uri' => '/rule_triggers/' . $ruleTrigger->id,
],
],
];
return $data;
}
}