Merge pull request #34 from Miljar/rel/v0.4.0

Rel/v0.4.0

Author: Miljar

CHANGELOG.rst

@@ -1,6 +1,15 @@
 CHANGELOG
 =====
 
+0.4.0
+-----
+
+* Improvement `#25`_: Extracted mapping logic into separate classes
+* Added ``GPS`` information
+* Improved unit tests; coverage up to 100%
+* Added contributor to README.md
+* Added extra stuff about unit tests to the ``Contributing`` section of the README.md
+
 0.3.0
 -----
 
@@ -12,6 +21,7 @@ CHANGELOG
 * Composer.json: added semver version for phpmd; removed pdepend
 * added ``Orientation``, ``MimeType``, ``FileSize`` and ``ColorSpace`` options to EXIF
 
+.. _`#25`: https://github.com/Miljar/php-exif/issues/25
 .. _`#24`: https://github.com/Miljar/php-exif/issues/24
 .. _`#18`: https://github.com/Miljar/php-exif/issues/18
 .. _`#15`: https://github.com/Miljar/php-exif/issues/15

README.md

@@ -1,4 +1,4 @@
-# [PHPExif v0.3.0](http://github.com/Miljar/php-exif) [![Build Status](https://travis-ci.org/Miljar/php-exif.png?branch=master)](https://travis-ci.org/Miljar/php-exif) [![Coverage Status](https://coveralls.io/repos/Miljar/php-exif/badge.svg?branch=master)](https://coveralls.io/r/Miljar/php-exif?branch=master) [![Code Climate](https://codeclimate.com/github/Miljar/php-exif/badges/gpa.svg)](https://codeclimate.com/github/Miljar/php-exif)
+# [PHPExif v0.4.0](http://github.com/Miljar/php-exif) [![Build Status](https://travis-ci.org/Miljar/php-exif.png?branch=master)](https://travis-ci.org/Miljar/php-exif) [![Coverage Status](https://coveralls.io/repos/Miljar/php-exif/badge.svg?branch=master)](https://coveralls.io/r/Miljar/php-exif?branch=master) [![Code Climate](https://codeclimate.com/github/Miljar/php-exif/badges/gpa.svg)](https://codeclimate.com/github/Miljar/php-exif)
 
 PHPExif is a library which gives you easy access to the EXIF meta-data of an image.
 
@@ -12,7 +12,7 @@ PHPExif serves as a wrapper around some native or CLI tools which access this EX
 ## Installation (composer)
 
 ```json
-"miljar/php-exif": "~0.3.0"
+"miljar/php-exif": "~0.4.0"
 ```
 
 
@@ -27,6 +27,7 @@ PHPExif serves as a wrapper around some native or CLI tools which access this EX
 Please submit all pull requests against the correct branch. The release branch for the next version is a branch with the same name as the next version. Bugfixes should go in the master branch, unless they are for code in a new release branch.
 
 PHPExif is written according the [PSR-0/1/2 standards](http://www.php-fig.org/). When submitting code, please make sure it is conform these standards.
+We aim to have all functionality covered by unit tests. When submitting code, you are strongly encouraged to unit test your code and to keep the level of code coverage on par with the current level.
 
 All contributions are welcomed and greatly appreciated.
 
@@ -40,6 +41,7 @@ Have a bug or a feature request? [Please open a new issue](https://github.com/Mi
 * [Ingewikkeld](https://github.com/Ingewikkeld)
 * [Christophe Singer](https://github.com/wasinger)
 * [Hanov Ruslan](https://github.com/hanovruslan)
+* [Julian Gutierrez](https://github.com/juliangut)
 
 ## License
 

lib/PHPExif/Adapter/AdapterAbstract.php

@@ -11,6 +11,9 @@
 
 namespace PHPExif\Adapter;
 
+use PHPExif\Mapper\MapperInterface;
+use PHPExif\Hydrator\HydratorInterface;
+
 /**
  * PHP Exif Reader Adapter Abstract
  *
@@ -21,10 +24,25 @@
  */
 abstract class AdapterAbstract implements AdapterInterface
 {
+    /**
+     * @var string
+     */
+    protected $hydratorClass = '\\PHPExif\\Hydrator\\Mutator';
+
+    /**
+     * @var \PHPExif\Mapper\MapperInterface
+     */
+    protected $mapper;
+
+    /**
+     * @var \PHPExif\Hydrator\HydratorInterface
+     */
+    protected $hydrator;
+
     /**
      * Class constructor
      *
-     * @param array $data Optional array of data to initialize the object with
+     * @param array $options Optional array of data to initialize the object with
      */
     public function __construct(array $options = array())
     {
@@ -34,88 +52,76 @@ public function __construct(array $options = array())
     }
 
     /**
-     * Set array of options in the current object
+     * Mutator for the data mapper
      *
-     * @param array $options
-     * @return \PHPExif\Reader\AdapterAbstract
+     * @param \PHPExif\Mapper\MapperInterface $mapper
+     * @return \PHPExif\Adapter\AdapterInterface
      */
-    public function setOptions(array $options)
+    public function setMapper(MapperInterface $mapper)
     {
-        foreach ($options as $property => $value) {
-            $setter = $this->determinePropertySetter($property);
-            if (method_exists($this, $setter)) {
-                $this->$setter($value);
-            }
-        }
+        $this->mapper = $mapper;
 
         return $this;
     }
 
     /**
-     * Detemines the name of the getter method for given property name
+     * Accessor for the data mapper
      *
-     * @param string $property  The property to determine the getter for
-     * @return string   The name of the getter method
+     * @return \PHPExif\Mapper\MapperInterface
      */
-    protected function determinePropertyGetter($property)
+    public function getMapper()
     {
-        $method = 'get' . ucfirst($property);
-        return $method;
+        if (null === $this->mapper) {
+            // lazy load one
+            $mapper = new $this->mapperClass;
+
+            $this->setMapper($mapper);
+        }
+
+        return $this->mapper;
     }
 
     /**
-     * Detemines the name of the setter method for given property name
+     * Mutator for the hydrator
      *
-     * @param string $property  The property to determine the setter for
-     * @return string   The name of the setter method
+     * @param \PHPExif\Hydrator\HydratorInterface $hydrator
+     * @return \PHPExif\Adapter\AdapterInterface
      */
-    protected function determinePropertySetter($property)
+    public function setHydrator(HydratorInterface $hydrator)
     {
-        $method = 'set' . ucfirst($property);
-        return $method;
+        $this->hydrator = $hydrator;
+
+        return $this;
     }
 
     /**
-     * Get a list of the class constants prefixed with given $type
+     * Accessor for the data hydrator
      *
-     * @param string $type
-     * @return array
+     * @return \PHPExif\Hydrator\HydratorInterface
      */
-    public function getClassConstantsOfType($type)
+    public function getHydrator()
     {
-        $class = new \ReflectionClass(get_called_class());
-        $constants = $class->getConstants();
-
-        $list = array();
-        $type = strtoupper($type) . '_';
-        foreach ($constants as $key => $value) {
-            if (strpos($key, $type) === 0) {
-                $list[$key] = $value;
-            }
+        if (null === $this->hydrator) {
+            // lazy load one
+            $hydrator = new $this->hydratorClass;
+
+            $this->setHydrator($hydrator);
         }
-        return $list;
+
+        return $this->hydrator;
     }
 
     /**
-     * Returns an array notation of current instance
+     * Set array of options in the current object
      *
-     * @return array
+     * @param array $options
+     * @return \PHPExif\Reader\AdapterAbstract
      */
-    public function toArray()
+    public function setOptions(array $options)
     {
-        $rc = new \ReflectionClass(get_class($this));
-        $properties = $rc->getProperties();
-        $arrResult = array();
-
-        foreach ($properties as $rp) {
-            /* @var $rp \ReflectionProperty */
-            $getter = $this->determinePropertyGetter($rp->getName());
-            if (!method_exists($this, $getter)) {
-                continue;
-            }
-            $arrResult[$rp->getName()] = $this->$getter();
-        }
+        $hydrator = $this->getHydrator();
+        $hydrator->hydrate($this, $options);
 
-        return $arrResult;
+        return $this;
     }
 }

lib/PHPExif/Adapter/AdapterInterface.php

@@ -7,6 +7,7 @@
  * @license     http://github.com/miljar/PHPExif/blob/master/LICENSE MIT License
  * @category    PHPExif
  * @package     Reader
+ * @codeCoverageIgnore
  */
 
 namespace PHPExif\Adapter;

lib/PHPExif/Adapter/Exiftool.php

@@ -14,7 +14,6 @@
 use PHPExif\Exif;
 use InvalidArgumentException;
 use RuntimeException;
-use DateTime;
 
 /**
  * PHP Exif Exiftool Reader Adapter
@@ -40,6 +39,11 @@ class Exiftool extends AdapterAbstract
      */
     protected $numeric = true;
 
+    /**
+     * @var string
+     */
+    protected $mapperClass = '\\PHPExif\\Mapper\\Exiftool';
+
     /**
      * Setter for the exiftool binary path
      *
@@ -109,8 +113,16 @@ public function getExifFromFile($file)
         );
 
         $data = json_decode($result, true);
-        $mappedData = $this->mapData(reset($data));
-        $exif = new Exif($mappedData);
+
+        // map the data:
+        $mapper = $this->getMapper();
+        $mapper->setNumeric($this->numeric);
+        $mappedData = $mapper->mapRawData(reset($data));
+
+        // hydrate a new Exif object
+        $exif = new Exif();
+        $hydrator = $this->getHydrator();
+        $hydrator->hydrate($exif, $mappedData);
         $exif->setRawData(reset($data));
 
         return $exif;
@@ -148,96 +160,4 @@ protected function getCliOutput($command)
 
         return $result;
     }
-
-    /**
-     * Maps native data to Exif format
-     *
-     * @param array $source
-     * @return array
-     */
-    public function mapData(array $source)
-    {
-        $focalLength = false;
-        if (isset($source['FocalLength'])) {
-            $focalLengthParts = explode(' ', $source['FocalLength']);
-            $focalLength = (int) reset($focalLengthParts);
-        }
-
-        $exposureTime = false;
-        if (isset($source['ExposureTime'])) {
-            $exposureTime = '1/' . round(1 / $source['ExposureTime']);
-        }
-
-        $caption = false;
-        if (isset($source['Caption'])) {
-            $caption = $source['Caption'];
-        } elseif (isset($source['Caption-Abstract'])) {
-            $caption = $source['Caption-Abstract'];
-        }
-
-        $gpsLocation = false;
-        if (isset($source['GPSLatitudeRef']) && isset($source['GPSLongitudeRef'])) {
-            $latitude  = $this->extractGPSCoordinates($source['GPSLatitude']);
-            $longitude = $this->extractGPSCoordinates($source['GPSLongitude']);
-
-            if ($latitude !== false && $longitude !== false) {
-                $gpsLocation = sprintf(
-                    '%s,%s',
-                    (strtoupper($source['GPSLatitudeRef'][0]) === 'S' ? -1 : 1) * $latitude,
-                    (strtoupper($source['GPSLongitudeRef'][0]) === 'W' ? -1 : 1) * $longitude
-                );
-            }
-        }
-
-        return array(
-            Exif::APERTURE              => (!isset($source['Aperture'])) ?
-                false : sprintf('f/%01.1f', $source['Aperture']),
-            Exif::AUTHOR                => (!isset($source['Artist'])) ? false : $source['Artist'],
-            Exif::CAMERA                => (!isset($source['Model'])) ? false : $source['Model'],
-            Exif::CAPTION               => $caption,
-            Exif::COLORSPACE            => (!isset($source[Exif::COLORSPACE]) ? false : $source[Exif::COLORSPACE]),
-            Exif::COPYRIGHT             => (!isset($source['Copyright'])) ? false : $source['Copyright'],
-            Exif::CREATION_DATE         => (!isset($source['CreateDate'])) ?
-                false : DateTime::createFromFormat('Y:m:d H:i:s', $source['CreateDate']),
-            Exif::CREDIT                => (!isset($source['Credit'])) ? false : $source['Credit'],
-            Exif::EXPOSURE              => $exposureTime,
-            Exif::FILESIZE              => (!isset($source[Exif::FILESIZE]) ? false : $source[Exif::FILESIZE]),
-            Exif::FOCAL_LENGTH          => $focalLength,
-            Exif::FOCAL_DISTANCE        => (!isset($source['ApproximateFocusDistance'])) ?
-                false : sprintf('%1$sm', $source['ApproximateFocusDistance']),
-            Exif::HEADLINE              => (!isset($source['Headline'])) ? false : $source['Headline'],
-            Exif::HEIGHT                => (!isset($source['ImageHeight'])) ? false : $source['ImageHeight'],
-            Exif::HORIZONTAL_RESOLUTION => (!isset($source['XResolution'])) ? false : $source['XResolution'],
-            Exif::ISO                   => (!isset($source['ISO'])) ? false : $source['ISO'],
-            Exif::JOB_TITLE             => (!isset($source['JobTitle'])) ? false : $source['JobTitle'],
-            Exif::KEYWORDS              => (!isset($source['Keywords'])) ? false : $source['Keywords'],
-            Exif::MIMETYPE              => (!isset($source['MIMEType'])) ? false : $source['MIMEType'],
-            Exif::ORIENTATION           => (!isset($source['Orientation'])) ? false : $source['Orientation'],
-            Exif::SOFTWARE              => (!isset($source['Software'])) ? false : $source['Software'],
-            Exif::SOURCE                => (!isset($source['Source'])) ? false : $source['Source'],
-            Exif::TITLE                 => (!isset($source['Title'])) ? false : $source['Title'],
-            Exif::VERTICAL_RESOLUTION   => (!isset($source['YResolution'])) ? false : $source['YResolution'],
-            Exif::WIDTH                 => (!isset($source['ImageWidth'])) ? false : $source['ImageWidth'],
-            Exif::GPS                   => $gpsLocation,
-        );
-    }
-
-    /**
-     * Extract GPS coordinates from formatted string
-     *
-     * @param string $coordinates
-     * @return array
-     */
-    protected function extractGPSCoordinates($coordinates)
-    {
-        if ($this->numeric === true) {
-            return abs((float) $coordinates);
-        } else {
-            if (!preg_match('!^([0-9.]+) deg ([0-9.]+)\' ([0-9.]+)"!', $coordinates, $matches)) {
-                return false;
-            }
-
-            return intval($matches[1]) + (intval($matches[2]) / 60) + (floatval($matches[3]) / 3600);
-        }
-    }
 }