FlexSequenceComponentTest::testJsonSerializeIncludesTraitProperties() - Code Metrics - Inspection of "add APL support" - maxbeckers/amazon-alexa-php - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#97)

by Maximilian

created 2025-10-06 14:11 UTC

testJsonSerializeIncludesTraitProperties() B

↳ Parent: FlexSequenceComponentTest

Complexity

Conditions	11
Paths	18

Size

Total Lines	50
Code Lines	32

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	11
eloc	32
c	0
b	0
f	0
nc	18
nop	0
dl	0
loc	50
rs	7.3166

How to fix Complexity

<?php

declare(strict_types=1);

namespace MaxBeckers\AmazonAlexa\Test\Response\Directives\APL\Component;

use MaxBeckers\AmazonAlexa\Request\ScrollDirection;
use MaxBeckers\AmazonAlexa\Response\Directives\APL\Component\APLBaseComponent;
use MaxBeckers\AmazonAlexa\Response\Directives\APL\Component\FlexSequenceComponent;
use MaxBeckers\AmazonAlexa\Response\Directives\APL\Component\Traits\ActionableComponentTrait;
use MaxBeckers\AmazonAlexa\Response\Directives\APL\Component\Traits\MultiChildComponentTrait;
use MaxBeckers\AmazonAlexa\Response\Directives\APL\Document\APLComponentType;
use MaxBeckers\AmazonAlexa\Response\Directives\APL\Document\FlexAlignItems;
use MaxBeckers\AmazonAlexa\Response\Directives\APL\Document\Snap;
use MaxBeckers\AmazonAlexa\Response\Directives\APL\StandardCommand\AbstractStandardCommand;
use MaxBeckers\AmazonAlexa\Response\Directives\APL\Component\Action; // added
use PHPUnit\Framework\TestCase;

class FlexSequenceComponentTest extends TestCase
{
    public function testConstructorWithAllParameters(): void
    {
        $alignItems = FlexAlignItems::CENTER;
        $numbered = true;
        $onScroll = [$this->createMock(AbstractStandardCommand::class)];
        $scrollDirection = ScrollDirection::VERTICAL;
        $snap = Snap::START;

        $component = new FlexSequenceComponent($alignItems, $numbered, $onScroll, $scrollDirection, $snap);

        $this->assertSame($alignItems, $component->alignItems);
        $this->assertTrue($component->numbered);
        $this->assertSame($onScroll, $component->onScroll);
        $this->assertSame($scrollDirection, $component->scrollDirection);
        $this->assertSame($snap, $component->snap);
    }

    public function testConstructorWithDefaultParameters(): void
    {
        $component = new FlexSequenceComponent();

        $this->assertNull($component->alignItems);
        $this->assertFalse($component->numbered);
        $this->assertNull($component->onScroll);
        $this->assertNull($component->scrollDirection);
        $this->assertNull($component->snap);
    }

    public function testJsonSerializeWithAllProperties(): void
    {
        $alignItems = FlexAlignItems::END;
        $onScroll = [
            $this->createMock(AbstractStandardCommand::class),
            $this->createMock(AbstractStandardCommand::class),
        ];
        $scrollDirection = ScrollDirection::HORIZONTAL;
        $snap = Snap::CENTER;

        $component = new FlexSequenceComponent($alignItems, true, $onScroll, $scrollDirection, $snap);
        $result = $component->jsonSerialize();

        $this->assertSame(APLComponentType::FLEX_SEQUENCE->value, $result['type']);
        $this->assertSame($alignItems->value, $result['alignItems']);
        $this->assertTrue($result['numbered']);
        $this->assertSame($onScroll, $result['onScroll']);
        $this->assertSame($scrollDirection->value, $result['scrollDirection']);
        $this->assertSame($snap->value, $result['snap']);
    }

    public function testJsonSerializeWithDefaultNumbered(): void
    {
        $component = new FlexSequenceComponent();
        $result = $component->jsonSerialize();

        $this->assertArrayNotHasKey('numbered', $result);
    }

    public function testJsonSerializeWithNumberedTrue(): void
    {
        $component = new FlexSequenceComponent(numbered: true);
        $result = $component->jsonSerialize();

        $this->assertTrue($result['numbered']);
    }

    public function testJsonSerializeWithEmptyOnScroll(): void
    {
        $component = new FlexSequenceComponent(onScroll: []);
        $result = $component->jsonSerialize();

        $this->assertArrayNotHasKey('onScroll', $result);
    }

    public function testJsonSerializeWithNullValues(): void
    {
        $component = new FlexSequenceComponent();
        $result = $component->jsonSerialize();

        $this->assertSame(APLComponentType::FLEX_SEQUENCE->value, $result['type']);
        $this->assertArrayNotHasKey('alignItems', $result);
        $this->assertArrayNotHasKey('onScroll', $result);
        $this->assertArrayNotHasKey('scrollDirection', $result);
        $this->assertArrayNotHasKey('snap', $result);
    }

    public function testTypeConstant(): void
    {
        $this->assertSame(APLComponentType::FLEX_SEQUENCE, FlexSequenceComponent::TYPE);
    }

    public function testExtendsAPLBaseComponent(): void
    {
        $component = new FlexSequenceComponent();

        $this->assertInstanceOf(APLBaseComponent::class, $component);
    }

    public function testUsesActionableComponentTrait(): void
    {
        $component = new FlexSequenceComponent();

        $this->assertTrue(in_array(
            ActionableComponentTrait::class,
            class_uses($component),
            true
        ));
    }

    public function testUsesMultiChildComponentTrait(): void
    {
        $component = new FlexSequenceComponent();

        $this->assertTrue(in_array(
            MultiChildComponentTrait::class,
            class_uses($component),
            true
        ));
    }

    public function testImplementsJsonSerializable(): void
    {
        $component = new FlexSequenceComponent();

        $this->assertInstanceOf(\JsonSerializable::class, $component);
    }

    /**
     * Ensure every public property exposed by the actionable & multi child traits
     * (when present on FlexSequenceComponent) is serialized when populated.
     */
    public function testJsonSerializeIncludesTraitProperties(): void
    {
        $component = new FlexSequenceComponent();

        // Candidate properties from ActionableComponentTrait & MultiChildComponentTrait (and some common APL base actionable hooks).
        $candidates = [
            // Actionable / gesture / event related:
            'actions', 'action', 'gestures',
            'onMount', 'onPress', 'onLongPress',
            'onSwipe', 'onScroll', 'onCursorEnter', 'onCursorExit', 'onCursorMove',
            'onDown', 'onUp', 'onCancel',
            'handleTick', 'handleVisibilityChange',
            // Multi-child:
            'item', 'items',
        ];

        $expected = [];

        foreach ($candidates as $prop) {
            if (!property_exists($component, $prop)) {
                continue;
            }

            if ($prop === 'item') {
                $expected[$prop] = ['child' => 1];
            } elseif ($prop === 'items') {
                $expected[$prop] = [['child' => 1], ['child' => 2]];
            } elseif ($prop === 'gestures') {
                $expected[$prop] = [['type' => 'TestGesture']];
            } elseif ($prop === 'action') {                      // changed: single Action
                $expected[$prop] = $this->createMock(Action::class);
            } elseif ($prop === 'actions') {                     // changed: array of Actions
                $expected[$prop] = [$this->createMock(Action::class)];
            } elseif (str_starts_with($prop, 'on') || str_starts_with($prop, 'handle')) {
                $expected[$prop] = [$this->createMock(AbstractStandardCommand::class)];
            } else {
                $expected[$prop] = ['value'];
            }

            $component->$prop = $expected[$prop];
        }

        $json = $component->jsonSerialize();

        // Basic type assertion
        $this->assertSame(APLComponentType::FLEX_SEQUENCE->value, $json['type']);

        foreach ($expected as $prop => $value) {
            $this->assertArrayHasKey($prop, $json, "Property '$prop' was not serialized.");
            $this->assertSame($value, $json[$prop], "Mismatch for serialized property '$prop'.");
        }
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace MaxBeckers\AmazonAlexa\Test\Response\Directives\APL\Component;
6
7			use MaxBeckers\AmazonAlexa\Request\ScrollDirection;
8			use MaxBeckers\AmazonAlexa\Response\Directives\APL\Component\APLBaseComponent;
9			use MaxBeckers\AmazonAlexa\Response\Directives\APL\Component\FlexSequenceComponent;
10			use MaxBeckers\AmazonAlexa\Response\Directives\APL\Component\Traits\ActionableComponentTrait;
11			use MaxBeckers\AmazonAlexa\Response\Directives\APL\Component\Traits\MultiChildComponentTrait;
12			use MaxBeckers\AmazonAlexa\Response\Directives\APL\Document\APLComponentType;
13			use MaxBeckers\AmazonAlexa\Response\Directives\APL\Document\FlexAlignItems;
14			use MaxBeckers\AmazonAlexa\Response\Directives\APL\Document\Snap;
15			use MaxBeckers\AmazonAlexa\Response\Directives\APL\StandardCommand\AbstractStandardCommand;
16			use MaxBeckers\AmazonAlexa\Response\Directives\APL\Component\Action; // added
17			use PHPUnit\Framework\TestCase;
18
19			class FlexSequenceComponentTest extends TestCase
20			{
21			public function testConstructorWithAllParameters(): void
22			{
23			$alignItems = FlexAlignItems::CENTER;
24			$numbered = true;
25			$onScroll = [$this->createMock(AbstractStandardCommand::class)];
26			$scrollDirection = ScrollDirection::VERTICAL;
27			$snap = Snap::START;
28
29			$component = new FlexSequenceComponent($alignItems, $numbered, $onScroll, $scrollDirection, $snap);
30
31			$this->assertSame($alignItems, $component->alignItems);
32			$this->assertTrue($component->numbered);
33			$this->assertSame($onScroll, $component->onScroll);
34			$this->assertSame($scrollDirection, $component->scrollDirection);
35			$this->assertSame($snap, $component->snap);
36			}
37
38			public function testConstructorWithDefaultParameters(): void
39			{
40			$component = new FlexSequenceComponent();
41
42			$this->assertNull($component->alignItems);
43			$this->assertFalse($component->numbered);
44			$this->assertNull($component->onScroll);
45			$this->assertNull($component->scrollDirection);
46			$this->assertNull($component->snap);
47			}
48
49			public function testJsonSerializeWithAllProperties(): void
50			{
51			$alignItems = FlexAlignItems::END;
52			$onScroll = [
53			$this->createMock(AbstractStandardCommand::class),
54			$this->createMock(AbstractStandardCommand::class),
55			];
56			$scrollDirection = ScrollDirection::HORIZONTAL;
57			$snap = Snap::CENTER;
58
59			$component = new FlexSequenceComponent($alignItems, true, $onScroll, $scrollDirection, $snap);
60			$result = $component->jsonSerialize();
61
62			$this->assertSame(APLComponentType::FLEX_SEQUENCE->value, $result['type']);
63			$this->assertSame($alignItems->value, $result['alignItems']);
64			$this->assertTrue($result['numbered']);
65			$this->assertSame($onScroll, $result['onScroll']);
66			$this->assertSame($scrollDirection->value, $result['scrollDirection']);
67			$this->assertSame($snap->value, $result['snap']);
68			}
69
70			public function testJsonSerializeWithDefaultNumbered(): void
71			{
72			$component = new FlexSequenceComponent();
73			$result = $component->jsonSerialize();
74
75			$this->assertArrayNotHasKey('numbered', $result);
76			}
77
78			public function testJsonSerializeWithNumberedTrue(): void
79			{
80			$component = new FlexSequenceComponent(numbered: true);
81			$result = $component->jsonSerialize();
82
83			$this->assertTrue($result['numbered']);
84			}
85
86			public function testJsonSerializeWithEmptyOnScroll(): void
87			{
88			$component = new FlexSequenceComponent(onScroll: []);
89			$result = $component->jsonSerialize();
90
91			$this->assertArrayNotHasKey('onScroll', $result);
92			}
93
94			public function testJsonSerializeWithNullValues(): void
95			{
96			$component = new FlexSequenceComponent();
97			$result = $component->jsonSerialize();
98
99			$this->assertSame(APLComponentType::FLEX_SEQUENCE->value, $result['type']);
100			$this->assertArrayNotHasKey('alignItems', $result);
101			$this->assertArrayNotHasKey('onScroll', $result);
102			$this->assertArrayNotHasKey('scrollDirection', $result);
103			$this->assertArrayNotHasKey('snap', $result);
104			}
105
106			public function testTypeConstant(): void
107			{
108			$this->assertSame(APLComponentType::FLEX_SEQUENCE, FlexSequenceComponent::TYPE);
109			}
110
111			public function testExtendsAPLBaseComponent(): void
112			{
113			$component = new FlexSequenceComponent();
114
115			$this->assertInstanceOf(APLBaseComponent::class, $component);
116			}
117
118			public function testUsesActionableComponentTrait(): void
119			{
120			$component = new FlexSequenceComponent();
121
122			$this->assertTrue(in_array(
123			ActionableComponentTrait::class,
124			class_uses($component),
125			true
126			));
127			}
128
129			public function testUsesMultiChildComponentTrait(): void
130			{
131			$component = new FlexSequenceComponent();
132
133			$this->assertTrue(in_array(
134			MultiChildComponentTrait::class,
135			class_uses($component),
136			true
137			));
138			}
139
140			public function testImplementsJsonSerializable(): void
141			{
142			$component = new FlexSequenceComponent();
143
144			$this->assertInstanceOf(\JsonSerializable::class, $component);
145			}
146
147			/**
148			* Ensure every public property exposed by the actionable & multi child traits
149			* (when present on FlexSequenceComponent) is serialized when populated.
150			*/
151			public function testJsonSerializeIncludesTraitProperties(): void
152			{
153			$component = new FlexSequenceComponent();
154
155			// Candidate properties from ActionableComponentTrait & MultiChildComponentTrait (and some common APL base actionable hooks).
156			$candidates = [
157			// Actionable / gesture / event related:
158			'actions', 'action', 'gestures',
159			'onMount', 'onPress', 'onLongPress',
160			'onSwipe', 'onScroll', 'onCursorEnter', 'onCursorExit', 'onCursorMove',
161			'onDown', 'onUp', 'onCancel',
162			'handleTick', 'handleVisibilityChange',
163			// Multi-child:
164			'item', 'items',
165			];
166
167			$expected = [];
168
169			foreach ($candidates as $prop) {
170			if (!property_exists($component, $prop)) {
171			continue;
172			}
173
174			if ($prop === 'item') {
175			$expected[$prop] = ['child' => 1];
176			} elseif ($prop === 'items') {
177			$expected[$prop] = [['child' => 1], ['child' => 2]];
178			} elseif ($prop === 'gestures') {
179			$expected[$prop] = [['type' => 'TestGesture']];
180			} elseif ($prop === 'action') { // changed: single Action
181			$expected[$prop] = $this->createMock(Action::class);
182			} elseif ($prop === 'actions') { // changed: array of Actions
183			$expected[$prop] = [$this->createMock(Action::class)];
184			} elseif (str_starts_with($prop, 'on') \|\| str_starts_with($prop, 'handle')) {
185			$expected[$prop] = [$this->createMock(AbstractStandardCommand::class)];
186			} else {
187			$expected[$prop] = ['value'];
188			}
189
190			$component->$prop = $expected[$prop];
191			}
192
193			$json = $component->jsonSerialize();
194
195			// Basic type assertion
196			$this->assertSame(APLComponentType::FLEX_SEQUENCE->value, $json['type']);
197
198			foreach ($expected as $prop => $value) {
199			$this->assertArrayHasKey($prop, $json, "Property '$prop' was not serialized.");
200			$this->assertSame($value, $json[$prop], "Mismatch for serialized property '$prop'.");
201			}
202			}
203			}
204

maxbeckers / amazon-alexa-php

Pull Request — master (#97)

testJsonSerializeIncludesTraitProperties() B

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like