Test fixes

Author: ivanlanin

src/PhpWord/Shared/ZipArchive.php

@@ -31,9 +31,9 @@
  * @method  bool addFromString(string $localname, string $contents)
  * @method  bool close()
  * @method  bool extractTo(string $destination, mixed $entries = null)
- * @method  bool getFromName(string $name)
- * @method  bool getNameIndex(int $index)
- * @method  bool locateName (string $name)
+ * @method  string getFromName(string $name)
+ * @method  string getNameIndex(int $index)
+ * @method  int locateName(string $name)
  * @method  bool open(string $filename, int $flags = null)
  * @since   0.10.0
  */
@@ -142,7 +142,7 @@ public function close()
      *
      * @param string $destination
      * @param string|array $entries
-     * @return boolean
+     * @return bool
      * @since 0.10.0
      */
     public function extractTo($destination, $entries = null)
@@ -266,7 +266,7 @@ public function pclzipAddFromString($localname, $contents)
      *
      * @param string $destination
      * @param string|array $entries
-     * @return boolean
+     * @return bool
      * @since 0.10.0
      */
     public function pclzipExtractTo($destination, $entries = null)
@@ -320,7 +320,7 @@ public function pclzipGetFromName($filename)
     /**
      * Returns the name of an entry using its index (emulate \ZipArchive)
      *
-     * @param integer $index
+     * @param int $index
      * @return string|false
      * @since 0.10.0
      */
@@ -338,7 +338,7 @@ public function pclzipGetNameIndex($index)
      * Returns the index of the entry in the archive (emulate \ZipArchive)
      *
      * @param string $filename Filename for the file in zip archive
-     * @return integer|false
+     * @return int|false
      */
     public function pclzipLocateName($filename)
     {

src/PhpWord/Writer/AbstractWriter.php

@@ -281,11 +281,10 @@ protected function getZipArchive($filename)
     /**
      * Add files to package
      *
-     * @param $zip
+     * @param \PhpOffice\PhpWord\Shared\ZipArchive $zip
      * @param mixed $elements
-     * @return \PhpOffice\PhpWord\Shared\ZipArchive $zip
      */
-    protected function addFilesToPackage($zip, $elements)
+    protected function addFilesToPackage(ZipArchive $zip, $elements)
     {
         foreach ($elements as $element) {
             $type = $element['type']; // image|object|link

tests/PhpWord/Tests/Shared/ZipArchiveTest.php

@@ -28,57 +28,43 @@
  */
 class ZipArchiveTest extends \PHPUnit_Framework_TestCase
 {
+
     /**
-     * Test all methods
+     * Test close method exception
      *
-     * @covers ::<public>
+     * @expectedException \PhpOffice\PhpWord\Exception\Exception
+     * @expectedExceptionMessage Could not close zip file
+     * @covers ::close
      */
-    public function testZipArchive()
+    public function testCloseException()
     {
-        // Preparation
-        $existingFile = __DIR__ . "/../_files/documents/sheet.xls";
-        $zipFile      = __DIR__ . "/../_files/documents/ziptest.zip";
-        $destination1 = __DIR__ . "/../_files/documents/extract1";
-        $destination2 = __DIR__ . "/../_files/documents/extract2";
-        @mkdir($destination1);
-        @mkdir($destination2);
-
-        Settings::setZipClass('PhpOffice\PhpWord\Shared\ZipArchive');
+        $zipFile = __DIR__ . "/../_files/documents/ziptest.zip";
 
         $object = new ZipArchive();
         $object->open($zipFile, ZipArchive::CREATE);
-        $object->addFile($existingFile, 'xls/new.xls');
         $object->addFromString('content/string.txt', 'Test');
-        $object->close();
-        $object->open($zipFile);
-
-        // Run tests
-        $this->assertEquals(0, $object->locateName('xls/new.xls'));
-        $this->assertFalse($object->locateName('blablabla'));
 
-        $this->assertEquals('Test', $object->getFromName('content/string.txt'));
-        $this->assertEquals('Test', $object->getFromName('/content/string.txt'));
+        // Lock the file
+        $fp = fopen($zipFile, "w");
+        flock($fp, LOCK_EX);
 
-        $this->assertFalse($object->getNameIndex(-1));
-        $this->assertEquals('content/string.txt', $object->getNameIndex(1));
+        // Closing the file should throws an exception
+        $object->close();
 
-        $this->assertFalse($object->extractTo('blablabla'));
-        $this->assertTrue($object->extractTo($destination1));
-        $this->assertTrue($object->extractTo($destination2, 'xls/new.xls'));
-        $this->assertFalse($object->extractTo($destination2, 'blablabla'));
+        // Unlock the file
+        flock($fp, LOCK_UN);
+        fclose($fp);
 
-        // Cleanup
-        $this->deleteDir($destination1);
-        $this->deleteDir($destination2);
         @unlink($zipFile);
     }
 
     /**
      * Test all methods
      *
+     * @param string $zipClass
      * @covers ::<public>
      */
-    public function testPCLZip()
+    public function testZipArchive($zipClass = 'ZipArchive')
     {
         // Preparation
         $existingFile = __DIR__ . "/../_files/documents/sheet.xls";
@@ -88,7 +74,7 @@ public function testPCLZip()
         @mkdir($destination1);
         @mkdir($destination2);
 
-        Settings::setZipClass('ZipArchive');
+        Settings::setZipClass($zipClass);
 
         $object = new ZipArchive();
         $object->open($zipFile, ZipArchive::CREATE);
@@ -118,6 +104,16 @@ public function testPCLZip()
         @unlink($zipFile);
     }
 
+    /**
+     * Test PclZip
+     *
+     * @covers ::<public>
+     */
+    public function testPCLZip()
+    {
+        $this->testZipArchive('PhpOffice\PhpWord\Shared\ZipArchive');
+    }
+
     /**
      * Delete directory
      *