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 |
||
| 18 | class ActiveRecordAbstractTest extends \PHPUnit_Framework_TestCase { |
||
| 19 | |||
| 20 | /** |
||
| 21 | * Checking values setting |
||
| 22 | * |
||
| 23 | * @covers ::db |
||
| 24 | * @covers ::setDb |
||
| 25 | * @covers ::tableName |
||
| 26 | * @covers ::calcTableName |
||
| 27 | * @covers ::dbPrepareQuery |
||
| 28 | */ |
||
| 29 | public function testDbData() { |
||
| 30 | $this->assertEquals(\classSupernova::services()->db, RecordActiveAbstractObject::db()); |
||
| 31 | |||
| 32 | $db = new \db_mysql(new GlobalContainer()); |
||
| 33 | RecordActiveAbstractObject::setDb($db); |
||
| 34 | $this->assertAttributeEquals($db, 'db', 'DBAL\Tests\Fixtures\RecordActiveAbstractObject'); |
||
| 35 | $this->assertEquals($db, RecordActiveAbstractObject::db()); |
||
| 36 | |||
| 37 | $this->assertEquals('active_abstract_object', RecordActiveAbstractObject::tableName()); |
||
| 38 | $this->assertEquals('active_abstract_object_dump', ActiveAbstractObjectDump::tableName()); |
||
| 39 | |||
| 40 | $dbq = invokeMethod(RecordActiveAbstractObject::class, 'dbPrepareQuery'); |
||
| 41 | $this->assertEquals("DBAL\\DbQuery", get_class($dbq)); |
||
| 42 | $this->assertAttributeEquals('active_abstract_object', 'table', $dbq); |
||
| 43 | } |
||
| 44 | |||
| 45 | /** |
||
| 46 | * @covers ::haveTranslationToProperty |
||
| 47 | */ |
||
| 48 | public function testHaveTranslationToProperty() { |
||
| 49 | // Direct access field have NO translation |
||
| 50 | $this->assertFalse(invokeMethod(RecordActiveAbstractObject::class, 'haveTranslationToProperty', ['varchar'])); |
||
| 51 | // Translated field DO HAVE translation |
||
| 52 | $this->assertTrue(invokeMethod(RecordActiveAbstractObject::class, 'haveTranslationToProperty', ['timestamp_current'])); |
||
| 53 | // Property name have NO translation |
||
| 54 | $this->assertFalse(invokeMethod(RecordActiveAbstractObject::class, 'haveTranslationToProperty', ['timestampCurrent'])); |
||
| 55 | // Not exists field have NO translation |
||
| 56 | $this->assertFalse(invokeMethod(RecordActiveAbstractObject::class, 'haveTranslationToProperty', ['notAField'])); |
||
| 57 | } |
||
| 58 | |||
| 59 | /** |
||
| 60 | * @covers ::haveField |
||
| 61 | */ |
||
| 62 | public function testHaveField() { |
||
| 63 | // Checking for fields and properties |
||
| 64 | $this->assertTrue(invokeMethod(RecordActiveAbstractObject::class, 'haveField', ['varchar'])); |
||
| 65 | $this->assertTrue(invokeMethod(RecordActiveAbstractObject::class, 'haveField', ['timestamp_current'])); |
||
| 66 | $this->assertFalse(invokeMethod(RecordActiveAbstractObject::class, 'haveField', ['timestampCurrent'])); |
||
| 67 | $this->assertFalse(invokeMethod(RecordActiveAbstractObject::class, 'haveField', ['notAField'])); |
||
| 68 | } |
||
| 69 | |||
| 70 | /** |
||
| 71 | * @covers ::haveProperty |
||
| 72 | */ |
||
| 73 | public function testHaveProperty() { |
||
| 74 | $this->assertTrue(invokeMethod(RecordActiveAbstractObject::class, 'haveProperty', ['varchar'])); |
||
| 75 | $this->assertTrue(invokeMethod(RecordActiveAbstractObject::class, 'haveProperty', ['timestampCurrent'])); |
||
| 76 | $this->assertFalse(invokeMethod(RecordActiveAbstractObject::class, 'haveProperty', ['timestamp_current'])); |
||
| 77 | $this->assertFalse(invokeMethod(RecordActiveAbstractObject::class, 'haveProperty', ['notAField'])); |
||
| 78 | } |
||
| 79 | |||
| 80 | |||
| 81 | public function dataGetPropertyName() { |
||
| 82 | return |
||
| 83 | [ |
||
| 84 | ['varchar', 'varchar'], |
||
| 85 | ['timestamp_current', 'timestampCurrent'], |
||
| 86 | ['timestampCurrent', ''], |
||
| 87 | ['notAField', ''], |
||
| 88 | ]; |
||
| 89 | } |
||
| 90 | |||
| 91 | /** |
||
| 92 | * @covers ::getPropertyName |
||
| 93 | * @dataProvider dataGetPropertyName |
||
| 94 | */ |
||
| 95 | public function testGetPropertyName($param, $expected) { |
||
| 96 | $this->assertEquals($expected, invokeMethod(RecordActiveAbstractObject::class, 'getPropertyName', [$param])); |
||
| 97 | } |
||
| 98 | |||
| 99 | |||
| 100 | /** |
||
| 101 | * @return array |
||
| 102 | */ |
||
| 103 | public function dataGetFieldName() { |
||
| 104 | return |
||
| 105 | [ |
||
| 106 | ['varchar', 'varchar'], |
||
| 107 | ['timestampCurrent', 'timestamp_current'], |
||
| 108 | ['timestamp_current', ''], |
||
| 109 | ['notAField', ''], |
||
| 110 | ]; |
||
| 111 | } |
||
| 112 | |||
| 113 | /** |
||
| 114 | * @covers ::getFieldName |
||
| 115 | * @dataProvider dataGetFieldName |
||
| 116 | */ |
||
| 117 | public function testGetFieldName($param, $expected) { |
||
| 118 | $this->assertEquals($expected, invokeMethod(RecordActiveAbstractObject::class, 'getFieldName', [$param])); |
||
| 119 | } |
||
| 120 | |||
| 121 | /** |
||
| 122 | * @covers ::translateNames |
||
| 123 | */ |
||
| 124 | public function testTranslation() { |
||
| 125 | // Fields to Properties |
||
| 126 | $this->assertEquals( |
||
| 127 | [ |
||
| 128 | 'timestampCurrent' => TEST_VALUE_SQL_DATE, |
||
| 129 | 'varchar' => 'varvalue', |
||
| 130 | // TODO - add incorrect field |
||
| 131 | ], |
||
| 132 | invokeMethod(RecordActiveAbstractObject::class, 'translateNames', [ |
||
| 133 | [ |
||
| 134 | 'timestamp_current' => TEST_VALUE_SQL_DATE, |
||
| 135 | 'varchar' => 'varvalue', |
||
| 136 | 'notAField' => 'test', |
||
| 137 | ], |
||
| 138 | ActiveRecordAbstract::FIELDS_TO_PROPERTIES |
||
| 139 | ])); |
||
| 140 | |||
| 141 | // Properties to Fields |
||
| 142 | $this->assertEquals( |
||
| 143 | [ |
||
| 144 | 'timestamp_current' => TEST_VALUE_SQL_DATE, |
||
| 145 | 'varchar' => 'varvalue', |
||
| 146 | ], |
||
| 147 | invokeMethod(RecordActiveAbstractObject::class, 'translateNames', [ |
||
| 148 | [ |
||
| 149 | 'timestampCurrent' => TEST_VALUE_SQL_DATE, |
||
| 150 | 'varchar' => 'varvalue', |
||
| 151 | 'notAProperty' => 'test', |
||
| 152 | ], |
||
| 153 | ActiveRecordAbstract::PROPERTIES_TO_FIELDS |
||
| 154 | ])); |
||
| 155 | } |
||
| 156 | |||
| 157 | /** |
||
| 158 | * @covers ::__construct |
||
| 159 | * @covers ::AcceptChanges |
||
| 160 | */ |
||
| 161 | public function testConstructor() { |
||
| 162 | $object = new RecordActiveAbstractObject(); |
||
| 163 | $this->assertAttributeEquals(\classSupernova::$gc, 'services', $object); |
||
| 164 | $this->assertAttributeEquals(true, '_isNew', $object); |
||
| 165 | $this->assertEquals(0, $object->id); |
||
| 166 | |||
| 167 | $object->acceptChanges(); |
||
| 168 | $this->assertAttributeEquals(true, '_isNew', $object); |
||
| 169 | $this->assertEquals(0, $object->id); |
||
| 170 | |||
| 171 | $object->id = 5; |
||
| 172 | $object->acceptChanges(); |
||
| 173 | $this->assertAttributeEquals(false, '_isNew', $object); |
||
| 174 | $this->assertEquals(5, $object->id); |
||
| 175 | |||
| 176 | } |
||
| 177 | |||
| 178 | /** |
||
| 179 | * @covers ::defaultValues |
||
| 180 | * @covers ::fromProperties |
||
| 181 | * @covers ::buildEvenEmpty |
||
| 182 | * @covers ::build |
||
| 183 | */ |
||
| 184 | public function testBuild() { |
||
| 185 | // Testing empty buildEvenEmpty() |
||
| 186 | $this->assertEquals( |
||
| 187 | RecordActiveAbstractObject::class, |
||
| 188 | get_class(invokeMethod(RecordActiveAbstractObject::class, 'buildEvenEmpty', [[]])) |
||
| 189 | ); |
||
| 190 | |||
| 191 | // Testing empty build |
||
| 192 | $this->assertFalse(RecordActiveAbstractObject::build([])); |
||
| 193 | |||
| 194 | // Testing default values and overriding CURRENT_TIMESTAMP |
||
| 195 | $object = RecordActiveAbstractObject::build([ |
||
| 196 | 'timestampCurrent' => TEST_VALUE_SQL_DATE, |
||
| 197 | 'varchar' => 'varvalue', |
||
| 198 | ]); |
||
| 199 | $this->assertEquals(TEST_VALUE_SQL_DATE, $object->timestampCurrent); |
||
| 200 | $this->assertEquals('varvalue', $object->varchar); |
||
| 201 | $this->assertNull($object->null); |
||
| 202 | $this->assertNull($object->notAField); |
||
| 203 | $this->assertEquals( |
||
| 204 | [ |
||
| 205 | 'timestampCurrent' => TEST_VALUE_SQL_DATE, |
||
| 206 | 'varchar' => "varvalue", |
||
| 207 | 'null' => null, |
||
| 208 | ], |
||
| 209 | $object->asArray() |
||
| 210 | ); |
||
| 211 | |||
| 212 | |||
| 213 | // Testing CURRENT_TIMESTAMP and setting values to NULL-defaulted values |
||
| 214 | $object = RecordActiveAbstractObject::build([ |
||
| 215 | 'null' => 'nullvalue', |
||
| 216 | ]); |
||
| 217 | |||
| 218 | $this->assertEquals(date(FMT_DATE_TIME_SQL, SN_TIME_NOW), $object->timestampCurrent); |
||
| 219 | $this->assertEquals('', $object->varchar); |
||
| 220 | $this->assertEquals('nullvalue', $object->null); |
||
| 221 | } |
||
| 222 | |||
| 223 | /** |
||
| 224 | * @covers ::fromFields |
||
| 225 | */ |
||
| 226 | public function testFromFields() { |
||
| 227 | $object = new RecordActiveAbstractObject(); |
||
| 228 | invokeMethod($object, 'fromFields', [[ |
||
| 229 | 'timestamp_current' => TEST_VALUE_SQL_DATE, |
||
| 230 | 'notAField' => 'test', |
||
| 231 | ]]); |
||
| 232 | |||
| 233 | $this->assertEquals(TEST_VALUE_SQL_DATE, $object->timestampCurrent); |
||
| 234 | $this->assertEquals('', $object->varchar); |
||
| 235 | $this->assertNull($object->notAField); |
||
| 236 | } |
||
| 237 | |||
| 238 | |||
| 239 | /** |
||
| 240 | * @covers ::getDefault |
||
| 241 | */ |
||
| 242 | public function testGetDefault() { |
||
| 243 | $object = RecordActiveAbstractObject::buildEvenEmpty([]); |
||
| 244 | |||
| 245 | $this->assertNull(invokeMethod($object, 'getDefault', ['timestamp_current'])); |
||
| 246 | $this->assertNull(invokeMethod($object, 'getDefault', ['NonExistingProperty'])); |
||
| 247 | } |
||
| 248 | |||
| 249 | /** |
||
| 250 | * @covers ::shieldName |
||
| 251 | * @covers ::__set |
||
| 252 | * expectedExceptionMessageRegExp /{{{ Свойство \s+ не существует в ActiveRecord \s+ }}}/ |
||
| 253 | * expectedExceptionMessage {{{ Свойство \s+ не существует в ActiveRecord \s+ }}} |
||
| 254 | */ |
||
| 255 | public function test__set() { |
||
| 256 | $object = RecordActiveAbstractObject::buildEvenEmpty([]); |
||
| 257 | $this->assertEquals(SN_TIME_SQL, $object->timestampCurrent); |
||
| 258 | $object->timestampCurrent = TEST_VALUE_SQL_DATE; |
||
| 259 | $this->assertEquals(TEST_VALUE_SQL_DATE, $object->timestampCurrent); |
||
| 260 | $this->expectExceptionMessage('{{{ Свойство \'q\' не существует в ActiveRecord \'' . RecordActiveAbstractObject::class . '\' }}}'); |
||
| 261 | $object->q = 5; |
||
| 262 | } |
||
| 263 | |||
| 264 | /** |
||
| 265 | * @covers ::shieldName |
||
| 266 | * @covers ::getDefault |
||
| 267 | * @covers ::__get |
||
| 268 | */ |
||
| 269 | public function test__get() { |
||
| 270 | // Testing directly set values |
||
| 271 | $object = RecordActiveAbstractObject::build([ |
||
| 272 | 'timestampCurrent' => TEST_VALUE_SQL_DATE, |
||
| 273 | 'varchar' => 'varvalue', |
||
| 274 | 'null' => 'qwe', |
||
| 275 | ]); |
||
| 276 | $this->assertEquals(TEST_VALUE_SQL_DATE, $object->__get('timestampCurrent')); |
||
| 277 | $this->assertEquals(TEST_VALUE_SQL_DATE, $object->timestampCurrent); |
||
| 278 | |||
| 279 | // Checking false-positive for field translated to property |
||
| 280 | $this->assertNull($object->__get('timestamp_current')); |
||
| 281 | $this->assertNull($object->timestamp_current); |
||
| 282 | |||
| 283 | $this->assertEquals('varvalue', $object->varchar); |
||
| 284 | $this->assertEquals('qwe', $object->null); |
||
| 285 | $this->assertNull($object->notAProperty); |
||
| 286 | |||
| 287 | // Testing CURRENT_TIMESTAMP and setting values to NULL-defaulted values |
||
| 288 | $object = RecordActiveAbstractObject::buildEvenEmpty([]); |
||
| 289 | |||
| 290 | $this->assertEquals(date(FMT_DATE_TIME_SQL, SN_TIME_NOW), $object->timestampCurrent); |
||
| 291 | $this->assertEquals('', $object->varchar); |
||
| 292 | $this->assertNull($object->null); |
||
| 293 | } |
||
| 294 | |||
| 295 | /** |
||
| 296 | * @covers ::fromRecordList |
||
| 297 | */ |
||
| 298 | public function testFromRecordList() { |
||
| 299 | $this->assertEquals([], invokeMethod(RecordActiveAbstractObject::class, 'fromRecordList', [''])); |
||
| 300 | $this->assertEquals([], invokeMethod(RecordActiveAbstractObject::class, 'fromRecordList', [[]])); |
||
| 301 | |||
| 302 | $testable = invokeMethod(RecordActiveAbstractObject::class, 'fromRecordList', [[ |
||
| 303 | ['null' => null,], |
||
| 304 | [], |
||
| 305 | ['timestamp_current' => TEST_VALUE_SQL_DATE, 'null' => 'test',], |
||
| 306 | ]]); |
||
| 307 | $this->assertCount(2, $testable); |
||
| 308 | $this->assertEquals(RecordActiveAbstractObject::class, get_class($testable[0])); |
||
| 309 | // Checking that indexes are maintained |
||
| 310 | $this->assertEquals(RecordActiveAbstractObject::class, get_class($testable[2])); |
||
| 311 | $this->assertEquals(TEST_VALUE_SQL_DATE, $testable[2]->timestampCurrent); |
||
| 312 | $this->assertEquals('test', $testable[2]->null); |
||
| 313 | |||
| 314 | $testable = invokeMethod(RecordActiveAbstractObject::class, 'fromRecordList', [ |
||
| 315 | [ |
||
| 316 | ['null' => null,], |
||
| 317 | [], |
||
| 318 | ['timestampCurrent' => TEST_VALUE_SQL_DATE, 'null' => 'test',], |
||
| 319 | ], |
||
| 320 | RecordActiveAbstractObject::PROPERTIES_TO_FIELDS |
||
| 321 | ]); |
||
| 322 | $this->assertCount(2, $testable); |
||
| 323 | $this->assertEquals(RecordActiveAbstractObject::class, get_class($testable[0])); |
||
| 324 | $this->assertEquals(RecordActiveAbstractObject::class, get_class($testable[2])); |
||
| 325 | $this->assertEquals(TEST_VALUE_SQL_DATE, $testable[2]->timestampCurrent); |
||
| 326 | $this->assertEquals('test', $testable[2]->null); |
||
| 327 | } |
||
| 328 | |||
| 329 | } |
||
| 330 |