added API methods to NameCorpus

Author: yooper

src/Corpus/NameCorpus.php

@@ -21,7 +21,13 @@ class NameCorpus extends ReadCorpusAbstract
      *
      * @var array
      */
-    protected $cache = [];
+    protected $firstNameCache = [];
+    
+    /**
+     *
+     * @var array
+     */
+    protected $lastNameCache = [];
 
     public function __construct($dir = null, $lang = 'eng') 
     {
@@ -44,7 +50,23 @@ public function getFileNames(): array
      */
     public function isFirstName($name) : bool
     {
-        return $this->isName('names_by_state_and_year', $name);
+        return !empty($this->getFirstName($name));
+    }
+    
+    /**
+     * @todo make this more flexible
+     * @param string $name
+     * @return array
+     */
+    public function getFirstName($name) : array
+    {
+        if(!isset($this->firstNameCache[$name])) {
+            $stmt = $this->getPdo()->prepare("SELECT * FROM us_names_by_state_and_year WHERE name = LOWER(:name) LIMIT 1"); 
+            $stmt->bindParam(':name', $name);
+            $stmt->execute();
+            $this->firstNameCache[$name] = $stmt->fetchAll(PDO::FETCH_ASSOC) ?? [];  
+        }
+        return $this->firstNameCache[$name];
     }
 
     /**
@@ -54,45 +76,41 @@ public function isFirstName($name) : bool
     */    
     public function isLastName($name) : bool
     {
-        return $this->isName('surnames', $name);
+        return !empty($this->getLastName($name));
     }
 
     /**
      * 
      * @param string $name
-     * @return bool
+     * @return array
      */
-    public function isFullName($name) : bool
+    public function getLastName($name) : array
     {
-        $tokens = explode(" ", $name);
-        if(count($tokens) < 2) { 
-            return false;
+        if(!isset($this->lastNameCache[$name])) {        
+            $stmt = $this->getPdo()->prepare("SELECT * FROM surnames WHERE name = LOWER(:name)"); 
+            $stmt->bindParam(':name', $name);
+            $stmt->execute();
+            $this->lastNameCache[$name] = $stmt->fetchAll(PDO::FETCH_ASSOC)[0] ?? [];            
         }
-        return $this->isFirstName(current($tokens)) && $this->isLastName(end($tokens));
+        return $this->lastNameCache[$name];
     }
 
     /**
-     * Check if the name exists
-     * @param string $tableName
+     * 
      * @param string $name
-     * @return boolean
+     * @return bool
      */
-    protected function isName($tableName, $name) : bool
+    public function isFullName($name) : bool
     {
-        $key = "{$tableName}_{$name}";
-        if(!isset($this->cache[$key])) {
-        
-            $stmt = $this->getPdo()->prepare("SELECT name FROM $tableName WHERE name = LOWER(:name) LIMIT 1"); 
-            $stmt->bindParam(':name', $name);
-            $stmt->execute();
-            $r = !empty($stmt->fetchColumn());
-            $this->cache[$key] = $r;
+        $tokens = explode(" ", $name);
+        if(count($tokens) < 2) { 
+            return false;
         }
-        return $this->cache[$key];
-    }
-    
+        return !empty($this->isFirstName(current($tokens))) && !empty($this->isLastName(end($tokens)));
+    }    
 
     /**
+     * Return the raw pdo
      * @return PDO
      */
     public function getPdo() : PDO
@@ -106,7 +124,8 @@ public function getPdo() : PDO
     public function __destruct() 
     {
         unset($this->pdo);
-        unset($this->cache);
+        unset($this->firstNameCache);
+        unset($this->lastNameCache);
     }
 
 }

tests/TextAnalysis/Corpus/NameCorpusTest.php

@@ -20,11 +20,24 @@ public function testFirstNames()
         }
 
         $corpus = new NameCorpus();
-        $this->assertTrue($corpus->isFirstName('Dan'));
-        $this->assertFalse($corpus->isFirstName('very'));
+        $this->assertTrue($corpus->isFirstName('Mike'));        
+        $this->assertFalse($corpus->isFirstName('very'));        
+    }
+
+    public function testGetFirstName()
+    {
+        if( getenv('SKIP_TEST')) {
+            return;
+        }    
 
+        $corpus = new NameCorpus();
+        $firstName = $corpus->getFirstName('Mike');
+        $this->assertNotEmpty($firstName);
+        
+        $this->assertEmpty($corpus->getFirstName('very'));       
     }
 
+    
     public function testLastNames()
     {
         if( getenv('SKIP_TEST')) {
@@ -33,8 +46,23 @@ public function testLastNames()
 
         $corpus = new NameCorpus();
         $this->assertTrue($corpus->isLastName('Williamson'));
-        $this->assertFalse($corpus->isLastName('baggins'));                          
-    }   
+        $this->assertFalse($corpus->isLastName('Baggins'));                          
+    }
+    
+    public function testGetLastName()
+    {
+        if( getenv('SKIP_TEST')) {
+            return;
+        }    
+        
+        $corpus = new NameCorpus();
+        $lastName = $corpus->getLastName('Williamson');
+        $this->assertEquals(245, $lastName['rank']); 
+
+        $lastName = $corpus->getLastName('Baggins');
+        $this->assertEmpty($lastName);        
+    }
+    
 
     public function testFullNames()
     {
@@ -45,8 +73,9 @@ public function testFullNames()
         $corpus = new NameCorpus();
         $this->assertTrue($corpus->isFullName('Brad Von Williamson'));
         $this->assertFalse($corpus->isFullName('Jimbo'));        
-        $this->assertTrue($corpus->isFullName('Bradley Thomas'));
-        
-    }       
+        $this->assertTrue($corpus->isFullName('Bradley Thomas'));        
+    }  
+    
+    
 
 }