IntenseFinance/firefly-iii
3
0
Fork 0
mirror of https://github.com/firefly-iii/firefly-iii.git synced 2024-11-23 09:26:29 -06:00
Code Issues Packages Projects Releases Wiki Activity

Lots of new stuff.

Browse Source
This commit is contained in:
James Cole 2014-11-24 10:12:34 +01:00
parent 4456ef2326
commit bfda4bc199
12 changed files with 467 additions and 79 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
app/controllers/RepeatedExpenseController.php
View File

@ -1,5 +1,6 @@
<?php
use Carbon\Carbon;
use FireflyIII\Exception\FireflyException;
use Illuminate\Support\MessageBag;
@ -35,58 +36,24 @@ class RepeatedExpenseController extends BaseController
$repository = App::make('FireflyIII\Database\RepeatedExpense');
$expenses = $repository->get();
$expenses->each(
function (\Piggybank $piggyBank) {
// do something with "parts".
$piggyBank->currentRep = $piggyBank->currentRelevantRep();
if (!is_null($piggyBank->reminder)) {
switch ($piggyBank->reminder) {
default:
throw new FireflyException('Cannot handle "' . $piggyBank->reminder . '" reminders for repeated expenses');
break;
case 'month':
$start = clone $piggyBank->currentRep->startdate;
$start->startOfMonth();
$end = clone $piggyBank->currentRep->targetdate;
$end->endOfMonth();
$piggyBank->parts = $start->diffInMonths($end);
unset($start, $end);
break;
}
} else {
$piggyBank->parts = 1;
}
// number of bars:
$piggyBank->barCount = floor(12 / $piggyBank->parts) == 0 ? 1 : floor(12 / $piggyBank->parts);
$amountPerBar = floatval($piggyBank->targetamount) / $piggyBank->parts;
$currentAmount = floatval($amountPerBar);
$bars = [];
$currentDate = clone $piggyBank->currentRep->startdate;
for ($i = 0; $i < $piggyBank->parts; $i++) {
// niet elke keer een andere dinges pakken? om target te redden?
if (!is_null($piggyBank->reminder)) {
$currentDate = \DateKit::addPeriod($currentDate, $piggyBank->reminder, 0);
}
$bars[] = [
'amount' => $currentAmount,
'date' => $currentDate
];
$currentAmount += $amountPerBar;
}
$piggyBank->bars = $bars;
function (Piggybank $piggyBank) use ($repository) {
$piggyBank->currentRelevantRep();
$piggyBank->currentRep = $repository->calculateParts($piggyBank->currentRep);
}
);
return View::make('repeatedexpense.index', compact('expenses', 'subTitle'));
}
public function show(Piggybank $piggyBank)
{
$subTitle = $piggyBank->name;
$today = Carbon::now();
return View::make('repeatedexpense.show', compact('piggyBank', 'today', 'subTitle'));
}
/**
*
*/

135
app/lib/FireflyIII/Collection/PiggybankPart.php Normal file
View File

@ -0,0 +1,135 @@
<?php
namespace FireflyIII\Collection;
use Carbon\Carbon;
class PiggybankPart
{
/** @var int */
public $amount;
public $amountPerBar;
/** @var int */
public $currentamount;
/** @var \PiggybankRepetition */
public $repetition;
/** @var Carbon */
public $startdate;
/** @var Carbon */
public $targetdate;
/**
* @return \PiggybankRepetition
*/
public function getRepetition()
{
return $this->repetition;
}
/**
* @param \PiggybankRepetition $repetition
*/
public function setRepetition($repetition)
{
$this->repetition = $repetition;
}
/**
* @return Carbon
*/
public function getStartdate()
{
return $this->startdate;
}
/**
* @param Carbon $startdate
*/
public function setStartdate($startdate)
{
$this->startdate = $startdate;
}
/**
* @return Carbon
*/
public function getTargetdate()
{
return $this->targetdate;
}
/**
* @param Carbon $targetdate
*/
public function setTargetdate($targetdate)
{
$this->targetdate = $targetdate;
}
public function percentage()
{
if ($this->getCurrentamount() < $this->getAmount()) {
$pct = 0;
// calculate halway point?
if ($this->getAmount() - $this->getCurrentamount() < $this->getAmountPerBar()) {
$left = $this->getCurrentamount() % $this->getAmountPerBar();
$pct = round($left / $this->getAmountPerBar() * 100);
}
return $pct;
} else {
return 100;
}
}
/**
* @return int
*/
public function getCurrentamount()
{
return $this->currentamount;
}
/**
* @param int $currentamount
*/
public function setCurrentamount($currentamount)
{
$this->currentamount = $currentamount;
}
/**
* @return int
*/
public function getAmount()
{
return $this->amount;
}
/**
* @param int $amount
*/
public function setAmount($amount)
{
$this->amount = $amount;
}
/**
* @return mixed
*/
public function getAmountPerBar()
{
return $this->amountPerBar;
}
/**
* @param mixed $amountPerBar
*/
public function setAmountPerBar($amountPerBar)
{
$this->amountPerBar = $amountPerBar;
}
}

212
app/lib/FireflyIII/Database/RepeatedExpense.php
View File

@ -4,9 +4,11 @@ namespace FireflyIII\Database;
use Carbon\Carbon;
use FireflyIII\Collection\PiggybankPart;
use FireflyIII\Database\Ifaces\CommonDatabaseCalls;
use FireflyIII\Database\Ifaces\CUD;
use FireflyIII\Database\Ifaces\PiggybankInterface;
use FireflyIII\Exception\FireflyException;
use FireflyIII\Exception\NotImplementedException;
use Illuminate\Support\Collection;
use Illuminate\Support\MessageBag;
@ -24,6 +26,212 @@ class RepeatedExpense implements CUD, CommonDatabaseCalls, PiggybankInterface
$this->setUser(\Auth::user());
}
/**
* Based on the piggy bank, the reminder-setting and
* other variables this method tries to divide the piggy bank into equal parts. Each is
* accommodated by a reminder (if everything goes to plan).
*
* @return \PiggybankRepetition
*/
public function calculateParts(\PiggybankRepetition $repetition)
{
\Log::debug('NOW in calculateParts()');
\Log::debug('Repetition id is ' . $repetition->id);
/** @var \Piggybank $piggyBank */
$piggyBank = $repetition->piggybank()->first();
\Log::debug('connected piggy bank is: ' . $piggyBank->name . ' (#' . $piggyBank->id . ')');
/*
* If no reminders are set, the repetition is split in exactly one part:
*/
if (is_null($piggyBank->reminder)) {
$parts = 1;
} else {
/*
* Number of parts is the number of [reminder period]s between
* the start date and the target date
*/
/** @var Carbon $start */
$start = clone $repetition->startdate;
/** @var Carbon $target */
$target = clone $repetition->targetdate;
switch ($piggyBank->reminder) {
default:
throw new FireflyException('Cannot handle "' . $piggyBank->reminder . '" reminders for repeated expenses (calculateParts)');
break;
case 'week':
$parts = $start->diffInWeeks($target);
break;
case 'month':
$parts = $start->diffInMonths($target);
break;
case 'quarter':
$parts = ceil($start->diffInMonths($target) / 3);
break;
case 'year':
$parts = $start->diffInYears($target);
break;
}
$parts = $parts < 1 ? 1 : $parts;
unset($start, $target);
// /*
// * Otherwise, FF3 splits by the difference in time and the amount
// * of reminders the user wants.
// */
// switch ($piggyBank->reminder) {
// default:
// throw new FireflyException('Cannot handle "' . $piggyBank->reminder . '" reminders for repeated expenses (calculateParts)');
// break;
// case 'week':
// $start = clone $repetition->startdate;
// $start->startOfWeek();
// $end = clone $repetition->targetdate;
// $end->endOfWeek();
// $parts = $start->diffInWeeks($end);
// unset($start, $end);
// break;
// case 'month':
// $start = clone $repetition->startdate;
// $start->startOfMonth();
// $end = clone $repetition->targetdate;
// $end->endOfMonth();
// $parts = $start->diffInMonths($end);
// unset($start, $end);
// break;
// }
}
$amountPerBar = floatval($piggyBank->targetamount) / $parts;
$currentAmount = floatval($amountPerBar);
$currentStart = clone $repetition->startdate;
$currentTarget = clone $repetition->targetdate;
$bars = new Collection;
// if($parts > 12) {
// $parts = 12;
// $currentStart = \DateKit::startOfPeriod(Carbon::now(), $piggyBank->reminder);
// $currentEnd = \DateKit::endOfPeriod($currentEnd, $piggyBank->reminder);
// }
for ($i = 0; $i < $parts; $i++) {
/*
* Jump one month ahead after the first instance:
*/
// if ($i > 0) {
// $currentStart = \DateKit::addPeriod($currentStart, $piggyBank->reminder, 0);
// /*
// * Jump to the start of the period too:
// */
// $currentStart = \DateKit::startOfPeriod($currentStart, $piggyBank->reminder);
//
// }
/*
* Move the current start to the actual start of
* the [period] once the first iteration has passed.
*/
// if ($i != 0) {
// $currentStart = \DateKit::startOfPeriod($currentStart, $piggyBank->reminder);
// }
// if($i == 0 && !is_null($piggyBank->reminder)) {
// $currentEnd = \DateKit::startOfPeriod($currentStart, $piggyBank->reminder);
// $currentEnd = \DateKit::endOfPeriod($currentEnd, $piggyBank->reminder);
// }
$part = new PiggybankPart;
$part->setRepetition($repetition);
$part->setAmount($currentAmount);
$part->setAmountPerBar($amountPerBar);
$part->setCurrentamount($repetition->currentamount);
$part->setStartdate($currentStart);
$part->setTargetdate($currentTarget);
// if (!is_null($piggyBank->reminder)) {
// $currentStart = \DateKit::addPeriod($currentStart, $piggyBank->reminder, 0);
// $currentEnd = \DateKit::endOfPeriod($currentStart, $piggyBank->reminder);
// }
$bars->push($part);
$currentAmount += $amountPerBar;
}
$repetition->bars = $bars;
return $repetition;
exit;
$repetition->hello = 'World!';
return $repetition;
$return = new Collection;
$repetitions = $piggyBank->piggybankrepetitions()->get();
/** @var \PiggybankRepetition $repetition */
foreach ($repetitions as $repetition) {
if (is_null($piggyBank->reminder)) {
// simple, one part "repetition".
$part = new PiggybankPart;
$part->setRepetition($repetition);
} else {
$part = new PiggybankPart;
}
// end!
$return->push($part);
}
exit;
return $return;
$piggyBank->currentRelevantRep(); // get the current relevant repetition.
if (!is_null($piggyBank->reminder)) {
switch ($piggyBank->reminder) {
default:
throw new FireflyException('Cannot handle "' . $piggyBank->reminder . '" reminders for repeated expenses');
break;
case 'month':
$start = clone $piggyBank->currentRep->startdate;
$start->startOfMonth();
$end = clone $piggyBank->currentRep->targetdate;
$end->endOfMonth();
$piggyBank->parts = $start->diffInMonths($end);
unset($start, $end);
break;
}
} else {
$piggyBank->parts = 1;
}
// number of bars:
$piggyBank->barCount = floor(12 / $piggyBank->parts) == 0 ? 1 : floor(12 / $piggyBank->parts);
$amountPerBar = floatval($piggyBank->targetamount) / $piggyBank->parts;
$currentAmount = floatval($amountPerBar);
$bars = [];
$currentStart = clone $piggyBank->currentRep->startdate;
for ($i = 0; $i < $piggyBank->parts; $i++) {
// niet elke keer een andere dinges pakken? om target te redden?
if (!is_null($piggyBank->reminder)) {
$currentStart = \DateKit::addPeriod($currentStart, $piggyBank->reminder, 0);
}
$bars[] = [
'amount' => $currentAmount,
'date' => $currentStart
];
$currentAmount += $amountPerBar;
}
$piggyBank->bars = $bars;
}
/**
* @param Ardent $model
*
@ -119,6 +327,10 @@ class RepeatedExpense implements CUD, CommonDatabaseCalls, PiggybankInterface
} catch (\Exception $e) {
$errors->add('targetdate', 'Invalid date.');
}
$diff = Carbon::now()->diff(new Carbon($model['targetdate']));
if ($diff->days > 365) {
$errors->add('targetdate', 'First target date should a a year or less from now.');
}
} else {
$errors->add('targetdate', 'Invalid target date.');
}

3
app/lib/FireflyIII/Shared/Toolkit/Date.php
View File

@ -82,12 +82,14 @@ class Date
case 'monthly':
$currentEnd->addMonth()->subDay();
break;
case 'quarter':
case 'quarterly':
$currentEnd->addMonths(3)->subDay();
break;
case 'half-year':
$currentEnd->addMonths(6)->subDay();
break;
case 'year':
case 'yearly':
$currentEnd->addYear()->subDay();
break;
@ -154,6 +156,7 @@ class Date
$date->addMonths(6);
}
break;
case 'year':
case 'yearly':
$date->startOfYear();
break;

7
app/lib/FireflyIII/Shared/Toolkit/Reminders.php
View File

@ -71,8 +71,13 @@ class Reminders
/** @var \FireflyIII\Database\Piggybank $repository */
$repository = \App::make('FireflyIII\Database\Piggybank');
/** @var \FireflyIII\Database\Piggybank $repeatedRepository */
$repeatedRepository = \App::make('FireflyIII\Database\RepeatedExpense');
/** @var Collection $piggybanks */
$piggybanks = $repository->get();
$piggybanks = $repository->get()->merge($repeatedRepository->get());
$set = $piggybanks->filter(
function (\Piggybank $piggybank) {
if (!is_null($piggybank->reminder)) {

58
app/models/Piggybank.php
View File

@ -42,7 +42,7 @@ use LaravelBook\Ardent\Ardent as Ardent;
* @method static \Illuminate\Database\Query\Builder|\Piggybank whereReminderSkip($value)
* @method static \Illuminate\Database\Query\Builder|\Piggybank whereOrder($value)
* @method static \Illuminate\Database\Query\Builder|\Piggybank whereRemindMe($value)
* @property-read \Illuminate\Database\Eloquent\Collection|\Reminder[] $reminders
* @property-read \Illuminate\Database\Eloquent\Collection|\Reminder[] $reminders
*/
class Piggybank extends Ardent
{
@ -56,7 +56,7 @@ class Piggybank extends Ardent
'rep_length' => 'in:day,week,month,quarter,year', // how long is the period?
'rep_every' => 'required|min:1|max:100', // how often does it repeat? every 3 years.
'rep_times' => 'min:1|max:100', // how many times do you want to save this amount? eg. 3 times
'reminder' => 'in:day,week,month,year', // want a reminder to put money in this?
'reminder' => 'in:day,week,quarter,month,year', // want a reminder to put money in this?
'reminder_skip' => 'required|min:0|max:100', // every week? every 2 months?
'remind_me' => 'required|boolean', 'order' => 'required:min:1', // not yet used.
];
@ -77,16 +77,12 @@ class Piggybank extends Ardent
*
* @return int
*/
public function amountPerReminder() {
public function amountPerReminder()
{
return 0;
}
public function reminders()
{
return $this->morphMany('Reminder', 'remindersable');
}
/**
* TODO remove this method in favour of something in the FireflyIII libraries.
*
@ -130,37 +126,44 @@ class Piggybank extends Ardent
return $this->currentRep;
}
if ($this->repeats == 0) {
$rep = $this->piggybankrepetitions()->first();
$rep = $this->piggybankrepetitions()->first(['piggybank_repetitions.*']);
$this->currentRep = $rep;
return $rep;
} else {
$query = $this->piggybankrepetitions()->where(
$query = $this->piggybankrepetitions()->where(
function ($q) {
$q->where(
function ($q) {
$today = new Carbon;
$q->whereNull('startdate');
$q->orWhere('startdate', '<=', $today->format('Y-m-d'));
$q->where(
function ($q) {
$today = new Carbon;
$q->whereNull('startdate');
$q->orWhere('startdate', '<=', $today->format('Y-m-d'));
}
)->where(
function ($q) {
$today = new Carbon;
$q->whereNull('targetdate');
$q->orWhere('targetdate', '>=', $today->format('Y-m-d'));
}
);
}
)->where(
)->orWhere(
function ($q) {
$today = new Carbon;
$q->whereNull('targetdate');
$q->orWhere('targetdate', '>=', $today->format('Y-m-d'));
$q->where('startdate', '>=', $today->format('Y-m-d'));
$q->where('targetdate', '>=', $today->format('Y-m-d'));
}
);
}
)->orWhere(
function ($q) {
$today = new Carbon;
$q->where('startdate', '>=', $today->format('Y-m-d'));
$q->where('targetdate', '>=', $today->format('Y-m-d'));
}
)->orderBy('startdate', 'ASC');
$result = $query->first();
)
->orderBy('startdate', 'ASC');
$result = $query->first(['piggybank_repetitions.*']);
$this->currentRep = $result;
\Log::debug('Found relevant rep in currentRelevantRep(): ' . $result->id);
return $result;
}
@ -192,6 +195,11 @@ class Piggybank extends Ardent
return $this->hasMany('PiggybankEvent');
}
public function reminders()
{
return $this->morphMany('Reminder', 'remindersable');
}
/**
* TODO remove this method in favour of something in the FireflyIII libraries.
*

18
app/routes.php
View File

@ -103,13 +103,27 @@ Route::bind(
'piggybank', function ($value, $route) {
if (Auth::check()) {
return Piggybank::
where('piggybanks.id', $value)->leftJoin('accounts', 'accounts.id', '=', 'piggybanks.account_id')->where('accounts.user_id', Auth::user()->id)
->first(['piggybanks.*']);
where('piggybanks.id', $value)
->leftJoin('accounts', 'accounts.id', '=', 'piggybanks.account_id')
->where('accounts.user_id', Auth::user()->id)
->where('repeats',0)->first(['piggybanks.*']);
}
return null;
}
);
Route::bind(
'repeated', function ($value, $route) {
if (Auth::check()) {
return Piggybank::
where('piggybanks.id', $value)
->leftJoin('accounts', 'accounts.id', '=', 'piggybanks.account_id')
->where('accounts.user_id', Auth::user()->id)
->where('repeats',1)->first(['piggybanks.*']);
}
return null;
}
);
// protected routes:
Route::group(

2
app/views/accounts/index.blade.php
View File

@ -21,9 +21,7 @@
</div>
<div class="panel-body">
@include('list.accounts')
</div>
</div>
</div>
</div>

2
app/views/list/accounts.blade.php
View File

@ -1,4 +1,4 @@
<table class="table table-bordered table-striped">
<table class="table table-striped">
<tr>
<th>&nbsp;</th>
<th>Name</th>

27
app/views/repeatedexpense/index.blade.php
View File

@ -14,14 +14,36 @@
</div>
</div>
@foreach($expenses as $entry)
<?php
$barSize = floor(12 / $entry->currentRep->bars->count()) == 0 ? 1 : floor(12 / $entry->currentRep->bars->count());
?>
<div class="row">
<div class="col-lg-12 col-sm-12 col-md-12">
<div class="panel panel-default">
<div class="panel-heading">
<a href="{{route('repeated.show',$entry->id)}}" title="{{{$entry->name}}}">{{{$entry->name}}}</a> ({{mf($entry->currentRep->currentamount)}})
<a href="{{route('repeated.show',$entry->id)}}" title="{{{$entry->name}}}">{{{$entry->name}}}</a>
</div>
<div class="panel-body">
<div class="row">
<div class="col-lg-12 col-sm-12 col-md-12">
<p>
Target amount: {{mf($entry->targetamount)}}. Currently saved: {{mf($entry->currentRep->currentamount)}}. Left to save: {{mf($entry->targetamount-$entry->currentRep->currentamount)}}<br />
Runs from {{$entry->currentRep->startdate->format('j F Y')}} to {{$entry->currentRep->targetdate->format('j F Y')}}
</p>
</div>
</div>
<div class="row">
@foreach($entry->currentRep->bars as $bar)
<div class="col-lg-{{$barSize}} col-md-{{$barSize}} col-sm-{{$barSize}}">
<div class="progress">
<!-- currentAmount:{{$bar->getCurrentAmount()}} getAmount:{{$bar->getAmount()}} -->
<div class="progress-bar progress-bar-success" role="progressbar" aria-valuenow="{{$bar->percentage()}}" aria-valuemin="0" aria-valuemax="100" style="width: {{$bar->percentage()}}%;"></div>
<div class="progress-bar progress-bar-info" role="progressbar" aria-valuenow="{{100-$bar->percentage()}}" aria-valuemin="0" aria-valuemax="100" style="width: {{100-$bar->percentage()}}%;"></div>
</div>
</div>
@endforeach
{{--
@for($i=0;$i<$entry->parts;$i++)
<!-- {{$entry->currentRep->currentamount}} < {{$entry->bars[$i]['amount']}} -->
<div class="col-lg-{{$entry->barCount}} col-md-{{$entry->barCount}} col-sm-{{$entry->barCount}}">
@ -37,13 +59,16 @@
</div>
@endfor
--}}
</div>
<div class="row">
{{--
@for($i=0;$i<$entry->parts;$i++)
<div class="col-lg-{{$entry->barCount}} col-md-{{$entry->barCount}} col-sm-{{$entry->barCount}}">
<small>{{DateKit::periodShow($entry->bars[$i]['date'],$entry->reminder)}}</small>
</div>
@endfor
--}}
</div>
</div>
</div>

23
app/views/repeatedexpense/show.blade.php Normal file
View File

@ -0,0 +1,23 @@
@extends('layouts.default')
@section('content')
<div class="row">
<div class="col-lg-12 col-md-12 col-sm-12">
@foreach($piggyBank->piggybankrepetitions as $rep)
<div class="panel
@if($today > $rep->startdate && $today < $rep->targetdate)
panel-primary
@else
panel-default
@endif
">
<div class="panel-heading">
Repetition from {{$rep->startdate->format('j F Y')}} to {{$rep->targetdate->format('j F Y')}}
</div>
<div class="panel-body">
{{$piggyBank->reminder}}
</div>
</div>
@endforeach
</div>
</div>
@stop

2
app/views/transactions/index.blade.php
View File

@ -6,9 +6,7 @@
<div class="panel-heading">
<i class="fa {{$subTitleIcon}}"></i> {{{$subTitle}}}
</div>
<div class="panel-body">
@include('list.journals-full')
</div>
</div>
</div>
</div>