declare fork

kornrunner · Feb 9, 2023 · 39a0750 · 39a0750
1 parent 5f62bc1
commit 39a0750
Show file tree

Hide file tree

Showing 14 changed files with 164 additions and 101 deletions.
diff --git a/.coveralls.yml b/.coveralls.yml
@@ -0,0 +1,3 @@
+service_name: travis-ci
+coverage_clover: build/logs/clover.xml
+json_path: coveralls-upload.json
diff --git a/.github/workflows/php.yml b/.github/workflows/php.yml
diff --git a/.github/workflows/static-analysis.yml b/.github/workflows/static-analysis.yml
@@ -0,0 +1,22 @@
+name: Static Analysis (informative)
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  phpstan:
+    name: PHPStan
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.0
+          coverage: none
+
+      - run: composer install --no-progress --prefer-dist
+      - run: composer require phpstan/phpstan --no-progress --dev
+      - run: vendor/bin/phpstan analyse src/
+        continue-on-error: true # is only informative
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -0,0 +1,86 @@
+name: Tests
+
+on: [push, pull_request]
+
+jobs:
+
+  linux:
+    name: Test on Linux
+    runs-on: ubuntu-20.04
+    strategy:
+      fail-fast: false
+      matrix:
+        php-version: ['7.4', '8.0', '8.1', '8.2']
+
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 1
+
+      - run: php${{ matrix.php-version }} -v
+      - run: php${{ matrix.php-version }} -m
+      - run: composer -V
+      - run: composer install --no-progress
+      - run: php${{ matrix.php-version }} vendor/bin/phpunit
+
+  windows:
+    name: Test on Windows
+    defaults:
+      run:
+        shell: cmd
+    runs-on: windows-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        php-version: ['7.4', '8.0', '8.1', '8.2']
+        arch: [x64]
+        ts: [nts]
+
+    steps:
+      - name: Setup PHP
+        id: setup-php
+        uses: cmb69/setup-php-sdk@v0.6
+        with:
+          version: ${{matrix.php-version}}
+          arch: ${{matrix.arch}}
+          ts: ${{matrix.ts}}
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 1
+
+      - name: Enable Developer Command Prompt
+        uses: ilammy/msvc-dev-cmd@v1
+        with:
+          arch: ${{matrix.arch}}
+          toolset: ${{steps.setup-php.outputs.toolset}}
+
+      - name: Define Other Environment
+        shell: powershell
+        run: |
+          chcp 65001
+          echo "PHP_EXECUTABLE=${{steps.setup-php.outputs.prefix}}\php.exe" >> $env:GITHUB_ENV
+
+      - run: php -v
+      - run: echo extension=gmp>>C:\tools\php\php.ini
+      - run: php -m
+      - run: composer -V
+      - run: composer install --no-progress
+      - run: php vendor/bin/phpunit
+
+  code_coverage:
+    name: Code Coverage
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.0
+          coverage: none
+
+      - run: composer install --no-progress
+      - run: mkdir -p build/logs
+      - run: phpdbg -qrr vendor/bin/phpunit
+      - run: wget https://github.com/php-coveralls/php-coveralls/releases/download/v2.4.3/php-coveralls.phar
+      - env:
+          COVERALLS_REPO_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: php php-coveralls.phar --verbose
diff --git a/.gitignore b/.gitignore
@@ -2,6 +2,8 @@ composer.phar
 /vendor/
 .phpintel/
 composer.lock
+.phpunit.cache/
+.phpunit.result.cache
 
 # Commit your application's lock file http://getcomposer.org/doc/01-basic-usage.md#composer-lock-the-lock-file
 # You may choose to ignore a library lock file http://getcomposer.org/doc/02-libraries.md#lock-file

diff --git a/README.md b/README.md
@@ -1,24 +1,20 @@
-# rlp
-
-[![PHP](https://github.com/web3p/rlp/actions/workflows/php.yml/badge.svg)](https://github.com/web3p/rlp/actions/workflows/php.yml)
-[![codecov](https://codecov.io/gh/web3p/rlp/branch/master/graph/badge.svg)](https://codecov.io/gh/web3p/rlp)
-[![Licensed under the MIT License](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/web3p/rlp/blob/master/LICENSE)
+# rlp [![Tests](https://github.com/kornrunner/rlp/actions/workflows/tests.yml/badge.svg?branch=master)](https://github.com/kornrunner/rlp/actions/workflows/tests.yml) [![Coverage Status](https://coveralls.io/repos/github/kornrunner/rlp/badge.svg?branch=master)](https://coveralls.io/github/kornrunner/rlp?branch=master) [![Latest Stable Version](https://poser.pugx.org/kornrunner/rlp/v/stable)](https://packagist.org/packages/kornrunner/rlp)
 
 Recursive Length Prefix Encoding in PHP.
 
 # Install
 
 Set minimum stability to dev
 ```
-composer require web3p/rlp
+composer require kornrunner/rlp
 ```
 
 # Usage
 
 RLP encode:
 
 ```php
-use Web3p\RLP\RLP;
+use kornrunner\RLP\RLP;
 
 $rlp = new RLP;
 // c483646f67
@@ -31,8 +27,8 @@ $encoded = $rlp->encode('dog');
 RLP decode:
 
 ```php
-use Web3p\RLP\RLP;
-use Web3p\RLP\Types\Str;
+use kornrunner\RLP\RLP;
+use kornrunner\RLP\Types\Str;
 
 $rlp = new RLP;
 $encoded = $rlp->encode(['dog']);
@@ -52,7 +48,7 @@ echo Str::decodeHex($decoded[0]);
 
 # API
 
-### Web3p\RLP\RLP
+### kornrunner\RLP\RLP
 
 #### encode
 
@@ -69,10 +65,10 @@ Mixed inputs - array of string, integer or numeric string.
 * Encode array of string.
 
 ```php
-use Web3p\RLP\RLP;
+use kornrunner\RLP\RLP;
 
 $rlp = new RLP;
-$encoded = $rlp->encode(['web3p', 'ethereum', 'solidity']);
+$encoded = $rlp->encode(['kornrunner', 'ethereum', 'solidity']);
 ```
 
 #### decode
@@ -90,14 +86,14 @@ String input - recursive length prefix encoded string.
 * Decode recursive length prefix encoded string.
 
 ```php
-use Web3p\RLP\RLP;
-use Web3p\RLP\Types\Str;
+use kornrunner\RLP\RLP;
+use kornrunner\RLP\Types\Str;
 
 $rlp = new RLP;
-$encoded = $rlp->encode(['web3p', 'ethereum', 'solidity']);
+$encoded = $rlp->encode(['kornrunner', 'ethereum', 'solidity']);
 $decoded = $rlp->decode('0x' . $encoded);
 
-// echo web3p
+// echo kornrunner
 echo hex2bin($decoded[0]);
 
 // echo ethereum
@@ -113,4 +109,5 @@ echo Str::decodeHex($decoded[2]);
 ```
 
 # License
+
 MIT
diff --git a/composer.json b/composer.json
@@ -1,5 +1,5 @@
 {
-    "name": "web3p/rlp",
+    "name": "kornrunner/rlp",
     "description": "Recursive Length Prefix Encoding in PHP.",
     "type": "library",
     "license": "MIT",
@@ -11,11 +11,11 @@
     ],
     "minimum-stability": "dev",
     "require-dev": {
-        "phpunit/phpunit": "~7|~8.0"
+        "phpunit/phpunit": "~7|~8.0|~9.0"
     },
     "autoload": {
         "psr-4": {
-            "Web3p\\RLP\\": "src/"
+            "kornrunner\\RLP\\": "src/"
         }
     },
     "autoload-dev": {
@@ -24,7 +24,7 @@
         }
     },
     "require": {
-        "PHP": "^7.1 | ^8.0",
+        "PHP": "^7.1 | ^8.0 | ^8.1 | ^8.2",
         "ext-mbstring": "*"
     }
 }
diff --git a/phpunit.xml b/phpunit.xml
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" bootstrap="vendor/autoload.php" backupGlobals="false" backupStaticAttributes="false" colors="true" verbose="true" convertErrorsToExceptions="true" convertNoticesToExceptions="true" convertWarningsToExceptions="true" processIsolation="false" stopOnFailure="false" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
+  <coverage>
+    <include>
+      <directory suffix=".php">src</directory>
+    </include>
+    <report>
+      <clover outputFile="build/logs/clover.xml"/>
+      <html outputDirectory="build/coverage"/>
+      <text outputFile="build/coverage.txt"/>
+    </report>
+  </coverage>
+  <testsuites>
+    <testsuite name="Keccak Test Suite">
+      <directory>test</directory>
+    </testsuite>
+  </testsuites>
+  <logging>
+    <junit outputFile="build/report.junit.xml"/>
+  </logging>
+</phpunit>
diff --git a/src/RLP.php b/src/RLP.php
@@ -9,20 +9,20 @@
  * @license MIT
  */
 
-namespace Web3p\RLP;
+namespace kornrunner\RLP;
 
 use InvalidArgumentException;
 use RuntimeException;
-use Web3p\RLP\Types\Str;
-use Web3p\RLP\Types\Numeric;
+use kornrunner\RLP\Types\Str;
+use kornrunner\RLP\Types\Numeric;
 
 /**
  * It's a instance for ethereum recursive length encoding.
  * 
  * RLP encode:
  * 
  * ```php
- * use Web3p\RLP\RLP;
+ * use kornrunner\RLP\RLP;
 
  * $rlp = new RLP;
  * // c483646f67
@@ -35,8 +35,8 @@
  * RLP decode:
  * 
  * ```php
- * use Web3p\RLP\RLP;
- * use Web3p\RLP\Types\Str;
+ * use kornrunner\RLP\RLP;
+ * use kornrunner\RLP\Types\Str;
  * 
  * $rlp = new RLP;
  * $encoded = $rlp->encode(['dog']);

diff --git a/src/Types/Numeric.php b/src/Types/Numeric.php
@@ -9,7 +9,7 @@
  * @license MIT
  */
 
-namespace Web3p\RLP\Types;
+namespace kornrunner\RLP\Types;
 
 
 /**

diff --git a/src/Types/Str.php b/src/Types/Str.php
@@ -9,7 +9,7 @@
  * @license MIT
  */
 
-namespace Web3p\RLP\Types;
+namespace kornrunner\RLP\Types;
 
 use InvalidArgumentException;
 
@@ -93,4 +93,4 @@ static function decodeHex(string $input)
         }
         return $output;
     }
-}
+}