Move marker element removal to end

Author: hxtree

.github/workflows/CONTRIBUTING.md

@@ -55,7 +55,7 @@ jobs:
           composer-options: "--no-scripts"
 
       - name: Run Code Standard Test
-        run: composer run-script check-code-standards
+        run: composer run-script code-standards-test
 
   php-static-analysis-test:
     needs:
@@ -71,7 +71,7 @@ jobs:
       - uses: php-actions/composer@v6
 
       - name: PHPStan Test
-        run: composer run-script analyze
+        run: composer run-script static-analysis-test
 
   php-unit-test:
     name: "PHP ${{ matrix.php-version }} Unit Tests"

.github/workflows/ci.yml

@@ -11,6 +11,10 @@ All releases must adhere to [SemVer 2](https://semver.org/) naming convention an
 ## PHPMarkup [Unreleased]
 Released: TBA. Notable changes:
 
+## PHPMarkup 4.2.5
+Released: 2021-10-08. Notable changes:
+* Changed: Marker attribute removal to end routine.
+
 ## PHPMarkup 4.2.5
 Released: 2021-10-08. Notable changes:
 * Fixed: QA tests.

CHANGELOG.md

@@ -1,5 +1,14 @@
 # PHPMarkup coding standards
 
+## Coding Guidelines
+
+*  PHPMarkup is built to adhere to the Unix philosophy.
+*  PHPMarkup is designed for use in other applications; not to be a monolithic solution.
+*  PHPMarkup use PHPDocs blocks.
+*  Classes use S.O.L.I.D. Design Principle.
+
+## Style Guidelines
+
 1. Variable names must be meaningful. One letter variable names must be avoided,
     except for places where the variable has no real meaning or a trivial
     meaning (e.g. `for (i=0; i<100; i++) ...`).

CODING_STANDARDS.md

@@ -2,27 +2,44 @@
 
 First off, thanks for taking the time to contribute!
 
+## Workflow
 For local package development use [Docker](https://www.docker.com/products/docker-desktop):
 
-**Step 1**) Pull code and build Test container
+### Step 1
+*  Pull code and build Test container.
+*  Fork the project.
+
 ```
 git clone https://github.com/Ouxsoft/phpmarkup.git
 cd phpmarkup
 docker build --target test --tag phpmarkup:latest -f Dockerfile .
 docker run -it --mount type=bind,source="$(pwd)"/,target=/application/ phpmarkup:latest composer install
 ```
 
-**Step 2**) Make code changes.
+### Step 2
+*  Make your code changes using CODING_STANDARDS.md.
+*  Run Automated QA using local volume.
+*  Test your changes using `composer test`.
+*  Update or add tests to avoid the change breaking in future releases.
 
-**Step 3**) Run Automated QA using local volume
 ```
 docker run -it --mount type=bind,source="$(pwd)"/,target=/application/ phpmarkup:latest composer qa
 ```
 
-**Step 4**) Rebuild Docs
+### Step 4
+*  Run `composer update` to update composer packages and commit new `composer.lock` file.
+*  Rebuild Docs
+
 ```
 docker build --target docs --tag phpmarkup:docs-latest -f Dockerfile .
 docker run -it --mount type=bind,source="$(pwd)"/,target=/app/ phpmarkup:docs-latest bash -c "cd /app/docs && doxygen Doxyfile && doxyphp2sphinx Ouxsoft::PHPMarkup"
 ```
 
-**Step 5**) Submit PR
+### Step 5
+*  Submit a [pull request](https://github.com/ouxsoft/phpmarkup-dev/pulls).
+
+## Reporting issues
+
+Please report issue and open new tickets:
+
+*  [Report Issues](https://github.com/ouxsoft/livingMarkup/issues)

CONTRIBUTING.md

@@ -44,18 +44,15 @@
   "scripts": {
     "qc" : [
       "@fix-code-standards",
-      "@check-code-standards",
-      "@analyze",
-      "@unit-test",
-      "@feature-test",
-      "@coverage-test",
-      "@benchmark-test"
+      "@test"
     ],
     "test": [
       "@unit-test",
       "@feature-test",
       "@coverage-test",
-      "@benchmark-test"
+      "@benchmark-test",
+      "@static-analysis-test",
+      "@code-standards-test"
     ],
     "unit-test": [
       "./vendor/bin/phpunit --no-coverage --testsuite unit"
@@ -69,14 +66,14 @@
     "benchmark-test" : [
       "./vendor/bin/phpbench run tests/src/Benchmark --report=env --progress=dots"
     ],
-    "analyze" : [
+    "static-analysis-test" : [
       "./vendor/bin/phpstan analyse -c phpstan.neon"
     ],
     "fix-code-standards": [
       "php-cs-fixer fix --using-cache=no src/",
       "php-cs-fixer fix --using-cache=no tests/"
     ],
-    "check-code-standards": [
+    "code-standards-test": [
       "php-cs-fixer fix --dry-run --diff --verbose --using-cache=no src/ ",
       "php-cs-fixer fix --dry-run --diff --verbose --using-cache=no tests/"
     ]

composer.json

@@ -73,7 +73,7 @@ ArgumentArray
     :param string $value:
       Default: ``null``
     :param ?string $type:
-      Default: ``NULL``
+      Default: ``null``
     :returns: void
 
   .. php:method:: public valid () -> bool

docs/api/argumentarray.rst

@@ -80,3 +80,13 @@ EngineInterface
     :param DOMElement $element:
     :param string $new_xml:
 
+  .. php:method:: public sanitizeXml (string $xml) -> string
+
+    :param string $xml:
+    :returns: string -- 
+
+  .. php:method:: public stripAttributes (array $attributes)
+
+    :param array $attributes:
+    :returns: void
+

docs/api/contract/engineinterface.rst

@@ -108,18 +108,17 @@ Engine
 
   .. php:method:: public sanitizeXml (string $xml) -> string
 
-    Remove args and INDEX_ATTRIBUTE
+    Remove args
 
     :param string $xml:
     :returns: string -- 
 
-  .. php:method:: public stripAttributes (string $xml, array $attributes) -> string
+  .. php:method:: public stripAttributes (array $attributes)
 
     Strip attributes
 
-    :param string $xml:
     :param array $attributes:
-    :returns: string -- 
+    :returns: void
 
   .. php:method:: private instantiateElement (DOMElement $element, string $class_name) -> bool
 

docs/api/engine.rst

@@ -78,11 +78,10 @@ public function renderElement(string $element_id): bool;
     public function sanitizeXml(string $xml): string;
 
     /**
-     * @param string $xml
      * @param array $attributes
-     * @return string
+     * @return void
      */
-    public function stripAttributes(string $xml, array $attributes): string;
+    public function stripAttributes(array $attributes): void;
 
     /**
      * @param string $element_id