AssertJsonResponse::seeJsonTypedStructure() - Code Metrics - Inspection of "✨ Add seeArrayTypedStructure and seeJsonTypedStruc..." - laravelfr/api-testing - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 1e4339...858a7e )

by Mathieu

created 2017-07-31 14:19 UTC

AssertJsonResponse::seeJsonTypedStructure() A

↳ Parent: AssertJsonResponse

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	8
ccs	5
cts	5
cp	1
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	4
nc	2
nop	2
crap	2

<?php

namespace LaravelFr\ApiTesting;

use Illuminate\Foundation\Testing\TestResponse;

trait AssertJsonResponse
{
    use AssertArrays;

    public function __construct()
    {
        if (class_exists(TestResponse::class)) {
            $this->addJsonResponseMacros();
        }
    }

    /**
     * Add the functions to the TestResponse objects.
     */
    public function addJsonResponseMacros()
    {
        $trait = $this;

        TestResponse::macro('assertJsonStructureEquals', function ($structure) use ($trait) {
            return $trait->assertJsonStructureEquals($structure, $this->decodeResponseJson());
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        });

        TestResponse::macro('seeJsonTypedStructure', function ($structure) use ($trait) {
            return $trait->seeJsonTypedStructure($structure, $this->decodeResponseJson());
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        });

        TestResponse::macro('jsonResponse', function ($key = null) use ($trait) {
            return $trait->jsonResponse($key, $this->decodeResponseJson());
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        });
    }

    /**
     * Assert that the JSON response has exactly the given structure.
     *
     * @param  array $structure
     * @param  array|null $responseData
     *
     * @return $this
     */
    public function assertJsonStructureEquals($structure, $responseData = null)
    {
        if (!$responseData) {
            $responseData = $this->decodeResponseJson();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        }

        return $this->assertArrayStructureEquals($structure, $responseData);
    }

    /**
     * Assert that the JSON response has a given typed structure.
     *
     * @param  array $structure
     * @param  array|null $responseData
     * @return $this
     */
    public function seeJsonTypedStructure($structure, $responseData = null)
    {
        if (!$responseData) {
            $responseData = $this->decodeResponseJson();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        }

        return $this->seeArrayTypedStructure($structure, $responseData);
    }

    /**
     * Return the json response or a part of it as an array.
     *
     * @param  string $key
     * @param  array|null $responseData
     *
     * @return mixed
     */
    public function jsonResponse($key = null, $responseData = null)
    {
        if (!$responseData) {
            $responseData = $this->decodeResponseJson();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        }

        return array_get($responseData, $key);
    }
}


1		<?php
2
3		namespace LaravelFr\ApiTesting;
4
5		use Illuminate\Foundation\Testing\TestResponse;
6
7		trait AssertJsonResponse
8		{
9		use AssertArrays;
10
11		public function __construct()
12		{
13		if (class_exists(TestResponse::class)) {
14		$this->addJsonResponseMacros();
15		}
16		}
17
18		/**
19		* Add the functions to the TestResponse objects.
20		*/
21		public function addJsonResponseMacros()
22		{
23		$trait = $this;
24
25		TestResponse::macro('assertJsonStructureEquals', function ($structure) use ($trait) {
26		return $trait->assertJsonStructureEquals($structure, $this->decodeResponseJson());
		1 ignored issue – show Bug introduced 2017-07-31 11:50 UTC by Report Bug Copy Issue Report It seems like `decodeResponseJson()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
27		});
28
29		TestResponse::macro('seeJsonTypedStructure', function ($structure) use ($trait) {
30		return $trait->seeJsonTypedStructure($structure, $this->decodeResponseJson());
		1 ignored issue – show Bug introduced 2017-07-31 14:20 UTC by Report Bug Copy Issue Report It seems like `decodeResponseJson()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
31		});
32
33		TestResponse::macro('jsonResponse', function ($key = null) use ($trait) {
34		return $trait->jsonResponse($key, $this->decodeResponseJson());
		1 ignored issue – show Bug introduced 2017-07-31 11:50 UTC by Report Bug Copy Issue Report It seems like `decodeResponseJson()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
35		});
36		}
37
38		/**
39		* Assert that the JSON response has exactly the given structure.
40		*
41		* @param array $structure
42		* @param array\|null $responseData
43		*
44		* @return $this
45		*/
46	1	public function assertJsonStructureEquals($structure, $responseData = null)
47		{
48	1	if (!$responseData) {
49	1	$responseData = $this->decodeResponseJson();
		1 ignored issue – show Bug introduced 2016-12-07 16:15 UTC by Report Bug Copy Issue Report It seems like `decodeResponseJson()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
50	1	}
51
52	1	return $this->assertArrayStructureEquals($structure, $responseData);
53		}
54
55		/**
56		* Assert that the JSON response has a given typed structure.
57		*
58		* @param array $structure
59		* @param array\|null $responseData
60		* @return $this
61		*/
62	1	public function seeJsonTypedStructure($structure, $responseData = null)
63		{
64	1	if (!$responseData) {
65	1	$responseData = $this->decodeResponseJson();
		1 ignored issue – show Bug introduced 2016-12-07 16:15 UTC by Report Bug Copy Issue Report It seems like `decodeResponseJson()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
66	1	}
67
68	1	return $this->seeArrayTypedStructure($structure, $responseData);
69		}
70
71		/**
72		* Return the json response or a part of it as an array.
73		*
74		* @param string $key
75		* @param array\|null $responseData
76		*
77		* @return mixed
78		*/
79	1	public function jsonResponse($key = null, $responseData = null)
80		{
81	1	if (!$responseData) {
82	1	$responseData = $this->decodeResponseJson();
		1 ignored issue – show Bug introduced 2017-07-31 14:20 UTC by Report Bug Copy Issue Report It seems like `decodeResponseJson()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
83	1	}
84
85	1	return array_get($responseData, $key);
86		}
87		}
88

laravelfr / api-testing

Push — master ( 1e4339...858a7e )

AssertJsonResponse::seeJsonTypedStructure() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like