cleanup; add more tests; improve handling of edge cases;

Webifi · Dec 14, 2016 · 491547b · 491547b
1 parent c49e66c
commit 491547b
Show file tree

Hide file tree

Showing 26 changed files with 721 additions and 463 deletions.
diff --git a/composer.json b/composer.json
@@ -13,12 +13,12 @@
         "php": ">=5.4"
     },
     "require-dev": {
-        "phpunit/phpunit": "4.4.*",
+        "phpunit/phpunit": "^5.0",
         "satooshi/php-coveralls": "^1.0"
     },
     "autoload": {
         "psr-4": {
-            "TheIconic\\NameParser\\": "src/"
+            "TheIconic\\NameParser\\": ["src/", "tests/"]
         }
     }
 }
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -5,7 +5,7 @@
         >
     <testsuites>
         <testsuite name="The Iconic Name Parser Test Suite">
-            <directory>./tests/TheIconic/NameParser</directory>
+            <directory>./tests</directory>
         </testsuite>
     </testsuites>
     <filter>

diff --git a/src/Mapper/AbstractMapper.php b/src/Mapper/AbstractMapper.php
@@ -4,7 +4,9 @@
 
 abstract class AbstractMapper
 {
-
+    /**
+     * @var array
+     */
     protected $options = [];
 
     /**
@@ -26,5 +28,4 @@ public function __construct(array $options = null)
      * @return array $parts - the mapped parts
      */
     abstract public function map(array $parts);
-
 }
diff --git a/src/Mapper/FirstnameMapper.php b/src/Mapper/FirstnameMapper.php
@@ -10,7 +10,6 @@
 
 class FirstnameMapper extends AbstractMapper
 {
-
     /**
      * map firstnames in parts array
      *
@@ -19,23 +18,11 @@ class FirstnameMapper extends AbstractMapper
      */
     public function map(array $parts) {
         if (count($parts) < 2) {
-            if ($parts[0] instanceof AbstractPart) {
-                return $parts;
-            }
-
-            $parts[0] = new Firstname($parts[0]);
-
-            return $parts;
+            return [$this->handleSinglePart($parts[0])];
         }
 
-        // skip to after salutation
         $length = count($parts);
-        $start = 0;
-        for ($i = 0; $i < $length; $i++) {
-            if ($parts[$i] instanceof Salutation) {
-                $start = $i + 1;
-            }
-        }
+        $start = $this->getStartIndex($parts, $length);
 
         $pos = null;
 
@@ -46,10 +33,8 @@ public function map(array $parts) {
                 break;
             }
 
-            if ($part instanceof Initial) {
-                if (null === $pos) {
-                    $pos = $k;
-                }
+            if ($part instanceof Initial && null === $pos) {
+                $pos = $k;
             }
 
             if ($part instanceof AbstractPart) {
@@ -67,4 +52,35 @@ public function map(array $parts) {
         return $parts;
     }
 
+    /**
+     * @param $part
+     * @return Firstname
+     */
+    protected function handleSinglePart($part)
+    {
+        if ($part instanceof AbstractPart) {
+            return $part;
+        }
+
+        return new Firstname($part);
+    }
+
+    /**
+     * @param array $parts
+     * @param int $total
+     * @return int
+     */
+    protected function getStartIndex(array $parts, $total)
+    {
+        // skip to after salutation
+        $start = 0;
+
+        for ($i = 0; $i < $total; $i++) {
+            if ($parts[$i] instanceof Salutation) {
+                $start = $i + 1;
+            }
+        }
+
+        return $start;
+    }
 }
diff --git a/src/Mapper/InitialMapper.php b/src/Mapper/InitialMapper.php
@@ -5,10 +5,11 @@
 use TheIconic\NameParser\Part\AbstractPart;
 use TheIconic\NameParser\Part\Initial;
 
-// single letter, possibly followed by a period
+/**
+ * single letter, possibly followed by a period
+ */
 class InitialMapper extends AbstractMapper
 {
-
     /**
      * map intials in parts array
      *
@@ -28,5 +29,4 @@ function map(array $parts) {
 
         return $parts;
     }
-
 }
diff --git a/src/Mapper/LastnameMapper.php b/src/Mapper/LastnameMapper.php
@@ -8,7 +8,6 @@
 
 class LastnameMapper extends AbstractMapper
 {
-
     /**
      * @var array options
      */
@@ -67,8 +66,7 @@ public function map(array $parts) {
      */
     protected function hasUnmappedPartsBefore(array $parts, $index)
     {
-        foreach ($parts as $k => $part)
-        {
+        foreach ($parts as $k => $part) {
             if ($k === $index) {
                 break;
             }
@@ -80,5 +78,4 @@ protected function hasUnmappedPartsBefore(array $parts, $index)
 
         return false;
     }
-
 }
diff --git a/src/Mapper/MiddlenameMapper.php b/src/Mapper/MiddlenameMapper.php
@@ -9,7 +9,6 @@
 
 class MiddlenameMapper extends AbstractMapper
 {
-
     /**
      * map middlenames in the parts array
      *
@@ -23,12 +22,7 @@ public function map(array $parts) {
 
         // skip to after salutation
         $length = count($parts);
-        $start = 0;
-        for ($i = 0; $i < $length; $i++) {
-            if ($parts[$i] instanceof Firstname) {
-                $start = $i + 1;
-            }
-        }
+        $start = $this->getStartIndex($parts, $length);
 
         for ($k = $start; $k < $length; $k++) {
             $part = $parts[$k];
@@ -47,4 +41,22 @@ public function map(array $parts) {
         return $parts;
     }
 
+    /**
+     * @param array $parts
+     * @param int $total
+     * @return int
+     */
+    protected function getStartIndex(array $parts, $total)
+    {
+        // skip to after salutation
+        $start = 0;
+
+        for ($i = 0; $i < $total; $i++) {
+            if ($parts[$i] instanceof Firstname) {
+                $start = $i + 1;
+            }
+        }
+
+        return $start;
+    }
 }
diff --git a/src/Mapper/NicknameMapper.php b/src/Mapper/NicknameMapper.php
@@ -5,28 +5,40 @@
 use TheIconic\NameParser\Part\AbstractPart;
 use TheIconic\NameParser\Part\Nickname;
 
-// single letter, possibly followed by a period
 class NicknameMapper extends AbstractMapper
 {
-
     /**
      * map nicknames in the parts array
      *
      * @param array $parts the name parts
      * @return array the mapped parts
      */
     function map(array $parts) {
+        $isEncapsulated = false;
+
         foreach ($parts as $k => $part) {
             if ($part instanceof AbstractPart) {
                 continue;
             }
 
-            if (preg_match('/^[\(\[\<\{].*[\)\]\>\}]$/', $part)) {
-                $parts[$k] = new Nickname(substr($part, 1, -1));
+            if (preg_match('/^[\(\[\<\{]/', $part)) {
+                $isEncapsulated = true;
+
+                $part = substr($part, 1);
+            }
+
+            $addPart = $isEncapsulated;
+
+            if (preg_match('/[\)\]\>\}]$/', $part)) {
+                $isEncapsulated = false;
+                $part = substr($part, 0, -1);
+            }
+
+            if ($addPart) {
+                $parts[$k] = new Nickname($part);
             }
         }
 
         return $parts;
     }
-
 }
diff --git a/src/Mapper/SalutationMapper.php b/src/Mapper/SalutationMapper.php
@@ -7,7 +7,6 @@
 
 class SalutationMapper extends AbstractMapper
 {
-
     /**
      * map salutations in the parts array
      *
@@ -27,5 +26,4 @@ function map(array $parts) {
 
         return $parts;
     }
-
 }
diff --git a/src/Mapper/SuffixMapper.php b/src/Mapper/SuffixMapper.php
@@ -7,6 +7,12 @@
 
 class SuffixMapper extends AbstractMapper
 {
+    /**
+     * @var array options
+     */
+    protected $options = [
+        'match_single' => false,
+    ];
 
     /**
      * map suffixes in the parts array
@@ -15,6 +21,11 @@ class SuffixMapper extends AbstractMapper
      * @return array the mapped parts
      */
     function map(array $parts) {
+        if ($this->options['match_single'] && count($parts) == 1 && Suffix::isSuffix($parts[0])) {
+            $parts[0] = new Suffix($parts[0]);
+            return $parts;
+        }
+
         $start = count($parts) - 1;
 
         for ($k = $start; $k > 1; $k--) {
@@ -33,5 +44,4 @@ function map(array $parts) {
 
         return $parts;
     }
-
 }
diff --git a/src/Name.php b/src/Name.php
@@ -6,14 +6,14 @@
 
 class Name
 {
-
     /**
      * @var array the parts that make up this name
      */
     protected $parts = [];
 
     /**
      * constructor takes the array of parts this name consists of
+     *
      * @param array|null $parts
      */
     public function __construct(array $parts = null)
@@ -46,6 +46,9 @@ public function getParts()
         return $this->parts;
     }
 
+    /**
+     * @return array
+     */
     public function getAll()
     {
         $results = [];
@@ -149,5 +152,4 @@ protected function export($type)
 
         return implode(' ',  $matched);
     }
-
 }
-Original file line number
+Diff line change
@@ Expand Up / @@ -7,7 +7,6 @@ @@
     class SalutationMapper extends AbstractMapper
     {
         /**
          * map salutations in the parts array
          *
@@ Expand All / @@ -27,5 +26,4 @@ function map(array $parts) { @@
             return $parts;
         }
     }