Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
| 1 | <?php |
||
| 6 | class NamedFormElementTest extends TestCase |
||
| 7 | { |
||
| 8 | public function tearDown() |
||
| 9 | { |
||
| 10 | m::close(); |
||
| 11 | } |
||
| 12 | |||
| 13 | /** |
||
| 14 | * @param string $path |
||
| 15 | * @param string|null $label |
||
| 16 | * |
||
| 17 | * @return NamedFormElement |
||
| 18 | */ |
||
| 19 | protected function getElement($path = 'path', $label = null) |
||
| 20 | { |
||
| 21 | return $this->getMockForAbstractClass(NamedFormElement::class, [ |
||
| 22 | $path, |
||
| 23 | $label, |
||
| 24 | ]); |
||
| 25 | } |
||
| 26 | |||
| 27 | /** |
||
| 28 | * @covers NamedFormElement::__constructor |
||
| 29 | * @covers NamedFormElement::getLabel |
||
| 30 | * @covers NamedFormElement::setLabel |
||
| 31 | * @covers NamedFormElement::getPath |
||
| 32 | * @covers NamedFormElement::setPath |
||
| 33 | * @covers NamedFormElement::getName |
||
| 34 | * @covers NamedFormElement::setName |
||
| 35 | */ |
||
| 36 | public function test_constructor() |
||
| 37 | { |
||
| 38 | $element = $this->getElement($path = 'path.test.test1.tets2', $label = 'Label'); |
||
| 39 | |||
| 40 | $this->assertEquals($label, $element->getLabel()); |
||
| 41 | $this->assertEquals($path, $element->getPath()); |
||
| 42 | $this->assertEquals('path[test][test1][tets2]', $element->getName()); |
||
| 43 | } |
||
| 44 | |||
| 45 | /** |
||
| 46 | * @covers NamedFormElement::__constructor |
||
| 47 | * @expectedException \SleepingOwl\Admin\Exceptions\Form\FormElementException |
||
| 48 | */ |
||
| 49 | public function test_constructor_exception() |
||
| 50 | { |
||
| 51 | $this->getElement(null); |
||
| 52 | } |
||
| 53 | |||
| 54 | /** |
||
| 55 | * @covers NamedFormElement::setAttribute |
||
| 56 | * @covers NamedFormElement::getAttribute |
||
| 57 | */ |
||
| 58 | public function test_gets_and_sets_attribute() |
||
| 59 | { |
||
| 60 | $element = $this->getElement(); |
||
| 61 | |||
| 62 | $element->setModelAttributeKey('test'); |
||
| 63 | $this->assertEquals('test', $element->getModelAttributeKey()); |
||
| 64 | } |
||
| 65 | |||
| 66 | /** |
||
| 67 | * @covers NamedFormElement::setDefaultValue |
||
| 68 | * @covers NamedFormElement::getDefaultValue |
||
| 69 | */ |
||
| 70 | public function test_gets_and_sets_default_value() |
||
| 71 | { |
||
| 72 | $element = $this->getElement(); |
||
| 73 | |||
| 74 | $element->setDefaultValue('test'); |
||
| 75 | $this->assertEquals('test', $element->getDefaultValue()); |
||
| 76 | } |
||
| 77 | |||
| 78 | /** |
||
| 79 | * @covers NamedFormElement::setHelpText |
||
| 80 | * @covers NamedFormElement::getHelpText |
||
| 81 | */ |
||
| 82 | public function test_gets_and_sets_help_text() |
||
| 83 | { |
||
| 84 | $element = $this->getElement(); |
||
| 85 | |||
| 86 | $element->setHelpText('test'); |
||
| 87 | $this->assertEquals('test', $element->getHelpText()); |
||
| 88 | |||
| 89 | $helpText = m::mock(\Illuminate\Contracts\Support\Htmlable::class); |
||
| 90 | $helpText->shouldReceive('toHtml')->once()->andReturn('html'); |
||
| 91 | |||
| 92 | $element->setHelpText($helpText); |
||
| 93 | $this->assertEquals('html', $element->getHelpText()); |
||
| 94 | } |
||
| 95 | |||
| 96 | /** |
||
| 97 | * @covers NamedFormElement::required |
||
| 98 | * @covers NamedFormElement::getValidationRules |
||
| 99 | */ |
||
| 100 | public function test_add_required_rule() |
||
| 101 | { |
||
| 102 | $element = $this->getElement('key'); |
||
| 103 | |||
| 104 | $element->required(); |
||
| 105 | $this->assertEquals(['key' => ['required']], $element->getValidationRules()); |
||
| 106 | } |
||
| 107 | |||
| 108 | /** |
||
| 109 | * @covers NamedFormElement::required |
||
| 110 | * @covers NamedFormElement::getValidationMessages |
||
| 111 | */ |
||
| 112 | public function test_add_required_rule_with_message() |
||
| 113 | { |
||
| 114 | $element = $this->getElement('key'); |
||
| 115 | |||
| 116 | $element->required('required field'); |
||
| 117 | |||
| 118 | $this->assertEquals(['key.required' => 'required field'], $element->getValidationMessages()); |
||
| 119 | } |
||
| 120 | |||
| 121 | /** |
||
| 122 | * @covers NamedFormElement::required |
||
| 123 | * @covers NamedFormElement::getValidationRules |
||
| 124 | */ |
||
| 125 | public function test_add_unique_rule() |
||
| 126 | { |
||
| 127 | $element = $this->getElement('key'); |
||
| 128 | |||
| 129 | $model = m::mock(\Illuminate\Database\Eloquent\Model::class); |
||
| 130 | $element->setModel($model); |
||
| 131 | |||
| 132 | $model->shouldReceive('getTable')->once()->andReturn('test_table'); |
||
| 133 | |||
| 134 | $element->unique(); |
||
| 135 | $this->assertEquals(['key' => ['unique:test_table,key']], $element->getValidationRules()); |
||
| 136 | } |
||
| 137 | |||
| 138 | /** |
||
| 139 | * @covers NamedFormElement::unique |
||
| 140 | * @covers NamedFormElement::getValidationMessages |
||
| 141 | */ |
||
| 142 | public function test_add_unique_rule_with_message() |
||
| 143 | { |
||
| 144 | $element = $this->getElement('key'); |
||
| 145 | |||
| 146 | $element->unique('must be unique'); |
||
| 147 | $this->assertEquals(['key.unique' => 'must be unique'], $element->getValidationMessages()); |
||
| 148 | } |
||
| 149 | |||
| 150 | /** |
||
| 151 | * @covers NamedFormElement::addValidationMessage |
||
| 152 | * @covers NamedFormElement::getValidationMessages |
||
| 153 | */ |
||
| 154 | public function test_gets_validation_messages() |
||
| 155 | { |
||
| 156 | $element = $this->getElement('key'); |
||
| 157 | |||
| 158 | $element->addValidationMessage('test', 'test message'); |
||
| 159 | $element->addValidationMessage('hello', 'hello message'); |
||
| 160 | $this->assertEquals(['key.test' => 'test message', 'key.hello' => 'hello message'], $element->getValidationMessages()); |
||
| 161 | } |
||
| 162 | |||
| 163 | /** |
||
| 164 | * @covers NamedFormElement::getValidationLabels |
||
| 165 | */ |
||
| 166 | public function test_gets_validation_labels() |
||
| 167 | { |
||
| 168 | $element = $this->getElement('key.subkey', 'Label'); |
||
| 169 | |||
| 170 | $this->assertEquals(['key.subkey' => 'Label'], $element->getValidationLabels()); |
||
| 171 | } |
||
| 172 | |||
| 173 | /** |
||
| 174 | * @covers NamedFormElement::getValueFromRequest |
||
| 175 | */ |
||
| 176 | public function test_gets_session_value_from_request() |
||
| 177 | { |
||
| 178 | $request = $this->app['request']; |
||
| 179 | $session = $request->getSession(); |
||
| 180 | |||
| 181 | $element = $this->getElement('key.subkey', 'Label'); |
||
| 182 | $session->shouldReceive('getOldInput')->andReturn('test'); |
||
| 183 | |||
| 184 | $this->assertEquals('test', $element->getValueFromRequest($request)); |
||
| 185 | } |
||
| 186 | |||
| 187 | /** |
||
| 188 | * @covers NamedFormElement::getValueFromRequest |
||
| 189 | */ |
||
| 190 | public function test_gets_value_from_request() |
||
| 191 | { |
||
| 192 | /** @var \Illuminate\Http\Request $request */ |
||
| 193 | $request = $this->app['request']; |
||
| 194 | $request->offsetSet('key', [ |
||
| 195 | 'subkey1' => 'hello world', |
||
| 196 | ]); |
||
| 197 | |||
| 198 | $session = $request->getSession(); |
||
| 199 | |||
| 200 | $element = $this->getElement('key.subkey1', 'Label'); |
||
| 201 | $session->shouldReceive('getOldInput')->andReturn(null); |
||
| 202 | $this->assertEquals('hello world', $element->getValueFromRequest($request)); |
||
| 203 | } |
||
| 204 | |||
| 205 | /** |
||
| 206 | * @covers NamedFormElement::getValue |
||
| 207 | */ |
||
| 208 | public function test_gets_value_with_request() |
||
| 209 | { |
||
| 210 | $request = $this->app['request']; |
||
| 211 | |||
| 212 | $session = $request->getSession(); |
||
| 213 | $session->shouldReceive('getOldInput')->andReturn(null); |
||
| 214 | |||
| 215 | $element = $this->getElement('key.subkey', 'Label'); |
||
| 216 | $request->offsetSet('key', [ |
||
| 217 | 'subkey' => 'hello world', |
||
| 218 | ]); |
||
| 219 | |||
| 220 | $this->assertEquals('hello world', $element->getValueFromModel()); |
||
| 221 | } |
||
| 222 | |||
| 223 | /** |
||
| 224 | * @covers NamedFormElement::getValue |
||
| 225 | */ |
||
| 226 | public function test_gets_value() |
||
| 227 | { |
||
| 228 | $request = $this->app['request']; |
||
| 229 | $session = $request->getSession(); |
||
| 230 | $session->shouldReceive('getOldInput')->andReturn(null); |
||
| 231 | |||
| 232 | $element = $this->getElement('key', 'Label'); |
||
| 233 | |||
| 234 | $this->assertNull($element->getValueFromModel()); |
||
| 235 | |||
| 236 | $element->setModel($model = m::mock(\Illuminate\Database\Eloquent\Model::class)); |
||
| 237 | $model->shouldReceive('getAttribute')->with('key')->andReturn('value'); |
||
| 238 | |||
| 239 | $this->assertNull($element->getValue()); |
||
| 240 | |||
| 241 | $model->exists = true; |
||
| 242 | $this->assertEquals('value', $element->getValueFromModel()); |
||
| 243 | } |
||
| 244 | |||
| 245 | /** |
||
| 246 | * @covers NamedFormElement::resolvePath |
||
| 247 | */ |
||
| 248 | public function test_resolving_path() |
||
| 249 | { |
||
| 250 | $element = $this->getElement('key', 'Label'); |
||
| 251 | $element->setModel($model = m::mock(\Illuminate\Database\Eloquent\Model::class)); |
||
| 252 | |||
| 253 | $this->assertEquals($model, $element->resolvePath()); |
||
| 254 | |||
| 255 | // ------------- |
||
| 256 | |||
| 257 | $element = $this->getElement('key.subkey', 'Label'); |
||
| 258 | $element->setModel($model = m::mock(\Illuminate\Database\Eloquent\Model::class)); |
||
| 259 | $model->exists = true; |
||
| 260 | |||
| 261 | $model->shouldReceive('getAttribute')->andReturn($subModel = m::mock(\Illuminate\Database\Eloquent\Model::class)); |
||
| 262 | |||
| 263 | $this->assertEquals($subModel, $element->resolvePath()); |
||
| 264 | |||
| 265 | // ------------- |
||
| 266 | |||
| 267 | $element = $this->getElement('key.subkey', 'Label'); |
||
| 268 | $element->setModel($model = new NamedFormElementTestModuleForTestingResolvePath()); |
||
| 269 | |||
| 270 | $this->assertInstanceOf(NamedFormElementTestModuleForTestingResolvePathBelongsTo::class, $element->resolvePath()); |
||
| 271 | |||
| 272 | // ------------- |
||
| 273 | |||
| 274 | $element = $this->getElement('key1.subkey', 'Label'); |
||
| 275 | $element->setModel($model = new NamedFormElementTestModuleForTestingResolvePath()); |
||
| 276 | |||
| 277 | $this->assertInstanceOf(NamedFormElementTestModuleForTestingResolvePathHasOne::class, $element->resolvePath()); |
||
| 278 | |||
| 279 | // ------------- |
||
| 280 | |||
| 281 | $element = $this->getElement('key2.subkey', 'Label'); |
||
| 282 | $element->setModel($model = new NamedFormElementTestModuleForTestingResolvePath()); |
||
| 283 | |||
| 284 | $this->assertInstanceOf(NamedFormElementTestModuleForTestingResolvePathHasMany::class, $element->resolvePath()); |
||
| 285 | } |
||
| 286 | |||
| 287 | /** |
||
| 288 | * @covers NamedFormElement::toArray |
||
| 289 | */ |
||
| 290 | public function test_gets_array() |
||
| 291 | { |
||
| 292 | $element = $this->getElement('key2.subkey', 'Label'); |
||
| 293 | |||
| 294 | $request = $this->app['request']; |
||
| 295 | $session = $request->getSession(); |
||
| 296 | $session->shouldReceive('getOldInput')->andReturn(null); |
||
| 297 | |||
| 298 | $this->assertEquals([ |
||
| 299 | 'value' => null, |
||
| 300 | 'readonly' => false, |
||
| 301 | 'model' => null, |
||
| 302 | 'id' => 'key2[subkey]', |
||
| 303 | 'name' => 'key2[subkey]', |
||
| 304 | 'path' => 'key2.subkey', |
||
| 305 | 'label' => 'Label', |
||
| 306 | 'helpText' => null, |
||
| 307 | 'required' => false, |
||
| 308 | ], $element->toArray()); |
||
| 309 | } |
||
| 310 | |||
| 311 | public function test_save() |
||
| 472 |