Start explaining Phug Component concept

Author: kylekatarnls

.gitignore

@@ -1,6 +1,5 @@
 composer.phar
+composer.lock
+*.cache
+/coverage/
 /vendor/
-
-# Commit your application's lock file https://getcomposer.org/doc/01-basic-usage.md#commit-your-composer-lock-file-to-version-control
-# You may choose to ignore a library lock file http://getcomposer.org/doc/02-libraries.md#lock-file
-# composer.lock

.travis.yml

@@ -0,0 +1,28 @@
+language: php
+
+php:
+  - 7.2
+  - 7.3
+  - 7.4
+  - nightly
+
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+  - travis_retry composer self-update
+  - travis_retry composer install --no-interaction --prefer-source --dev
+
+script:
+  - vendor/bin/phpunit --verbose --coverage-text --coverage-clover=coverage.xml
+
+after_script:
+  - vendor/bin/test-reporter --coverage-report coverage.xml
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
+
+after_success:
+  - bash <(curl -s https://codecov.io/bash)
+
+env:
+  global:
+    - CC_TEST_REPORTER_ID=985c432a65a5dabaacffbd031324ecd0390128f73c99b7e3fe04dcec307262c2

README.md

@@ -1,2 +1,48 @@
-# component
-Extension for pug-php/phug to use components in templates
+# Phug Component
+
+Extension for pug-php and phug to use components in templates
+
+## Install
+
+```
+composer require phug/component
+```
+
+Enable it globally:
+```php
+\Phug\Component\ComponentExtension::enable();
+```
+
+## Usage
+
+```pug
+//- Register a component
+component alert
+  .alert.alert-danger
+    .alert-title
+      slot title
+  
+    slot
+
+section
+  //- Somewhere later in your template
+  @alert
+    slot title
+      | Hello #[em world]!
+
+    p This is an alert!
+```
+
+Output:
+
+```html
+<section>
+  <div class="alert alert-danger">
+    <div class="alert-title">
+      Hello <em>world</em>!
+    </div>
+
+    <p>This is an alert!</p>
+  </div>
+</section>
+```

composer.json

@@ -0,0 +1,39 @@
+{
+    "name": "phug/component",
+    "type": "library",
+    "keywords": ["phug", "pug", "html", "component"],
+    "description": "Extension for pug-php and phug to use components in templates",
+    "license": "MIT",
+    "homepage": "http://phug-lang.com",
+    "authors": [
+        {
+            "name": "KyleKatarn",
+            "email": "jade-php@selfbuild.fr",
+            "homepage": "http://github.com/kylekatarnls"
+        }
+    ],
+    "support": {
+        "email": "support@phug-lang.com",
+        "issues": "https://github.com/phug-php/phug/issues",
+        "source": "https://github.com/phug-php/phug",
+        "docs": "http://phug-lang.com/docs"
+    },
+    "minimum-stability": "stable",
+    "require": {
+        "php": ">=7.2",
+        "phug/renderer": "^1.3"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^8"
+    },
+    "autoload": {
+        "psr-4": {
+            "Phug\\Component\\": "./src/Phug/Component/"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Phug\\Test\\Component\\": "./tests/Phug/Component/"
+        }
+    }
+}

phpunit.xml

@@ -0,0 +1,25 @@
+<phpunit
+        bootstrap="vendor/autoload.php"
+        backupGlobals="false"
+        colors="true"
+        convertErrorsToExceptions="true"
+        convertNoticesToExceptions="true"
+        convertWarningsToExceptions="true"
+        forceCoversAnnotation="true"
+>
+    <testsuites>
+        <testsuite name="plug">
+            <directory suffix="Test.php">tests</directory>
+        </testsuite>
+    </testsuites>
+    <filter>
+        <whitelist processUncoveredFilesFromWhitelist="true">
+            <directory suffix=".php">src</directory>
+        </whitelist>
+    </filter>
+    <logging>
+        <log type="coverage-clover" target="./coverage/result.xml"/>
+        <log type="coverage-html" target="./coverage/result"/>
+        <log type="coverage-text" target="./coverage/result.txt"/>
+    </logging>
+</phpunit>

src/Phug/Component/ComponentExtension.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace Phug\Component;
+
+class ComponentExtension
+{
+}

tests/Phug/Component/ComponentExtensionTest.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Phug\Test\Component;
+
+use PHPUnit\Framework\TestCase;
+
+class ComponentExtensionTest extends TestCase
+{
+    public function getReadmeExamples()
+    {
+        preg_match_all(
+            '/```pug\n(?<pug>[\s\S]+)\n```[\s\S]*```html\n(?<html>[\s\S]+)\n```/U',
+            file_get_contents(__DIR__.'/../../../README.md'),
+            $examples,
+            PREG_SET_ORDER
+        );
+
+        foreach ($examples as $example) {
+            yield [$example['html'], $example['pug']];
+        }
+    }
+
+    /**
+     * @dataProvider getReadmeExamples
+     */
+    public function testReadme($htmlCode, $pugCode)
+    {
+        $this->assertSame($htmlCode, $pugCode);
+    }
+}