use contracts (#61)

ildyria · web-flow · commit 14c624b97d3a · 2023-02-15T16:26:35.000+01:00
* use contracts
* update phpstan
diff --git a/composer.json b/composer.json
@@ -37,7 +37,7 @@
     "require-dev": {
         "friendsofphp/php-cs-fixer": "^3.3",
         "infection/infection": "^0.26.13",
-        "lychee-org/phpstan-lychee": "dev-master",
+        "lychee-org/phpstan-lychee": "^1.0.1",
         "php-parallel-lint/php-parallel-lint": "^1.2",
         "phpmd/phpmd": "^2.9",
         "phpunit/phpunit": "^9.5.10",
@@ -85,5 +85,6 @@
             "infection/extension-installer": true
         }
     },
-    "prefer-stable": true
+	"prefer-stable": true,
+    "minimum-stability": "dev"
 }
diff --git a/composer.lock b/composer.lock
diff --git a/lib/PHPExif/Adapter/AbstractAdapter.php b/lib/PHPExif/Adapter/AbstractAdapter.php
@@ -2,9 +2,10 @@
 
 namespace PHPExif\Adapter;
 
-use PHPExif\Mapper\MapperInterface;
-use PHPExif\Hydrator\HydratorInterface;
 use ForceUTF8\Encoding;
+use PHPExif\Contracts\AdapterInterface;
+use PHPExif\Contracts\HydratorInterface;
+use PHPExif\Contracts\MapperInterface;
 use PHPExif\Hydrator\Mutator;
 
 /**
@@ -39,8 +40,8 @@ public function __construct(array $options = array())
     /**
      * Mutator for the data mapper
      *
-     * @param \PHPExif\Mapper\MapperInterface $mapper
-     * @return \PHPExif\Adapter\AdapterInterface
+     * @param \PHPExif\Contracts\MapperInterface $mapper
+     * @return \PHPExif\Contracts\AdapterInterface
      */
     public function setMapper(MapperInterface $mapper) : AdapterInterface
     {
@@ -52,7 +53,7 @@ public function setMapper(MapperInterface $mapper) : AdapterInterface
     /**
      * Accessor for the data mapper
      *
-     * @return \PHPExif\Mapper\MapperInterface
+     * @return \PHPExif\Contracts\MapperInterface
      */
     public function getMapper() : MapperInterface
     {
@@ -70,8 +71,8 @@ public function getMapper() : MapperInterface
     /**
      * Mutator for the hydrator
      *
-     * @param \PHPExif\Hydrator\HydratorInterface $hydrator
-     * @return \PHPExif\Adapter\AdapterInterface
+     * @param \PHPExif\Contracts\HydratorInterface $hydrator
+     * @return \PHPExif\Contracts\AdapterInterface
      */
     public function setHydrator(HydratorInterface $hydrator) : AdapterInterface
     {
@@ -83,7 +84,7 @@ public function setHydrator(HydratorInterface $hydrator) : AdapterInterface
     /**
      * Accessor for the data hydrator
      *
-     * @return \PHPExif\Hydrator\HydratorInterface
+     * @return \PHPExif\Contracts\HydratorInterface
      */
     public function getHydrator() : HydratorInterface
     {
@@ -102,7 +103,7 @@ public function getHydrator() : HydratorInterface
      * Set array of options in the current object
      *
      * @param array $options
-     * @return \PHPExif\Adapter\AdapterInterface
+     * @return \PHPExif\Contracts\AdapterInterface
      */
     public function setOptions(array $options) : AdapterInterface
     {
diff --git a/lib/PHPExif/Contracts/AdapterInterface.php b/lib/PHPExif/Contracts/AdapterInterface.php
@@ -3,7 +3,7 @@
  * @codeCoverageIgnore
  */
 
-namespace PHPExif\Adapter;
+namespace PHPExif\Contracts;
 
 use PHPExif\Exif;
 
diff --git a/lib/PHPExif/Contracts/HydratorInterface.php b/lib/PHPExif/Contracts/HydratorInterface.php
@@ -3,7 +3,7 @@
  * @codeCoverageIgnore
  */
 
-namespace PHPExif\Hydrator;
+namespace PHPExif\Contracts;
 
 /**
  * PHP Exif Hydrator
diff --git a/lib/PHPExif/Contracts/MapperInterface.php b/lib/PHPExif/Contracts/MapperInterface.php
@@ -3,7 +3,7 @@
  * @codeCoverageIgnore
  */
 
-namespace PHPExif\Mapper;
+namespace PHPExif\Contracts;
 
 /**
  * PHP Exif Mapper
diff --git a/lib/PHPExif/Contracts/ReaderInterface.php b/lib/PHPExif/Contracts/ReaderInterface.php
@@ -3,7 +3,7 @@
  * @codeCoverageIgnore
  */
 
-namespace PHPExif\Reader;
+namespace PHPExif\Contracts;
 
 use PHPExif\Exif;
 
diff --git a/lib/PHPExif/Hydrator/Mutator.php b/lib/PHPExif/Hydrator/Mutator.php
@@ -2,6 +2,8 @@
 
 namespace PHPExif\Hydrator;
 
+use PHPExif\Contracts\HydratorInterface;
+
 /**
  * PHP Exif Mutator Hydrator
  *
diff --git a/lib/PHPExif/Mapper/AbstractMapper.php b/lib/PHPExif/Mapper/AbstractMapper.php
@@ -2,6 +2,8 @@
 
 namespace PHPExif\Mapper;
 
+use PHPExif\Contracts\MapperInterface;
+
 /**
  * PHP Exif Mapper Abstract
  *
diff --git a/lib/PHPExif/Reader/Reader.php b/lib/PHPExif/Reader/Reader.php
@@ -2,12 +2,13 @@
 
 namespace PHPExif\Reader;
 
-use PHPExif\Adapter\AdapterInterface;
 use PHPExif\Adapter\NoAdapterException;
 use PHPExif\Adapter\Exiftool as ExiftoolAdapter;
 use PHPExif\Adapter\FFprobe as FFprobeAdapter;
 use PHPExif\Adapter\ImageMagick as ImageMagickAdapter;
 use PHPExif\Adapter\Native as NativeAdapter;
+use PHPExif\Contracts\AdapterInterface;
+use PHPExif\Contracts\ReaderInterface;
 use PHPExif\Exif;
 use PHPExif\Enum\ReaderType;
 
@@ -30,7 +31,7 @@ class Reader implements ReaderInterface
     /**
      * Reader constructor
      *
-     * @param \PHPExif\Adapter\AdapterInterface $adapter
+     * @param \PHPExif\Contracts\AdapterInterface $adapter
      */
     public function __construct(AdapterInterface $adapter)
     {
@@ -40,7 +41,7 @@ public function __construct(AdapterInterface $adapter)
     /**
      * Getter for the reader adapter
      *
-     * @return \PHPExif\Adapter\AdapterInterface
+     * @return \PHPExif\Contracts\AdapterInterface
      * @throws NoAdapterException When no adapter is set
      */
     public function getAdapter(): AdapterInterface
diff --git a/tests/PHPExif/Mapper/ExiftoolMapperTest.php b/tests/PHPExif/Mapper/ExiftoolMapperTest.php
@@ -1,4 +1,7 @@
 <?php
+
+use PHPExif\Contracts\MapperInterface;
+
 /**
  * @covers \PHPExif\Mapper\Exiftool::<!public>
  */
@@ -16,7 +19,7 @@ public function setUp(): void
      */
     public function testClassImplementsCorrectInterface()
     {
-        $this->assertInstanceOf('\\PHPExif\\Mapper\\MapperInterface', $this->mapper);
+        $this->assertInstanceOf(MapperInterface::class, $this->mapper);
     }
 
     /**
diff --git a/tests/PHPExif/Mapper/FFprobeMapperTest.php b/tests/PHPExif/Mapper/FFprobeMapperTest.php
@@ -1,4 +1,7 @@
 <?php
+
+use PHPExif\Contracts\MapperInterface;
+
 /**
  * @covers \PHPExif\Mapper\FFprobe::<!public>
  */
@@ -16,7 +19,7 @@ public function setUp(): void
      */
     public function testClassImplementsCorrectInterface()
     {
-        $this->assertInstanceOf('\\PHPExif\\Mapper\\MapperInterface', $this->mapper);
+        $this->assertInstanceOf(MapperInterface::class, $this->mapper);
     }
 
     /**
diff --git a/tests/PHPExif/Mapper/ImageMagickMapperTest.php b/tests/PHPExif/Mapper/ImageMagickMapperTest.php
@@ -1,4 +1,7 @@
 <?php
+
+use PHPExif\Contracts\MapperInterface;
+
 /**
  * @covers \PHPExif\Mapper\ImageMagick::<!public>
  */
@@ -16,7 +19,7 @@ public function setUp(): void
      */
     public function testClassImplementsCorrectInterface()
     {
-        $this->assertInstanceOf('\\PHPExif\\Mapper\\MapperInterface', $this->mapper);
+        $this->assertInstanceOf(MapperInterface::class, $this->mapper);
     }
 
     /**
diff --git a/tests/PHPExif/Mapper/NativeMapperTest.php b/tests/PHPExif/Mapper/NativeMapperTest.php
@@ -1,4 +1,7 @@
 <?php
+
+use PHPExif\Contracts\MapperInterface;
+
 /**
  * @covers \PHPExif\Mapper\Native::<!public>
  */
@@ -16,7 +19,7 @@ public function setUp(): void
      */
     public function testClassImplementsCorrectInterface()
     {
-        $this->assertInstanceOf('\\PHPExif\\Mapper\\MapperInterface', $this->mapper);
+        $this->assertInstanceOf(MapperInterface::class, $this->mapper);
     }
 
     /**
diff --git a/tests/PHPExif/Reader/ReaderTest.php b/tests/PHPExif/Reader/ReaderTest.php
@@ -18,8 +18,8 @@ class ReaderTest extends \PHPUnit\Framework\TestCase
      */
     public function setUp() : void
     {
-        /** @var \PHPExif\Adapter\AdapterInterface */
-        $adapter = $this->getMockBuilder('\PHPExif\Adapter\AdapterInterface')->getMockForAbstractClass();
+        /** @var \PHPExif\Contracts\AdapterInterface */
+        $adapter = $this->getMockBuilder('\PHPExif\Contracts\AdapterInterface')->getMockForAbstractClass();
         $this->reader = new \PHPExif\Reader\Reader($adapter);
     }
 
@@ -29,8 +29,8 @@ public function setUp() : void
      */
     public function testConstructorWithAdapter()
     {
-        /** @var \PHPExif\Adapter\AdapterInterface */
-        $mock = $this->getMockBuilder('\PHPExif\Adapter\AdapterInterface')->getMockForAbstractClass();
+        /** @var \PHPExif\Contracts\AdapterInterface */
+        $mock = $this->getMockBuilder('\PHPExif\Contracts\AdapterInterface')->getMockForAbstractClass();
         $reflProperty = new \ReflectionProperty('\PHPExif\Reader\Reader', 'adapter');
         $reflProperty->setAccessible(true);
 
@@ -45,7 +45,7 @@ public function testConstructorWithAdapter()
      */
     public function testGetAdapterFromProperty()
     {
-        $mock = $this->getMockBuilder('\PHPExif\Adapter\AdapterInterface')->getMockForAbstractClass();
+        $mock = $this->getMockBuilder('\PHPExif\Contracts\AdapterInterface')->getMockForAbstractClass();
 
         $reflProperty = new \ReflectionProperty('\PHPExif\Reader\Reader', 'adapter');
         $reflProperty->setAccessible(true);
@@ -75,7 +75,7 @@ public function testGetAdapterThrowsExceptionWhenNoAdapterIsSet()
      */
     public function testGetExifPassedToAdapter()
     {
-        $adapter = $this->getMockBuilder('\PHPExif\Adapter\AdapterInterface')->getMockForAbstractClass();
+        $adapter = $this->getMockBuilder('\PHPExif\Contracts\AdapterInterface')->getMockForAbstractClass();
         $adapter->expects($this->once())->method('getExifFromFile');
 
         $reflProperty = new \ReflectionProperty('\PHPExif\Reader\Reader', 'adapter');

Original file line number	Diff line number	Diff line change
`@@ -2,9 +2,10 @@`
`2`	`2`
`3`	`3`	`namespace PHPExif\Adapter;`
`4`	`4`
`5`		`-use PHPExif\Mapper\MapperInterface;`
`6`		`-use PHPExif\Hydrator\HydratorInterface;`
`7`	`5`	`use ForceUTF8\Encoding;`
	`6`	`+use PHPExif\Contracts\AdapterInterface;`
	`7`	`+use PHPExif\Contracts\HydratorInterface;`
	`8`	`+use PHPExif\Contracts\MapperInterface;`
`8`	`9`	`use PHPExif\Hydrator\Mutator;`
`9`	`10`
`10`	`11`	`/**`
`@@ -39,8 +40,8 @@ public function __construct(array $options = array())`
`39`	`40`	`/**`
`40`	`41`	`* Mutator for the data mapper`
`41`	`42`	`*`
`42`		`- * @param \PHPExif\Mapper\MapperInterface $mapper`
`43`		`- * @return \PHPExif\Adapter\AdapterInterface`
	`43`	`+ * @param \PHPExif\Contracts\MapperInterface $mapper`
	`44`	`+ * @return \PHPExif\Contracts\AdapterInterface`
`44`	`45`	`*/`
`45`	`46`	`public function setMapper(MapperInterface $mapper) : AdapterInterface`
`46`	`47`	`{`
`@@ -52,7 +53,7 @@ public function setMapper(MapperInterface $mapper) : AdapterInterface`
`52`	`53`	`/**`
`53`	`54`	`* Accessor for the data mapper`
`54`	`55`	`*`
`55`		`- * @return \PHPExif\Mapper\MapperInterface`
	`56`	`+ * @return \PHPExif\Contracts\MapperInterface`
`56`	`57`	`*/`
`57`	`58`	`public function getMapper() : MapperInterface`
`58`	`59`	`{`
`@@ -70,8 +71,8 @@ public function getMapper() : MapperInterface`
`70`	`71`	`/**`
`71`	`72`	`* Mutator for the hydrator`
`72`	`73`	`*`
`73`		`- * @param \PHPExif\Hydrator\HydratorInterface $hydrator`
`74`		`- * @return \PHPExif\Adapter\AdapterInterface`
	`74`	`+ * @param \PHPExif\Contracts\HydratorInterface $hydrator`
	`75`	`+ * @return \PHPExif\Contracts\AdapterInterface`
`75`	`76`	`*/`
`76`	`77`	`public function setHydrator(HydratorInterface $hydrator) : AdapterInterface`
`77`	`78`	`{`
`@@ -83,7 +84,7 @@ public function setHydrator(HydratorInterface $hydrator) : AdapterInterface`
`83`	`84`	`/**`
`84`	`85`	`* Accessor for the data hydrator`
`85`	`86`	`*`
`86`		`- * @return \PHPExif\Hydrator\HydratorInterface`
	`87`	`+ * @return \PHPExif\Contracts\HydratorInterface`
`87`	`88`	`*/`
`88`	`89`	`public function getHydrator() : HydratorInterface`
`89`	`90`	`{`
`@@ -102,7 +103,7 @@ public function getHydrator() : HydratorInterface`
`102`	`103`	`* Set array of options in the current object`
`103`	`104`	`*`
`104`	`105`	`* @param array $options`
`105`		`- * @return \PHPExif\Adapter\AdapterInterface`
	`106`	`+ * @return \PHPExif\Contracts\AdapterInterface`
`106`	`107`	`*/`
`107`	`108`	`public function setOptions(array $options) : AdapterInterface`
`108`	`109`	`{`
Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,8 @@`
`2`	`2`
`3`	`3`	`namespace PHPExif\Hydrator;`
`4`	`4`
	`5`	`+use PHPExif\Contracts\HydratorInterface;`
	`6`	`+`
`5`	`7`	`/**`
`6`	`8`	`* PHP Exif Mutator Hydrator`
`7`	`9`	`*`
Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,8 @@`
`2`	`2`
`3`	`3`	`namespace PHPExif\Mapper;`
`4`	`4`
	`5`	`+use PHPExif\Contracts\MapperInterface;`
	`6`	`+`
`5`	`7`	`/**`
`6`	`8`	`* PHP Exif Mapper Abstract`
`7`	`9`	`*`