PHPCS + PhpStan + badges

.github/workflows/codecoverage.yml

@@ -0,0 +1,82 @@
+name: Code Coverage
+
+# Runs PHPUnit with code coverage enabled, commits the html report to
+# GitHub Pages, generates a README badge with the coverage percentage.
+#
+# Requires a gh-pages branch already created.
+#
+# git checkout --orphan gh-pages
+# touch index.html
+# git add index.html
+# git commit -m 'Set up gh-pages branch' index.html
+# git push origin gh-pages
+# git checkout master
+#
+# @author BrianHenryIE
+
+on:
+ push:
+ branches:
+ - master
+
+jobs:
+ tests:
+ runs-on: ubuntu-latest
+
+ steps:
+
+ - name: Git checkout
+ uses: actions/checkout@v2
+
+ - name: Install PHP
+ uses: shivammathur/setup-php@v2
+ with:
+ php-version: '7.4'
+ coverage: xdebug
+
+# - name: Checkout GitHub Pages branch for code coverage report
+# uses: actions/checkout@v2
+# with:
+# ref: gh-pages
+# path: tests/_reports/html
+
+ - name: Install dependencies
+ run: composer install --prefer-dist --no-suggest --no-progress
+
+# - name: Clear previous code coverage
+# run: |
+# cd tests/_reports/html
+# rm -rf *
+# cd ../../..
+
+ - name: Run tests with code coverage
+ run: XDEBUG_MODE=coverage vendor/bin/phpunit --coverage-text --coverage-clover tests/_reports/clover.xml --coverage-html tests/_reports/html
+
+# - name: Edit phpcov html output to work with gh-pages
+# run: |
+# cd tests/_reports/html
+# mv _css css; find . -depth -name '*.html' -exec sed -i "s/_css\//css\//" {} +
+# mv _icons icons; find . -depth -name '*.html' -exec sed -i "s/_icons\//icons\//" {} +
+# mv _js js; find . -depth -name '*.html' -exec sed -i "s/_js\//js\//" {} +
+# git add *
+# cd ../../..
+
+# - name: Commit code coverage to gh-pages
+# uses: stefanzweifel/git-auto-commit-action@v4.1.1
+# with:
+# repository: tests/_reports/html
+# branch: gh-pages
+# commit_message: "🤖 Commit code coverage to gh-pages"
+# commit_options:
+# env:
+# GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
+
+ - name: Update README badge
+ run: vendor/bin/php-coverage-badger tests/_reports/clover.xml .github/coverage.svg
+
+ - name: Commit code coverage badge
+ uses: stefanzweifel/git-auto-commit-action@v4.1.1
+ with:
+ commit_message: "🤖 Commit code coverage badge"
+
+

.gitignore

@@ -1,4 +1,5 @@
 .idea
 .phpunit.*
 /vendor
-composer.lock
+composer.lock
+tests/_reports/

README.md

@@ -1,3 +1,5 @@
+[![PHP 7.1](https://img.shields.io/badge/PHP-7.1-8892BF.svg)]() [![PHPCS PSR-12](https://img.shields.io/badge/PHPCS-PSR–12-226146.svg)](https://www.php-fig.org/psr/psr-12/) [![PHPUnit ](.github/coverage.svg)](https://brianhenryie.github.io/bh-php-monero-explorer/) [![PHPStan ](https://img.shields.io/badge/PHPStan-Level%208-2a5ea7.svg)](https://phpstan.org/)
+
 ## PHP Bitcoin Address
 
 A simple P2PK, P2PKH, P2SH, P2WPKH, P2WSH, P2TR output script/address parser/generator/validator.

composer.json

@@ -22,7 +22,10 @@
  "shanecurran/phpecc": "^0.0.1"
  },
  "require-dev": {
- "phpunit/phpunit": ">=5.7"
+ "dealerdirect/phpcodesniffer-composer-installer": "*",
+ "phpstan/phpstan": "^1.10",
+ "phpunit/phpunit": ">=5.7",
+ "squizlabs/php_codesniffer": "*"
  },
  "autoload": {
  "psr-4": {
@@ -33,5 +36,24 @@
  "psr-4": {
  "AndKom\\Bitcoin\\Address\\Tests\\": "tests/"
  }
+ },
+ "config": {
+ "sort-packages": true,
+ "allow-plugins": {
+ "dealerdirect/phpcodesniffer-composer-installer": true
+ }
+ },
+ "scripts": {
+ "test": [
+ "phpunit"
+ ],
+ "test-coverage":[
+ "phpunit --coverage-text --coverage-clover tests/_reports/clover.xml --coverage-html tests/_reports/html"
+ ],
+ "lint": [
+ "phpcbf || true",
+ "phpcs || true",
+ "phpstan"
+ ]
  }
 }

phpcs.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0"?>
+<ruleset name="PHP_CodeSniffer">
+
+ <description>PHPCS configuration file.</description>
+
+ <file>src</file>
+ <file>tests</file>
+
+ <rule ref="PSR12"/>
+
+ <exclude-pattern>tests/_reports</exclude-pattern>
+ <exclude-pattern>tests/_data</exclude-pattern>
+
+</ruleset>

phpstan.neon

@@ -0,0 +1,8 @@
+parameters:
+ level: 9
+ paths:
+ - src
+ - tests
+ excludePaths:
+ - tests/_reports
+ treatPhpDocTypesAsCertain: false

phpunit.xml.dist

@@ -11,4 +11,9 @@
  <directory suffix=".php">./src</directory>
  </include>
  </source>
-</phpunit>
+ <filter>
+ <whitelist processUncoveredFilesFromWhitelist="true">
+ <directory suffix=".php">./src</directory>
+ </whitelist>
+ </filter>
+</phpunit>

src/Ecc/Point.php

@@ -16,7 +16,7 @@
 class Point extends \Mdanter\Ecc\Primitives\Point
 {
  /**
- * @return $this
+ * @return Point
  * @throws Exception
  */
  public function liftX(): self
@@ -50,24 +50,28 @@ public function liftX(): self
  $curve->getPrime()
  );
 
- if ($adapter->cmp(
+ if (
+ $adapter->cmp(
  $c,
  $adapter->powmod(
  $y,
  gmp_init(2, 10),
  $curve->getPrime()
  )
- ) !== 0) {
+ ) !== 0
+ ) {
  throw new Exception('C is not equal to point Y^2.');
  }
 
- if ($adapter->cmp(
+ if (
+ $adapter->cmp(
  $adapter->mod(
  $y,
  gmp_init(2, 10)
  ),
  gmp_init(0, 10)
- ) === 0) {
+ ) === 0
+ ) {
  $point = new Point($adapter, $curve, $x, $y);
  } else {
  $point = new Point($adapter, $curve, $x, $adapter->sub($curve->getPrime(), $y));
@@ -91,6 +95,6 @@ static function fromPubKey(GmpMathInterface $adapter, CurveFpInterface $curve, s
  $y = $curve->recoverYfromX($prefix === '03', $x);
  }
 
- return new static($adapter, $curve, $x, $y);
+ return new Point($adapter, $curve, $x, $y);
  }
 }

src/Exception.php

@@ -10,4 +10,4 @@
  */
 class Exception extends \Exception
 {
-}
+}

src/Network/NetworkFactory.php

@@ -27,9 +27,9 @@
 class NetworkFactory
 {
  /**
- * @var array
+ * @var string[]
  */
- static protected $networks = [
+ protected static $networks = [
  'bitcoin',
  'bitcoinTestnet',
  'bitcoinCash',
@@ -49,27 +49,27 @@ class NetworkFactory
  /**
  * @var NetworkInterface
  */
- static protected $defaultNetwork;
+ protected static $defaultNetwork;
 
  /**
  * @param NetworkInterface $network
  */
- static public function setDefaultNetwork(NetworkInterface $network)
+ public static function setDefaultNetwork(NetworkInterface $network): void
  {
  static::$defaultNetwork = $network;
  }
 
  /**
  * @return NetworkInterface
  */
- static public function getDefaultNetwork(): NetworkInterface
+ public static function getDefaultNetwork(): NetworkInterface
  {
  return static::$defaultNetwork ?: static::bitcoin();
  }
 
  /**
  * @param string $name
- * @param array $arguments
+ * @param array<mixed> $arguments
  * @return NetworkInterface
  * @throws Exception
  */
@@ -81,27 +81,33 @@ public function createNetwork(string $name, array $arguments): NetworkInterface
 
  $class = 'AndKom\\Bitcoin\\Address\\Network\\Networks\\' . ucfirst($name);
 
- return new $class(...$arguments);
+ $network = new $class(...$arguments);
+
+ if (! $network instanceof NetworkInterface) {
+ throw new Exception("{$class} was not a NetworkInterface");
+ }
+
+ return $network;
  }
 
  /**
- * @param $name
- * @param $arguments
+ * @param string $name
+ * @param array<mixed> $arguments
  * @return NetworkInterface
  * @throws Exception
  */
- public function __call($name, $arguments)
+ public function __call(string $name, array $arguments)
  {
  return $this->createNetwork($name, $arguments);
  }
 
  /**
- * @param $name
- * @param $arguments
+ * @param string $name
+ * @param array<mixed> $arguments
  * @return NetworkInterface
  */
- public static function __callStatic($name, $arguments)
+ public static function __callStatic(string $name, array $arguments)
  {
- return (new static)->createNetwork($name, $arguments);
+ return (new NetworkFactory())->createNetwork($name, $arguments);
  }
-}
+}

src/Network/NetworkInterface.php

@@ -53,4 +53,4 @@ public function decodeAddress(string $address): OutputInterface;
  * @return bool
  */
  public function validateAddress(string $address): bool;
-}
+}

src/Network/Networks/Bitcoin.php

@@ -19,4 +19,4 @@ class Bitcoin extends BitcoinAbstract
  * @var bool
  */
  protected $hasTaproot = true;
-}
+}

src/Network/Networks/BitcoinAbstract.php

@@ -15,8 +15,10 @@
 use AndKom\Bitcoin\Address\Utils;
 use AndKom\Bitcoin\Address\Validate;
 use BrooksYang\Bech32m\Exception\Bech32mException;
+
 use function BrooksYang\Bech32m\decodeSegwit;
 use function BrooksYang\Bech32m\encodeSegwit;
+
 use const BrooksYang\Bech32m\BECH32;
 use const BrooksYang\Bech32m\BECH32M;
 
@@ -26,8 +28,8 @@
  */
 abstract class BitcoinAbstract implements NetworkInterface
 {
- const VERSION_SEGWIT = 0;
- const VERSION_TAPROOT = 1;
+ public const VERSION_SEGWIT = 0;
+ public const VERSION_TAPROOT = 1;
 
  /**
  * @var string
@@ -185,4 +187,4 @@ public function validateAddress(string $address): bool
  return false;
  }
  }
-}
+}