chore: set up graham-campbell/analyzer

ArkEcosystem · Oct 14, 2020 · 0964beb · 0964beb
1 parent 56e5536
commit 0964beb
Show file tree

Hide file tree

Showing 61 changed files with 154 additions and 113 deletions.
diff --git a/composer.json b/composer.json
@@ -9,19 +9,22 @@
         "currency"
     ],
     "license": "MIT",
-    "authors": [{
-        "name": "Brian Faust",
-        "email": "[email protected]",
-        "homepage": "https://github.com/faustbrian"
-    }],
+    "authors": [
+        {
+            "name": "Brian Faust",
+            "email": "[email protected]",
+            "homepage": "https://github.com/faustbrian"
+        }
+    ],
     "require": {
         "php": "^7.2",
         "bitwasp/bitcoin": "^1.0",
-        "kodekeep/bytebuffer": "^1.0",
-        "kodekeep/binary": "^1.0"
+        "kodekeep/binary": "^1.0",
+        "kodekeep/bytebuffer": "^1.0"
     },
     "require-dev": {
         "friendsofphp/php-cs-fixer": "^2.16",
+        "graham-campbell/analyzer": "^3.0",
         "illuminate/support": "^7.0.0",
         "mockery/mockery": "^1.2",
         "pestphp/drift": "^0.3.0",

diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -16,8 +16,11 @@
          verbose="true"
 >
     <testsuites>
-        <testsuite name="Ark PHP Crypto Test Suite">
-            <directory suffix="Test.php">./tests</directory>
+        <testsuite name="Analysis">
+            <directory suffix="Test.php">./tests/Analysis</directory>
+        </testsuite>
+        <testsuite name="Unit">
+            <directory suffix="Test.php">./tests/Unit</directory>
         </testsuite>
     </testsuites>
     <filter>

diff --git a/src/Identities/Address.php b/src/Identities/Address.php
@@ -34,8 +34,8 @@ class Address
     /**
      * Derive the address from the given passphrase.
      *
-     * @param string                                             $passphrase
-     * @param \ArkEcosystem\Crypto\Networks\AbstractNetwork|null $network
+     * @param string               $passphrase
+     * @param AbstractNetwork|null $network
      *
      * @return string
      */
@@ -47,8 +47,8 @@ public static function fromPassphrase(string $passphrase, AbstractNetwork $netwo
     /**
      * Derive the address from the given public key.
      *
-     * @param string                                             $publicKey
-     * @param \ArkEcosystem\Crypto\Networks\AbstractNetwork|null $network
+     * @param string               $publicKey
+     * @param AbstractNetwork|null $network
      *
      * @return string
      */
@@ -66,7 +66,7 @@ public static function fromPublicKey(string $publicKey, $network = null): string
      * Derive the address from the given private key.
      *
      * @param \BitWasp\Bitcoin\Crypto\EcAdapter\Impl\PhpEcc\Key\PrivateKey $privateKey
-     * @param ArkEcosystem\Crypto\Networks\AbstractNetwork|null            $network
+     * @param AbstractNetwork|null                                         $network
      *
      * @return string
      */
@@ -80,8 +80,8 @@ public static function fromPrivateKey(EccPrivateKey $privateKey, AbstractNetwork
     /**
      * Validate the given address.
      *
-     * @param string                                                 $address
-     * @param \ArkEcosystem\Crypto\Networks\AbstractNetwork|int|null $network
+     * @param string                   $address
+     * @param AbstractNetwork|int|null $network
      *
      * @return bool
      */

diff --git a/src/Transactions/Builder/DelegateRegistrationBuilder.php b/src/Transactions/Builder/DelegateRegistrationBuilder.php
@@ -38,7 +38,7 @@ public function __construct()
      *
      * @param string $username
      *
-     * @return \ArkEcosystem\Crypto\Transactions\Builder\DelegateRegistration
+     * @return self
      */
     public function username(string $username): self
     {
@@ -52,7 +52,7 @@ public function username(string $username): self
      *
      * @param string $passphrase
      *
-     * @return \ArkEcosystem\Crypto\Transactions\Builder\AbstractTransactionBuilder
+     * @return self
      */
     public function sign(string $passphrase): AbstractTransactionBuilder
     {

diff --git a/src/Transactions/Builder/MultiPaymentBuilder.php b/src/Transactions/Builder/MultiPaymentBuilder.php
@@ -38,7 +38,7 @@ public function __construct()
      * @param string $recipientId
      * @param string $amount
      *
-     * @return \ArkEcosystem\Crypto\Transactions\Builder\MultiPayment
+     * @return self
      */
     public function add(string $recipientId, string $amount): self
     {
@@ -52,7 +52,7 @@ public function add(string $recipientId, string $amount): self
      *
      * @param string $vendorField
      *
-     * @return \ArkEcosystem\Crypto\Transactions\Builder\MultiPayment
+     * @return self
      */
     public function vendorField(string $vendorField): self
     {

diff --git a/src/Transactions/Builder/MultiSignatureRegistrationBuilder.php b/src/Transactions/Builder/MultiSignatureRegistrationBuilder.php
@@ -40,7 +40,7 @@ public function __construct()
      *
      * @param int $min
      *
-     * @return \ArkEcosystem\Crypto\Transactions\Builder\MultiSignatureRegistration
+     * @return self
      */
     public function min(int $min): self
     {
@@ -54,7 +54,7 @@ public function min(int $min): self
      *
      * @param int $lifetime
      *
-     * @return \ArkEcosystem\Crypto\Transactions\Builder\MultiSignatureRegistration
+     * @return self
      */
     public function lifetime(int $lifetime): self
     {
@@ -68,7 +68,7 @@ public function lifetime(int $lifetime): self
      *
      * @param array $keysgroup
      *
-     * @return \ArkEcosystem\Crypto\Transactions\Builder\MultiSignatureRegistration
+     * @return self
      */
     public function keysgroup(array $keysgroup): self
     {

diff --git a/src/Transactions/Builder/SecondSignatureRegistrationBuilder.php b/src/Transactions/Builder/SecondSignatureRegistrationBuilder.php
@@ -28,7 +28,7 @@ class SecondSignatureRegistrationBuilder extends AbstractTransactionBuilder
      *
      * @param string $secondPassphrase
      *
-     * @return \ArkEcosystem\Crypto\Transactions\Builder\SecondSignatureRegistration
+     * @return self
      */
     public function signature(string $secondPassphrase): self
     {

diff --git a/src/Transactions/Builder/TransferBuilder.php b/src/Transactions/Builder/TransferBuilder.php
@@ -34,7 +34,7 @@ public function __construct()
      *
      * @param string $recipientId
      *
-     * @return \ArkEcosystem\Crypto\Transactions\Builder\Transfer
+     * @return self
      */
     public function recipient(string $recipientId): self
     {
@@ -48,7 +48,7 @@ public function recipient(string $recipientId): self
      *
      * @param string $amount
      *
-     * @return \ArkEcosystem\Crypto\Transactions\Builder\Transfer
+     * @return self
      */
     public function amount(string $amount): self
     {
@@ -62,7 +62,7 @@ public function amount(string $amount): self
      *
      * @param string $vendorField
      *
-     * @return \ArkEcosystem\Crypto\Transactions\Builder\Transfer
+     * @return self
      */
     public function vendorField(string $vendorField): self
     {

diff --git a/src/Transactions/Builder/VoteBuilder.php b/src/Transactions/Builder/VoteBuilder.php
@@ -39,7 +39,7 @@ public function __construct()
      *
      * @param array $votes
      *
-     * @return \ArkEcosystem\Crypto\Transactions\Builder\Vote
+     * @return self
      */
     public function votes(array $votes): self
     {
@@ -53,7 +53,7 @@ public function votes(array $votes): self
      *
      * @param string $passphrase
      *
-     * @return \ArkEcosystem\Crypto\Transactions\Builder\AbstractTransactionBuilder
+     * @return self
      */
     public function sign(string $passphrase): AbstractTransactionBuilder
     {

diff --git a/src/Transactions/Deserializer.php b/src/Transactions/Deserializer.php
@@ -13,7 +13,7 @@
 
 namespace ArkEcosystem\Crypto\Transactions;
 
-use ArkEcosystem\Crypto\Transactions\Types as Transactions;
+use ArkEcosystem\Crypto\Transactions\Types\Transaction;
 use BitWasp\Bitcoin\Crypto\Hash;
 use KodeKeep\ByteBuffer\ByteBuffer;
 
@@ -30,17 +30,17 @@ class Deserializer
      * @var array
      */
     private $transactionsClasses = [
-        Transactions\Transfer::class,
-        Transactions\SecondSignatureRegistration::class,
-        Transactions\DelegateRegistration::class,
-        Transactions\Vote::class,
-        Transactions\MultiSignatureRegistration::class,
-        Transactions\IPFS::class,
-        Transactions\MultiPayment::class,
-        Transactions\DelegateResignation::class,
-        Transactions\HtlcLock::class,
-        Transactions\HtlcClaim::class,
-        Transactions\HtlcRefund::class,
+        Types\Transfer::class,
+        Types\SecondSignatureRegistration::class,
+        Types\DelegateRegistration::class,
+        Types\Vote::class,
+        Types\MultiSignatureRegistration::class,
+        Types\IPFS::class,
+        Types\MultiPayment::class,
+        Types\DelegateResignation::class,
+        Types\HtlcLock::class,
+        Types\HtlcClaim::class,
+        Types\HtlcRefund::class,
     ];
 
     /**
@@ -68,9 +68,9 @@ public static function new(string $serialized)
     /**
      * Perform AIP11 compliant deserialization.
      *
-     * @return \ArkEcosystem\Crypto\Transactions\Transaction
+     * @return Transaction
      */
-    public function deserialize(): Transactions\Transaction
+    public function deserialize(): Transaction
     {
         $data = [];
 
@@ -108,7 +108,7 @@ private function deserializeCommon(array &$data): void
         $data['fee']             = strval($this->buffer->readUInt64());
     }
 
-    private function deserializeVendorField(Transactions\Transaction $transaction): void
+    private function deserializeVendorField(Transaction $transaction): void
     {
         $vendorFieldLength = $this->buffer->readUInt8();
         if ($vendorFieldLength > 0) {
@@ -264,11 +264,11 @@ private function detectSchnorr(): bool
     /**
      * Handle the deserialization of transaction data with a version of 2.0.
      *
-     * @param \ArkEcosystem\Crypto\Transaction $transaction
+     * @param Transaction $transaction
      *
-     * @return \ArkEcosystem\Crypto\Transactions\Transaction
+     * @return Transaction
      */
-    public function handleVersionTwo(Transactions\Transaction $transaction): Transactions\Transaction
+    public function handleVersionTwo(Transaction $transaction): Transaction
     {
         $transaction->data['id'] = Hash::sha256(Serializer::new($transaction)->serialize())->getHex();
 

diff --git a/src/Transactions/Serializer.php b/src/Transactions/Serializer.php
@@ -120,7 +120,7 @@ private function serializeVendorField(ByteBuffer $buffer): void
     /**
      * Handle the serialization of transaction data.
      *
-     * @param \BrianFaust\ByteBuffer\ByteBuffer $buffer
+     * @param ByteBuffer $buffer
      *
      * @return string
      */

diff --git a/src/Transactions/Types/Transaction.php b/src/Transactions/Types/Transaction.php
@@ -54,7 +54,7 @@ public function getBytes($options = []): Buffer
      *
      * @param \BitWasp\Bitcoin\Crypto\EcAdapter\Impl\PhpEcc\Key\PrivateKey $keys
      *
-     * @return \ArkEcosystem\Crypto\Transactions\Transaction
+     * @return Transaction
      */
     public function sign(PrivateKey $keys): self
     {
@@ -73,7 +73,7 @@ public function sign(PrivateKey $keys): self
      *
      * @param \BitWasp\Bitcoin\Crypto\EcAdapter\Impl\PhpEcc\Key\PrivateKey $keys
      *
-     * @return \ArkEcosystem\Crypto\Transactions\Transaction
+     * @return Transaction
      */
     public function secondSign(PrivateKey $keys): self
     {
@@ -143,14 +143,14 @@ public function verifySchnorr(Buffer $bytes, string $publicKey, string $signatur
     /**
      * Perform AIP11 compliant serialization.
      *
-     * @return \BrianFaust\ByteBuffer $buffer
+     * @return ByteBuffer $buffer
      */
     abstract public function serialize(array $options = []): ByteBuffer;
 
     /**
      * Perform AIP11 compliant deserialization.
      *
-     * @param \BrianFaust\ByteBuffer $buffer
+     * @param ByteBuffer $buffer
      *
      * @return void
      */

diff --git a/src/Utils/Message.php b/src/Utils/Message.php
@@ -109,7 +109,7 @@ public static function new($message): self
      * @param string $message
      * @param string $passphrase
      *
-     * @return \ArkEcosystem\Crypto\Message
+     * @return \ArkEcosystem\Crypto\Utils\Message
      */
     public static function sign(string $message, string $passphrase): self
     {

diff --git a/tests/Analysis/AnalysisTest.php b/tests/Analysis/AnalysisTest.php
@@ -0,0 +1,27 @@
+<?php
+
+namespace Tests\Analysis;
+
+use GrahamCampbell\Analyzer\AnalysisTrait;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @coversNothing
+ */
+class AnalysisTest extends TestCase
+{
+    use AnalysisTrait;
+
+    public function getPaths(): array
+    {
+        return [
+            __DIR__.'/../../src',
+            __DIR__.'/../../tests',
+        ];
+    }
+
+    public function getIgnored(): array
+    {
+        return [];
+    }
+}