composer (#18)

* composer

Author: oittaa

.github/workflows/main.yml

@@ -21,7 +21,7 @@ jobs:
         php-version: '8.0'
         tools: cs2pr, phpcs
     - name: Run phpcs
-      run: phpcs -q --report=checkstyle *.php tests/*.php | cs2pr
+      run: phpcs -q --report=checkstyle src/*.php tests/*.php | cs2pr
 
   unit-tests:
     runs-on: ubuntu-20.04
@@ -34,6 +34,12 @@ jobs:
       uses: shivammathur/setup-php@2.15.0
       with:
         php-version: ${{ matrix.php-versions }}   
-        tools: phpunit
+        tools: composer, phpunit
+    - name: Install dependencies
+      run: composer install
     - name: PHPUnit
-      run: phpunit --coverage-text --whitelist uuid.php --bootstrap uuid.php tests
+      run: phpunit --coverage-clover coverage.xml
+    - name: Upload coverage to Codecov
+      uses: codecov/codecov-action@v2.1.0
+      with:
+        flags: unittests

.gitignore

@@ -1,4 +1,6 @@
 composer.lock
+coverage.xml
 vendor/*
 phpcs-report.xml
 .php-cs-fixer.cache
+.phpunit.cache

README.md

@@ -6,12 +6,18 @@ A small PHP class for generating [RFC 4122](http://tools.ietf.org/html/rfc4122)
 
 If all you want is a unique ID, you should call `uuid4()`.
 
-## Examples
+## Installation
+
+```bash
+composer require oittaa/uuid
+```
+
+## Usage
 
 ```php
 <?php
 
-require_once 'uuid.php';
+require 'vendor/autoload.php';
 
 use UUID\UUID;
 

composer.json

@@ -0,0 +1,19 @@
+{
+    "name": "oittaa/uuid",
+    "type": "library",
+    "description": "A small PHP class for generating RFC 4122 version 3, 4, 5, and 6 (draft) universally unique identifiers (UUID).",
+    "keywords": [
+        "uuid",
+        "identifier",
+        "guid"
+    ],
+    "license": "MIT",
+    "require": {
+        "php": "^7.4 || ^8.0"
+    },
+    "autoload": {
+        "psr-4": {
+            "UUID\\": "src/"
+        }
+    }
+}

phpunit.xml

@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.5/phpunit.xsd"
+         bootstrap="vendor/autoload.php"
+         cacheResultFile=".phpunit.cache/test-results"
+         executionOrder="depends,defects"
+         forceCoversAnnotation="true"
+         beStrictAboutCoversAnnotation="true"
+         beStrictAboutOutputDuringTests="true"
+         beStrictAboutTodoAnnotatedTests="true"
+         convertDeprecationsToExceptions="true"
+         failOnRisky="true"
+         failOnWarning="true"
+         verbose="true">
+    <testsuites>
+        <testsuite name="default">
+            <directory>tests</directory>
+        </testsuite>
+    </testsuites>
+
+    <coverage cacheDirectory=".phpunit.cache/code-coverage"
+              processUncoveredFiles="true">
+        <include>
+            <directory suffix=".php">src</directory>
+        </include>
+    </coverage>
+</phpunit>

uuid.php src/UUID.phpuuid.php renamed to src/UUID.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace UUID;
 
 /**

tests/UuidTest.php

@@ -1,8 +1,11 @@
 <?php
 
-namespace UUID;
+declare(strict_types=1);
+
+namespace UUID\Test;
 
 use PHPUnit\Framework\TestCase;
+use UUID\UUID;
 
 /**
  * @covers \UUID\UUID
@@ -11,7 +14,7 @@ final class UuidTest extends TestCase
 {
     public function testCanGenerateValidVersion3()
     {
-        $this->assertEquals(
+        $this->assertSame(
             '11a38b9a-b3da-360f-9353-a5a725514269',
             UUID::uuid3(UUID::NAMESPACE_DNS, 'php.net')
         );
@@ -33,7 +36,7 @@ public function testCanGenerateValidVersion4()
 
     public function testCanGenerateValidVersion5()
     {
-        $this->assertEquals(
+        $this->assertSame(
             'c4a760a8-dbcf-5254-a0d9-6a4474bd1b62',
             UUID::uuid5(UUID::NAMESPACE_DNS, 'php.net')
         );
@@ -97,19 +100,19 @@ public function testCanValidate()
 
     public function testCanGetVersion()
     {
-        $this->assertEquals(
+        $this->assertSame(
             3,
             UUID::getVersion('11a38b9a-b3da-360f-9353-a5a725514269')
         );
-        $this->assertEquals(
+        $this->assertSame(
             5,
             UUID::getVersion('c4a760a8-dbcf-5254-a0d9-6a4474bd1b62')
         );
     }
 
     public function testCanCompare()
     {
-        $this->assertEquals(
+        $this->assertSame(
             0,
             UUID::cmp('c4a760a8-dbcf-5254-a0d9-6a4474bd1b62', 'C4A760A8-DBCF-5254-A0D9-6A4474BD1B62')
         );
@@ -121,27 +124,27 @@ public function testCanCompare()
 
     public function testToString()
     {
-        $this->assertEquals(
+        $this->assertSame(
             'c4a760a8-dbcf-5254-a0d9-6a4474bd1b62',
             UUID::toString('{C4A760A8-DBCF-5254-A0D9-6A4474BD1B62}')
         );
     }
 
     public function testCanUseAliases()
     {
-        $this->assertEquals(
+        $this->assertSame(
             '11a38b9a-b3da-360f-9353-a5a725514269',
             UUID::v3(UUID::NAMESPACE_DNS, 'php.net')
         );
-        $this->assertEquals(
+        $this->assertSame(
             4,
             UUID::getVersion(UUID::v4())
         );
-        $this->assertEquals(
+        $this->assertSame(
             'c4a760a8-dbcf-5254-a0d9-6a4474bd1b62',
             UUID::v5(UUID::NAMESPACE_DNS, 'php.net')
         );
-        $this->assertEquals(
+        $this->assertSame(
             6,
             UUID::getVersion(UUID::v6())
         );