Converted listCredentials() to return an iterator

gmo · Apr 10, 2016 · 872b480 · 872b480
1 parent 4a2c49d
commit 872b480
Show file tree

Hide file tree

Showing 4 changed files with 36 additions and 32 deletions.
diff --git a/src/CredStash.php b/src/CredStash.php
@@ -8,6 +8,7 @@
 use CredStash\Exception\AutoIncrementException;
 use CredStash\Store\DynamoDbStore;
 use CredStash\Store\StoreInterface;
+use Iterator;
 use Traversable;
 
 /**
@@ -93,7 +94,7 @@ public function listCredentials($pattern = '*')
 
         $credentials = $this->filterCredentials($pattern, $credentials);
 
-        $credentials = array_map(function ($version) { return ltrim($version, '0'); }, $credentials);
+        $credentials = $this->unpadVersion($credentials);
 
         return $credentials;
     }
@@ -115,12 +116,9 @@ public function search($pattern = '*', $context = [], $version = null)
 
         $credentials = $this->listCredentials($pattern);
 
-        $result = [];
         foreach ($credentials as $name => $credentialVersion) {
-            $result[$name] = $this->get($name, $context, $version !== null ? $version : $credentialVersion);
+            yield $name => $this->get($name, $context, $version !== null ? $version : $credentialVersion);
         }
-
-        return $result;
     }
 
     /**
@@ -266,27 +264,36 @@ private function paddedInt($int)
     /**
      * Filter list of credentials to those that match the pattern given.
      *
-     * @param string $pattern
-     * @param array  $credentials
+     * @param string   $pattern
+     * @param Iterator $credentials
      *
-     * @return array
+     * @return Iterator
      */
-    private function filterCredentials($pattern, array $credentials)
+    private function filterCredentials($pattern, $credentials)
     {
-        if (!$pattern || $pattern === '*') {
-            return $credentials;
+        if ($pattern && $pattern !== '*') {
+            $pattern = str_replace('\\', '\\\\', $pattern);
+        } else {
+            $pattern = null;
         }
 
-        $pattern = str_replace('\\', '\\\\', $pattern);
-
-        $result = [];
-
         foreach ($credentials as $name => $version) {
-            if (fnmatch($pattern, $name)) {
-                $result[$name] = $version;
+            if ($pattern && !fnmatch($pattern, $name)) {
+                continue;
             }
+            yield $name => $version;
         }
+    }
 
-        return $result;
+    /**
+     * @param Iterator $credentials
+     *
+     * @return Iterator
+     */
+    private function unpadVersion($credentials)
+    {
+        foreach ($credentials as $name => $version) {
+            yield $name => ltrim($version, '0');
+        }
     }
 }
diff --git a/src/CredStashInterface.php b/src/CredStashInterface.php
@@ -8,6 +8,7 @@
 use CredStash\Exception\DuplicateCredentialVersionException;
 use CredStash\Exception\EncryptionException;
 use CredStash\Exception\IntegrityException;
+use Iterator;
 use Traversable;
 
 /**
@@ -28,7 +29,7 @@ interface CredStashInterface
      *
      * @param string $pattern The pattern to search for.
      *
-     * @return array [name => version]
+     * @return Iterator [name => version]
      */
     public function listCredentials($pattern = '*');
 
@@ -42,7 +43,7 @@ public function listCredentials($pattern = '*');
      * @throws IntegrityException If the HMAC does not match.
      * @throws DecryptionException If decryption fails.
      *
-     * @return array [name => secret]
+     * @return Iterator [name => secret]
      */
     public function getAll($context = [], $version = null);
 
@@ -57,7 +58,7 @@ public function getAll($context = [], $version = null);
      * @throws IntegrityException If the HMAC does not match.
      * @throws DecryptionException If decryption fails.
      *
-     * @return array [name => secret]
+     * @return Iterator [name => secret]
      */
     public function search($pattern = '*', $context = [], $version = null);
 

diff --git a/src/Store/DynamoDbStore.php b/src/Store/DynamoDbStore.php
@@ -39,24 +39,19 @@ public function __construct(DynamoDbClient $db, $tableName = self::DEFAULT_TABLE
      */
     public function listCredentials()
     {
-        $response = $this->db->scan([
+        $pages = $this->db->getPaginator('Scan', [
             'TableName'                => $this->tableName,
             'ProjectionExpression'     => '#N, version',
             'ExpressionAttributeNames' => [
                 '#N' => 'name',
             ],
         ]);
 
-        if ($response['Count'] === 0) {
-            return [];
-        }
-
-        $result = [];
-        foreach ($response['Items'] as $item) {
-            $result[$item['name']['S']] = $item['version']['S'];
+        foreach ($pages as $page) {
+            foreach ($page['Items'] as $item) {
+                yield $item['name']['S'] => $item['version']['S'];
+            }
         }
-
-        return $result;
     }
 
     /**

diff --git a/src/Store/StoreInterface.php b/src/Store/StoreInterface.php
@@ -5,6 +5,7 @@
 use CredStash\Credential;
 use CredStash\Exception\DuplicateCredentialVersionException;
 use CredStash\Exception\CredentialNotFoundException;
+use Iterator;
 
 /**
  * A credential storage.
@@ -16,7 +17,7 @@ interface StoreInterface
     /**
      * Fetches the names and version of every credential in the store.
      *
-     * @return array [name => normalized (padded) numeric version string]
+     * @return Iterator [name => normalized (padded) numeric version string]
      */
     public function listCredentials();