QA: Additional unit tests and docblock fixes

ivanlanin · ivanlanin · commit 92c7a24c38eb · 2014-05-25T23:08:02.000+07:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -43,6 +43,7 @@ This release marked the change of PHPWord license from LGPL 2.1 to LGPL 3; new r
 - `Writer\Word2007\Part`: `Numbering::writeNumbering()`, `Settings::writeSettings()`, `WebSettings::writeWebSettings()`, `ContentTypes::writeContentTypes()`, `Styles::writeStyles()`, `Document::writeDocument()` all changed into `write()`
 - `Writer\Word2007\Part\DocProps`: Split into `Writer\Word2007\Part\DocPropsCore` and `Writer\Word2007\Part\DocPropsApp`
 - `Element\Title::getBookmarkId()` replaced by `Element\Title::getRelationId()`
+- `Writer\HTML::writeDocument`: Replaced by `Writer\HTML::getContent`
 
 ### Miscellaneous
 
diff --git a/src/PhpWord/Autoloader.php b/src/PhpWord/Autoloader.php
@@ -22,6 +22,7 @@
  */
 class Autoloader
 {
+    /** @const string */
     const NAMESPACE_PREFIX = 'PhpOffice\\PhpWord\\';
 
     /**
diff --git a/src/PhpWord/DocumentProperties.php b/src/PhpWord/DocumentProperties.php
@@ -22,7 +22,7 @@
  */
 class DocumentProperties
 {
-    /** Constants */
+    /** @const string Property type constants */
     const PROPERTY_TYPE_BOOLEAN = 'b';
     const PROPERTY_TYPE_INTEGER = 'i';
     const PROPERTY_TYPE_FLOAT = 'f';
diff --git a/src/PhpWord/Shared/XMLWriter.php b/src/PhpWord/Shared/XMLWriter.php
@@ -68,9 +68,8 @@ public function __construct($tempLocation = self::STORAGE_MEMORY, $tempFolder =
             // Create temporary filename
             $this->tempFile = @tempnam($tempFolder, 'xml');
 
-            // Open storage
+            // Fallback to memory when temporary file cannot be used
             if ($this->xmlWriter->openUri($this->tempFile) === false) {
-                // Fallback to memory...
                 $this->xmlWriter->openMemory();
             }
         }
@@ -105,9 +104,16 @@ public function __destruct()
      *
      * @param mixed $function
      * @param mixed $args
+     * @throws \BadMethodCallException
      */
     public function __call($function, $args)
     {
+        // Catch exception
+        if (method_exists($this->xmlWriter, $function) === false) {
+            throw new \BadMethodCallException("Method '{$function}' does not exists.");
+        }
+
+        // Run method
         try {
             @call_user_func_array(array($this->xmlWriter, $function), $args);
         } catch (\Exception $ex) {
diff --git a/src/PhpWord/Style/AbstractStyle.php b/src/PhpWord/Style/AbstractStyle.php
@@ -265,7 +265,7 @@ protected function setEnumVal($value = null, $enum = array(), $default = null)
     {
         if ($value != null && trim($value) != '' && !empty($enum) && !in_array($value, $enum)) {
             throw new \InvalidArgumentException('Invalid style value.');
-        } elseif (is_null($value) || trim($value) == '') {
+        } elseif ($value === null || trim($value) == '') {
             $value = $default;
         }
 
diff --git a/src/PhpWord/Style/Cell.php b/src/PhpWord/Style/Cell.php
@@ -144,7 +144,7 @@ public function setTextDirection($value = null)
      */
     public function getBgColor()
     {
-        if (!is_null($this->shading)) {
+        if ($this->shading !== null) {
             return $this->shading->getFill();
         } else {
             return null;
diff --git a/src/PhpWord/Style/Font.php b/src/PhpWord/Style/Font.php
@@ -540,7 +540,7 @@ public function setFgColor($value = null)
      */
     public function getBgColor()
     {
-        if (!is_null($this->shading)) {
+        if ($this->shading !== null) {
             return $this->shading->getFill();
         } else {
             return null;
diff --git a/src/PhpWord/Style/LineNumbering.php b/src/PhpWord/Style/LineNumbering.php
@@ -20,11 +20,12 @@
 /**
  * Line numbering style
  *
- * @link http://www.schemacentral.com/sc/ooxml/e-w_lnNumType-1.html
+ * @link http://www.schemacentral.com/sc/ooxml/t-w_CT_LineNumber.html
  * @since 0.10.0
  */
 class LineNumbering extends AbstractStyle
 {
+    /** @const string Line numbering restart setting http://www.schemacentral.com/sc/ooxml/a-w_restart-1.html */
     const LINE_NUMBERING_CONTINUOUS  = 'continuous';
     const LINE_NUMBERING_NEW_PAGE    = 'newPage';
     const LINE_NUMBERING_NEW_SECTION = 'newSection';
diff --git a/src/PhpWord/Style/ListItem.php b/src/PhpWord/Style/ListItem.php
@@ -65,7 +65,7 @@ class ListItem extends AbstractStyle
      */
     public function __construct($numStyle = null)
     {
-        if (!is_null($numStyle)) {
+        if ($numStyle !== null) {
             $this->setNumStyle($numStyle);
         } else {
             $this->setListType();
@@ -149,7 +149,7 @@ private function getListTypeStyle()
     {
         // Check if legacy style already registered in global Style collection
         $numStyle = "PHPWordList{$this->listType}";
-        if (!is_null(Style::getStyle($numStyle))) {
+        if (Style::getStyle($numStyle) !== null) {
             $this->setNumStyle($numStyle);
             return;
         }
diff --git a/src/PhpWord/Style/Paragraph.php b/src/PhpWord/Style/Paragraph.php
@@ -171,7 +171,7 @@ public function setAlign($value = null)
      */
     public function getSpaceBefore()
     {
-        if (!is_null($this->spacing)) {
+        if ($this->spacing !== null) {
             return $this->spacing->getBefore();
         } else {
             return null;
@@ -196,7 +196,7 @@ public function setSpaceBefore($value = null)
      */
     public function getSpaceAfter()
     {
-        if (!is_null($this->spacing)) {
+        if ($this->spacing !== null) {
             return $this->spacing->getAfter();
         } else {
             return null;
@@ -221,7 +221,7 @@ public function setSpaceAfter($value = null)
      */
     public function getSpacing()
     {
-        if (!is_null($this->spacing)) {
+        if ($this->spacing !== null) {
             return $this->spacing->getLine();
         } else {
             return null;
@@ -278,7 +278,7 @@ public function setLineHeight($lineHeight)
      */
     public function getIndent()
     {
-        if (!is_null($this->indentation)) {
+        if ($this->indentation !== null) {
             return $this->indentation->getLeft();
         } else {
             return null;
@@ -303,7 +303,7 @@ public function setIndent($value = null)
      */
     public function getHanging()
     {
-        if (!is_null($this->indentation)) {
+        if ($this->indentation !== null) {
             return $this->indentation->getHanging();
         } else {
             return null;
diff --git a/src/PhpWord/Style/Table.php b/src/PhpWord/Style/Table.php
@@ -169,7 +169,7 @@ public function getFirstRow()
      */
     public function getBgColor()
     {
-        if (!is_null($this->shading)) {
+        if ($this->shading !== null) {
             return $this->shading->getFill();
         }
 
diff --git a/src/PhpWord/Style/TextBox.php b/src/PhpWord/Style/TextBox.php
@@ -179,7 +179,7 @@ public function hasInnerMargins()
         $hasInnerMargins = false;
         $margins = $this->getInnerMargin();
         for ($i = 0; $i < count($margins); $i++) {
-            if (!is_null($margins[$i])) {
+            if ($margins[$i] !== null) {
                 $hasInnerMargins = true;
             }
         }
diff --git a/src/PhpWord/Writer/AbstractWriter.php b/src/PhpWord/Writer/AbstractWriter.php
@@ -258,7 +258,7 @@ protected function clearTempDir()
      *
      * @param string $filename
      * @return \PhpOffice\PhpWord\Shared\ZipArchive
-     * @throws \PhpOffice\PhpWord\Exception\Exception
+     * @throws \Exception
      */
     protected function getZipArchive($filename)
     {
@@ -271,13 +271,46 @@ protected function getZipArchive($filename)
         $zip = new ZipArchive();
         if ($zip->open($filename, ZipArchive::OVERWRITE) !== true) {
             if ($zip->open($filename, ZipArchive::CREATE) !== true) {
-                throw new Exception("Could not open " . $filename . " for writing.");
+                throw new \Exception("Could not open '{$filename}' for writing.");
             }
         }
 
         return $zip;
     }
 
+    /**
+     * Open file for writing
+     *
+     * @param string $filename
+     * @return resource
+     * @throws \Exception
+     * @since 0.11.0
+     */
+    protected function openFile($filename)
+    {
+        $filename = $this->getTempFile($filename);
+        $fileHandle = fopen($filename, 'w');
+        if ($fileHandle === false) {
+            throw new \Exception("Could not open '{$filename}' for writing.");
+        }
+
+        return $fileHandle;
+    }
+
+    /**
+     * Write content to file
+     *
+     * @param resource $fileHandle
+     * @param string $content
+     * @since 0.11.0
+     */
+    protected function writeFile(&$fileHandle, $content)
+    {
+        fwrite($fileHandle, $content);
+        fclose($fileHandle);
+        $this->cleanupTempFile();
+    }
+
     /**
      * Add files to package
      *
diff --git a/src/PhpWord/Writer/HTML.php b/src/PhpWord/Writer/HTML.php
@@ -17,7 +17,6 @@
 
 namespace PhpOffice\PhpWord\Writer;
 
-use PhpOffice\PhpWord\Exception\Exception;
 use PhpOffice\PhpWord\PhpWord;
 
 /**
@@ -69,25 +68,20 @@ public function __construct(PhpWord $phpWord = null)
      */
     public function save($filename = null)
     {
-        $this->setTempDir(sys_get_temp_dir() . '/PHPWordWriter/');
-        $hFile = fopen($filename, 'w');
-        if ($hFile !== false) {
-            fwrite($hFile, $this->writeDocument());
-            fclose($hFile);
-        } else {
-            throw new Exception("Can't open file");
-        }
-        $this->clearTempDir();
+        $fileHandle = $this->openFile($filename);
+        $this->writeFile($fileHandle, $this->getContent());
     }
 
     /**
-     * Get phpWord data
+     * Get content
      *
      * @return string
+     * @since 0.11.0
      */
-    public function writeDocument()
+    public function getContent()
     {
         $content = '';
+
         $content .= '<!DOCTYPE html>' . PHP_EOL;
         $content .= '<!-- Generated by PHPWord -->' . PHP_EOL;
         $content .= '<html>' . PHP_EOL;
@@ -128,4 +122,16 @@ public function addNote($noteId, $noteMark)
     {
         $this->notes[$noteId] = $noteMark;
     }
+
+    /**
+     * Write document
+     *
+     * @return string
+     * @deprecated 0.11.0
+     * @codeCoverageIgnore
+     */
+    public function writeDocument()
+    {
+        return $this->getContent();
+    }
 }
diff --git a/src/PhpWord/Writer/PDF.php b/src/PhpWord/Writer/PDF.php
@@ -65,13 +65,13 @@ public function __construct(PhpWord $phpWord)
      * @param string $name Renderer library method name
      * @param mixed[] $arguments Array of arguments to pass to the renderer method
      * @return mixed Returned data from the PDF renderer wrapper method
-     * @throws \PhpOffice\PhpWord\Exception\Exception
      */
     public function __call($name, $arguments)
     {
-        if ($this->renderer === null) {
-            throw new Exception("PDF Rendering library has not been defined.");
-        }
+        // Note: Commented because all exceptions should already be catched by `__construct`
+        // if ($this->renderer === null) {
+        //     throw new Exception("PDF Rendering library has not been defined.");
+        // }
 
         return call_user_func_array(array($this->renderer, $name), $arguments);
     }
diff --git a/src/PhpWord/Writer/PDF/DomPDF.php b/src/PhpWord/Writer/PDF/DomPDF.php
@@ -50,7 +50,7 @@ public function save($filename = null)
         //  Create PDF
         $pdf = new \DOMPDF();
         $pdf->set_paper(strtolower($paperSize), $orientation);
-        $pdf->load_html($this->writeDocument());
+        $pdf->load_html($this->getContent());
         $pdf->render();
 
         //  Write to file
diff --git a/src/PhpWord/Writer/PDF/MPDF.php b/src/PhpWord/Writer/PDF/MPDF.php
@@ -61,7 +61,7 @@ public function save($filename = null)
         $pdf->setKeywords($docProps->getKeywords());
         $pdf->setCreator($docProps->getCreator());
 
-        $pdf->writeHTML($this->writeDocument());
+        $pdf->writeHTML($this->getContent());
 
         //  Write to file
         fwrite($fileHandle, $pdf->output($filename, 'S'));
diff --git a/src/PhpWord/Writer/PDF/TCPDF.php b/src/PhpWord/Writer/PDF/TCPDF.php
@@ -54,7 +54,7 @@ public function save($filename = null)
         $pdf->setPrintFooter(false);
         $pdf->addPage();
         $pdf->setFont($this->getFont());
-        $pdf->writeHTML($this->writeDocument());
+        $pdf->writeHTML($this->getContent());
 
         // Write document properties
         $phpWord = $this->getPhpWord();
diff --git a/src/PhpWord/Writer/RTF.php b/src/PhpWord/Writer/RTF.php
@@ -17,7 +17,6 @@
 
 namespace PhpOffice\PhpWord\Writer;
 
-use PhpOffice\PhpWord\Exception\Exception;
 use PhpOffice\PhpWord\PhpWord;
 
 /**
@@ -56,29 +55,34 @@ public function __construct(PhpWord $phpWord = null)
     }
 
     /**
-     * Save PhpWord to file
+     * Save content to file
      *
      * @param string $filename
      * @throws \PhpOffice\PhpWord\Exception\Exception
      */
     public function save($filename = null)
+    {
+        $fileHandle = $this->openFile($filename);
+        $this->writeFile($fileHandle, $this->getContent());
+    }
+
+    /**
+     * Get content
+     *
+     * @return string
+     * @since 0.11.0
+     */
+    private function getContent()
     {
         $content = '';
-        $filename = $this->getTempFile($filename);
-        $hFile = fopen($filename, 'w');
-        if ($hFile !== false) {
-            $content .= '{';
-            $content .= '\rtf1' . PHP_EOL;
-            $content .= $this->getWriterPart('Header')->write();
-            $content .= $this->getWriterPart('Document')->write();
-            $content .= '}';
 
-            fwrite($hFile, $content);
-            fclose($hFile);
-        } else {
-            throw new Exception("Can't open file");
-        }
-        $this->cleanupTempFile();
+        $content .= '{';
+        $content .= '\rtf1' . PHP_EOL;
+        $content .= $this->getWriterPart('Header')->write();
+        $content .= $this->getWriterPart('Document')->write();
+        $content .= '}';
+
+        return $content;
     }
 
     /**
diff --git a/src/PhpWord/Writer/Word2007/Part/Styles.php b/src/PhpWord/Writer/Word2007/Part/Styles.php
diff --git a/tests/PhpWord/Tests/Shared/XMLWriterTest.php b/tests/PhpWord/Tests/Shared/XMLWriterTest.php
diff --git a/tests/PhpWord/Tests/Style/AbstractStyleTest.php b/tests/PhpWord/Tests/Style/AbstractStyleTest.php
diff --git a/tests/PhpWord/Tests/Style/CellTest.php b/tests/PhpWord/Tests/Style/CellTest.php
diff --git a/tests/PhpWord/Tests/Style/FontTest.php b/tests/PhpWord/Tests/Style/FontTest.php
diff --git a/tests/PhpWord/Tests/Style/ParagraphTest.php b/tests/PhpWord/Tests/Style/ParagraphTest.php
diff --git a/tests/PhpWord/Tests/Style/TableTest.php b/tests/PhpWord/Tests/Style/TableTest.php
diff --git a/tests/PhpWord/Tests/_files/documents/reader.docx b/tests/PhpWord/Tests/_files/documents/reader.docx

Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,7 @@`
`22`	`22`	`*/`
`23`	`23`	`class Autoloader`
`24`	`24`	`{`
	`25`	`+ /** @const string */`
`25`	`26`	`const NAMESPACE_PREFIX = 'PhpOffice\\PhpWord\\';`
`26`	`27`
`27`	`28`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@`
`22`	`22`	`*/`
`23`	`23`	`class DocumentProperties`
`24`	`24`	`{`
`25`		`- /** Constants */`
	`25`	`+ /** @const string Property type constants */`
`26`	`26`	`const PROPERTY_TYPE_BOOLEAN = 'b';`
`27`	`27`	`const PROPERTY_TYPE_INTEGER = 'i';`
`28`	`28`	`const PROPERTY_TYPE_FLOAT = 'f';`
Original file line number	Diff line number	Diff line change
`@@ -265,7 +265,7 @@ protected function setEnumVal($value = null, $enum = array(), $default = null)`
`265`	`265`	`{`
`266`	`266`	`if ($value != null && trim($value) != '' && !empty($enum) && !in_array($value, $enum)) {`
`267`	`267`	`throw new \InvalidArgumentException('Invalid style value.');`
`268`		`- } elseif (is_null($value) \|\| trim($value) == '') {`
	`268`	`+ } elseif ($value === null \|\| trim($value) == '') {`
`269`	`269`	`$value = $default;`
`270`	`270`	`}`
`271`	`271`
Original file line number	Diff line number	Diff line change
`@@ -144,7 +144,7 @@ public function setTextDirection($value = null)`
`144`	`144`	`*/`
`145`	`145`	`public function getBgColor()`
`146`	`146`	`{`
`147`		`- if (!is_null($this->shading)) {`
	`147`	`+ if ($this->shading !== null) {`
`148`	`148`	`return $this->shading->getFill();`
`149`	`149`	`} else {`
`150`	`150`	`return null;`
Original file line number	Diff line number	Diff line change
`@@ -540,7 +540,7 @@ public function setFgColor($value = null)`
`540`	`540`	`*/`
`541`	`541`	`public function getBgColor()`
`542`	`542`	`{`
`543`		`- if (!is_null($this->shading)) {`
	`543`	`+ if ($this->shading !== null) {`
`544`	`544`	`return $this->shading->getFill();`
`545`	`545`	`} else {`
`546`	`546`	`return null;`
Original file line number	Diff line number	Diff line change
`@@ -20,11 +20,12 @@`
`20`	`20`	`/**`
`21`	`21`	`* Line numbering style`
`22`	`22`	`*`
`23`		`- * @link http://www.schemacentral.com/sc/ooxml/e-w_lnNumType-1.html`
	`23`	`+ * @link http://www.schemacentral.com/sc/ooxml/t-w_CT_LineNumber.html`
`24`	`24`	`* @since 0.10.0`
`25`	`25`	`*/`
`26`	`26`	`class LineNumbering extends AbstractStyle`
`27`	`27`	`{`
	`28`	`+ /** @const string Line numbering restart setting http://www.schemacentral.com/sc/ooxml/a-w_restart-1.html */`
`28`	`29`	`const LINE_NUMBERING_CONTINUOUS = 'continuous';`
`29`	`30`	`const LINE_NUMBERING_NEW_PAGE = 'newPage';`
`30`	`31`	`const LINE_NUMBERING_NEW_SECTION = 'newSection';`
Original file line number	Diff line number	Diff line change
`@@ -65,7 +65,7 @@ class ListItem extends AbstractStyle`
`65`	`65`	`*/`
`66`	`66`	`public function __construct($numStyle = null)`
`67`	`67`	`{`
`68`		`- if (!is_null($numStyle)) {`
	`68`	`+ if ($numStyle !== null) {`
`69`	`69`	`$this->setNumStyle($numStyle);`
`70`	`70`	`} else {`
`71`	`71`	`$this->setListType();`
`@@ -149,7 +149,7 @@ private function getListTypeStyle()`
`149`	`149`	`{`
`150`	`150`	`// Check if legacy style already registered in global Style collection`
`151`	`151`	`$numStyle = "PHPWordList{$this->listType}";`
`152`		`- if (!is_null(Style::getStyle($numStyle))) {`
	`152`	`+ if (Style::getStyle($numStyle) !== null) {`
`153`	`153`	`$this->setNumStyle($numStyle);`
`154`	`154`	`return;`
`155`	`155`	`}`