Additional unit tests and @SInCE documentation

ivanlanin · ivanlanin · commit d764de018c12 · 2014-05-21T22:36:00.000+07:00
diff --git a/src/PhpWord/Reader/AbstractReader.php b/src/PhpWord/Reader/AbstractReader.php
@@ -22,6 +22,7 @@
 /**
  * Reader abstract class
  *
+ * @since 0.8.0
  * @codeCoverageIgnore Abstract class
  */
 abstract class AbstractReader implements ReaderInterface
diff --git a/src/PhpWord/Reader/ODText/AbstractPart.php b/src/PhpWord/Reader/ODText/AbstractPart.php
@@ -22,6 +22,9 @@
 
 /**
  * Abstract part reader
+ *
+ * @since 0.10.0
+ * @codeCoverageIgnore Nothing in here yet
  */
 abstract class AbstractPart extends Word2007AbstractPart
 {
diff --git a/src/PhpWord/Reader/ReaderInterface.php b/src/PhpWord/Reader/ReaderInterface.php
@@ -19,6 +19,8 @@
 
 /**
  * Reader interface
+ *
+ * @since 0.8.0
  */
 interface ReaderInterface
 {
diff --git a/src/PhpWord/Reader/Word2007/AbstractPart.php b/src/PhpWord/Reader/Word2007/AbstractPart.php
@@ -24,6 +24,8 @@
  * Abstract part reader
  *
  * This class is inherited by ODText reader
+ *
+ * @since 0.10.0
  */
 abstract class AbstractPart
 {
@@ -466,6 +468,7 @@ protected function readStyleDefs(XMLReader $xmlReader, \DOMElement $parentNode =
             }
         }
 
+        /** @var array $styles Type hint */
         return $styles;
     }
 
diff --git a/src/PhpWord/Reader/Word2007/DocPropsApp.php b/src/PhpWord/Reader/Word2007/DocPropsApp.php
@@ -19,6 +19,8 @@
 
 /**
  * Extended properties reader
+ *
+ * @since 0.10.0
  */
 class DocPropsApp extends DocPropsCore
 {
diff --git a/src/PhpWord/Reader/Word2007/DocPropsCore.php b/src/PhpWord/Reader/Word2007/DocPropsCore.php
@@ -22,6 +22,8 @@
 
 /**
  * Core properties reader
+ *
+ * @since 0.10.0
  */
 class DocPropsCore extends AbstractPart
 {
diff --git a/src/PhpWord/Reader/Word2007/DocPropsCustom.php b/src/PhpWord/Reader/Word2007/DocPropsCustom.php
@@ -23,6 +23,8 @@
 
 /**
  * Custom properties reader
+ *
+ * @since 0.11.0
  */
 class DocPropsCustom extends AbstractPart
 {
diff --git a/src/PhpWord/Reader/Word2007/Document.php b/src/PhpWord/Reader/Word2007/Document.php
@@ -22,6 +22,8 @@
 
 /**
  * Document reader
+ *
+ * @since 0.10.0
  */
 class Document extends AbstractPart
 {
diff --git a/src/PhpWord/Reader/Word2007/Endnotes.php b/src/PhpWord/Reader/Word2007/Endnotes.php
@@ -19,6 +19,8 @@
 
 /**
  * Endnotes reader
+ *
+ * @since 0.10.0
  */
 class Endnotes extends Footnotes
 {
diff --git a/src/PhpWord/Reader/Word2007/Footnotes.php b/src/PhpWord/Reader/Word2007/Footnotes.php
@@ -22,6 +22,8 @@
 
 /**
  * Footnotes reader
+ *
+ * @since 0.10.0
  */
 class Footnotes extends AbstractPart
 {
diff --git a/src/PhpWord/Reader/Word2007/Numbering.php b/src/PhpWord/Reader/Word2007/Numbering.php
@@ -22,6 +22,8 @@
 
 /**
  * Numbering reader
+ *
+ * @since 0.10.0
  */
 class Numbering extends AbstractPart
 {
diff --git a/src/PhpWord/Reader/Word2007/Styles.php b/src/PhpWord/Reader/Word2007/Styles.php
@@ -22,6 +22,8 @@
 
 /**
  * Styles reader
+ *
+ * @since 0.10.0
  */
 class Styles extends AbstractPart
 {
diff --git a/tests/PhpWord/Tests/Element/ListItemRunTest.php b/tests/PhpWord/Tests/Element/ListItemRunTest.php
@@ -51,6 +51,17 @@ public function testConstructString()
         $this->assertEquals($oListItemRun->getParagraphStyle(), 'pStyle');
     }
 
+    /**
+     * New instance with string
+     */
+    public function testConstructListString()
+    {
+        $oListItemRun = new ListItemRun(0, 'numberingStyle');
+
+        $this->assertInstanceOf('PhpOffice\\PhpWord\\Element\\ListItemRun', $oListItemRun);
+        $this->assertCount(0, $oListItemRun->getElements());
+    }
+
     /**
      * New instance with array
      */
diff --git a/tests/PhpWord/Tests/SettingsTest.php b/tests/PhpWord/Tests/SettingsTest.php
@@ -103,6 +103,14 @@ public function testLoadConfig()
             'defaultFontName' => 'Arial',
             'defaultFontSize' => 10,
         );
+
+        // Test default value
+        $this->assertEquals($expected, Settings::loadConfig());
+
+        // Test with valid file
         $this->assertEquals($expected, Settings::loadConfig(__DIR__ . '/../../../phpword.ini.dist'));
+
+        // Test with invalid file
+        $this->assertEmpty(Settings::loadConfig(__DIR__ . '/files/xsl/passthrough.xsl'));
     }
 }
diff --git a/tests/PhpWord/Tests/Shared/StringTest.php b/tests/PhpWord/Tests/Shared/StringTest.php
@@ -54,4 +54,14 @@ public function testControlCharacterPHP2OOXML()
         $this->assertEquals('', String::controlCharacterPHP2OOXML(''));
         $this->assertEquals('_x0008_', String::controlCharacterPHP2OOXML(chr(0x08)));
     }
+
+    /**
+     * Test unicode conversion
+     */
+    public function testToUnicode()
+    {
+        $this->assertEquals('a', String::toUnicode('a'));
+        $this->assertEquals('\uc0{\u8364}', String::toUnicode('€'));
+        $this->assertEquals('\uc0{\u233}', String::toUnicode('é'));
+    }
 }
diff --git a/tests/PhpWord/Tests/_files/documents/reader.odt b/tests/PhpWord/Tests/_files/documents/reader.odt

Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,7 @@`
`22`	`22`	`/**`
`23`	`23`	`* Reader abstract class`
`24`	`24`	`*`
	`25`	`+ * @since 0.8.0`
`25`	`26`	`* @codeCoverageIgnore Abstract class`
`26`	`27`	`*/`
`27`	`28`	`abstract class AbstractReader implements ReaderInterface`
Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,9 @@`
`22`	`22`
`23`	`23`	`/**`
`24`	`24`	`* Abstract part reader`
	`25`	`+ *`
	`26`	`+ * @since 0.10.0`
	`27`	`+ * @codeCoverageIgnore Nothing in here yet`
`25`	`28`	`*/`
`26`	`29`	`abstract class AbstractPart extends Word2007AbstractPart`
`27`	`30`	`{`
Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,8 @@`
`19`	`19`
`20`	`20`	`/**`
`21`	`21`	`* Reader interface`
	`22`	`+ *`
	`23`	`+ * @since 0.8.0`
`22`	`24`	`*/`
`23`	`25`	`interface ReaderInterface`
`24`	`26`	`{`
Original file line number	Diff line number	Diff line change
`@@ -24,6 +24,8 @@`
`24`	`24`	`* Abstract part reader`
`25`	`25`	`*`
`26`	`26`	`* This class is inherited by ODText reader`
	`27`	`+ *`
	`28`	`+ * @since 0.10.0`
`27`	`29`	`*/`
`28`	`30`	`abstract class AbstractPart`
`29`	`31`	`{`
`@@ -466,6 +468,7 @@ protected function readStyleDefs(XMLReader $xmlReader, \DOMElement $parentNode =`
`466`	`468`	`}`
`467`	`469`	`}`
`468`	`470`
	`471`	`+ /** @var array $styles Type hint */`
`469`	`472`	`return $styles;`
`470`	`473`	`}`
`471`	`474`
Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,8 @@`
`22`	`22`
`23`	`23`	`/**`
`24`	`24`	`* Core properties reader`
	`25`	`+ *`
	`26`	`+ * @since 0.10.0`
`25`	`27`	`*/`
`26`	`28`	`class DocPropsCore extends AbstractPart`
`27`	`29`	`{`
Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,8 @@`
`23`	`23`
`24`	`24`	`/**`
`25`	`25`	`* Custom properties reader`
	`26`	`+ *`
	`27`	`+ * @since 0.11.0`
`26`	`28`	`*/`
`27`	`29`	`class DocPropsCustom extends AbstractPart`
`28`	`30`	`{`