AS1024/Kanboard-Prod
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Move project validator methods

Browse Source
This commit is contained in:
Frederic Guillot
2016-01-11 22:07:39 -05:00
parent e31185a2bd
commit 3699073371
9 changed files with 157 additions and 99 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
app/Api/Me.php
View File

@@ -44,7 +44,7 @@ class Me extends Base
'is_private' => 1, 'is_private' => 1,
); );
list($valid, ) = $this->project->validateCreation($values); list($valid, ) = $this->projectValidator->validateCreation($values);
return $valid ? $this->project->create($values, $this->userSession->getId(), true) : false; return $valid ? $this->project->create($values, $this->userSession->getId(), true) : false;
} }

4
app/Api/Project.php
View File

@@ -69,7 +69,7 @@ class Project extends Base
'description' => $description 'description' => $description
); );
list($valid, ) = $this->project->validateCreation($values); list($valid, ) = $this->projectValidator->validateCreation($values);
return $valid ? $this->project->create($values) : false; return $valid ? $this->project->create($values) : false;
} }
@@ -81,7 +81,7 @@ class Project extends Base
'description' => $description 'description' => $description
); );
list($valid, ) = $this->project->validateModification($values); list($valid, ) = $this->projectValidator->validateModification($values);
return $valid && $this->project->update($values); return $valid && $this->project->update($values);
} }
} }

4
app/Controller/Project.php
View File

@@ -169,7 +169,7 @@ class Project extends Base
} }
} }
list($valid, $errors) = $this->project->validateModification($values); list($valid, $errors) = $this->projectValidator->validateModification($values);
if ($valid) { if ($valid) {
if ($this->project->update($values)) { if ($this->project->update($values)) {
@@ -329,7 +329,7 @@ class Project extends Base
public function save() public function save()
{ {
$values = $this->request->getValues(); $values = $this->request->getValues();
list($valid, $errors) = $this->project->validateCreation($values); list($valid, $errors) = $this->projectValidator->validateCreation($values);
if ($valid) { if ($valid) {
$project_id = $this->project->create($values, $this->userSession->getId(), true); $project_id = $this->project->create($values, $this->userSession->getId(), true);

1
app/Core/Base.php
View File

@@ -114,6 +114,7 @@ use Pimple\Container;
* @property \Kanboard\Model\UserMetadata $userMetadata * @property \Kanboard\Model\UserMetadata $userMetadata
* @property \Kanboard\Model\Webhook $webhook * @property \Kanboard\Model\Webhook $webhook
* @property \Kanboard\Validator\PasswordResetValidator $passwordResetValidator * @property \Kanboard\Validator\PasswordResetValidator $passwordResetValidator
* @property \Kanboard\Validator\ProjectValidator $projectValidator
* @property \Kanboard\Validator\SubtaskValidator $subtaskValidator * @property \Kanboard\Validator\SubtaskValidator $subtaskValidator
* @property \Kanboard\Validator\SwimlaneValidator $swimlaneValidator * @property \Kanboard\Validator\SwimlaneValidator $swimlaneValidator
* @property \Kanboard\Validator\TaskLinkValidator $taskLinkValidator * @property \Kanboard\Validator\TaskLinkValidator $taskLinkValidator

69
app/Model/Project.php
View File

@@ -2,8 +2,6 @@
namespace Kanboard\Model; namespace Kanboard\Model;
use SimpleValidator\Validator;
use SimpleValidator\Validators;
use Kanboard\Core\Security\Token; use Kanboard\Core\Security\Token;
use Kanboard\Core\Security\Role; use Kanboard\Core\Security\Role;
@@ -510,71 +508,4 @@ class Project extends Base
->eq('id', $project_id) ->eq('id', $project_id)
->save(array('is_public' => 0, 'token' => '')); ->save(array('is_public' => 0, 'token' => ''));
} }
/**
* Common validation rules
*
* @access private
* @return array
*/
private function commonValidationRules()
{
return array(
new Validators\Integer('id', t('This value must be an integer')),
new Validators\Integer('is_active', t('This value must be an integer')),
new Validators\Required('name', t('The project name is required')),
new Validators\MaxLength('name', t('The maximum length is %d characters', 50), 50),
new Validators\MaxLength('identifier', t('The maximum length is %d characters', 50), 50),
new Validators\MaxLength('start_date', t('The maximum length is %d characters', 10), 10),
new Validators\MaxLength('end_date', t('The maximum length is %d characters', 10), 10),
new Validators\AlphaNumeric('identifier', t('This value must be alphanumeric')) ,
new Validators\Unique('identifier', t('The identifier must be unique'), $this->db->getConnection(), self::TABLE),
);
}
/**
* Validate project creation
*
* @access public
* @param array $values Form values
* @return array $valid, $errors [0] = Success or not, [1] = List of errors
*/
public function validateCreation(array $values)
{
if (! empty($values['identifier'])) {
$values['identifier'] = strtoupper($values['identifier']);
}
$v = new Validator($values, $this->commonValidationRules());
return array(
$v->execute(),
$v->getErrors()
);
}
/**
* Validate project modification
*
* @access public
* @param array $values Form values
* @return array $valid, $errors [0] = Success or not, [1] = List of errors
*/
public function validateModification(array $values)
{
if (! empty($values['identifier'])) {
$values['identifier'] = strtoupper($values['identifier']);
}
$rules = array(
new Validators\Required('id', t('This value is required')),
);
$v = new Validator($values, array_merge($rules, $this->commonValidationRules()));
return array(
$v->execute(),
$v->getErrors()
);
}
} }

1
app/ServiceProvider/ClassProvider.php
View File

@@ -86,6 +86,7 @@ class ClassProvider implements ServiceProviderInterface
), ),
'Validator' => array( 'Validator' => array(
'PasswordResetValidator', 'PasswordResetValidator',
'ProjectValidator',
'SubtaskValidator', 'SubtaskValidator',
'SwimlaneValidator', 'SwimlaneValidator',
'TaskValidator', 'TaskValidator',

83
app/Validator/ProjectValidator.php Normal file
View File

@@ -0,0 +1,83 @@
<?php
namespace Kanboard\Validator;
use SimpleValidator\Validator;
use SimpleValidator\Validators;
use Kanboard\Model\Project;
/**
* Project Validator
*
* @package validator
* @author Frederic Guillot
*/
class ProjectValidator extends Base
{
/**
* Common validation rules
*
* @access private
* @return array
*/
private function commonValidationRules()
{
return array(
new Validators\Integer('id', t('This value must be an integer')),
new Validators\Integer('is_active', t('This value must be an integer')),
new Validators\Required('name', t('The project name is required')),
new Validators\MaxLength('name', t('The maximum length is %d characters', 50), 50),
new Validators\MaxLength('identifier', t('The maximum length is %d characters', 50), 50),
new Validators\MaxLength('start_date', t('The maximum length is %d characters', 10), 10),
new Validators\MaxLength('end_date', t('The maximum length is %d characters', 10), 10),
new Validators\AlphaNumeric('identifier', t('This value must be alphanumeric')) ,
new Validators\Unique('identifier', t('The identifier must be unique'), $this->db->getConnection(), Project::TABLE),
);
}
/**
* Validate project creation
*
* @access public
* @param array $values Form values
* @return array $valid, $errors [0] = Success or not, [1] = List of errors
*/
public function validateCreation(array $values)
{
if (! empty($values['identifier'])) {
$values['identifier'] = strtoupper($values['identifier']);
}
$v = new Validator($values, $this->commonValidationRules());
return array(
$v->execute(),
$v->getErrors()
);
}
/**
* Validate project modification
*
* @access public
* @param array $values Form values
* @return array $valid, $errors [0] = Success or not, [1] = List of errors
*/
public function validateModification(array $values)
{
if (! empty($values['identifier'])) {
$values['identifier'] = strtoupper($values['identifier']);
}
$rules = array(
new Validators\Required('id', t('This value is required')),
);
$v = new Validator($values, array_merge($rules, $this->commonValidationRules()));
return array(
$v->execute(),
$v->getErrors()
);
}
}

25
tests/units/Model/ProjectTest.php
View File

@@ -277,30 +277,5 @@ class ProjectTest extends Base
$project = $p->getByIdentifier(''); $project = $p->getByIdentifier('');
$this->assertFalse($project); $this->assertFalse($project);
// Validation rules
$r = $p->validateCreation(array('name' => 'test', 'identifier' => 'TEST1'));
$this->assertFalse($r[0]);
$r = $p->validateCreation(array('name' => 'test', 'identifier' => 'test1'));
$this->assertFalse($r[0]);
$r = $p->validateModification(array('id' => 1, 'name' => 'test', 'identifier' => 'TEST1'));
$this->assertTrue($r[0]);
$r = $p->validateModification(array('id' => 1, 'name' => 'test', 'identifier' => 'test3'));
$this->assertTrue($r[0]);
$r = $p->validateModification(array('id' => 1, 'name' => 'test', 'identifier' => ''));
$this->assertTrue($r[0]);
$r = $p->validateModification(array('id' => 1, 'name' => 'test', 'identifier' => 'TEST2'));
$this->assertFalse($r[0]);
$r = $p->validateCreation(array('name' => 'test', 'identifier' => 'a-b-c'));
$this->assertFalse($r[0]);
$r = $p->validateCreation(array('name' => 'test', 'identifier' => 'test 123'));
$this->assertFalse($r[0]);
} }
} }

67
tests/units/Validator/ProjectValidatorTest.php Normal file
View File

@@ -0,0 +1,67 @@
<?php
require_once __DIR__.'/../Base.php';
use Kanboard\Validator\ProjectValidator;
use Kanboard\Model\Project;
class ProjectValidatorTest extends Base
{
public function testValidateCreation()
{
$validator = new ProjectValidator($this->container);
$p = new Project($this->container);
$this->assertEquals(1, $p->create(array('name' => 'UnitTest1', 'identifier' => 'test1')));
$this->assertEquals(2, $p->create(array('name' => 'UnitTest2')));
$project = $p->getById(1);
$this->assertNotEmpty($project);
$this->assertEquals('TEST1', $project['identifier']);
$project = $p->getById(2);
$this->assertNotEmpty($project);
$this->assertEquals('', $project['identifier']);
$r = $validator->validateCreation(array('name' => 'test', 'identifier' => 'TEST1'));
$this->assertFalse($r[0]);
$r = $validator->validateCreation(array('name' => 'test', 'identifier' => 'test1'));
$this->assertFalse($r[0]);
$r = $validator->validateCreation(array('name' => 'test', 'identifier' => 'a-b-c'));
$this->assertFalse($r[0]);
$r = $validator->validateCreation(array('name' => 'test', 'identifier' => 'test 123'));
$this->assertFalse($r[0]);
}
public function testValidateModification()
{
$validator = new ProjectValidator($this->container);
$p = new Project($this->container);
$this->assertEquals(1, $p->create(array('name' => 'UnitTest1', 'identifier' => 'test1')));
$this->assertEquals(2, $p->create(array('name' => 'UnitTest2', 'identifier' => 'TEST2')));
$project = $p->getById(1);
$this->assertNotEmpty($project);
$this->assertEquals('TEST1', $project['identifier']);
$project = $p->getById(2);
$this->assertNotEmpty($project);
$this->assertEquals('TEST2', $project['identifier']);
$r = $validator->validateModification(array('id' => 1, 'name' => 'test', 'identifier' => 'TEST1'));
$this->assertTrue($r[0]);
$r = $validator->validateModification(array('id' => 1, 'name' => 'test', 'identifier' => 'test3'));
$this->assertTrue($r[0]);
$r = $validator->validateModification(array('id' => 1, 'name' => 'test', 'identifier' => ''));
$this->assertTrue($r[0]);
$r = $validator->validateModification(array('id' => 1, 'name' => 'test', 'identifier' => 'TEST2'));
$this->assertFalse($r[0]);
}
}