Merge pull request #87 from phug-php/fix/issue-86-attributes-precedence

Align markup vs &attributes precedence with pug-js
phug-php · Nov 11, 2021 · 523139f · 523139f
2 parents 1e19e5b + b40122a
commit 523139f
Show file tree

Hide file tree

Showing 49 changed files with 254 additions and 125 deletions.
diff --git a/.github/workflows/coverage.yml b/.github/workflows/coverage.yml
@@ -37,7 +37,6 @@ jobs:
           ${{ runner.os }}-${{ matrix.setup }}-v2-php-${{ matrix.php }}-
 
     - name: Code Climate Test Reporter Preparation
-      if: matrix.php == '7.4' && matrix.setup == 'stable'
       run: |
         curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
         chmod +x ./cc-test-reporter
@@ -56,7 +55,7 @@ jobs:
       run: vendor/bin/phpunit --coverage-text --coverage-clover=coverage.xml
 
     - name: Code Climate Test Reporter
-      if: ${{ matrix.php == '7.4' && matrix.setup == 'stable' && env.CC_TEST_REPORTER_ID != '' }}
+      if: ${{ env.CC_TEST_REPORTER_ID != '' }}
       run: |
         cp coverage.xml clover.xml
         bash <(curl -s https://codecov.io/bash)

diff --git a/composer.json b/composer.json
@@ -7,9 +7,12 @@
     "homepage": "http://phug-lang.com",
     "authors": [
         {
-            "name": "KyleKatarn",
-            "email": "[email protected]",
+            "name": "kylekatarnls",
             "homepage": "http://github.com/kylekatarnls"
+        },
+        {
+            "name": "Torben Koehn",
+            "email": "[email protected]"
         }
     ],
     "support": {

diff --git a/src/Phug/Ast/Ast/Node.php b/src/Phug/Ast/Ast/Node.php
@@ -4,6 +4,7 @@
 
 use InvalidArgumentException;
 use Phug\AstException;
+use ReturnTypeWillChange;
 
 /**
  * Represents a node in a tree-like data structure.
@@ -418,6 +419,7 @@ public function findArray(callable $callback, $depth = null)
     /**
      * {@inheritdoc}
      */
+    #[ReturnTypeWillChange]
     public function getIterator()
     {
         foreach ($this->children as $child) {
@@ -428,6 +430,7 @@ public function getIterator()
     /**
      * {@inheritdoc}
      */
+    #[ReturnTypeWillChange]
     public function count()
     {
         return $this->getChildCount();
@@ -436,6 +439,7 @@ public function count()
     /**
      * {@inheritdoc}
      */
+    #[ReturnTypeWillChange]
     public function offsetExists($offset)
     {
         return $this->hasChildAt($offset);
@@ -444,6 +448,7 @@ public function offsetExists($offset)
     /**
      * {@inheritdoc}
      */
+    #[ReturnTypeWillChange]
     public function offsetGet($offset)
     {
         return $this->getChildAt($offset);
@@ -452,6 +457,7 @@ public function offsetGet($offset)
     /**
      * {@inheritdoc}
      */
+    #[ReturnTypeWillChange]
     public function offsetSet($offset, $value)
     {
         if (!($value instanceof NodeInterface)) {
@@ -475,6 +481,7 @@ public function offsetSet($offset, $value)
     /**
      * {@inheritdoc}
      */
+    #[ReturnTypeWillChange]
     public function offsetUnset($offset)
     {
         $this->removeChildAt($offset);

diff --git a/src/Phug/Ast/composer.json b/src/Phug/Ast/composer.json
@@ -11,8 +11,7 @@
             "email": "[email protected]"
         },
         {
-            "name": "KyleKatarn",
-            "email": "[email protected]",
+            "name": "kylekatarnls",
             "homepage": "http://github.com/kylekatarnls"
         }
     ],

diff --git a/src/Phug/Compiler/Compiler/NodeCompiler/ImportNodeCompiler.php b/src/Phug/Compiler/Compiler/NodeCompiler/ImportNodeCompiler.php
@@ -23,7 +23,7 @@ class ImportNodeCompiler extends AbstractNodeCompiler
     protected function isPugImport($path)
     {
         $compiler = $this->getCompiler();
-        $extension = pathinfo($path, PATHINFO_EXTENSION) ?: '';
+        $extension = pathinfo((string) $path, PATHINFO_EXTENSION);
         $extensions = $compiler->getOption('extensions');
 
         if ($extension === '') {
@@ -72,7 +72,7 @@ public function compileNode(NodeInterface $node, ElementInterface $parent = null
 
         $paths = $isAbsolutePath
             ? null
-            : [dirname($compiler->getPath()) ?: '.'];
+            : [dirname((string) $compiler->getPath()) ?: '.'];
 
         $path = $compiler->resolve($node->getPath(), $paths);
         $compiler->registerImportPath($path);

diff --git a/src/Phug/Compiler/composer.json b/src/Phug/Compiler/composer.json
@@ -7,9 +7,12 @@
     "homepage": "http://phug-lang.com",
     "authors": [
         {
-            "name": "KyleKatarn",
-            "email": "[email protected]",
+            "name": "kylekatarnls",
             "homepage": "http://github.com/kylekatarnls"
+        },
+        {
+            "name": "Torben Koehn",
+            "email": "[email protected]"
         }
     ],
     "support": {

diff --git a/src/Phug/DependencyInjection/composer.json b/src/Phug/DependencyInjection/composer.json
@@ -11,8 +11,7 @@
             "email": "[email protected]"
         },
         {
-            "name": "KyleKatarn",
-            "email": "[email protected]",
+            "name": "kylekatarnls",
             "homepage": "http://github.com/kylekatarnls"
         }
     ],

diff --git a/src/Phug/Event/Event/ListenerQueue.php b/src/Phug/Event/Event/ListenerQueue.php
@@ -2,10 +2,12 @@
 
 namespace Phug\Event;
 
+use ReturnTypeWillChange;
 use SplPriorityQueue;
 
 class ListenerQueue extends SplPriorityQueue
 {
+    #[ReturnTypeWillChange]
     public function compare($priority, $priorityToCompare)
     {
         if ($priority === $priorityToCompare) {
@@ -15,6 +17,7 @@ public function compare($priority, $priorityToCompare)
         return $priority > $priorityToCompare ? -1 : 1;
     }
 
+    #[ReturnTypeWillChange]
     public function insert($value, $priority)
     {
         if (!is_callable($value)) {

diff --git a/src/Phug/Event/composer.json b/src/Phug/Event/composer.json
@@ -11,8 +11,7 @@
             "email": "[email protected]"
         },
         {
-            "name": "KyleKatarn",
-            "email": "[email protected]",
+            "name": "kylekatarnls",
             "homepage": "http://github.com/kylekatarnls"
         }
     ],

diff --git a/src/Phug/Formatter/Formatter/AbstractFormat.php b/src/Phug/Formatter/Formatter/AbstractFormat.php
@@ -51,7 +51,7 @@ abstract class AbstractFormat implements FormatInterface, OptionInterface
         is_object($_pug_temp = %s) && method_exists($_pug_temp, "__toBoolean")
             ? $_pug_temp->__toBoolean()
             : $_pug_temp';
-    const HTML_EXPRESSION_ESCAPE = 'htmlspecialchars(%s)';
+    const HTML_EXPRESSION_ESCAPE = 'htmlspecialchars((string) (%s))';
     const HTML_TEXT_ESCAPE = 'htmlspecialchars';
     const PAIR_TAG = '%s%s%s';
     const TRANSFORM_EXPRESSION = '%s';

diff --git a/src/Phug/Formatter/Formatter/Element/AssignmentElement.php b/src/Phug/Formatter/Formatter/Element/AssignmentElement.php
@@ -6,10 +6,11 @@
 use Phug\Formatter\AbstractElement;
 use Phug\Formatter\AssignmentContainerInterface;
 use Phug\Parser\NodeInterface as ParserNode;
+use Phug\Util\AttributesInterface;
 use Phug\Util\Partial\AttributeTrait;
 use Phug\Util\Partial\NameTrait;
 
-class AssignmentElement extends AbstractElement
+class AssignmentElement extends AbstractElement implements AttributesInterface
 {
     use AttributeTrait;
     use NameTrait;

diff --git a/src/Phug/Formatter/Formatter/Element/MarkupElement.php b/src/Phug/Formatter/Formatter/Element/MarkupElement.php
@@ -4,10 +4,11 @@
 
 use Phug\Ast\NodeInterface;
 use Phug\Parser\NodeInterface as ParserNode;
+use Phug\Util\AttributesInterface;
 use Phug\Util\Partial\AttributeTrait;
 use Phug\Util\Partial\NameTrait;
 
-class MarkupElement extends AbstractMarkupElement
+class MarkupElement extends AbstractMarkupElement implements AttributesInterface
 {
     use AttributeTrait;
     use NameTrait;

diff --git a/src/Phug/Formatter/Formatter/Element/MixinCallElement.php b/src/Phug/Formatter/Formatter/Element/MixinCallElement.php
@@ -2,10 +2,11 @@
 
 namespace Phug\Formatter\Element;
 
+use Phug\Util\AttributesInterface;
 use Phug\Util\Partial\AttributeTrait;
 use Phug\Util\Partial\NameTrait;
 
-class MixinCallElement extends AbstractAssignmentContainerElement
+class MixinCallElement extends AbstractAssignmentContainerElement implements AttributesInterface
 {
     use AttributeTrait;
     use NameTrait;

diff --git a/src/Phug/Formatter/Formatter/Element/MixinElement.php b/src/Phug/Formatter/Formatter/Element/MixinElement.php
@@ -3,10 +3,11 @@
 namespace Phug\Formatter\Element;
 
 use Phug\Formatter\AbstractElement;
+use Phug\Util\AttributesInterface;
 use Phug\Util\Partial\AttributeTrait;
 use Phug\Util\Partial\NameTrait;
 
-class MixinElement extends AbstractElement
+class MixinElement extends AbstractElement implements AttributesInterface
 {
     use AttributeTrait;
     use NameTrait;

diff --git a/src/Phug/Formatter/Formatter/Format/XmlFormat.php b/src/Phug/Formatter/Formatter/Format/XmlFormat.php
@@ -2,8 +2,10 @@
 
 namespace Phug\Formatter\Format;
 
+use Generator;
 use Phug\Formatter;
 use Phug\Formatter\AbstractFormat;
+use Phug\Formatter\AssignmentContainerInterface;
 use Phug\Formatter\Element\AbstractValueElement;
 use Phug\Formatter\Element\AssignmentElement;
 use Phug\Formatter\Element\AttributeElement;
@@ -16,6 +18,7 @@
 use Phug\Formatter\MarkupInterface;
 use Phug\Formatter\Partial\AssignmentHelpersTrait;
 use Phug\FormatterException;
+use Phug\Util\AttributesInterface;
 use Phug\Util\Joiner;
 use SplObjectStorage;
 
@@ -163,7 +166,7 @@ protected function formatAttributeElement(AttributeElement $element)
         $nonEmptyAttribute = ($name === 'class' || $name === 'id');
         if ($nonEmptyAttribute && (
             !$value ||
-            ($value instanceof TextElement && ($value->getValue() ?: '') === '') ||
+            ($value instanceof TextElement && ((string) $value->getValue()) === '') ||
             (is_string($value) && in_array(trim($value), ['', '""', "''"]))
         )) {
             return '';
@@ -266,25 +269,78 @@ protected function yieldAssignmentElement(AssignmentElement $element)
         /* @var MarkupElement $markup */
         $markup = $element->getContainer();
 
+        $arguments = $markup instanceof AssignmentContainerInterface
+            ? $this->formatAttributeAssignments($markup)
+            : [];
+
+        $arguments = array_merge(
+            $markup instanceof AttributesInterface
+                ? $this->formatMarkupAttributes($markup)
+                : [],
+            $arguments
+        );
+
+        foreach ($markup->getAssignments() as $assignment) {
+            /* @var AssignmentElement $assignment */
+            $this->throwException(
+                'Unable to handle '.$assignment->getName().' assignment',
+                $assignment
+            );
+        }
+
+        if (count($arguments)) {
+            yield $this->attributesAssignmentsFromPairs($arguments);
+        }
+    }
+
+    /**
+     * @param AssignmentContainerInterface $markup
+     *
+     * @return array<string>
+     */
+    protected function formatAttributeAssignments(AssignmentContainerInterface $markup)
+    {
         $arguments = [];
 
+        foreach ($this->yieldAssignmentAttributes($markup) as $attribute) {
+            $checked = method_exists($attribute, 'isChecked') && $attribute->isChecked();
+
+            while (method_exists($attribute, 'getValue')) {
+                $attribute = $attribute->getValue();
+            }
+
+            $arguments[] = $this->formatCode($attribute, $checked);
+        }
+
+        return $arguments;
+    }
+
+    /**
+     * @param AssignmentContainerInterface $markup
+     *
+     * @return Generator|AbstractValueElement[]
+     */
+    protected function yieldAssignmentAttributes(AssignmentContainerInterface $markup)
+    {
         foreach ($markup->getAssignmentsByName('attributes') as $attributesAssignment) {
             /* @var AssignmentElement $attributesAssignment */
             foreach ($attributesAssignment->getAttributes() as $attribute) {
                 /* @var AbstractValueElement $attribute */
-                $value = $attribute;
-                $checked = method_exists($value, 'isChecked') && $value->isChecked();
-
-                while (method_exists($value, 'getValue')) {
-                    $value = $value->getValue();
-                }
-
-                $arguments[] = $this->formatCode($value, $checked);
+                yield $attribute;
             }
 
             $markup->removedAssignment($attributesAssignment);
         }
+    }
 
+    /**
+     * @param AttributesInterface $markup
+     *
+     * @return array<string>
+     */
+    protected function formatMarkupAttributes(AttributesInterface $markup)
+    {
+        $arguments = [];
         $attributes = $markup->getAttributes();
 
         foreach ($attributes as $attribute) {
@@ -294,17 +350,7 @@ protected function yieldAssignmentElement(AssignmentElement $element)
 
         $attributes->removeAll($attributes);
 
-        foreach ($markup->getAssignments() as $assignment) {
-            /* @var AssignmentElement $assignment */
-            $this->throwException(
-                'Unable to handle '.$assignment->getName().' assignment',
-                $assignment
-            );
-        }
-
-        if (count($arguments)) {
-            yield $this->attributesAssignmentsFromPairs($arguments);
-        }
+        return $arguments;
     }
 
     /**

diff --git a/src/Phug/Formatter/Formatter/Partial/AssignmentHelpersTrait.php b/src/Phug/Formatter/Formatter/Partial/AssignmentHelpersTrait.php
@@ -202,11 +202,14 @@ protected function provideStyleAttributeAssignment()
             if (is_string($value) && mb_substr($value, 0, 7) === '{&quot;') {
                 $value = json_decode(htmlspecialchars_decode($value));
             }
+
             $styles = isset($attributes['style']) ? array_filter(explode(';', $attributes['style'])) : [];
+
             foreach ((array) $value as $propertyName => $propertyValue) {
                 if (!is_int($propertyName)) {
                     $propertyValue = $propertyName.':'.$propertyValue;
                 }
+
                 $styles[] = $propertyValue;
             }
 

diff --git a/src/Phug/Formatter/composer.json b/src/Phug/Formatter/composer.json
@@ -7,8 +7,7 @@
     "homepage": "http://phug-lang.com",
     "authors": [
         {
-            "name": "KyleKatarn",
-            "email": "[email protected]",
+            "name": "kylekatarnls",
             "homepage": "http://github.com/kylekatarnls"
         },
         {