PHP7 support

Author: Thomas Kerin

.travis.yml

@@ -1,10 +1,9 @@
 language: php
 
 php:
-  - 5.6
   - 7
-  - hhvm
   - 7.1
+  - 7.2
   - nightly
 
 dist: trusty
@@ -17,11 +16,11 @@ install:
 
 script:
   - php vendor/bin/phpunit
-  - php vendor/bin/phpcs -n --standard=PSR1,PSR2 --report=full src/
+  - php vendor/bin/phpcs -n --standard=PSR1,PSR2 --report=full src/ tests/ examples/
 
 after_success:
   - wget https://scrutinizer-ci.com/ocular.phar
-  - sh -c 'if [ "$TRAVIS_PHP_VERSION" != "hhvm" && "$TRAVIS_PHP_VERSION" !== "nightly" ] && [ "$TRAVIS_PHP_VERSION" != "nightly"  ]; then php ocular.phar code-coverage:upload --format=php-clover build/docs/clover.xml; fi;'
+  - sh -c 'if [ "$TRAVIS_PHP_VERSION" != "hhvm" ] && [ "$TRAVIS_PHP_VERSION" != "nightly" ]; then php ocular.phar code-coverage:upload --format=php-clover build/docs/clover.xml; fi;'
 
 matrix:
     fast_finish: true

composer.json

@@ -23,7 +23,7 @@
     }
   },
   "require": {
-    "mdanter/ecc": "~0.4"
+    "mdanter/ecc": "v0.5.0"
   },
   "require-dev": {
     "phpunit/phpunit": "~5.0",

examples/usingParser.php

@@ -20,4 +20,4 @@
 
 foreach ($set as $item) {
     echo $item->getBinary() . PHP_EOL;
-}
+}

examples/usingTemplates.php

@@ -28,11 +28,11 @@
 // a structure-specific parser reads the internal structure (not needed for writing)
 
 $vector = (new TemplateFactory())
-    ->vector(function () {}) // can be null, since we're writing
+    ->vector(function () {
+    }) // can be null, since we're writing
     ->getTemplate()
     ->write([$set]);
 
 echo $vector->getHex() . PHP_EOL;
 
 echo $vector->getBinary() . PHP_EOL;
-

examples/usingTemplates2.php

@@ -32,4 +32,4 @@
 // Use the template to read resulting Buffer
 $parsed = $template->parse(new Parser($binary));
 
-print_r($parsed);
+print_r($parsed);

phpunit.xml

@@ -7,6 +7,11 @@
             <directory>./tests/</directory>
         </testsuite>
     </testsuites>
+    <filter>
+        <whitelist>
+            <directory>src</directory>
+        </whitelist>
+    </filter>
     <logging>
         <log type="coverage-html" target="build/docs/code-coverage"/>
         <log type="coverage-clover" target="build/docs/clover.xml"/>

src/Buffertools/Buffer.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace BitWasp\Buffertools;
 
 use Mdanter\Ecc\EccFactory;
@@ -17,20 +19,14 @@ class Buffer implements BufferInterface
      */
     protected $buffer;
 
-    /**
-     * @var GmpMathInterface
-     */
-    protected $math;
-
     /**
      * @param string               $byteString
      * @param null|integer         $byteSize
      * @param GmpMathInterface     $math
      * @throws \Exception
      */
-    public function __construct($byteString = '', $byteSize = null, GmpMathInterface $math = null)
+    public function __construct(string $byteString = '', int $byteSize = null, GmpMathInterface $math = null)
     {
-        $this->math = $math ?: EccFactory::getAdapter();
         if ($byteSize !== null) {
             // Check the integer doesn't overflow its supposed size
             if (strlen($byteString) > $byteSize) {
@@ -64,7 +60,7 @@ public function __debugInfo()
      * @return Buffer
      * @throws \Exception
      */
-    public static function hex($hexString = '', $byteSize = null, GmpMathInterface $math = null)
+    public static function hex(string $hexString = '', int $byteSize = null, GmpMathInterface $math = null): Buffer
     {
         if (strlen($hexString) > 0 && !ctype_xdigit($hexString)) {
             throw new \InvalidArgumentException('Buffer::hex: non-hex character passed');
@@ -81,7 +77,7 @@ public static function hex($hexString = '', $byteSize = null, GmpMathInterface $
      * @param GmpMathInterface|null $math
      * @return Buffer
      */
-    public static function int($integer, $byteSize = null, GmpMathInterface $math = null)
+    public static function int($integer, $byteSize = null, GmpMathInterface $math = null): Buffer
     {
         if ($integer < 0) {
             throw new \InvalidArgumentException('Negative integers not supported by Buffer::int. This could be an application error, or you should be using templates.');
@@ -95,10 +91,10 @@ public static function int($integer, $byteSize = null, GmpMathInterface $math =
     /**
      * @param integer      $start
      * @param integer|null $end
-     * @return Buffer
+     * @return BufferInterface
      * @throws \Exception
      */
-    public function slice($start, $end = null)
+    public function slice(int $start, int $end = null): BufferInterface
     {
         if ($start > $this->getSize()) {
             throw new \Exception('Start exceeds buffer length');
@@ -118,15 +114,15 @@ public function slice($start, $end = null)
         }
 
         $length = strlen($string);
-        return new self($string, $length, $this->math);
+        return new self($string, $length);
     }
 
     /**
      * Get the size of the buffer to be returned
      *
      * @return int
      */
-    public function getSize()
+    public function getSize(): int
     {
         return $this->size;
     }
@@ -136,15 +132,15 @@ public function getSize()
      *
      * @return int
      */
-    public function getInternalSize()
+    public function getInternalSize(): int
     {
         return strlen($this->buffer);
     }
 
     /**
      * @return string
      */
-    public function getBinary()
+    public function getBinary(): string
     {
         // if a size is specified we'll make sure the value returned is that size
         if ($this->size !== null) {
@@ -161,15 +157,15 @@ public function getBinary()
     /**
      * @return string
      */
-    public function getHex()
+    public function getHex(): string
     {
         return unpack("H*", $this->getBinary())[1];
     }
 
     /**
      * @return \GMP
      */
-    public function getGmp()
+    public function getGmp(): \GMP
     {
         $gmp = gmp_init($this->getHex(), 16);
         return $gmp;
@@ -178,24 +174,26 @@ public function getGmp()
     /**
      * @return int|string
      */
-    public function getInt()
+    public function getInt(): string
     {
         return gmp_strval($this->getGmp(), 10);
     }
 
     /**
-     * @return BufferInterface
+     * @return Buffer
      */
-    public function flip()
+    public function flip(): Buffer
     {
-        return Buffertools::flipBytes($this);
+        /** @var Buffer $buffer */
+        $buffer = Buffertools::flipBytes($this);
+        return $buffer;
     }
 
     /**
      * @param BufferInterface $other
      * @return bool
      */
-    public function equals(BufferInterface $other)
+    public function equals(BufferInterface $other): bool
     {
         return ($other->getSize() === $this->getSize()
              && $other->getBinary() === $this->getBinary());

src/Buffertools/BufferInterface.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace BitWasp\Buffertools;
 
 interface BufferInterface
@@ -10,49 +12,50 @@ interface BufferInterface
      * @return BufferInterface
      * @throws \Exception
      */
-    public function slice($start, $end = null);
+    public function slice(int $start, int $end = null): BufferInterface;
 
     /**
      * Get the size of the buffer to be returned
      *
      * @return int
      */
-    public function getSize();
+    public function getSize(): int;
 
     /**
      * Get the size of the value stored in the buffer
      *
      * @return int
      */
-    public function getInternalSize();
+    public function getInternalSize(): int;
 
     /**
      * @return string
      */
-    public function getBinary();
+    public function getBinary(): string;
 
     /**
      * @return string
      */
-    public function getHex();
+    public function getHex(): string;
 
     /**
      * @return int|string
      */
-    public function getInt();
+    public function getInt(): string;
 
     /**
      * @return \GMP
      */
-    public function getGmp();
+    public function getGmp(): \GMP;
 
     /**
      * @return Buffer
      */
-    public function flip();
+    public function flip(): Buffer;
 
     /**
+     * @param BufferInterface $other
      * @return bool
      */
-    public function equals(BufferInterface $other);
+    public function equals(BufferInterface $other): bool;
 }

src/Buffertools/Buffertools.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace BitWasp\Buffertools;
 
 class Buffertools
@@ -9,7 +11,7 @@ class Buffertools
      * @return string
      * @throws \Exception
      */
-    public static function numToVarIntBin($decimal)
+    public static function numToVarIntBin(int $decimal): string
     {
         if ($decimal < 0xfd) {
             $bin = chr($decimal);
@@ -31,10 +33,10 @@ public static function numToVarIntBin($decimal)
      * Convert a decimal number into a VarInt Buffer
      *
      * @param  integer $decimal
-     * @return Buffer
+     * @return BufferInterface
      * @throws \Exception
      */
-    public static function numToVarInt($decimal)
+    public static function numToVarInt(int $decimal): BufferInterface
     {
         return new Buffer(static::numToVarIntBin($decimal));
     }
@@ -67,7 +69,7 @@ public static function flipBytes($bytes)
      * @param int    $size
      * @return BufferInterface
      */
-    public static function concat(BufferInterface $buffer1, BufferInterface $buffer2, $size = null)
+    public static function concat(BufferInterface $buffer1, BufferInterface $buffer2, int $size = null)
     {
         return new Buffer($buffer1->getBinary() . $buffer2->getBinary(), $size);
     }
@@ -89,7 +91,7 @@ public static function concat(BufferInterface $buffer1, BufferInterface $buffer2
      * @param callable $convertToBuffer
      * @return array
      */
-    public static function sort(array $items, callable $convertToBuffer = null)
+    public static function sort(array $items, callable $convertToBuffer = null): array
     {
         if (null == $convertToBuffer) {
             $convertToBuffer = function ($value) {

src/Buffertools/ByteOrder.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace BitWasp\Buffertools;
 
 class ByteOrder