OAI Refactoring

modules/oai/models/DefaultServer.php

@@ -50,25 +50,13 @@ class Oai_Model_DefaultServer extends Application_Model_Abstract
 {
     use Oai_Model_OptionsTrait;
 
-    /**
-     * Holds xml representation of document information to be processed.
-     *
-     * @var DOMDocument Defaults to null.
-     */
+    /** @var DOMDocument Document data. */
     protected $xml;
 
-    /**
-     * Holds the stylesheet for the transformation.
-     *
-     * @var DOMDocument Defaults to null.
-     */
+    /** @var DOMDocument Transformation stylesheet. */
     protected $xslt;
 
-    /**
-     * Holds the xslt processor.
-     *
-     * @var XSLTProcessor Defaults to null.
-     */
+    /** @var XSLTProcessor */
     protected $proc;
 
     /** @var Oai_Model_XmlFactory */
@@ -125,7 +113,7 @@ class Oai_Model_DefaultServer extends Application_Model_Abstract
     /** @var array */
     private $documentTypesAllowed;
 
-    /** @var array Holds information about which document state aka server_state are delivered out. */
+    /** @var array Document states aka server_states to be delivered out. */
     private $documentStatesAllowed = ['published', 'deleted'];  // maybe deleted documents too
 
     /** @var bool */

modules/oai/models/ServerFactory.php

@@ -83,21 +83,25 @@ public function create($metaDataPrefix = null)
             $serverClass = $options['class'];
         } elseif (isset($defaults['class'])) {
             $serverClass = $defaults['class'];
-        } else {
-            $serverClass = Oai_Model_DefaultServer::class;
         }
 
         if (empty($serverClass) || ! ClassLoaderHelper::classExists($serverClass)) {
-            $server = new Oai_Model_DefaultServer();
-        } else {
-            $server = new $serverClass();
+            $serverClass = Oai_Model_DefaultServer::class;
         }
 
+        $server = new $serverClass();
+
         $server->setOaiConfig($this->getOaiConfig());
         $server->initDefaults();
 
         if ($options) {
             if (isset($options['viewHelpers'])) {
+                /*
+                In order to prevent required view helpers (configured in the default configuration or directly
+                in a derived server class) from being unintentionally removed by configuring a specific format,
+                they will be always just appended to the existing ones.
+                */
+
                 $previousViewHelpers = $server->getViewHelpers();
                 $viewHelpers         = $options['viewHelpers'];
 
@@ -133,14 +137,4 @@ public function createByResumptionToken($resumptionToken)
 
         return $this->create($token->getMetadataPrefix());
     }
-
-    /**
-     * Gets all configured format prefixes
-     *
-     * @return string[]
-     */
-    public function getFormats()
-    {
-        return $this->getOaiConfig()->getFormats();
-    }
 }

tests/Bootstrap.php

@@ -42,6 +42,7 @@
 
 // Ensure library/ is on include_path
 set_include_path(implode(PATH_SEPARATOR, [
+    APPLICATION_PATH . DIRECTORY_SEPARATOR . 'tests' . DIRECTORY_SEPARATOR . 'modules' . DIRECTORY_SEPARATOR . 'oai'. DIRECTORY_SEPARATOR . 'models',
     APPLICATION_PATH . DIRECTORY_SEPARATOR . 'tests' . DIRECTORY_SEPARATOR . 'support', // Support-Klassen fuer Tests
     APPLICATION_PATH . DIRECTORY_SEPARATOR . 'tests' . DIRECTORY_SEPARATOR . 'library', // tests/library
     APPLICATION_PATH . DIRECTORY_SEPARATOR . 'library', // Server library

tests/support/DefaultOaiServer.php → tests/modules/oai/models/MockDefaultOaiServer.php

@@ -29,6 +29,6 @@
  * @license     http://www.gnu.org/licenses/gpl.html General Public License
  */
 
-class DefaultOaiServer extends Oai_Model_DefaultServer
+class MockDefaultOaiServer extends Oai_Model_DefaultServer
 {
 }

tests/support/XMetaDissPlusServer.php → tests/modules/oai/models/MockXMetaDissPlusServer.php

@@ -29,7 +29,7 @@
  * @license     http://www.gnu.org/licenses/gpl.html General Public License
  */
 
-class XMetaDissPlusServer extends Oai_Model_Prefix_XMetaDissPlus_XMetaDissPlusServer
+class MockXMetaDissPlusServer extends Oai_Model_Prefix_XMetaDissPlus_XMetaDissPlusServer
 {
     protected function initFormatDefaults()
     {

tests/modules/oai/models/OaiConfigTest.php

@@ -50,7 +50,7 @@ protected function getTestConfiguration()
                 ],
                 'format' => [
                     'default'       => [
-                        'class'       => DefaultOaiServer::class,
+                        'class'       => MockDefaultOaiServer::class,
                         'viewHelpers' => 'optionValue, fileUrl, frontdoorUrl, transferUrl, dcmiType, dcType, openAireType',
                         'xsltFile'    => 'oaiFile.xslt',
                     ],
@@ -88,7 +88,7 @@ public function testGetDefaults()
             'resumptionTokenPath' => '/vagrant/tests/workspace/tmp/resumption',
             'emailContact'        => 'opus4ci@example.org',
             'xsltFile'            => 'oaiFile.xslt',
-            'class'               => DefaultOaiServer::class,
+            'class'               => MockDefaultOaiServer::class,
             'viewHelpers'         => 'optionValue, fileUrl, frontdoorUrl, transferUrl, dcmiType, dcType, openAireType',
         ];
 

tests/modules/oai/models/ServerFactoryTest.php

@@ -53,7 +53,7 @@ protected function getTestConfiguration()
                 ],
                 'format' => [
                     'default'       => [
-                        'class'                => DefaultOaiServer::class,
+                        'class'                => MockDefaultOaiServer::class,
                         'viewHelpers'          => 'optionValue, fileUrl, frontdoorUrl, transferUrl, dcmiType, dcType, openAireType',
                         'xsltFile'             => 'oaiFile.xslt',
                         'hasFilesVisibleInOai' => 1,
@@ -102,7 +102,7 @@ public function testCreate()
         $serverFactory = new Oai_Model_ServerFactory();
         $serverFactory->setOaiConfig($this->getOaiConfig());
         $server = $serverFactory->create();
-        $this->assertEquals(DefaultOaiServer::class, get_class($server));
+        $this->assertEquals(MockDefaultOaiServer::class, get_class($server));
     }
 
     public function testCreateWithMetadataPrefix()
@@ -118,7 +118,7 @@ public function testCreateWithUnknownMetadataPrefix()
         $serverFactory = new Oai_Model_ServerFactory();
         $serverFactory->setOaiConfig($this->getOaiConfig());
         $server = $serverFactory->create('unknownPrefix');
-        $this->assertEquals(DefaultOaiServer::class, get_class($server));
+        $this->assertEquals(MockDefaultOaiServer::class, get_class($server));
     }
 
     public function testCreateWithNoFormatConfiguration()
@@ -194,15 +194,15 @@ public function testDefaultServerOptionsWithDefaultConfiguration()
             'checkEmbargo'          => false,
         ];
 
-        $this->assertEquals(DefaultOaiServer::class, get_class($server));
+        $this->assertEquals(MockDefaultOaiServer::class, get_class($server));
         $this->assertEquals($expectedOptions, $server->getOptions(array_keys($expectedOptions)));
     }
 
     public function testFormatServerClassOverwritesDefaults()
     {
         $testConfiguration                                   = $this->getTestConfiguration();
         $testConfiguration['oai']['format']['xmetadissplus'] = [
-            'class' => XMetaDissPlusServer::class,
+            'class' => MockXMetaDissPlusServer::class,
         ];
         $oaiConfig                                           = $this->getOaiConfig($testConfiguration);
         $serverFactory                                       = new Oai_Model_ServerFactory();
@@ -227,15 +227,15 @@ public function testFormatServerClassOverwritesDefaults()
             'metadataNamespaceUrl'  => 'http://www.d-nb.de/standards/xmetadissplus/',
         ];
 
-        $this->assertEquals(XMetaDissPlusServer::class, get_class($server));
+        $this->assertEquals(MockXMetaDissPlusServer::class, get_class($server));
         $this->assertEquals($expectedOptions, $server->getOptions(array_keys($expectedOptions)));
     }
 
     public function testFormatServerClassOptionsOverwrittenByFormatConfiguration()
     {
         $testConfiguration                                   = $this->getTestConfiguration();
         $testConfiguration['oai']['format']['xmetadissplus'] = [
-            'class'        => XMetaDissPlusServer::class,
+            'class'        => MockXMetaDissPlusServer::class,
             'viewHelpers'  => 'additionalViewHelper1, additionalViewHelper2',
             'xsltFile'     => 'configuredXMetaDissPlus.xslt',
             'checkEmbargo' => 0,
@@ -263,7 +263,7 @@ public function testFormatServerClassOptionsOverwrittenByFormatConfiguration()
             'metadataNamespaceUrl'  => 'http://www.d-nb.de/standards/xmetadissplus/',
         ];
 
-        $this->assertEquals(XMetaDissPlusServer::class, get_class($server));
+        $this->assertEquals(MockXMetaDissPlusServer::class, get_class($server));
         $this->assertEquals($expectedOptions, $server->getOptions(array_keys($expectedOptions)));
     }