forked from fzaninotto/Faker
-
Notifications
You must be signed in to change notification settings - Fork 344
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added the UUID extension to Core and deprecated the global uuid call …
…with an uuid3 to specify version
- Loading branch information
Showing
5 changed files
with
132 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
<?php | ||
|
||
declare(strict_types=1); | ||
|
||
namespace Faker\Core; | ||
|
||
use Faker\Extension\UuidExtension; | ||
|
||
final class Uuid implements UuidExtension | ||
{ | ||
public function uuid3(): string | ||
{ | ||
$number = new Number(); | ||
|
||
// fix for compatibility with 32bit architecture; each mt_rand call is restricted to 32bit | ||
// two such calls will cause 64bits of randomness regardless of architecture | ||
$seed = $number->numberBetween(0, 2147483647) . '#' . $number->numberBetween(0, 2147483647); | ||
|
||
// Hash the seed and convert to a byte array | ||
$val = md5($seed, true); | ||
$byte = array_values(unpack('C16', $val)); | ||
|
||
// extract fields from byte array | ||
$tLo = ($byte[0] << 24) | ($byte[1] << 16) | ($byte[2] << 8) | $byte[3]; | ||
$tMi = ($byte[4] << 8) | $byte[5]; | ||
$tHi = ($byte[6] << 8) | $byte[7]; | ||
$csLo = $byte[9]; | ||
$csHi = $byte[8] & 0x3f | (1 << 7); | ||
|
||
// correct byte order for big edian architecture | ||
if (pack('L', 0x6162797A) == pack('N', 0x6162797A)) { | ||
$tLo = (($tLo & 0x000000ff) << 24) | (($tLo & 0x0000ff00) << 8) | ||
| (($tLo & 0x00ff0000) >> 8) | (($tLo & 0xff000000) >> 24); | ||
$tMi = (($tMi & 0x00ff) << 8) | (($tMi & 0xff00) >> 8); | ||
$tHi = (($tHi & 0x00ff) << 8) | (($tHi & 0xff00) >> 8); | ||
} | ||
|
||
// apply version number | ||
$tHi &= 0x0fff; | ||
$tHi |= (3 << 12); | ||
|
||
// cast to string | ||
return sprintf( | ||
'%08x-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x', | ||
$tLo, | ||
$tMi, | ||
$tHi, | ||
$csHi, | ||
$csLo, | ||
$byte[10], | ||
$byte[11], | ||
$byte[12], | ||
$byte[13], | ||
$byte[14], | ||
$byte[15] | ||
); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
<?php | ||
|
||
namespace Faker\Extension; | ||
|
||
/** | ||
* @experimental This interface is experimental and does not fall under our BC promise | ||
*/ | ||
interface UuidExtension extends Extension | ||
{ | ||
/** | ||
* Generate name based md5 UUID (version 3). | ||
* | ||
* @example '7e57d004-2b97-0e7a-b45f-5387367791cd' | ||
* | ||
* @return string | ||
*/ | ||
public function uuid3(): string; | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
<?php | ||
|
||
namespace Faker\Test\Core; | ||
|
||
use Faker\Test\TestCase; | ||
|
||
final class UuidTest extends TestCase | ||
{ | ||
public function testUuidReturnsUuid() | ||
{ | ||
$uuid = $this->faker->uuid3(); | ||
self::assertTrue($this->isUuid($uuid)); | ||
} | ||
|
||
public function testUuidExpectedSeed() | ||
{ | ||
if (pack('L', 0x6162797A) == pack('N', 0x6162797A)) { | ||
self::markTestSkipped('Big Endian'); | ||
} | ||
$this->faker->seed(123); | ||
self::assertEquals('8e2e0c84-50dd-367c-9e66-f3ab455c78d6', $this->faker->uuid3()); | ||
self::assertEquals('073eb60a-902c-30ab-93d0-a94db371f6c8', $this->faker->uuid3()); | ||
} | ||
|
||
protected function isUuid($uuid) | ||
{ | ||
return is_string($uuid) && (bool) preg_match('/^[a-f0-9]{8,8}-(?:[a-f0-9]{4,4}-){3,3}[a-f0-9]{12,12}$/i', $uuid); | ||
} | ||
} |