AssertResourceObject::assertHasValidFields() - Code Metrics - VGirol/JsonApi-Assert - Measure and Improve Code Quality continuously with Scrutinizer

AssertResourceObject::assertHasValidFields() A
last analyzed 2021-04-04 22:06 UTC

↳ Parent: AssertResourceObject

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	1
dl	0
loc	3
ccs	2
cts	2
cp	1
crap	1
rs	10
c	0
b	0
f	0

<?php

declare(strict_types=1);

namespace VGirol\JsonApiAssert\Asserts\Structure;

/**
 * Assertions relating to the resource object
 */
trait AssertResourceObject
{
    /**
     * Asserts that a json fragment is a valid collection of resource objects.
     *
     * It will do the following checks :
     * 1) asserts that the provided resource collection is either an empty array or an array of objects
     * (@see assertIsArrayOfObjects).
     * 2) asserts that the collection of resources is valid (@see assertIsValidResourceObject).
     *
     * @param array|null $json
     * @param boolean    $strict If true, unsafe characters are not allowed when checking members name.
     *
     * @return void
     * @throws \PHPUnit\Framework\AssertionFailedError
     */
    public static function assertIsValidResourceObjectCollection($json, bool $strict): void
    {
        static::askService('validateResourceObjectCollection', $json, $strict);
    }

    /**
     * Asserts that a json fragment is a valid resource.
     *
     * It will do the following checks :
     * 1) asserts that the resource object has valid top-level structure
     * (@see assertResourceObjectHasValidTopLevelStructure).
     * 2) asserts that the resource object has valid "type" and "id" members
     * (@see assertResourceIdMember and @see assertResourceTypeMember).
     * 3) asserts that the resource object has valid fields (@see assertHasValidFields).
     *
     * Optionaly, if presents, it will checks :
     * 4) asserts thats the resource object has valid "attributes" member.
     * 5) asserts thats the resource object has valid "relationships" member.
     * 6) asserts thats the resource object has valid "links" member.
     * 7) asserts thats the resource object has valid "meta" member.
     *
     * @param array   $json
     * @param boolean $strict If true, unsafe characters are not allowed when checking members name.
     *
     * @return void
     * @throws \PHPUnit\Framework\AssertionFailedError
     */
    public static function assertIsValidResourceObject($json, bool $strict): void
    {
        static::askService('validateResourceObject', $json, $strict);
    }

    /**
     * Asserts that a resource object has a valid top-level structure.
     *
     * It will do the following checks :
     * 1) asserts that the resource has an "id" member.
     * 2) asserts that the resource has a "type" member.
     * 3) asserts that the resource contains at least one of the following members :
     * "attributes", "relationships", "links", "meta" (@see assertContainsAtLeastOneMember).
     * 4) asserts that the resource contains only the following allowed members :
     * "id", "type", "meta", "attributes", "links", "relationships" (@see assertContainsOnlyAllowedMembers).
     *
     * @param array $resource
     * @param boolean $strict   If true, unsafe characters are not allowed when checking members name.
     *
     * @return void
     * @throws \PHPUnit\Framework\AssertionFailedError
     */
    public static function assertResourceObjectHasValidTopLevelStructure($resource, bool $strict): void
    {
        static::askService('validateResourceObjectTopLevelStructure', $resource, $strict);
    }

    /**
     * Asserts that a resource id member is valid.
     *
     * It will do the following checks :
     * 1) asserts that the "id" member is not empty.
     * 2) asserts that the "id" member is a string.
     *
     * @param array $resource
     *
     * @return void
     * @throws \PHPUnit\Framework\AssertionFailedError
     */
    public static function assertResourceIdMember($resource): void
    {
        static::askService('validateResourceIdMember', $resource);
    }

    /**
     * Asserts that a resource type member is valid.
     *
     * It will do the following checks :
     * 1) asserts that the "type" member is not empty.
     * 2) asserts that the "type" member is a string.
     * 3) asserts that the "type" member has a valid value (@see assertIsValidMemberName).
     *
     * @param array   $resource
     * @param boolean $strict   If true, excludes not safe characters when checking members name
     *
     * @return void
     * @throws \PHPUnit\Framework\AssertionFailedError
     */
    public static function assertResourceTypeMember($resource, bool $strict): void
    {
        static::askService('validateResourceTypeMember', $resource, $strict);
    }

    /**
     * Asserts that a json fragment is a valid resource links object.
     *
     * It will do the following checks :
     * 1) asserts that le links object is valid (@see assertIsValidLinksObject) with only "self" member allowed.
     *
     * @param array   $json
     * @param boolean $strict If true, excludes not safe characters when checking members name
     *
     * @return void
     * @throws \PHPUnit\Framework\AssertionFailedError
     */
    public static function assertIsValidResourceLinksObject($json, bool $strict): void
    {
        static::askService('validateResourceLinksObject', $json, $strict);
    }

    /**
     * Asserts that a resource object has valid fields (i.e., resource object’s attributes and its relationships).
     *
     * It will do the following checks :
     * 1) asserts that each attributes member and each relationship name is valid
     * (@see assertIsNotForbiddenResourceFieldName)
     *
     * @param array $resource
     *
     * @return void
     * @throws \PHPUnit\Framework\AssertionFailedError
     */
    public static function assertHasValidFields($resource): void
    {
        static::askService('validateFields', $resource);
    }

    /**
     * Asserts that a resource field name is not a forbidden name (like "type" or "id").
     *
     * @param string $name
     *
     * @return void
     * @throws \PHPUnit\Framework\AssertionFailedError
     */
    public static function assertIsNotForbiddenResourceFieldName(string $name): void
    {
        static::askService('isNotForbiddenResourceFieldName', $name);
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace VGirol\JsonApiAssert\Asserts\Structure;
6
7		/**
8		* Assertions relating to the resource object
9		*/
10		trait AssertResourceObject
11		{
12		/**
13		* Asserts that a json fragment is a valid collection of resource objects.
14		*
15		* It will do the following checks :
16		* 1) asserts that the provided resource collection is either an empty array or an array of objects
17		* (@see assertIsArrayOfObjects).
18		* 2) asserts that the collection of resources is valid (@see assertIsValidResourceObject).
19		*
20		* @param array\|null $json
21		* @param boolean $strict If true, unsafe characters are not allowed when checking members name.
22		*
23		* @return void
24		* @throws \PHPUnit\Framework\AssertionFailedError
25		*/
26	15	public static function assertIsValidResourceObjectCollection($json, bool $strict): void
27		{
28	15	static::askService('validateResourceObjectCollection', $json, $strict);
29	6	}
30
31		/**
32		* Asserts that a json fragment is a valid resource.
33		*
34		* It will do the following checks :
35		* 1) asserts that the resource object has valid top-level structure
36		* (@see assertResourceObjectHasValidTopLevelStructure).
37		* 2) asserts that the resource object has valid "type" and "id" members
38		* (@see assertResourceIdMember and @see assertResourceTypeMember).
39		* 3) asserts that the resource object has valid fields (@see assertHasValidFields).
40		*
41		* Optionaly, if presents, it will checks :
42		* 4) asserts thats the resource object has valid "attributes" member.
43		* 5) asserts thats the resource object has valid "relationships" member.
44		* 6) asserts thats the resource object has valid "links" member.
45		* 7) asserts thats the resource object has valid "meta" member.
46		*
47		* @param array $json
48		* @param boolean $strict If true, unsafe characters are not allowed when checking members name.
49		*
50		* @return void
51		* @throws \PHPUnit\Framework\AssertionFailedError
52		*/
53	36	public static function assertIsValidResourceObject($json, bool $strict): void
54		{
55	36	static::askService('validateResourceObject', $json, $strict);
56	3	}
57
58		/**
59		* Asserts that a resource object has a valid top-level structure.
60		*
61		* It will do the following checks :
62		* 1) asserts that the resource has an "id" member.
63		* 2) asserts that the resource has a "type" member.
64		* 3) asserts that the resource contains at least one of the following members :
65		* "attributes", "relationships", "links", "meta" (@see assertContainsAtLeastOneMember).
66		* 4) asserts that the resource contains only the following allowed members :
67		* "id", "type", "meta", "attributes", "links", "relationships" (@see assertContainsOnlyAllowedMembers).
68		*
69		* @param array $resource
70		* @param boolean $strict If true, unsafe characters are not allowed when checking members name.
71		*
72		* @return void
73		* @throws \PHPUnit\Framework\AssertionFailedError
74		*/
75	18	public static function assertResourceObjectHasValidTopLevelStructure($resource, bool $strict): void
76		{
77	18	static::askService('validateResourceObjectTopLevelStructure', $resource, $strict);
78	3	}
79
80		/**
81		* Asserts that a resource id member is valid.
82		*
83		* It will do the following checks :
84		* 1) asserts that the "id" member is not empty.
85		* 2) asserts that the "id" member is a string.
86		*
87		* @param array $resource
88		*
89		* @return void
90		* @throws \PHPUnit\Framework\AssertionFailedError
91		*/
92	9	public static function assertResourceIdMember($resource): void
93		{
94	9	static::askService('validateResourceIdMember', $resource);
95	3	}
96
97		/**
98		* Asserts that a resource type member is valid.
99		*
100		* It will do the following checks :
101		* 1) asserts that the "type" member is not empty.
102		* 2) asserts that the "type" member is a string.
103		* 3) asserts that the "type" member has a valid value (@see assertIsValidMemberName).
104		*
105		* @param array $resource
106		* @param boolean $strict If true, excludes not safe characters when checking members name
107		*
108		* @return void
109		* @throws \PHPUnit\Framework\AssertionFailedError
110		*/
111	15	public static function assertResourceTypeMember($resource, bool $strict): void
112		{
113	15	static::askService('validateResourceTypeMember', $resource, $strict);
114	3	}
115
116		/**
117		* Asserts that a json fragment is a valid resource links object.
118		*
119		* It will do the following checks :
120		* 1) asserts that le links object is valid (@see assertIsValidLinksObject) with only "self" member allowed.
121		*
122		* @param array $json
123		* @param boolean $strict If true, excludes not safe characters when checking members name
124		*
125		* @return void
126		* @throws \PHPUnit\Framework\AssertionFailedError
127		*/
128	6	public static function assertIsValidResourceLinksObject($json, bool $strict): void
129		{
130	6	static::askService('validateResourceLinksObject', $json, $strict);
131	3	}
132
133		/**
134		* Asserts that a resource object has valid fields (i.e., resource object’s attributes and its relationships).
135		*
136		* It will do the following checks :
137		* 1) asserts that each attributes member and each relationship name is valid
138		* (@see assertIsNotForbiddenResourceFieldName)
139		*
140		* @param array $resource
141		*
142		* @return void
143		* @throws \PHPUnit\Framework\AssertionFailedError
144		*/
145	12	public static function assertHasValidFields($resource): void
146		{
147	12	static::askService('validateFields', $resource);
148	3	}
149
150		/**
151		* Asserts that a resource field name is not a forbidden name (like "type" or "id").
152		*
153		* @param string $name
154		*
155		* @return void
156		* @throws \PHPUnit\Framework\AssertionFailedError
157		*/
158	9	public static function assertIsNotForbiddenResourceFieldName(string $name): void
159		{
160	9	static::askService('isNotForbiddenResourceFieldName', $name);
161	3	}
162		}
163

VGirol / JsonApi-Assert

AssertResourceObject::assertHasValidFields() A last analyzed 2021-04-04 22:06 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

AssertResourceObject::assertHasValidFields() A
last analyzed 2021-04-04 22:06 UTC