#reader-interface fixed @Covers notations + fixed example in README + cleaned reader immutable behavior

Author: hanovruslan

README.md

@@ -28,7 +28,7 @@ $reader = \PHPExif\Reader::factory(\PHPExif\Reader::TYPE_NATIVE);
 // reader with Exiftool adapter
 //$reader = \PHPExif\Reader::factory(\PHPExif\Reader::TYPE_EXIFTOOL);
 
-$exif = $reader->getExifFromFile('/path/to/file');
+$exif = $reader->read('/path/to/file');
 
 echo 'Title: ' . $exif->getTitle() . PHP_EOL;
 ```
@@ -44,7 +44,7 @@ $adapter = new \PHPExif\Reader\Adapter\Exiftool(
 );
 $reader = new \PHPExif\Reader($adapter);
 
-$exif = $reader->getExifFromFile('/path/to/file');
+$exif = $reader->read('/path/to/file');
 
 echo 'Title: ' . $exif->getTitle() . PHP_EOL;
 ```

lib/PHPExif/Reader/Reader.php

@@ -45,27 +45,10 @@ class Reader implements ReaderInterface
     public function __construct(AdapterInterface $adapter = null)
     {
         if (!is_null($adapter)) {
-            $this->setAdapter($adapter);
+            $this->adapter = $adapter;
         }
     }
 
-    /**
-     * Setter for the reader adapter
-     *
-     * @param \PHPExif\Adapter\AdapterInterface $adapter
-     * @return $this Current instance for chaining
-     * @throws ImmutableException when adapter is already set
-     */
-    public function setAdapter(AdapterInterface $adapter)
-    {
-        if (isset($this->adapter)) {
-            throw new ImmutableException('cannot override adapter');
-        }
-        $this->adapter = $adapter;
-
-        return $this;
-    }
-
     /**
      * Getter for the reader adapter
      *
@@ -108,10 +91,7 @@ public static function factory($type)
                 );
                 break;
         }
-        $result = new $classname();
-        $result->setAdapter($adapter);
-
-        return $result;
+        return $classname($adapter);
     }
 
     /**
@@ -124,4 +104,15 @@ public function read($file)
     {
         return $this->getAdapter()->getExifFromFile($file);
     }
+
+    /**
+     * alias to read method
+     *
+     * @param string $file
+     * @return \PHPExif\Exif Instance of Exif object with data
+     */
+    public function getExifFromFile($file)
+    {
+        return $this->read($file);
+    }
 }

tests/PHPExif/Reader/AdapterAbstractTest.php

@@ -14,7 +14,7 @@ public function setUp()
 
     /**
      * @group adapter
-     * @covers \PHPExif\AdapterAbstract::determinePropertyGetter
+     * @covers \PHPExif\Adapter\AdapterAbstract::determinePropertyGetter
      */
     public function testDeterminePropertyGetter()
     {
@@ -31,7 +31,7 @@ public function testDeterminePropertyGetter()
 
     /**
      * @group adapter
-     * @covers \PHPExif\AdapterAbstract::determinePropertySetter
+     * @covers \PHPExif\Adapter\AdapterAbstract::determinePropertySetter
      */
     public function testDeterminePropertySetter()
     {
@@ -48,7 +48,7 @@ public function testDeterminePropertySetter()
 
     /**
      * @group adapter
-     * @covers \PHPExif\AdapterAbstract::getClassConstantsOfType
+     * @covers \PHPExif\Adapter\AdapterAbstract::getClassConstantsOfType
      */
     public function testGetClassConstantsOfTypeAlwaysReturnsArray()
     {
@@ -60,7 +60,7 @@ public function testGetClassConstantsOfTypeAlwaysReturnsArray()
 
     /**
      * @group adapter
-     * @covers \PHPExif\AdapterAbstract::getClassConstantsOfType
+     * @covers \PHPExif\Adapter\AdapterAbstract::getClassConstantsOfType
      */
     public function testGetClassConstantsOfTypeReturnsCorrectData()
     {
@@ -74,7 +74,7 @@ public function testGetClassConstantsOfTypeReturnsCorrectData()
 
     /**
      * @group adapter
-     * @covers \PHPExif\AdapterAbstract::toArray
+     * @covers \PHPExif\Adapter\AdapterAbstract::toArray
      */
     public function testToArrayReturnsPropertiesWithGetters()
     {
@@ -90,7 +90,7 @@ public function testToArrayReturnsPropertiesWithGetters()
 
     /**
      * @group adapter
-     * @covers \PHPExif\AdapterAbstract::toArray
+     * @covers \PHPExif\Adapter\AdapterAbstract::toArray
      */
     public function testToArrayOmmitsPropertiesWithoutGetters()
     {
@@ -105,7 +105,7 @@ public function testToArrayOmmitsPropertiesWithoutGetters()
 
     /**
      * @group adapter
-     * @covers \PHPExif\AdapterAbstract::setOptions
+     * @covers \PHPExif\Adapter\AdapterAbstract::setOptions
      */
     public function testSetOptionsReturnsCurrentInstance()
     {
@@ -115,7 +115,7 @@ public function testSetOptionsReturnsCurrentInstance()
 
     /**
      * @group adapter
-     * @covers \PHPExif\AdapterAbstract::setOptions
+     * @covers \PHPExif\Adapter\AdapterAbstract::setOptions
      */
     public function testSetOptionsCorrectlySetsProperties()
     {
@@ -135,7 +135,7 @@ public function testSetOptionsCorrectlySetsProperties()
 
     /**
      * @group adapter
-     * @covers \PHPExif\AdapterAbstract::setOptions
+     * @covers \PHPExif\Adapter\AdapterAbstract::setOptions
      */
     public function testSetOptionsIgnoresPropertiesWithoutSetters()
     {
@@ -154,7 +154,7 @@ public function testSetOptionsIgnoresPropertiesWithoutSetters()
 
     /**
      * @group adapter
-     * @covers \PHPExif\AdapterAbstract::__construct
+     * @covers \PHPExif\Adapter\AdapterAbstract::__construct
      */
     public function testConstructorSetsOptions()
     {

tests/PHPExif/ReaderTest.php

@@ -16,22 +16,7 @@ public function setUp()
 
     /**
      * @group reader
-     * @covers \PHPExif\Reader::setAdapter
-     */
-    public function testSetAdapterInProperty()
-    {
-        $adapter = $this->getMock('\PHPExif\Adapter\AdapterInterface');
-        $reflProperty = new \ReflectionProperty('\PHPExif\Reader\Reader', 'adapter');
-        $reflProperty->setAccessible(true);
-        $this->assertNull($reflProperty->getValue($this->reader));
-        $this->reader->setAdapter($adapter);
-
-        $this->assertSame($adapter, $reflProperty->getValue($this->reader));
-    }
-
-    /**
-     * @group reader
-     * @covers \PHPExif\Reader::__construct
+     * @covers \PHPExif\Reader\Reader::__construct
      */
     public function testConstructorWithAdapter()
     {
@@ -46,7 +31,7 @@ public function testConstructorWithAdapter()
 
     /**
      * @group reader
-     * @covers \PHPExif\Reader::getAdapter
+     * @covers \PHPExif\Reader\Reader::getAdapter
      */
     public function testGetAdapterFromProperty()
     {
@@ -61,7 +46,7 @@ public function testGetAdapterFromProperty()
 
     /**
      * @group reader
-     * @covers \PHPExif\Reader::getAdapter
+     * @covers \PHPExif\Reader\Reader::getAdapter
      * @expectedException \PHPExif\Adapter\NoAdapterException
      */
     public function testGetAdapterThrowsException()
@@ -71,24 +56,23 @@ public function testGetAdapterThrowsException()
 
     /**
      * @group reader
-     * @covers \PHPExif\Reader::getExifFromFile
+     * @covers \PHPExif\Reader\Reader::read
      */
     public function testGetExifPassedToAdapter()
     {
-        $mock = $this->getMock('\PHPExif\Adapter\AdapterInterface');
-        $mock->expects($this->once())
-            ->method('getExifFromFile');
+        $adapter = $this->getMock('\PHPExif\Adapter\AdapterInterface');
+        $adapter->expects($this->once())->method('getExifFromFile');
 
         $reflProperty = new \ReflectionProperty('\PHPExif\Reader\Reader', 'adapter');
         $reflProperty->setAccessible(true);
-        $reflProperty->setValue($this->reader, $mock);
+        $reflProperty->setValue($this->reader, $adapter);
 
         $this->reader->read('/tmp/foo.bar');
     }
 
     /**
      * @group reader
-     * @covers \PHPExif\Reader::factory
+     * @covers \PHPExif\Reader\Reader::factory
      * @expectedException InvalidArgumentException
      */
     public function testFactoryThrowsException()
@@ -98,7 +82,7 @@ public function testFactoryThrowsException()
 
     /**
      * @group reader
-     * @covers \PHPExif\Reader::factory
+     * @covers \PHPExif\Reader\Reader::factory
      */
     public function testFactoryReturnsCorrectType()
     {
@@ -109,7 +93,7 @@ public function testFactoryReturnsCorrectType()
 
     /**
      * @group reader
-     * @covers \PHPExif\Reader::factory
+     * @covers \PHPExif\Reader\Reader::factory
      */
     public function testFactoryAdapterTypeNative()
     {
@@ -124,7 +108,7 @@ public function testFactoryAdapterTypeNative()
 
     /**
      * @group reader
-     * @covers \PHPExif\Reader::factory
+     * @covers \PHPExif\Reader\Reader::factory
      */
     public function testFactoryAdapterTypeExiftool()
     {
@@ -137,15 +121,4 @@ public function testFactoryAdapterTypeExiftool()
         $this->assertInstanceOf('\PHPExif\Adapter\Exiftool', $adapter);
     }
 
-    /**
-     * @group reader
-     * @covers \PHPExif\Reader::factory
-     */
-    public function testReaderIsImmutable()
-    {
-        $this->setExpectedException('\\PHPExif\\Reader\\ImmutableException');
-        $reader = \PHPExif\Reader\Reader::factory(\PHPExif\Reader\Reader::TYPE_EXIFTOOL);
-        $adapter = $this->getMock('\PHPExif\Adapter\AdapterInterface');
-        $reader->setAdapter($adapter);
-    }
 }