Merge pull request #207 from phil-davis/rename-ci-script

Rename GitHub workflow to ci.yml

CHANGELOG.md

@@ -13,7 +13,7 @@ ChangeLog
 ------------------
 
 * #183: fixed warning 'xml cannot be empty while reading', which might lead to a infinite-loop (@mrow4a)
-* #179, #178, #177 #176: several build/continous integration related improvements (@phil-davis)
+* #179, #178, #177 #176: several build/continuous integration related improvements (@phil-davis)
 
 2.2.0 (2020-01-31)
 ------------------

lib/ContextStackTrait.php

@@ -10,7 +10,7 @@
  * The Context maintains information about a document during either reading or
  * writing.
  *
- * During this process, it may be neccesary to override this context
+ * During this process, it may be necessary to override this context
  * information.
  *
  * This trait allows easy access to the context, and allows the end-user to

lib/Element/Base.php

@@ -35,7 +35,7 @@ public function __construct($value = null)
     }
 
     /**
-     * The xmlSerialize metod is called during xml writing.
+     * The xmlSerialize method is called during xml writing.
      *
      * Use the $writer argument to write its own xml serialization.
      *
@@ -58,7 +58,7 @@ public function xmlSerialize(Xml\Writer $writer)
     /**
      * The deserialize method is called during xml parsing.
      *
-     * This method is called statictly, this is because in theory this method
+     * This method is called statically, this is because in theory this method
      * may be used as a type of constructor, or factory method.
      *
      * Often you want to return an instance of the current class, but you are

lib/Element/Cdata.php

@@ -12,7 +12,7 @@
  * This element allows you to easily inject CDATA.
  *
  * Note that we strongly recommend avoiding CDATA nodes, unless you definitely
- * know what you're doing, or you're working with unchangable systems that
+ * know what you're doing, or you're working with unchangeable systems that
  * require CDATA.
  *
  * @copyright Copyright (C) 2009-2015 fruux GmbH (https://fruux.com/).
@@ -37,12 +37,12 @@ public function __construct(string $value)
     }
 
     /**
-     * The xmlSerialize metod is called during xml writing.
+     * The xmlSerialize method is called during xml writing.
      *
      * Use the $writer argument to write its own xml serialization.
      *
      * An important note: do _not_ create a parent element. Any element
-     * implementing XmlSerializble should only ever write what's considered
+     * implementing XmlSerializable should only ever write what's considered
      * its 'inner xml'.
      *
      * The parent of the current element is responsible for writing a

lib/Element/Elements.php

@@ -53,12 +53,12 @@ public function __construct(array $value = [])
     }
 
     /**
-     * The xmlSerialize metod is called during xml writing.
+     * The xmlSerialize method is called during xml writing.
      *
      * Use the $writer argument to write its own xml serialization.
      *
      * An important note: do _not_ create a parent element. Any element
-     * implementing XmlSerializble should only ever write what's considered
+     * implementing XmlSerializable should only ever write what's considered
      * its 'inner xml'.
      *
      * The parent of the current element is responsible for writing a
@@ -76,7 +76,7 @@ public function xmlSerialize(Xml\Writer $writer)
     /**
      * The deserialize method is called during xml parsing.
      *
-     * This method is called statictly, this is because in theory this method
+     * This method is called statically, this is because in theory this method
      * may be used as a type of constructor, or factory method.
      *
      * Often you want to return an instance of the current class, but you are

lib/Element/KeyValue.php

@@ -53,12 +53,12 @@ public function __construct(array $value = [])
     }
 
     /**
-     * The xmlSerialize metod is called during xml writing.
+     * The xmlSerialize method is called during xml writing.
      *
      * Use the $writer argument to write its own xml serialization.
      *
      * An important note: do _not_ create a parent element. Any element
-     * implementing XmlSerializble should only ever write what's considered
+     * implementing XmlSerializable should only ever write what's considered
      * its 'inner xml'.
      *
      * The parent of the current element is responsible for writing a
@@ -76,7 +76,7 @@ public function xmlSerialize(Xml\Writer $writer)
     /**
      * The deserialize method is called during xml parsing.
      *
-     * This method is called staticly, this is because in theory this method
+     * This method is called statically, this is because in theory this method
      * may be used as a type of constructor, or factory method.
      *
      * Often you want to return an instance of the current class, but you are

lib/Element/Uri.php

@@ -42,12 +42,12 @@ public function __construct($value)
     }
 
     /**
-     * The xmlSerialize metod is called during xml writing.
+     * The xmlSerialize method is called during xml writing.
      *
      * Use the $writer argument to write its own xml serialization.
      *
      * An important note: do _not_ create a parent element. Any element
-     * implementing XmlSerializble should only ever write what's considered
+     * implementing XmlSerializable should only ever write what's considered
      * its 'inner xml'.
      *
      * The parent of the current element is responsible for writing a

lib/Element/XmlFragment.php

@@ -48,12 +48,12 @@ public function getXml(): string
     }
 
     /**
-     * The xmlSerialize metod is called during xml writing.
+     * The xmlSerialize method is called during xml writing.
      *
      * Use the $writer argument to write its own xml serialization.
      *
      * An important note: do _not_ create a parent element. Any element
-     * implementing XmlSerializble should only ever write what's considered
+     * implementing XmlSerializable should only ever write what's considered
      * its 'inner xml'.
      *
      * The parent of the current element is responsible for writing a
@@ -121,7 +121,7 @@ public function xmlSerialize(Writer $writer)
     /**
      * The deserialize method is called during xml parsing.
      *
-     * This method is called statictly, this is because in theory this method
+     * This method is called statically, this is because in theory this method
      * may be used as a type of constructor, or factory method.
      *
      * Often you want to return an instance of the current class, but you are

lib/LibXMLException.php

@@ -8,7 +8,7 @@
 use Throwable;
 
 /**
- * This exception is thrown when the Readers runs into a parsing error.
+ * This exception is thrown when the Reader runs into a parsing error.
  *
  * This exception effectively wraps 1 or more LibXMLError objects.
  *

lib/Reader.php

@@ -92,11 +92,11 @@ public function parse(): array
 
     /**
      * parseGetElements parses everything in the current sub-tree,
-     * and returns a an array of elements.
+     * and returns an array of elements.
      *
      * Each element has a 'name', 'value' and 'attributes' key.
      *
-     * If the the element didn't contain sub-elements, an empty array is always
+     * If the element didn't contain sub-elements, an empty array is always
      * returned. If there was any text inside the element, it will be
      * discarded.
      *
@@ -249,7 +249,7 @@ public function parseCurrentElement(): array
      *
      * If the attributes are part of the same namespace, they will simply be
      * short keys. If they are defined on a different namespace, the attribute
-     * name will be retured in clark-notation.
+     * name will be returned in clark-notation.
      */
     public function parseAttributes(): array
     {
@@ -275,7 +275,7 @@ public function parseAttributes(): array
 
     /**
      * Returns the function that should be used to parse the element identified
-     * by it's clark-notation name.
+     * by its clark-notation name.
      */
     public function getDeserializerForElementName(string $name): callable
     {

lib/Service.php

@@ -7,7 +7,7 @@
 /**
  * XML parsing and writing service.
  *
- * You are encouraged to make a instance of this for your application and
+ * You are encouraged to make an instance of this for your application and
  * potentially extend it, as a central API point for dealing with xml and
  * configuring the reader and writer.
  *
@@ -117,7 +117,7 @@ public function parse($input, string $contextUri = null, string &$rootElementNam
             $input = (string) stream_get_contents($input);
         }
 
-        // If input is empty, then its safe to throw exception
+        // If input is empty, then it's safe to throw an exception
         if (empty($input)) {
             throw new ParseException('The input element to parse is empty. Do not attempt to parse');
         }
@@ -161,7 +161,7 @@ public function expect($rootElementName, $input, string $contextUri = null)
             $input = (string) stream_get_contents($input);
         }
 
-        // If input is empty, then its safe to throw exception
+        // If input is empty, then it's safe to throw an exception
         if (empty($input)) {
             throw new ParseException('The input element to parse is empty. Do not attempt to parse');
         }
@@ -217,9 +217,9 @@ public function write(string $rootElementName, $value, string $contextUri = null
     }
 
     /**
-     * Map an xml element to a PHP class.
+     * Map an XML element to a PHP class.
      *
-     * Calling this function will automatically setup the Reader and Writer
+     * Calling this function will automatically set up the Reader and Writer
      * classes to turn a specific XML element to a PHP class.
      *
      * For example, given a class such as :

lib/XmlSerializable.php

@@ -20,7 +20,7 @@ interface XmlSerializable
      * Use the $writer argument to write its own xml serialization.
      *
      * An important note: do _not_ create a parent element. Any element
-     * implementing XmlSerializble should only ever write what's considered
+     * implementing XmlSerializable should only ever write what's considered
      * its 'inner xml'.
      *
      * The parent of the current element is responsible for writing a

tests/Sabre/Xml/Deserializer/KeyValueTest.php

@@ -110,7 +110,7 @@ public function testKeyValueLoop()
 
     public function testEmptyKeyValue()
     {
-        // the nested structure below is necessary to detect if one of the deserialization functions eats to much elements
+        // the nested structure below is necessary to detect if one of the deserialization functions eats too many elements
         $input = <<<BLA
 <?xml version="1.0"?>
 <root xmlns="http://sabredav.org/ns">

tests/Sabre/Xml/Element/Eater.php

@@ -38,7 +38,7 @@ public function xmlSerialize(Xml\Writer $writer)
     /**
      * The deserialize method is called during xml parsing.
      *
-     * This method is called statictly, this is because in theory this method
+     * This method is called statically, this is because in theory this method
      * may be used as a type of constructor, or factory method.
      *
      * Often you want to return an instance of the current class, but you are

tests/Sabre/Xml/Element/Mock.php

@@ -30,7 +30,7 @@ public function xmlSerialize(Xml\Writer $writer)
     /**
      * The deserialize method is called during xml parsing.
      *
-     * This method is called statictly, this is because in theory this method
+     * This method is called statically, this is because in theory this method
      * may be used as a type of constructor, or factory method.
      *
      * Often you want to return an instance of the current class, but you are

tests/Sabre/Xml/InfiteLoopTest.php → tests/Sabre/Xml/InfiniteLoopTest.php

@@ -4,7 +4,7 @@
 
 namespace Sabre\Xml;
 
-class InfiteLoopTest extends \PHPUnit\Framework\TestCase
+class InfiniteLoopTest extends \PHPUnit\Framework\TestCase
 {
     /**
      * This particular xml body caused the parser to go into an infinite loop.