Add constraint factory #143
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,81 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the JsonSchema package. | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace JsonSchema\Constraints; | ||
|
|
||
| use JsonSchema\Exception\InvalidArgumentException; | ||
| use JsonSchema\Uri\UriRetriever; | ||
| use JsonSchema\Validator; | ||
|
|
||
| /** | ||
| * Factory for centralize constraint initialization. | ||
| */ | ||
| class Factory | ||
|
There was a problem hiding this comment. This library appears to duplicate the namespace in the class name. For example: This should maybe be called There was a problem hiding this comment. This seems to be just a cosmetic thing. Prefer to hear other opinions There was a problem hiding this comment. @bighappyface - one for you. There was a problem hiding this comment. I am okay with the name, but I think we would be best served to stick with the convention established in release 1.4.0: https://github.com/justinrainbow/json-schema/releases/tag/1.4.0 (PR #136) That being said, I think the suggestion @alecsammon put forth is good guidance. There was a problem hiding this comment. Well there are lot of opinions and this could be a large discussion.
|
||
| { | ||
| /** | ||
| * @var UriRetriever | ||
| */ | ||
| protected $uriRetriever; | ||
|
|
||
| /** | ||
| * @param UriRetriever $uriRetriever | ||
| */ | ||
| public function __construct(UriRetriever $uriRetriever = null) | ||
| { | ||
| if (!$uriRetriever) { | ||
| $uriRetriever = new UriRetriever(); | ||
| } | ||
|
|
||
| $this->uriRetriever = $uriRetriever; | ||
| } | ||
|
|
||
| /** | ||
| * @return UriRetriever | ||
| */ | ||
| public function getUriRetriever() | ||
| { | ||
| return $this->uriRetriever; | ||
| } | ||
|
|
||
| /** | ||
| * Create a constraint instance for the given constraint name. | ||
| * | ||
| * @param string $constraintName | ||
| * @return ConstraintInterface|ObjectConstraint | ||
| * @throws InvalidArgumentException if is not possible create the constraint instance. | ||
| */ | ||
| public function createInstanceFor($constraintName) | ||
| { | ||
| switch ($constraintName) { | ||
| case 'array': | ||
| case 'collection': | ||
| return new CollectionConstraint(Constraint::CHECK_MODE_NORMAL, $this->uriRetriever, $this); | ||
| case 'object': | ||
| return new ObjectConstraint(Constraint::CHECK_MODE_NORMAL, $this->uriRetriever, $this); | ||
| case 'type': | ||
| return new TypeConstraint(Constraint::CHECK_MODE_NORMAL, $this->uriRetriever, $this); | ||
| case 'undefined': | ||
| return new UndefinedConstraint(Constraint::CHECK_MODE_NORMAL, $this->uriRetriever, $this); | ||
| case 'string': | ||
| return new StringConstraint(Constraint::CHECK_MODE_NORMAL, $this->uriRetriever, $this); | ||
| case 'number': | ||
| return new NumberConstraint(Constraint::CHECK_MODE_NORMAL, $this->uriRetriever, $this); | ||
| case 'enum': | ||
| return new EnumConstraint(Constraint::CHECK_MODE_NORMAL, $this->uriRetriever, $this); | ||
| case 'format': | ||
| return new FormatConstraint(Constraint::CHECK_MODE_NORMAL, $this->uriRetriever, $this); | ||
| case 'schema': | ||
| return new SchemaConstraint(Constraint::CHECK_MODE_NORMAL, $this->uriRetriever, $this); | ||
| case 'validator': | ||
| return new Validator(Constraint::CHECK_MODE_NORMAL, $this->uriRetriever, $this); | ||
| } | ||
|
|
||
| throw new InvalidArgumentException('Unknown constraint ' . $constraintName); | ||
|
There was a problem hiding this comment. This line appears to be untested - here is a test :) /**
* @expectedException JsonSchema\Exception\InvalidArgumentException
*/
public function testInvalidConstraint()
{
$this->factory->factory('badConstraintName');
} |
||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the JsonSchema package. | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace JsonSchema\Tests\Constraints; | ||
|
|
||
| use JsonSchema\Constraints\Factory; | ||
| use PHPUnit_Framework_TestCase as TestCase; | ||
|
|
||
| class FactoryTest extends TestCase | ||
| { | ||
| /** | ||
| * @var Factory | ||
| */ | ||
| protected $factory; | ||
|
|
||
| protected function setUp() | ||
| { | ||
| $this->factory = new Factory(); | ||
| } | ||
|
|
||
| /** | ||
| * @dataProvider constraintNameProvider | ||
| * | ||
| * @param string $constraintName | ||
| * @param string $expectedClass | ||
| * @return void | ||
| */ | ||
| public function testCreateInstanceForConstraintName($constraintName, $expectedClass) | ||
| { | ||
| $constraint = $this->factory->createInstanceFor($constraintName); | ||
|
|
||
| $this->assertInstanceOf($expectedClass, $constraint); | ||
| $this->assertInstanceOf('JsonSchema\Constraints\ConstraintInterface', $constraint); | ||
| $this->assertSame($this->factory->getUriRetriever(), $constraint->getUriRetriever()); | ||
| } | ||
|
|
||
| public function constraintNameProvider() | ||
| { | ||
| return array( | ||
| array('array', 'JsonSchema\Constraints\CollectionConstraint'), | ||
| array('collection', 'JsonSchema\Constraints\CollectionConstraint'), | ||
| array('object', 'JsonSchema\Constraints\ObjectConstraint'), | ||
| array('type', 'JsonSchema\Constraints\TypeConstraint'), | ||
| array('undefined', 'JsonSchema\Constraints\UndefinedConstraint'), | ||
| array('string', 'JsonSchema\Constraints\StringConstraint'), | ||
| array('number', 'JsonSchema\Constraints\NumberConstraint'), | ||
| array('enum', 'JsonSchema\Constraints\EnumConstraint'), | ||
| array('format', 'JsonSchema\Constraints\FormatConstraint'), | ||
| array('schema', 'JsonSchema\Constraints\SchemaConstraint'), | ||
| array('validator', 'JsonSchema\Validator'), | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
| * @dataProvider invalidConstraintNameProvider | ||
| * | ||
| * @param string $constraintName | ||
| * @return void | ||
| */ | ||
| public function testExceptionWhenCreateInstanceForInvalidConstraintName($constraintName) | ||
| { | ||
| $this->setExpectedException('JsonSchema\Exception\InvalidArgumentException'); | ||
| $this->factory->createInstanceFor($constraintName); | ||
| } | ||
|
|
||
| public function invalidConstraintNameProvider() | ||
| { | ||
| return array( | ||
| array('invalidConstraintName'), | ||
| ); | ||
| } | ||
| } |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing |null