Merge branch '0.x' into 47-throw-exception-if-type-or-id-is-not-string

Author: Art4

CHANGELOG.md

@@ -61,6 +61,12 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - **BREAKING**: `Art4\JsonApiClient\Utils\Manager` removed, use `Art4\JsonApiClient\Manager\ErrorAbortManager` instead
 - **BREAKING**: `Art4\JsonApiClient\Utils\ManagerInterface` removed, use `Art4\JsonApiClient\Manager` instead
 
+## [0.10.1] - 2019-09-23
+
+### Deprecated
+
+- Providing the fields `type` or `id` in a resource not as a string will be throw a ValidationException in v1.0, provide them always as strings instead.
+
 ## [0.10] - 2018-11-07
 
 ### Added
@@ -304,7 +310,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - Validator fits nearly 100% specification
 - Full test coverage
 
-[Unreleased]: https://github.com/Art4/json-api-client/compare/0.10...HEAD
+[Unreleased]: https://github.com/Art4/json-api-client/compare/0.10.1...HEAD
+[0.10.1]: https://github.com/Art4/json-api-client/compare/0.10...0.10.1
 [0.10]: https://github.com/Art4/json-api-client/compare/0.9.1...0.10
 [0.9.1]: https://github.com/Art4/json-api-client/compare/0.9...0.9.1
 [0.9]: https://github.com/Art4/json-api-client/compare/0.8.1...0.9

src/V1/ResourceIdentifier.php

@@ -51,12 +51,20 @@ protected function parse($object)
  throw new ValidationException('A resource object MUST contain an id');
  }
 
- if (is_object($object->type) or is_array($object->type)) {
- throw new ValidationException('Resource type cannot be an array or object');
+ if (! is_string($object->type)) {
+ if (is_object($object->type) or is_array($object->type)) {
+ throw new ValidationException('Resource type cannot be an array or object');
+ }
+
+ @trigger_error('Parsing `type` not as string is deprecated since version 0.10.1 and will be throw an Exception in 1.0. Provide `type` always as string instead', E_USER_DEPRECATED);
  }
 
- if (is_object($object->id) or is_array($object->id)) {
- throw new ValidationException('Resource Id cannot be an array or object');
+ if (! is_string($object->id)) {
+ if (is_object($object->id) or is_array($object->id)) {
+ throw new ValidationException('Resource Id cannot be an array or object');
+ }
+
+ @trigger_error('Parsing `id` not as string is deprecated since version 0.10.1 and will be throw an Exception in 1.0. Provide `id` always as string instead', E_USER_DEPRECATED);
  }
 
  $this->set('type', strval($object->type));

src/V1/ResourceItem.php

@@ -48,8 +48,12 @@ protected function parse($object)
  throw new ValidationException('A resource object MUST contain a type');
  }
 
- if (is_object($object->type) or is_array($object->type)) {
- throw new ValidationException('Resource type cannot be an array or object');
+ if (! is_string($object->type)) {
+ if (is_object($object->type) or is_array($object->type)) {
+ throw new ValidationException('Resource type cannot be an array or object');
+ }
+
+ @trigger_error('Parsing `type` not as string is deprecated since version 0.10.1 and will be throw an Exception in 1.0. Provide `type` always as string instead', E_USER_DEPRECATED);
  }
 
  $this->set('type', strval($object->type));
@@ -62,8 +66,12 @@ protected function parse($object)
  throw new ValidationException('A resource object MUST contain an id');
  }
 
- if (is_object($object->id) or is_array($object->id)) {
- throw new ValidationException('Resource id cannot be an array or object');
+ if (! is_string($object->id)) {
+ if (is_object($object->id) or is_array($object->id)) {
+ throw new ValidationException('Resource id cannot be an array or object');
+ }
+
+ @trigger_error('Parsing `id` not as string is deprecated since version 0.10.1 and will be throw an Exception in 1.0. Provide `id` always as string instead', E_USER_DEPRECATED);
  }
 
  $this->set('id', strval($object->id));

tests/Fixtures/Factory.php

@@ -37,6 +37,10 @@ public function make($name, array $args = [])
  {
  return $this->testcase
  ->getMockBuilder('Art4\JsonApiClient\\' . $name . 'Interface') // Mock only the interfaces
+ ->disableOriginalConstructor()
+ ->disableOriginalClone()
+ ->disableArgumentCloning()
+ ->disallowMockingUnknownTypes()
  ->getMock();
  }
 }

tests/Fixtures/V1Factory.php

@@ -49,6 +49,11 @@ public function __construct($testcase)
  */
  public function make($name, array $args = [])
  {
- return $this->testcase->getMockBuilder(AccessableElement::class)->getMock();
+ return $this->testcase->getMockBuilder(AccessableElement::class)
+ ->disableOriginalConstructor()
+ ->disableOriginalClone()
+ ->disableArgumentCloning()
+ ->disallowMockingUnknownTypes()
+ ->getMock();
  }
 }

tests/files/16_type_and_id_as_integer.json

@@ -0,0 +1,10 @@
+{
+ "data": {
+ "type": "posts",
+ "id": 1,
+ "attributes": {
+ "title": "Post 1 title",
+ "content": "Post 1 content"
+ }
+ }
+}