Allow response classes to be initialized without args

For easier mocking

Author: danmichaelo

composer.json

@@ -5,7 +5,7 @@
     "homepage": "http://github.com/scriptotek/sru-client",
     "keywords": ["sru"],
     "require": {
-        "danmichaelo/quitesimplexmlelement": ">=0.2.1",
+        "danmichaelo/quitesimplexmlelement": ">=0.4.2",
         "guzzle/guzzle": "~3.8"
     },
     "require-dev": {

src/ExplainResponse.php

@@ -1,5 +1,7 @@
 <?php namespace Scriptotek\Sru;
 
+use Danmichaelo\QuiteSimpleXMLElement\QuiteSimpleXMLElement;
+
 /**
  * Explain response
  */
@@ -23,20 +25,28 @@ class ExplainResponse extends Response implements ResponseInterface
      * @param string $text Raw XML response
      * @param Client $client SRU client reference (optional)
      */
-    public function __construct($text, &$client = null)
+    public function __construct($text = null, &$client = null)
     {
         parent::__construct($text, $client);
 
         $this->indexes = array();
 
+        if (is_null($this->response)) {
+            return;
+        }
         $explain = $this->response->first('/srw:explainResponse/srw:record/srw:recordData/exp:explain');
         if (!$explain) {
             return;
         }
 
-        $serverInfo = $explain->first('exp:serverInfo');
-        $dbInfo = $explain->first('exp:databaseInfo');
-        $indexInfo = $explain->first('exp:indexInfo');
+        $this->parseExplainResponse($explain);
+    }
+
+    protected function parseExplainResponse(QuiteSimpleXMLElement $node)
+    {
+        $serverInfo = $node->first('exp:serverInfo');
+        $dbInfo = $node->first('exp:databaseInfo');
+        $indexInfo = $node->first('exp:indexInfo');
 
         $this->host = $serverInfo->text('exp:host');
         $this->port = (int) $serverInfo->text('exp:port');

src/Response.php

@@ -93,7 +93,7 @@ class Response implements ResponseInterface
     );
 
     /** @var string Raw XML response */
-    protected $rawResponse;
+    protected $rawResponse = '';
 
     /** @var QuiteSimpleXMLElement XML response */
     protected $response;
@@ -110,46 +110,56 @@ class Response implements ResponseInterface
      * @param string $text Raw XML response
      * @param Client $client SRU client reference (optional)
      */
-    public function __construct($text, &$client = null)
+    public function __construct($text = null, &$client = null)
     {
+        $this->client = $client;
+
+        if (!is_null($text)) {
+            $this->initializeFromText($text);
+        }
+    }
 
+    protected function initializeFromText($text)
+    {
         // Fix missing namespace in Alma records:
         $text = str_replace('<record xmlns="">', '<record xmlns="http://www.loc.gov/MARC21/slim">', $text);
 
         $this->rawResponse = $text;
 
         // Throws Danmichaelo\QuiteSimpleXMLElement\InvalidXMLException on invalid xml
-        $this->response = new QuiteSimpleXMLElement($text);
-
-        $this->client = $client;
-
-        $this->response->registerXPathNamespaces(array(
+        $this->response = QuiteSimpleXMLElement::make($text, [
             'srw' => 'http://www.loc.gov/zing/srw/',
             'exp' => 'http://explain.z3950.org/dtd/2.0/',
-            'd' => 'http://www.loc.gov/zing/srw/diagnostic/'
-        ));
+            'd' => 'http://www.loc.gov/zing/srw/diagnostic/',
+        ]);
 
         $this->version = $this->response->text('/srw:*/srw:version');
 
-        $diagnostic = $this->response->first('/srw:*/srw:diagnostics/d:diagnostic');
-        if ($diagnostic) {
-            // Only the 'uri' field is required, 'message' and 'details' are optional
-            $uri = $diagnostic->text('d:uri');
-            if (strlen($uri)) {
-                $msg = $diagnostic->text('d:message');
-                $details = $diagnostic->text('d:details');
-                if (empty($msg)) {
-                    if (isset(self::$errorMessages[$uri])) {
-                        $msg = self::$errorMessages[$uri];
-                    } else {
-                        $msg = 'Unknown error';
-                    }
-                }
-                if (!empty($details)) {
-                    $msg .= ' (' . $details . ')';
+        $this->handleDiagnostic($this->response->first('/srw:*/srw:diagnostics/d:diagnostic'));
+    }
+
+    protected function handleDiagnostic(QuiteSimpleXMLElement $node = null)
+    {
+        if (is_null($node)) {
+            return;
+        }
+
+        // Only the 'uri' field is required, 'message' and 'details' are optional
+        $uri = $node->text('d:uri');
+        if (strlen($uri)) {
+            $msg = $node->text('d:message');
+            $details = $node->text('d:details');
+            if (empty($msg)) {
+                if (isset(self::$errorMessages[$uri])) {
+                    $msg = self::$errorMessages[$uri];
+                } else {
+                    $msg = 'Unknown error';
                 }
-                throw new Exceptions\SruErrorException($msg, $uri);
             }
+            if (!empty($details)) {
+                $msg .= ' (' . $details . ')';
+            }
+            throw new Exceptions\SruErrorException($msg, $uri);
         }
     }
 

src/ResponseInterface.php

@@ -12,7 +12,7 @@ interface ResponseInterface
      * @param Client $client SRU client reference (optional)
      * @return void
      */
-    public function __construct($text, &$client = null);
+    public function __construct($text = null, &$client = null);
 
     /**
      * Get the raw xml response

src/SearchRetrieveResponse.php

@@ -6,27 +6,31 @@
 class SearchRetrieveResponse extends Response implements ResponseInterface
 {
     /** @var Record[] Array of records */
-    public $records;
+    public $records = [];
 
     /** @var int Total number of records in the result set */
-    public $numberOfRecords;
+    public $numberOfRecords = 0;
 
     /** @var int Position of next record in the result set, or null if no such record exist */
-    public $nextRecordPosition;
+    public $nextRecordPosition = null;
 
     /** @var string The CQL query used to generate the response */
-    public $query;
+    public $query = '';
 
     /**
      * Create a new searchRetrieve response
      *
      * @param string $text Raw XML response
      * @param Client $client SRU client reference (optional)
      */
-    public function __construct($text, &$client = null)
+    public function __construct($text = null, &$client = null)
     {
         parent::__construct($text, $client);
 
+        if (is_null($this->response)) {
+            return;
+        }
+
         $this->numberOfRecords = (int) $this->response->text('/srw:searchRetrieveResponse/srw:numberOfRecords');
         $this->nextRecordPosition = (int) $this->response->text('/srw:searchRetrieveResponse/srw:nextRecordPosition') ?: null;
 

tests/ExplainResponseTest.php

@@ -115,4 +115,10 @@ public function testNormalResponse()
         $this->assertEquals('Identifiserer en bibliografisk enhet', $res->indexes[0]->title);
         $this->assertEquals('bs.objektid', $res->indexes[0]->maps[0]);
     }
+
+    public function testCanBeInitializedWithoutAnyData()
+    {
+        $res = new ExplainResponse;
+        $this->assertNull($res->host);
+    }
 }

tests/SearchRetrieveResponseTest.php

@@ -158,4 +158,10 @@ public function testDiagnosticsWithoutError()
         </srw:searchRetrieveResponse>');
     }
 
+    public function testCanBeInitializedWithoutAnyData()
+    {
+        $res = new SearchRetrieveResponse;
+        $this->assertNull($res->version);
+    }
+
 }