More cleanup and php doc stuff.

This commit is contained in:
James Cole 2014-08-10 18:22:42 +02:00
parent d0a30f71cd
commit 80c1184eac
55 changed files with 342 additions and 11 deletions

View File

@ -3,6 +3,11 @@
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Database\Migrations\Migration;
/**
* Class CreateUsersTable
*
* @SuppressWarnings(PHPMD.ShortMethodName)
*/
class CreateUsersTable extends Migration {
/**

View File

@ -3,6 +3,11 @@
use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
/**
* Class CreateAccountTypesTable
*
* @SuppressWarnings(PHPMD.ShortMethodName)
*/
class CreateAccountTypesTable extends Migration
{

View File

@ -3,6 +3,11 @@
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Database\Migrations\Migration;
/**
* Class CreateAccountsTable
*
* @SuppressWarnings(PHPMD.ShortMethodName)
*/
class CreateAccountsTable extends Migration {
/**

View File

@ -3,6 +3,11 @@
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Database\Migrations\Migration;
/**
* Class CreateComponentsTable
*
* @SuppressWarnings(PHPMD.ShortMethodName)
*/
class CreateComponentsTable extends Migration {
/**

View File

@ -3,6 +3,11 @@
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Database\Migrations\Migration;
/**
* Class CreateTransactionCurrenciesTable
*
* @SuppressWarnings(PHPMD.ShortMethodName)
*/
class CreateTransactionCurrenciesTable extends Migration {
/**

View File

@ -3,6 +3,11 @@
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Database\Migrations\Migration;
/**
* Class CreateTransactionTypesTable
*
* @SuppressWarnings(PHPMD.ShortMethodName)
*/
class CreateTransactionTypesTable extends Migration {
/**

View File

@ -3,6 +3,11 @@
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Database\Migrations\Migration;
/**
* Class CreateTransactionJournalsTable
*
* @SuppressWarnings(PHPMD.ShortMethodName)
*/
class CreateTransactionJournalsTable extends Migration {
/**

View File

@ -3,6 +3,11 @@
use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
/**
* Class CreateTransactionsTable
*
* @SuppressWarnings(PHPMD.ShortMethodName)
*/
class CreateTransactionsTable extends Migration
{

View File

@ -3,6 +3,11 @@
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Database\Migrations\Migration;
/**
* Class CreateComponentTransactionTable
*
* @SuppressWarnings(PHPMD.ShortMethodName)
*/
class CreateComponentTransactionTable extends Migration {
/**

View File

@ -3,6 +3,11 @@
use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
/**
* Class CreatePiggybanksTable
*
* @SuppressWarnings(PHPMD.ShortMethodName)
*/
class CreatePiggybanksTable extends Migration
{

View File

@ -3,6 +3,11 @@
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Database\Migrations\Migration;
/**
* Class CreateRecurringTransactionsTable
*
* @SuppressWarnings(PHPMD.ShortMethodName)
*/
class CreateRecurringTransactionsTable extends Migration {
/**

View File

@ -3,6 +3,11 @@
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Database\Migrations\Migration;
/**
* Class CreateComponentTransactionJournalTable
*
* @SuppressWarnings(PHPMD.ShortMethodName)
*/
class CreateComponentTransactionJournalTable extends Migration {
/**

View File

@ -3,6 +3,11 @@
use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
/**
* Class CreatePreferencesTable
*
* @SuppressWarnings(PHPMD.ShortMethodName)
*/
class CreatePreferencesTable extends Migration
{

View File

@ -2,6 +2,11 @@
use Illuminate\Database\Migrations\Migration;
/**
* Class CreateSessionTable
*
* @SuppressWarnings(PHPMD.ShortMethodName)
*/
class CreateSessionTable extends Migration {
/**

View File

@ -3,6 +3,11 @@
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Database\Migrations\Migration;
/**
* Class CreateLimitsTable
*
* @SuppressWarnings(PHPMD.ShortMethodName)
*/
class CreateLimitsTable extends Migration {
/**

View File

@ -3,6 +3,11 @@
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Database\Migrations\Migration;
/**
* Class CreateLimitRepeatTable
*
* @SuppressWarnings(PHPMD.ShortMethodName)
*/
class CreateLimitRepeatTable extends Migration {
/**

View File

@ -3,6 +3,11 @@
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Database\Migrations\Migration;
/**
* Class RecurringTransactionsToComponents
*
* @SuppressWarnings(PHPMD.ShortMethodName)
*/
class RecurringTransactionsToComponents extends Migration {
/**

View File

@ -1,6 +1,9 @@
<?php
/**
* Class AccountTypeSeeder
*/
class AccountTypeSeeder extends Seeder
{
public function run()

View File

@ -1,5 +1,8 @@
<?php
/**
* Class DatabaseSeeder
*/
class DatabaseSeeder extends Seeder
{

View File

@ -1,5 +1,8 @@
<?php
/**
* Class DefaultUserSeeder
*/
class DefaultUserSeeder extends Seeder
{
public function run()

View File

@ -1,6 +1,9 @@
<?php
/**
* Class TransactionCurrencySeeder
*/
class TransactionCurrencySeeder extends Seeder
{
public function run()

View File

@ -1,6 +1,9 @@
<?php
/**
* Class TransactionTypeSeeder
*/
class TransactionTypeSeeder extends Seeder
{
public function run()

View File

@ -276,6 +276,7 @@ class EloquentAccountRepository implements AccountRepositoryInterface
* @param Carbon $date
*
* @return bool
* @SuppressWarnings(PHPMD.CamelCaseMethodName)
*/
protected function _createInitialBalance(\Account $account, $amount = 0, Carbon $date)
{

View File

@ -92,6 +92,11 @@ class Account extends Ardent
);
}
/**
* @param \Carbon\Carbon $date
*
* @return null
*/
public function predict(\Carbon\Carbon $date)
{
return null;

View File

@ -22,6 +22,9 @@ class AccountType extends Eloquent
'description' => 'string'
];
/**
* @return \Illuminate\Database\Eloquent\Relations\HasMany
*/
public function accounts()
{
return $this->hasMany('Account');

View File

@ -30,11 +30,17 @@ class Budget extends Component
];
protected $isSubclass = true;
/**
* @return \Illuminate\Database\Eloquent\Relations\HasMany
*/
public function limits()
{
return $this->hasMany('Limit', 'component_id');
}
/**
* @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
*/
public function transactionjournals()
{
return $this->belongsToMany('TransactionJournal', 'component_transaction_journal', 'component_id');

View File

@ -30,6 +30,9 @@ class Category extends Component
];
protected $isSubclass = true;
/**
* @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
*/
public function transactionjournals()
{
return $this->belongsToMany('TransactionJournal', 'component_transaction_journal', 'component_id');

View File

@ -38,21 +38,33 @@ class Component extends Firefly\Database\SingleTableInheritanceEntity
protected $table = 'components';
protected $subclassField = 'class';
/**
* @return \Illuminate\Database\Eloquent\Relations\HasMany
*/
public function limits()
{
return $this->hasMany('Limit');
}
/**
* @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
*/
public function transactionjournals()
{
return $this->belongsToMany('TransactionJournal');
}
/**
* @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
*/
public function transactions()
{
return $this->belongsToMany('Transaction');
}
/**
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
*/
public function user()
{
return $this->belongsTo('User');

View File

@ -40,6 +40,9 @@ class Limit extends Ardent
];
/**
* @return array
*/
public static function factory()
{
$start = new Carbon;
@ -54,16 +57,25 @@ class Limit extends Ardent
];
}
/**
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
*/
public function budget()
{
return $this->belongsTo('Budget', 'component_id');
}
/**
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
*/
public function component()
{
return $this->belongsTo('Component', 'component_id');
}
/**
* @param Carbon $start
*/
public function createRepetition(Carbon $start)
{
@ -116,12 +128,18 @@ class Limit extends Ardent
}
}
/**
* @return \Illuminate\Database\Eloquent\Relations\HasMany
*/
public function limitrepetitions()
{
return $this->hasMany('LimitRepetition');
}
/**
* @return array
*/
public function getDates()
{
return ['created_at', 'updated_at', 'startdate', 'enddate'];

View File

@ -31,6 +31,9 @@ class LimitRepetition extends Ardent
'amount' => 'numeric|required|min:0.01',
];
/**
* @return array
*/
public static function factory()
{
$start = new \Carbon\Carbon;
@ -46,6 +49,9 @@ class LimitRepetition extends Ardent
];
}
/**
* @return array
*/
public function getDates()
{
return ['created_at', 'updated_at', 'startdate', 'enddate'];
@ -76,6 +82,9 @@ class LimitRepetition extends Ardent
return $left;
}
/**
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
*/
public function limit()
{
return $this->belongsTo('Limit');

View File

@ -37,6 +37,9 @@ class Piggybank extends Ardent
'order' => 'required:min:1',
];
/**
* @return array
*/
public static function factory()
{
$start = new Carbon;
@ -52,14 +55,20 @@ class Piggybank extends Ardent
];
}
/**
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
*/
public function account()
{
return $this->belongsTo('Account');
}
/**
* @return array
*/
public function getDates()
{
return array('created_at', 'updated_at', 'targetdate');
return ['created_at', 'updated_at', 'targetdate'];
}
}

View File

@ -36,17 +36,27 @@ class Preference extends Ardent
'data' => 'string'
];
/**
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
*/
public function user()
{
return $this->belongsTo('User');
}
/**
* @param $value
*/
public function setDataAttribute($value)
{
$this->attributes['data'] = json_encode($value);
}
//
/**
* @param $value
*
* @return mixed
*/
public function getDataAttribute($value)
{
return json_decode($value);

View File

@ -50,6 +50,9 @@ class RecurringTransaction extends Ardent
'skip' => 'required|between:0,31',
];
/**
* @return array
*/
public static function factory()
{
$date = new Carbon;
@ -68,11 +71,17 @@ class RecurringTransaction extends Ardent
];
}
/**
* @return array
*/
public function getDates()
{
return ['created_at', 'updated_at', 'date'];
}
/**
* @return Carbon
*/
public function next()
{
$start = clone $this->date;
@ -105,6 +114,9 @@ class RecurringTransaction extends Ardent
return $start;
}
/**
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
*/
public function user()
{
return $this->belongsTo('User');

View File

@ -44,26 +44,41 @@ class Transaction extends Ardent
'amount' => 'integer:5'
];
/**
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
*/
public function account()
{
return $this->belongsTo('Account');
}
/**
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
*/
public function transactionJournal()
{
return $this->belongsTo('TransactionJournal');
}
/**
* @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
*/
public function components()
{
return $this->belongsToMany('Component');
}
/**
* @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
*/
public function budgets()
{
return $this->belongsToMany('Budget', 'component_transaction', 'transaction_id', 'component_id');
}
/**
* @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
*/
public function categories()
{
return $this->belongsToMany('Category', 'component_transaction', 'transaction_id', 'component_id');

View File

@ -22,7 +22,10 @@ class TransactionCurrency extends Eloquent
'code' => 'string'
];
public function transactionJournals()
/**
* @return \Illuminate\Database\Eloquent\Relations\HasMany
*/
public function transactionjournals()
{
return $this->hasMany('TransactionJournal');
}

View File

@ -84,6 +84,9 @@ class TransactionJournal extends Ardent
'completed' => 'required|between:0,1'
];
/**
* @return array
*/
public static function factory()
{
$date = new \Carbon\Carbon;
@ -98,6 +101,9 @@ class TransactionJournal extends Ardent
];
}
/**
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
*/
public function transactionType()
{
return $this->belongsTo('TransactionType');
@ -114,21 +120,33 @@ class TransactionJournal extends Ardent
}
/**
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
*/
public function transactionCurrency()
{
return $this->belongsTo('TransactionCurrency');
}
/**
* @return \Illuminate\Database\Eloquent\Relations\HasMany
*/
public function transactions()
{
return $this->hasMany('Transaction');
}
/**
* @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
*/
public function components()
{
return $this->belongsToMany('Component');
}
/**
* @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
*/
public function budgets()
{
return $this->belongsToMany(
@ -136,6 +154,9 @@ class TransactionJournal extends Ardent
);
}
/**
* @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
*/
public function categories()
{
return $this->belongsToMany(
@ -143,16 +164,31 @@ class TransactionJournal extends Ardent
);
}
/**
* @return array
*/
public function getDates()
{
return array('created_at', 'updated_at', 'date');
return ['created_at', 'updated_at', 'date'];
}
/**
* @param $query
* @param \Carbon\Carbon $date
*
* @return mixed
*/
public function scopeAfter($query, \Carbon\Carbon $date)
{
return $query->where('date', '>=', $date->format('Y-m-d'));
}
/**
* @param $query
* @param \Carbon\Carbon $date
*
* @return mixed
*/
public function scopeBefore($query, \Carbon\Carbon $date)
{
return $query->where('date', '<=', $date->format('Y-m-d'));

View File

@ -22,6 +22,9 @@ class TransactionType extends Ardent
'type' => 'string'
];
/**
* @return \Illuminate\Database\Eloquent\Relations\HasMany
*/
public function transactionJournals()
{
return $this->hasMany('TransactionJournal');

View File

@ -61,6 +61,9 @@ class User extends Ardent implements UserInterface, RemindableInterface
*/
protected $hidden = ['remember_token'];
/**
* @return array
*/
public static function factory()
{
return [
@ -71,41 +74,65 @@ class User extends Ardent implements UserInterface, RemindableInterface
];
}
/**
* @return \Illuminate\Database\Eloquent\Relations\HasMany
*/
public function accounts()
{
return $this->hasMany('Account');
}
/**
* @return \Illuminate\Database\Eloquent\Relations\HasMany
*/
public function budgets()
{
return $this->hasMany('Budget');
}
/**
* @return \Illuminate\Database\Eloquent\Relations\HasMany
*/
public function categories()
{
return $this->hasMany('Category');
}
/**
* @return \Illuminate\Database\Eloquent\Relations\HasMany
*/
public function components()
{
return $this->hasMany('Component');
}
/**
* @return \Illuminate\Database\Eloquent\Relations\HasMany
*/
public function preferences()
{
return $this->hasMany('Preference');
}
/**
* @return \Illuminate\Database\Eloquent\Relations\HasMany
*/
public function recurringtransactions()
{
return $this->hasMany('RecurringTransaction');
}
/**
* @param $value
*/
public function setPasswordAttribute($value)
{
$this->attributes['password'] = Hash::make($value);
}
/**
* @return \Illuminate\Database\Eloquent\Relations\HasMany
*/
public function transactionjournals()
{
return $this->hasMany('TransactionJournal');

View File

@ -1,5 +1,8 @@
<?php
/**
* Class TestCase
*/
class TestCase extends Illuminate\Foundation\Testing\TestCase
{
@ -7,6 +10,7 @@ class TestCase extends Illuminate\Foundation\Testing\TestCase
* Creates the application.
*
* @return \Symfony\Component\HttpKernel\HttpKernelInterface
* @SuppressWarnings(PHPMD.UnusedLocalVariable)
*/
public function createApplication()
{
@ -17,6 +21,11 @@ class TestCase extends Illuminate\Foundation\Testing\TestCase
return require __DIR__ . '/../../bootstrap/start.php';
}
/**
* @param $class
*
* @return \Mockery\MockInterface
*/
public function mock($class)
{
$mock = Mockery::mock($class);

View File

@ -7,6 +7,9 @@ use Zizaco\FactoryMuff\Facade\FactoryMuff as f;
/**
* Class AccountControllerTest
*
* @SuppressWarnings(PHPMD.TooManyMethods)
* @SuppressWarnings(PHPMD.CamelCasePropertyName)
*/
class AccountControllerTest extends TestCase
{

View File

@ -5,6 +5,12 @@ use Illuminate\Database\Eloquent\Collection;
use Mockery as m;
use Zizaco\FactoryMuff\Facade\FactoryMuff as f;
/**
* Class BudgetControllerTest
*
* @SuppressWarnings(PHPMD.TooManyMethods)
* @SuppressWarnings(PHPMD.CamelCasePropertyName)
*/
class BudgetControllerTest extends TestCase
{
protected $_repository;

View File

@ -7,6 +7,9 @@ use Zizaco\FactoryMuff\Facade\FactoryMuff as f;
/**
* Class CategoryControllerTest
*
* @SuppressWarnings(PHPMD.TooManyMethods)
* @SuppressWarnings(PHPMD.CamelCasePropertyName)
*/
class CategoryControllerTest extends TestCase
{
@ -100,6 +103,7 @@ class CategoryControllerTest extends TestCase
{
$category = f::create('Category');
$collection = new Collection();
$collection->add($category);
$this->_repository->shouldReceive('get')->with()->once()->andReturn($collection);
$this->action('GET', 'CategoryController@index');

View File

@ -8,6 +8,9 @@ use Zizaco\FactoryMuff\Facade\FactoryMuff as f;
/**
* Class ChartControllerTest
*
* @SuppressWarnings(PHPMD.TooManyMethods)
* @SuppressWarnings(PHPMD.CamelCasePropertyName)
*/
class ChartControllerTest extends TestCase
{

View File

@ -5,6 +5,9 @@ use Zizaco\FactoryMuff\Facade\FactoryMuff as f;
/**
* Class HomeControllerTest
*
* @SuppressWarnings(PHPMD.TooManyMethods)
* @SuppressWarnings(PHPMD.CamelCasePropertyName)
*/
class HomeControllerTest extends TestCase
{

View File

@ -3,6 +3,9 @@ use Zizaco\FactoryMuff\Facade\FactoryMuff as f;
/**
* Class JsonControllerTest
*
* @SuppressWarnings(PHPMD.TooManyMethods)
* @SuppressWarnings(PHPMD.CamelCasePropertyName)
*/
class JsonControllerTest extends TestCase
{

View File

@ -4,6 +4,9 @@ use Zizaco\FactoryMuff\Facade\FactoryMuff as f;
/**
* Class LimitControllerTest
*
* @SuppressWarnings(PHPMD.TooManyMethods)
* @SuppressWarnings(PHPMD.CamelCasePropertyName)
*/
class LimitControllerTest extends TestCase
{

View File

@ -6,6 +6,9 @@ use Zizaco\FactoryMuff\Facade\FactoryMuff as f;
/**
* Class PiggybankControllerTest
*
* @SuppressWarnings(PHPMD.TooManyMethods)
* @SuppressWarnings(PHPMD.CamelCasePropertyName)
*/
class PiggybankControllerTest extends TestCase
{

View File

@ -5,6 +5,9 @@ use Mockery as m;
/**
* Class PreferencesControllerTest
*
* @SuppressWarnings(PHPMD.TooManyMethods)
* @SuppressWarnings(PHPMD.CamelCasePropertyName)
*/
class PreferencesControllerTest extends TestCase
{

View File

@ -4,6 +4,9 @@ use Zizaco\FactoryMuff\Facade\FactoryMuff as f;
/**
* Class ProfileControllerTest
*
* @SuppressWarnings(PHPMD.TooManyMethods)
* @SuppressWarnings(PHPMD.CamelCasePropertyName)
*/
class ProfileControllerTest extends TestCase
{

View File

@ -4,6 +4,9 @@ use Zizaco\FactoryMuff\Facade\FactoryMuff as f;
/**
* Class RecurringControllerTest
*
* @SuppressWarnings(PHPMD.TooManyMethods)
* @SuppressWarnings(PHPMD.CamelCasePropertyName)
*/
class RecurringControllerTest extends TestCase
{

View File

@ -3,6 +3,9 @@ use Mockery as m;
/**
* Class ReportControllerTest
*
* @SuppressWarnings(PHPMD.TooManyMethods)
* @SuppressWarnings(PHPMD.CamelCasePropertyName)
*/
class ReportControllerTest extends TestCase
{

View File

@ -3,6 +3,9 @@ use Mockery as m;
/**
* Class SearchControllerTest
*
* @SuppressWarnings(PHPMD.TooManyMethods)
* @SuppressWarnings(PHPMD.CamelCasePropertyName)
*/
class SearchControllerTest extends TestCase
{

View File

@ -5,6 +5,9 @@ use Zizaco\FactoryMuff\Facade\FactoryMuff as f;
/**
* Class TransactionControllerTest
*
* @SuppressWarnings(PHPMD.TooManyMethods)
* @SuppressWarnings(PHPMD.CamelCasePropertyName)
*/
class TransactionControllerTest extends TestCase
{

View File

@ -6,6 +6,9 @@ use Zizaco\FactoryMuff\Facade\FactoryMuff as f;
/**
* Class UserControllerTest
*
* @SuppressWarnings(PHPMD.TooManyMethods)
* @SuppressWarnings(PHPMD.CamelCasePropertyName)
*/
class UserControllerTest extends TestCase
{
@ -57,11 +60,7 @@ class UserControllerTest extends TestCase
public function testPostLoginFails()
{
$input = [
'username' => 'bla@bla',
'password' => 'something',
'remindme' => 0
];
$this->action('POST', 'UserController@postLogin');
$this->assertResponseOk();
}

View File

@ -2,6 +2,11 @@
use Carbon\Carbon;
use Zizaco\FactoryMuff\Facade\FactoryMuff as f;
/**
* Class ModelTest
*
* @SuppressWarnings(PHPMD.TooManyMethods)
*/
class ModelTest extends TestCase
{
@ -179,7 +184,7 @@ class ModelTest extends TestCase
// repeat frequency (present) for periodOrder
$list = ['yearly', 'half-year', 'quarterly', 'monthly', 'weekly', 'daily'];
foreach ($list as $index => $entry) {
foreach ($list as $entry) {
$rep->repeat_freq = $entry;
$this->assertGreaterThan(0, strlen($rep->periodShow()));
}
@ -216,7 +221,7 @@ class ModelTest extends TestCase
$this->assertEquals($rec->user_id, $user->id);
$list = ['yearly', 'half-year', 'quarterly', 'monthly', 'weekly', 'daily'];
foreach ($list as $index => $entry) {
foreach ($list as $entry) {
$start = clone $rec->date;
$rec->repeat_freq = $entry;
$end = $rec->next();