Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow the schema to be an associative array #389

Merged
merged 4 commits into from
Mar 21, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions src/JsonSchema/Constraints/BaseConstraint.php
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@
namespace JsonSchema\Constraints;

use JsonSchema\ConstraintError;
use JsonSchema\Constraints\TypeCheck\LooseTypeCheck;
use JsonSchema\Entity\JsonPointer;
use JsonSchema\Exception\InvalidArgumentException;
use JsonSchema\Exception\ValidationException;

/**
Expand Down Expand Up @@ -89,4 +91,25 @@ public function reset()
{
$this->errors = array();
}

/**
* Recursively cast an associative array to an object
*
* @param array $array
*
* @return object
*/
public static function arrayToObjectRecursive($array)
{
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this any faster than just doing this?

return json_decode(json_encode($array), false);

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I haven't benchmarked it. Do you have an opinion on which is better?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would think my version is faster, because you're letting all the work happen in C, and you don't have the overhead of the recursive PHP function calls. Time it for yourself though and see what you think.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You make a good point 👍

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it is worth considering the performance in this case. Perhaps a continuous means of measuring performance can be added in another PR to facilitate a continuous improvement and scrutiny?

$json = json_encode($array);
if (json_last_error() !== \JSON_ERROR_NONE) {
$message = 'Unable to encode schema array as JSON';
if (version_compare(phpversion(), '5.5.0', '>=')) {
$message .= ': ' . json_last_error_msg();
}
throw new InvalidArgumentException($message);
}

return json_decode($json);
}
}
5 changes: 5 additions & 0 deletions src/JsonSchema/Validator.php
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,11 @@ public function validate(&$value, $schema = null, $checkMode = null)
// reset errors prior to validation
$this->reset();

// make sure $schema is an object
if (is_array($schema)) {
$schema = self::arrayToObjectRecursive($schema);
}

// set checkMode
$initialCheckMode = $this->factory->getConfig();
if ($checkMode !== null) {
Expand Down
59 changes: 59 additions & 0 deletions tests/ValidatorTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
<?php

namespace JsonSchema\Tests;

use JsonSchema\Constraints\Constraint;
use JsonSchema\Validator;

class ValidatorTest extends \PHPUnit_Framework_TestCase
{
public function testValidateWithAssocSchema()
{
$schema = json_decode('{"properties":{"propertyOne":{"type":"array","items":[{"type":"string"}]}}}', true);
$data = json_decode('{"propertyOne":[42]}', true);

$validator = new Validator();
$validator->validate($data, $schema);

$this->assertFalse($validator->isValid(), 'Validation succeeded, but should have failed.');
}

public function testBadAssocSchemaInput()
{
if (version_compare(phpversion(), '5.5.0', '<')) {
$this->markTestSkipped('PHP versions < 5.5.0 trigger an error on json_encode issues');
}
if (defined('HHVM_VERSION')) {
$this->markTestSkipped('HHVM has no problem with encoding resources');
}
$schema = array('propertyOne' => fopen('php://stdout', 'w'));
$data = json_decode('{"propertyOne":[42]}', true);

$validator = new Validator();

$this->setExpectedException('\JsonSchema\Exception\InvalidArgumentException');
$validator->validate($data, $schema);
}

public function testCheck()
{
$schema = json_decode('{"type":"string"}');
$data = json_decode('42');

$validator = new Validator();
$validator->check($data, $schema);

$this->assertFalse($validator->isValid(), 'Validation succeeded, but should have failed.');
}

public function testCoerce()
{
$schema = json_decode('{"type":"integer"}');
$data = json_decode('"42"');

$validator = new Validator();
$validator->coerce($data, $schema);

$this->assertTrue($validator->isValid(), 'Validation failed, but should have succeeded.');
}
}