Make Uuid final again (aka Revert 'Remove "final" keyword to allow extending')

.travis.yml

@@ -1,12 +1,8 @@
 language: php
 
 php:
-  - 5.4
-  - 5.5
-  - 5.6
-  - 7.0
-  - 7.1
   - 7.2
+  - 7.3
   - nightly
 
 matrix:
@@ -28,6 +24,7 @@ before_script:
 
 script:
   - ./vendor/bin/parallel-lint src tests
+  - composer run phpstan
   - travis_wait ./vendor/bin/phpunit --verbose --coverage-clover build/logs/clover.xml
   - ./vendor/bin/phpcs src tests --standard=psr2 -sp
 

CONTRIBUTING.md

@@ -2,6 +2,8 @@
 
 Contributions are welcome. We accept pull requests on [GitHub](https://github.com/ramsey/uuid).
 
+You can triage issues which may include reproducing bug reports or asking for vital information, such as version numbers or reproduction instructions. If you would like to start triaging issues, one easy way to get started is to [subscribe to ramsey/uuid on CodeTriage](https://codetriage.com/ramsey/uuid).
+
 This project adheres to a [Contributor Code of Conduct](https://github.com/ramsey/uuid/blob/master/CODE_OF_CONDUCT.md). By participating in this project and its community, you are expected to uphold this code.
 
 ## Team members

README.md

@@ -1,15 +1,14 @@
 # ramsey/uuid
 
-_NOTICE: Formerly known as `rhumsaa/uuid`, The package and namespace names have changed to `ramsey/uuid` and `Ramsey\Uuid`, respectively._
-
 [![Source Code][badge-source]][source]
 [![Latest Version][badge-release]][release]
 [![Software License][badge-license]][license]
 [![Build Status][badge-build]][build]
 [![Coverage Status][badge-coverage]][coverage]
 [![Total Downloads][badge-downloads]][downloads]
+[![Donate][badge-liberapay]][donate]
 
-ramsey/uuid is a PHP 5.4+ library for generating and working with [RFC 4122][rfc4122] version 1, 3, 4, and 5 universally unique identifiers (UUID).
+ramsey/uuid is a PHP 7.2+ library for generating and working with [RFC 4122][rfc4122] version 1, 3, 4, and 5 universally unique identifiers (UUID).
 
 This project adheres to a [Contributor Code of Conduct][conduct]. By participating in this project and its community, you are expected to uphold this code.
 
@@ -32,6 +31,11 @@ composer require ramsey/uuid
 ```
 
 
+## Upgrading from 3.x to 4.x
+
+TODO
+
+
 ## Upgrading from 2.x to 3.x
 
 While we have made significant internal changes to the library, we have made every effort to ensure a seamless upgrade path from the 2.x series of this library to 3.x.
@@ -65,7 +69,7 @@ After doing so, you will have the latest ramsey/uuid package in the 2.x series,
 
 ## Requirements
 
-Some methods in this library have requirements due to integer size restrictions on 32-bit and 64-bit builds of PHP. A 64-bit build of PHP and the [Moontoast\Math][] library are recommended. However, this library is designed to work on 32-bit builds of PHP without Moontoast\Math, with some degraded functionality. Please check the API documentation for more information.
+Some methods in this library have requirements due to integer size restrictions on 32-bit and 64-bit builds of PHP. A 64-bit build of PHP and either the [GMP PHP-extension][ext-gmp] or the [Moontoast\Math][] library are recommended. However, this library is designed to work on 32-bit builds of PHP without GMP or Moontoast\Math, with some degraded functionality. Please check the API documentation for more information.
 
 If a particular requirement is not present, then an `UnsatisfiedDependencyException` is thrown, allowing one to catch a bad call in an environment where the call is not supported and gracefully degrade.
 
@@ -74,14 +78,6 @@ If a particular requirement is not present, then an `UnsatisfiedDependencyExcept
 
 The [latest class API documentation][apidocs] is available online.
 
-This project uses [ApiGen](http://apigen.org/) to generate this documentation. To generate the documentation on your own, install dev dependencies and run the following command from the root of the project:
-
-```
-composer build-docs
-```
-
-This will generate documentation in the `build/apidocs/` folder.
-
 
 ## Examples
 
@@ -140,6 +136,7 @@ The ramsey/uuid library is copyright © [Ben Ramsey](https://benramsey.com/) and
 [packagist]: https://packagist.org/packages/ramsey/uuid
 [composer]: http://getcomposer.org/
 [moontoast\math]: https://packagist.org/packages/moontoast/math
+[ext-gmp]: http://php.net/manual/en/book.gmp.php
 [apidocs]: http://docs.benramsey.com/ramsey-uuid/latest/
 [wiki-cookbook]: https://github.com/ramsey/uuid/wiki/Ramsey%5CUuid-Cookbook
 [contributing]: https://github.com/ramsey/uuid/blob/master/CONTRIBUTING.md
@@ -150,10 +147,12 @@ The ramsey/uuid library is copyright © [Ben Ramsey](https://benramsey.com/) and
 [badge-build]: https://img.shields.io/travis/ramsey/uuid/master.svg?style=flat-square
 [badge-coverage]: https://img.shields.io/coveralls/ramsey/uuid/master.svg?style=flat-square
 [badge-downloads]: https://img.shields.io/packagist/dt/ramsey/uuid.svg?style=flat-square
+[badge-liberapay]: http://img.shields.io/liberapay/patrons/ramsey.svg?logo=liberapay&style=flat-square
 
 [source]: https://github.com/ramsey/uuid
 [release]: https://packagist.org/packages/ramsey/uuid
 [license]: https://github.com/ramsey/uuid/blob/master/LICENSE
 [build]: https://travis-ci.org/ramsey/uuid
 [coverage]: https://coveralls.io/r/ramsey/uuid?branch=master
 [downloads]: https://packagist.org/packages/ramsey/uuid
+[donate]: https://liberapay.com/ramsey/donate

composer.json

@@ -1,81 +1,79 @@
 {
     "name": "ramsey/uuid",
-    "description": "Formerly rhumsaa/uuid. A PHP 5.4+ library for generating RFC 4122 version 1, 3, 4, and 5 universally unique identifiers (UUID).",
     "type": "library",
-    "keywords": ["uuid", "identifier", "guid"],
+    "description": "A PHP 7.2+ library for generating RFC 4122 version 1, 3, 4, and 5 universally unique identifiers (UUID).",
+    "keywords": [
+        "uuid",
+        "identifier",
+        "guid"
+    ],
     "homepage": "https://github.com/ramsey/uuid",
     "license": "MIT",
-    "authors": [
-        {
-            "name": "Ben Ramsey",
-            "email": "ben@benramsey.com",
-            "homepage": "https://benramsey.com"
-        },
-        {
-            "name": "Marijn Huizendveld",
-            "email": "marijn.huizendveld@gmail.com"
-        },
-        {
-            "name": "Thibaud Fabre",
-            "email": "thibaud@aztech.io"
-        }
-    ],
-    "support": {
-        "issues": "https://github.com/ramsey/uuid/issues",
-        "source": "https://github.com/ramsey/uuid"
-    },
     "require": {
-        "php": "^5.4 || ^7.0",
+        "php": "^7.2",
         "ext-json": "*",
-        "paragonie/random_compat": "^1.0|^2.0|9.99.99",
         "symfony/polyfill-ctype": "^1.8"
     },
     "require-dev": {
-        "codeception/aspect-mock": "^1.0 | ~2.0.0",
-        "doctrine/annotations": "~1.2.0",
-        "goaop/framework": "1.0.0-alpha.2 | ^1.0 | ~2.1.0",
-        "ircmaxell/random-lib": "^1.1",
+        "ext-gmp": "*",
+        "codeception/aspect-mock": "~2.0.0",
+        "doctrine/annotations": "^1.2",
+        "goaop/framework": "^2.1 <2.2",
         "jakub-onderka/php-parallel-lint": "^0.9.0",
-        "mockery/mockery": "^0.9.9",
+        "mockery/mockery": "^1.0",
         "moontoast/math": "^1.1",
-        "php-mock/php-mock-phpunit": "^0.3|^1.1",
-        "phpunit/phpunit": "^4.7|^5.0|^6.5",
-        "squizlabs/php_codesniffer": "^2.3"
+        "paragonie/random-lib": "^2.0",
+        "php-mock/php-mock-phpunit": "^2.0",
+        "phpstan/phpstan-phpunit": "0.9.2",
+        "phpstan/phpstan-shim": "0.9.1",
+        "phpunit/phpunit": "^6.4",
+        "squizlabs/php_codesniffer": "^3.0"
     },
     "suggest": {
         "ext-ctype": "Provides support for PHP Ctype functions",
-        "ircmaxell/random-lib": "Provides RandomLib for use with the RandomLibAdapter",
+        "ext-gmp": "Provides support for converting UUID to 128-bit integer (in string form).",
         "ext-libsodium": "Provides the PECL libsodium extension for use with the SodiumRandomGenerator",
         "ext-uuid": "Provides the PECL UUID extension for use with the PeclUuidTimeGenerator and PeclUuidRandomGenerator",
         "moontoast/math": "Provides support for converting UUID to 128-bit integer (in string form).",
-        "ramsey/uuid-doctrine": "Allows the use of Ramsey\\Uuid\\Uuid as Doctrine field type.",
-        "ramsey/uuid-console": "A console application for generating UUIDs with ramsey/uuid"
+        "paragonie/random-lib": "Provides RandomLib for use with the RandomLibAdapter",
+        "ramsey/uuid-console": "A console application for generating UUIDs with ramsey/uuid",
+        "ramsey/uuid-doctrine": "Allows the use of Ramsey\\Uuid\\Uuid as Doctrine field type."
     },
-    "autoload": {
-        "psr-4": {"Ramsey\\Uuid\\": "src/"}
-    },
-    "autoload-dev": {
-        "psr-4": {"Ramsey\\Uuid\\Test\\": "tests/"}
-    },
-    "replace": {
-        "rhumsaa/uuid": "self.version"
+    "config": {
+        "sort-packages": true
     },
     "extra": {
         "branch-alias": {
-            "dev-master": "3.x-dev"
+            "dev-master": "4.x-dev"
+        }
+    },
+    "autoload": {
+        "psr-4": {
+            "Ramsey\\Uuid\\": "src/"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Ramsey\\Uuid\\Test\\": "tests/"
         }
     },
     "scripts": {
         "lint": "parallel-lint src tests",
-        "phpunit": "phpunit --verbose --colors=always",
         "phpcs": "phpcs src tests --standard=psr2 -sp --colors",
+        "phpstan": [
+            "phpstan analyse -c phpstan.neon src --level max --no-progress",
+            "phpstan analyse -c phpstan-tests.neon tests --level 4 --no-progress"
+        ],
+        "phpunit": "phpunit --verbose --colors=always",
         "test": [
             "@lint",
+            "@phpstan",
             "@phpunit",
             "@phpcs"
         ]
     },
-    "config": {
-        "sort-packages": true
+    "support": {
+        "issues": "https://github.com/ramsey/uuid/issues",
+        "rss": "https://packagist.org/feeds/package.ramsey/uuid.rss"
     }
 }

phpstan-tests.neon

@@ -0,0 +1,7 @@
+parameters:
+    ignoreErrors:
+        - '#Function uuid_create not found#'
+        - '#Function uuid_parse not found#'
+        - '#Constant UUID_TYPE_TIME not found#'
+        - '#Constant UUID_TYPE_RANDOM not found#'
+        - '#does not accept PHPUnit\\Framework\\MockObject\\MockObject#'

phpstan.neon

@@ -0,0 +1,7 @@
+parameters:
+    ignoreErrors:
+        - '#Function uuid_create not found#'
+        - '#Function uuid_parse not found#'
+        - '#Constant UUID_TYPE_TIME not found#'
+        - '#Constant UUID_TYPE_RANDOM not found#'
+        - '#Moontoast\\Math\\BigNumber::convertFromBase10\(\) expects int\|string, Moontoast\\Math\\BigNumber given.#'

phpunit.xml.dist

@@ -1,9 +1,14 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit bootstrap="./tests/bootstrap.php"
-         colors="true"
-         backupGlobals="false">
+
+<!-- https://phpunit.de/manual/current/en/appendixes.configuration.html -->
+<phpunit
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:noNamespaceSchemaLocation="http://schema.phpunit.de/6.4/phpunit.xsd"
+    bootstrap="./tests/bootstrap.php"
+    colors="true"
+>
     <testsuites>
-        <testsuite>
+        <testsuite name="ramsey/uuid test suite">
             <directory>./tests</directory>
         </testsuite>
     </testsuites>

src/BinaryUtils.php

@@ -10,7 +10,7 @@ class BinaryUtils
     /**
      * Applies the RFC 4122 variant field to the `clock_seq_hi_and_reserved` field
      *
-     * @param $clockSeqHi
+     * @param int $clockSeqHi
      * @return int The high field of the clock sequence multiplexed with the variant
      * @link http://tools.ietf.org/html/rfc4122#section-4.1.1
      */

src/Builder/DefaultUuidBuilder.php

@@ -16,6 +16,7 @@
 
 use Ramsey\Uuid\Codec\CodecInterface;
 use Ramsey\Uuid\Converter\NumberConverterInterface;
+use Ramsey\Uuid\Converter\TimeConverterInterface;
 use Ramsey\Uuid\Uuid;
 
 /**
@@ -27,16 +28,25 @@ class DefaultUuidBuilder implements UuidBuilderInterface
     /**
      * @var NumberConverterInterface
      */
-    private $converter;
+    private $numberConverter;
+
+    /**
+     * The time converter to use for converting timestamps extracted from UUIDs to unix timestamps
+     * @var TimeConverterInterface
+     */
+    protected $timeConverter;
 
     /**
      * Constructs the DefaultUuidBuilder
      *
-     * @param NumberConverterInterface $converter The number converter to use when constructing the Uuid
+     * @param NumberConverterInterface $numberConverter The number converter to use when constructing the Uuid
+     * @param TimeConverterInterface $timeConverter The time converter to use
+     *     for converting timestamps extracted from a UUID to unix timestamps
      */
-    public function __construct(NumberConverterInterface $converter)
+    public function __construct(NumberConverterInterface $numberConverter, TimeConverterInterface $timeConverter)
     {
-        $this->converter = $converter;
+        $this->numberConverter = $numberConverter;
+        $this->timeConverter = $timeConverter;
     }
 
     /**
@@ -49,6 +59,6 @@ public function __construct(NumberConverterInterface $converter)
      */
     public function build(CodecInterface $codec, array $fields)
     {
-        return new Uuid($fields, $this->converter, $codec);
+        return new Uuid($fields, $this->numberConverter, $codec, $this->timeConverter);
     }
 }

src/Builder/DegradedUuidBuilder.php

@@ -16,6 +16,7 @@
 
 use Ramsey\Uuid\Codec\CodecInterface;
 use Ramsey\Uuid\Converter\NumberConverterInterface;
+use Ramsey\Uuid\Converter\TimeConverterInterface;
 use Ramsey\Uuid\DegradedUuid;
 
 /**
@@ -26,16 +27,25 @@ class DegradedUuidBuilder implements UuidBuilderInterface
     /**
      * @var NumberConverterInterface
      */
-    private $converter;
+    private $numberConverter;
+
+    /**
+     * The time converter to use for converting timestamps extracted from UUIDs to unix timestamps
+     * @var TimeConverterInterface
+     */
+    protected $timeConverter;
 
     /**
      * Constructs the DegradedUuidBuilder
      *
-     * @param NumberConverterInterface $converter The number converter to use when constructing the DegradedUuid
+     * @param NumberConverterInterface $numberConverter The number converter to use when constructing the DegradedUuid
+     * @param TimeConverterInterface $timeConverter The time converter to use
+     *     for converting timestamps extracted from a UUID to unix timestamps
      */
-    public function __construct(NumberConverterInterface $converter)
+    public function __construct(NumberConverterInterface $numberConverter, TimeConverterInterface $timeConverter)
     {
-        $this->converter = $converter;
+        $this->numberConverter = $numberConverter;
+        $this->timeConverter = $timeConverter;
     }
 
     /**
@@ -48,6 +58,6 @@ public function __construct(NumberConverterInterface $converter)
      */
     public function build(CodecInterface $codec, array $fields)
     {
-        return new DegradedUuid($fields, $this->converter, $codec);
+        return new DegradedUuid($fields, $this->numberConverter, $codec, $this->timeConverter);
     }
 }