add test setup and phpcs check to circle ci (#3)

sulu · Apr 11, 2018 · f975ddd · f975ddd
1 parent e19b1a1
commit f975ddd
Show file tree

Hide file tree

Showing 11 changed files with 367 additions and 10 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -0,0 +1,22 @@
+version: 2
+
+jobs:
+  build:
+    docker:
+      - image: circleci/php:5.6-node-browsers
+
+    steps:
+      - checkout
+      - run: sudo composer self-update
+      - restore_cache:
+          keys:
+            - composer-v1-{{ checksum "composer.json" }}
+            - composer-v1-
+      - run: composer install -n --prefer-dist
+      - save_cache:
+          key: composer-v1-{{ checksum "composer.json" }}
+          paths:
+            - vendor
+            - ~/.composer/cache
+      - run: php -d memory_limit=2G ./vendor/bin/phpunit
+      - run: php -n -d memory_limit=2G ./vendor/bin/php-cs-fixer fix --verbose --diff --diff-format=udiff --dry-run
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1,6 @@
+.github export-ignore
+.circleci export-ignore
+.gitignore export-ignore
+.php_cs export-ignore
+.gitattributes export-ignore
+/tests export-ignore
diff --git a/.gitignore b/.gitignore
@@ -3,10 +3,14 @@
 /composer.phar
 /vendor
 
+# Cache
+/.php_cs.cache
+
 # IDEs
 /.idea
 *.iml
 *~
 
 # System files
 .DS_Store
+*.swp
diff --git a/.php_cs b/.php_cs
@@ -0,0 +1,21 @@
+<?php
+
+return PhpCsFixer\Config::create()
+    ->setRiskyAllowed(true)
+    ->setRules([
+        '@Symfony' => true,
+        'ordered_imports' => true,
+        'concat_space' => ['spacing' => 'one'],
+        'array_syntax' => ['syntax' => 'short'],
+        'php_unit_construct' => true,
+        'phpdoc_align' => false,
+        'class_definition' => [
+            'multiLineExtendsEachSingleLine' => true,
+        ]
+    ])
+    ->setFinder(
+        PhpCsFixer\Finder::create()
+            ->exclude('Resources')
+            ->exclude('vendor')
+            ->in(__DIR__)
+    );
diff --git a/composer.json b/composer.json
@@ -14,7 +14,9 @@
         "twig/twig": "^1.11 || ^2.0"
     },
     "require-dev": {
-        "symfony/property-access": "^2.8 || ^3.0 || ^4.0"
+        "phpunit/phpunit": "^5.0 || ^6.0 || ^7.0",
+        "symfony/property-access": "^2.8 || ^3.0 || ^4.0",
+        "friendsofphp/php-cs-fixer": "^2.11"
     },
     "suggest": {
         "symfony/property-access": "The ImageTwigExtension requires the symfony/property-access service."

diff --git a/docs/image.md b/docs/image.md
@@ -57,7 +57,7 @@ This could be:
 
 ```twig
 <img alt="Logo"
-     title="Logo"
+     title="Description"
      src="/uploads/media/sulu-400x400/01/image.jpg?v=1-0"
      srcset="/uploads/media/sulu-400x400/01/image.jpg?v=1-0 1024w, /uploads/media/sulu-170x170/01/image.jpg?v=1-0 800w, /uploads/media/sulu-100x100/01/image.jpg?v=1-0 460w"
      sizes="(max-width: 1024px) 100vw, (max-width: 800px) 100vw, 100vw"
@@ -88,8 +88,8 @@ This could be:
     <source media="(max-width: 650px)"
             srcset="/uploads/media/sulu-400x400/01/image.jpg?v=1-0 1024w, /uploads/media/sulu-170x170/01/image.jpg?v=1-0 800w, /uploads/media/sulu-100x100/01/image.jpg?v=1-0 460w"
             sizes="(max-width: 1024px) 100vw, (max-width: 800px) 100vw, 100vw">
-    <img alt="cody_redwoodsa-X2"
-         title="cody_redwoodsa-X2"
+    <img alt="Title"
+         title="Description"
          src="/uploads/media/sulu-400x400/01/image.jpg?v=1-0"
          class="image-class">
 </picture>

diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit colors="true" bootstrap="./vendor/autoload.php">
+   <testsuites>
+        <testsuite name="Massive Twig Extensions">
+            <directory>./tests</directory>
+        </testsuite>
+    </testsuites>
+</phpunit>
diff --git a/src/ComponentTwigExtension.php b/src/ComponentTwigExtension.php
@@ -100,7 +100,7 @@ public function getComponents($jsonEncode = true, $clear = true)
      *
      * @param bool $jsonEncode
      *
-     * @return string.
+     * @return string
      */
     public function getComponentList($jsonEncode = false)
     {
@@ -156,7 +156,7 @@ public function getServices($jsonEncode = true, $clear = true)
      *
      * @param bool $jsonEncode
      *
-     * @return string.
+     * @return string
      */
     public function getServiceList($jsonEncode = false)
     {

diff --git a/src/ImageTwigExtension.php b/src/ImageTwigExtension.php
@@ -35,6 +35,10 @@ public function getImage($media, $attributes = [], $sources = [])
             return '';
         }
 
+        if (is_array($media)) {
+            $media = (object) $media;
+        }
+
         $propertyAccessor = PropertyAccess::createPropertyAccessor();
 
         // Thumbnails exists all times - it only can be empty.
@@ -63,17 +67,19 @@ public function getImage($media, $attributes = [], $sources = [])
         $sourceTags = '';
         foreach ($sources as $media => $sourceAttributes) {
             // Get the source tag with all given attributes.
-            $sourceTags .= $this->createTag('source', array_merge(['media' => $media], $sourceAttributes),  $thumbnails);
+            $sourceTags .= $this->createTag('source', array_merge(['media' => $media], $sourceAttributes), $thumbnails);
         }
 
         // Returns the picture tag with all sources and the fallback image tag.
         return sprintf('<picture>%s%s</picture>', $sourceTags, $imgTag);
     }
 
     /**
-     * @param $tag
-     * @param $attributes
-     * @param $thumbnails
+     * Create html tag.
+     *
+     * @param string $tag
+     * @param array $attributes
+     * @param array $thumbnails
      *
      * @return string
      */

diff --git a/tests/ComponentTwigExtensionTest.php b/tests/ComponentTwigExtensionTest.php
@@ -0,0 +1,182 @@
+<?php
+
+use Massive\Component\Web\ComponentTwigExtension;
+use PHPUnit\Framework\TestCase;
+
+class ComponentTwigExtensionTest extends TestCase
+{
+    /**
+     * @var ComponentTwigExtension
+     */
+    private $componentTwigExtension;
+
+    public function setup()
+    {
+        $this->componentTwigExtension = new ComponentTwigExtension();
+    }
+
+    public function testRegisterComponent()
+    {
+        $this->assertEquals('test-1', $this->componentTwigExtension->registerComponent('test'));
+
+        $this->assertEquals(
+            json_encode([
+                [
+                    'name' => 'test',
+                    'id' => 'test-1',
+                    'options' => new stdClass(),
+                ],
+            ]),
+            $this->componentTwigExtension->getComponents()
+        );
+    }
+
+    public function testRegisterMultipleComponent()
+    {
+        $this->assertEquals('test-1', $this->componentTwigExtension->registerComponent('test'));
+        $this->assertEquals('test-2', $this->componentTwigExtension->registerComponent('test'));
+
+        $this->assertEquals(
+            json_encode([
+                [
+                    'name' => 'test',
+                    'id' => 'test-1',
+                    'options' => new stdClass(),
+                ],
+                [
+                    'name' => 'test',
+                    'id' => 'test-2',
+                    'options' => new stdClass(),
+                ],
+            ]),
+            $this->componentTwigExtension->getComponents()
+        );
+    }
+
+    public function testRegisterCustomIdComponent()
+    {
+        $this->assertEquals('custom', $this->componentTwigExtension->registerComponent('test', ['id' => 'custom']));
+
+        $this->assertEquals(
+            json_encode([
+                [
+                    'name' => 'test',
+                    'id' => 'custom',
+                    'options' => (object) ['id' => 'custom'],
+                ],
+            ]),
+            $this->componentTwigExtension->getComponents()
+        );
+    }
+
+    public function testRegisterOptionComponent()
+    {
+        $this->assertEquals('test-1', $this->componentTwigExtension->registerComponent('test', ['option1' => 'value1', 'option2' => 'value2']));
+
+        $this->assertEquals(
+            json_encode([
+                [
+                    'name' => 'test',
+                    'id' => 'test-1',
+                    'options' => (object) [
+                        'option1' => 'value1',
+                        'option2' => 'value2',
+                    ],
+                ],
+            ]),
+            $this->componentTwigExtension->getComponents()
+        );
+    }
+
+    public function testRegisterComponentArray()
+    {
+        $this->assertEquals('test-1', $this->componentTwigExtension->registerComponent('test'));
+
+        $this->assertEquals(
+            [
+                [
+                    'name' => 'test',
+                    'id' => 'test-1',
+                    'options' => new stdClass(),
+                ],
+            ],
+            $this->componentTwigExtension->getComponents(false)
+        );
+    }
+
+    public function testRegisterComponentClear()
+    {
+        $this->assertEquals('test-1', $this->componentTwigExtension->registerComponent('test'));
+
+        // Get components without clearing them.
+        $this->assertEquals(
+            [
+                [
+                    'name' => 'test',
+                    'id' => 'test-1',
+                    'options' => new stdClass(),
+                ],
+            ],
+            $this->componentTwigExtension->getComponents(false, false)
+        );
+
+        // Get components with clearing.
+        $this->assertEquals(
+            [
+                [
+                    'name' => 'test',
+                    'id' => 'test-1',
+                    'options' => new stdClass(),
+                ],
+            ],
+            $this->componentTwigExtension->getComponents(false)
+        );
+
+        // Check if cleared correctly.
+        $this->assertEquals([], $this->componentTwigExtension->getComponents(false));
+    }
+
+    public function testComponentList()
+    {
+        $this->componentTwigExtension->registerComponent('test');
+        $this->componentTwigExtension->registerComponent('test');
+        $this->componentTwigExtension->registerComponent('test2');
+        $this->componentTwigExtension->registerComponent('test3');
+
+        $componentList = $this->componentTwigExtension->getComponentList();
+
+        $this->assertCount(3, $componentList);
+        $this->assertEquals(['test', 'test2', 'test3'], $componentList);
+    }
+
+    public function testCallService()
+    {
+        $this->componentTwigExtension->callService('service', 'function', ['key' => 'value']);
+
+        $this->assertEquals(
+            json_encode([
+                [
+                    'name' => 'service',
+                    'func' => 'function',
+                    'args' => [
+                        'key' => 'value',
+                    ],
+                ],
+            ]),
+            $this->componentTwigExtension->getServices()
+        );
+    }
+
+    public function testGetServices()
+    {
+        $this->componentTwigExtension->callService('service', 'function', ['key' => 'value']);
+        $this->componentTwigExtension->callService('service2', 'function', ['key' => 'value']);
+        $this->componentTwigExtension->callService('service2', 'function', ['key' => 'value']);
+        $this->componentTwigExtension->callService('service3', 'function', ['key' => 'value']);
+
+        $servicesList = $this->componentTwigExtension->getServiceList();
+
+        $this->assertCount(3, $servicesList);
+        $this->assertEquals(['service', 'service2', 'service3'], $servicesList);
+    }
+}