Merge pull request #69 from niden-code/feature/volt-phase1

Feature/volt phase1

Author: niden

.github/workflows/continuous-integration.yml

@@ -0,0 +1,137 @@
+name: "Volt CI"
+
+on:
+  push:
+    paths-ignore:
+      - '**.md'
+      - '**.txt'
+  pull_request:
+  workflow_dispatch:
+
+permissions: {}
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ github.ref != 'refs/heads/master' }}
+
+jobs:
+  # PHP CodeSniffer + PHPStan inspection
+  phpcs:
+    name: "Validate code style"
+
+    permissions:
+      contents: read
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: true
+      matrix:
+        php:
+          - '8.1'
+          - '8.2'
+          - '8.3'
+          - '8.4'
+          - '8.5'
+
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: "Setup PHP"
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          extensions: mbstring, ctype
+          coverage: none
+          ini-values: apc.enable_cli=on, session.save_path=/tmp
+          tools: pecl
+        env:
+          COMPOSER_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Install development dependencies with Composer
+        uses: ramsey/composer-install@v4
+        with:
+          composer-options: "--prefer-dist"
+
+      - name: "PHPCS"
+        run: composer cs
+
+      - name: "PHPStan"
+        run: composer analyze
+
+  tests:
+    name: Unit tests
+    needs: phpcs
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: read
+
+    strategy:
+      fail-fast: false
+      matrix:
+        php:
+          - '8.1'
+          - '8.2'
+          - '8.3'
+          - '8.4'
+          - '8.5'
+
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          extensions: mbstring, ctype
+          coverage: xdebug
+          tools: composer:v2
+        env:
+          COMPOSER_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Validate composer.json
+        run: composer validate --no-check-all --no-check-publish
+
+      - name: Install dependencies
+        uses: ramsey/composer-install@v4
+        with:
+          composer-options: "--prefer-dist"
+
+      - name: Run tests
+        run: composer test
+
+  coverage:
+    name: Code Coverage
+    needs: tests
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: read
+
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.5'
+          extensions: mbstring, ctype
+          coverage: xdebug
+          tools: composer:v2
+        env:
+          COMPOSER_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Install dependencies
+        uses: ramsey/composer-install@v4
+        with:
+          composer-options: "--prefer-dist"
+
+      - name: Run tests with coverage
+        run: composer test-coverage
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v5
+        with:
+          files: ./tests/_output/coverage.xml
+          fail_ci_if_error: false

.github/workflows/main.yml

@@ -1,8 +1,14 @@
 .idea/
-composer.phar
+.worktrees/
 /vendor/
 /lemon-php/
-log.txt
-tests/support/output/
-tests/support/coverage/
+composer.phar
+
+# PHPUnit
+.phpunit.result.cache/
+tests/_output/
+coverage/
+coverage.xml
+
+# Volt compiled templates
 *.volt.php

.gitignore

@@ -1,14 +1,15 @@
 {
     "name": "phalcon/volt",
-    "description": "Phalcon Volt is a HTML template engine for sender-side rendering.",
-    "version": "1.0.0",
+    "description": "Phalcon Volt is an HTML template engine for server-side rendering.",
+    "type": "library",
     "keywords": [
         "phalcon",
         "volt",
         "template",
         "engine",
-        "HTML"
+        "html"
     ],
+    "homepage": "https://phalcon.io",
     "license": "MIT",
     "authors": [
         {
@@ -21,11 +22,24 @@
             "homepage": "https://github.com/phalcon/volt/graphs/contributors"
         }
     ],
+    "support": {
+        "email": "support@phalcon.io",
+        "issues": "https://github.com/phalcon/volt/issues",
+        "source": "https://github.com/phalcon/volt",
+        "discussions": "https://phalcon.io/discussions/",
+        "docs": "https://phalcon.io/docs/",
+        "rss": "https://blog.phalcon.io/rss"
+    },
     "require": {
-        "php": ">=8.1",
-        "ext-mbstring": "*",
-        "ext-ctype": "*"
+        "php": ">=8.1 <9.0",
+        "ext-ctype": "*",
+        "ext-mbstring": "*"
+    },
+    "suggest": {
+        "phalcon/phalcon": "The Phalcon framework this module integrates with"
     },
+    "minimum-stability": "stable",
+    "prefer-stable": true,
     "require-dev": {
         "pds/skeleton": "^1.0",
         "phalcon/ide-stubs": "^5.8",
@@ -54,20 +68,12 @@
             "Phalcon\\Tests\\Unit\\": "tests/unit/"
         }
     },
-    "support": {
-        "email": "support@phalcon.io",
-        "issues": "https://github.com/phalcon/volt/issues",
-        "discussions": "https://phalcon.io/discussions/",
-        "source": "https://github.com/phalcon/volt",
-        "docs": "https://phalcon.io/docs/",
-        "rss": "https://blog.phalcon.io/rss"
-    },
     "scripts": {
-        "analyze": "vendor/bin/phpstan analyse -c phpstan.neon",
+        "analyze": "vendor/bin/phpstan analyse -c phpstan.neon --memory-limit 1024M",
         "cs": "vendor/bin/phpcs --standard=phpcs.xml",
         "cs-fix": "vendor/bin/phpcbf --standard=phpcs.xml",
-        "test": "vendor/bin/phpunit",
-        "test-coverage": "vendor/bin/phpunit --coverage-clover ./tests/support/coverage.xml",
-        "test-coverage-html": "vendor/bin/phpunit --testdox --coverage-html ./tests/support/coverage/"
+        "test": "vendor/bin/phpunit -c phpunit.xml",
+        "test-coverage": "vendor/bin/phpunit -c phpunit.xml --coverage-clover tests/_output/coverage.xml",
+        "test-coverage-html": "vendor/bin/phpunit -c phpunit.xml --coverage-html tests/_output/"
     }
 }