summaryrefslogtreecommitdiff
path: root/www/wiki/vendor/param-processor/param-processor/tests/Unit/ParamDefinitionFactoryTest.php
blob: 1e7277137562499777515fb7dada4d3d9ececd2b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
<?php

namespace ParamProcessor\Tests\Unit;

use ParamProcessor\ParamDefinition;
use ParamProcessor\ParamDefinitionFactory;
use ParamProcessor\ParameterTypes;
use PHPUnit\Framework\TestCase;

/**
 * @covers \ParamProcessor\ParamDefinitionFactory
 *
 * @licence GNU GPL v2+
 * @author Jeroen De Dauw < jeroendedauw@gmail.com >
 */
class ParamDefinitionFactoryTest extends TestCase {

	public function testNewDefinitionFromArray() {
		$definition = ParamDefinitionFactory::newDefault()->newDefinitionFromArray(
			[
				'name' => 'some-list',
				'type' => 'integer',
				'message' => 'test-message',
				'islist' => true
			]
		);

		$this->assertSame( 'some-list', $definition->getName() );
		$this->assertSame( 'integer', $definition->getType() );
		$this->assertSame( 'test-message', $definition->getMessage() );
		$this->assertTrue( $definition->isList() );
		$this->assertTrue( $definition->isRequired() );
	}

	public function testNewDefinition() {
		$definition = ParamDefinitionFactory::newDefault()->newDefinition(
			'integer',
			'some-list',
			null,
			'test-message',
			true
		);

		$this->assertSame( 'some-list', $definition->getName() );
		$this->assertSame( 'integer', $definition->getType() );
		$this->assertSame( 'test-message', $definition->getMessage() );
		$this->assertTrue( $definition->isList() );
		$this->assertTrue( $definition->isRequired() );
	}

	public function testNewDefinitionFromArray_typeDefaultsToString() {
		$this->assertSame( 'string', $this->newBasicParamFromArray()->getType() );
	}

	private function newBasicParamFromArray(): ParamDefinition {
		return ParamDefinitionFactory::newDefault()->newDefinitionFromArray(
			[
				'name' => 'irrelevant',
				'message' => 'irrelevant'
			]
		);
	}

	public function testNewDefinitionFromArray_isListDefaultsToFalse() {
		$this->assertFalse( $this->newBasicParamFromArray()->isList() );
	}

	public function testNewDefinitionFromArray_isRequiredDefaultsToTrue() {
		$this->assertTrue( $this->newBasicParamFromArray()->isRequired() );
	}

	public function testNewDefinitionFromArray_optionsAreSet() {
		$arrayDefinition = [
			'name' => 'some-list',
			'type' => 'integer',
			'message' => 'test-message',
			'islist' => true
		];

		$definition = ParamDefinitionFactory::newDefault()->newDefinitionFromArray( $arrayDefinition );

		$this->assertSame( $arrayDefinition, $definition->getOptions() );
	}

	public function testNewDefinitionsFromArrays_preservesDefinitionInstances() {
		$this->assertEquals(
			[
				'kittens' => new ParamDefinition( ParameterTypes::STRING, 'kittens' ),
				'cats' => new ParamDefinition( ParameterTypes::INTEGER, 'cats' ),
			],
			ParamDefinitionFactory::newDefault()->newDefinitionsFromArrays(
				[
					new ParamDefinition( ParameterTypes::STRING, 'kittens' ),
					new ParamDefinition( ParameterTypes::INTEGER, 'cats' ),
				]
			)
		);
	}

	public function testNewDefinitionsFromArrays_handlesNamesAsKeys() {
		$definitions = ParamDefinitionFactory::newDefault()->newDefinitionsFromArrays(
			[
				'kittens' => [
					'type' => ParameterTypes::STRING,
					'message' => 'test-message',
				]
			]
		);

		$this->assertSame( 'kittens', $definitions['kittens']->getName() );
	}

	public function testNewDefinitionsFromArrays_nameFieldTakesPriorityOverKey() {
		$definitions = ParamDefinitionFactory::newDefault()->newDefinitionsFromArrays(
			[
				'cats' => [
					'name' => 'kittens',
					'type' => ParameterTypes::STRING,
					'message' => 'test-message',
				]
			]
		);

		$this->assertSame( 'kittens', $definitions['kittens']->getName() );
	}

	public function testNewDefinitionsFromArrays_missingNameLeadsToException() {
		$this->expectException( \Exception::class );

		ParamDefinitionFactory::newDefault()->newDefinitionsFromArrays(
			[
				[
					'type' => ParameterTypes::STRING,
					'message' => 'test-message',
				]
			]
		);
	}

}