initial commit

Author: CommandString

.github/workflows/php.yml

@@ -0,0 +1,44 @@
+name: PHP Composer
+
+on:
+  push:
+    branches:
+      - '**'
+  pull_request:
+    branches:
+      - '**'
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        php: [ '8.1', '8.2' ]
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Validate composer.json and composer.lock
+        run: composer validate --strict
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          coverage: xdebug
+          ini-values: xdebug.mode=develop,debug,coverage,
+
+      - name: Install dependencies
+        run: composer install --prefer-dist --no-progress
+
+      - name: PHP-CS-Fixer
+        run: composer fix:dry
+
+      - name: PHPUnit
+        run: composer test

.gitignore

@@ -0,0 +1,17 @@
+### PHP-CS-Fixer
+.php-cs-fixer.cache
+.php-cs-fixer.php
+
+### Composer
+composer.phar
+/vendor/
+composer.lock
+
+### JetBrains IDEs
+/.idea/
+
+### VSCode
+/.vscode/
+
+### PHPUnit
+/.phpunit.cache/

.php-cs-fixer.dist.php

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Totally Not Another PHP Framework
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

LICENSE

@@ -0,0 +1,41 @@
+# PackageTemplate
+
+A template repository for making composer packages
+
+## Requirements
+
+- PHP 8.1+
+
+## What's Included
+
+- [Composer Normalize](https://github.com/ergebnis/composer-normalize)
+- [Faker](https://github.com/fakerphp/faker)
+- [PHP-CS-Fixer](https://github.com/PHP-CS-Fixer/PHP-CS-Fixer)
+- [JetBrains Attributes](https://github.com/jetbrains/phpstorm-attributes)
+- [PHPUnit](https://phpunit.de)
+- [Roave Security Advisories](https://github.com/Roave/SecurityAdvisories)
+- [Symfony VarDumper](https://github.com/symfony/var-dumper)
+- [Composer Git Hooks](https://github.com/xheaven/composer-git-hooks)
+
+- GitHub Actions
+- Composer Scripts
+    - `composer test` - Run PHPUnit tests
+    - `composer test:coverage` - Run PHPUnit tests with coverage
+    - `composer fix:dry` - Run PHP-CS-Fixer in Dry-Run mode
+    - `composer fix` - Run PHP-CS-Fixer and fix errors
+
+## Installation
+
+```bash
+composer create-project tnapf/package <package>
+```
+
+## Setup GitHub Repository
+
+1. Run `git init` to initialize a new git repository
+2. Run `git add .` to add all files to the repository
+3. Run `git commit -m "initial commit"` to commit the files
+4. Run `git branch -M main` to rename the current branch to `main`
+5. Create a new repository on GitHub
+6. Run `git remote add origin https://github.com/tnapf/<package>.git` to add the new repository as remote
+7. Run `git push -u origin main` to push the files to the new repository

README.md

@@ -0,0 +1,48 @@
+{
+  "name": "cavephp/cavephp",
+  "description": "The core the CavePHP",
+  "license": "MIT",
+  "type": "library",
+  "authors": [
+    {
+      "name": "Robert Snedeker",
+      "email": "[email protected]"
+    },
+    {
+      "name": "Diego Casillas",
+      "email": "[email protected]"
+    }
+  ],
+  "require": {
+    "php": ">=8.2",
+    "react/socket": "^1.14"
+  },
+  "require-dev": {
+    "friendsofphp/php-cs-fixer": "^3.16",
+    "phpunit/phpunit": "^10.1"
+  },
+  "autoload": {
+    "psr-4": {
+      "CavePHP\\": "src/"
+    },
+    "files": [
+        "src/functions.php"
+    ]
+  },
+  "autoload-dev": {
+    "psr-4": {
+      "CavePHP\\Tests\\": "tests/"
+    }
+  },
+  "scripts": {
+    "fix": "php-cs-fixer fix --using-cache=no",
+    "fix:dry": "php-cs-fixer fix --using-cache=no --diff --dry-run",
+    "test": "phpunit",
+    "test:coverage": "phpunit --coverage-html .phpunit.cache/cov-html"
+  },
+  "config": {
+    "allow-plugins": {
+      "ergebnis/composer-normalize": false
+    }
+  }
+}

composer.json

@@ -0,0 +1,14 @@
+<?php
+
+use CavePHP\Server\Logger\Level;
+use CavePHP\Server\Server;
+
+require_once __DIR__ . '/vendor/autoload.php';
+
+$server = new Server();
+
+$server->on(Server::READY, function () use ($server) {
+    $server->logger->log(Level::INFO, 'Server is ready!');
+});
+
+$server->start();

index.php

@@ -0,0 +1,17 @@
+<?xml version="1.0"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" colors="true"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.1/phpunit.xsd"
+         beStrictAboutOutputDuringTests="true" failOnRisky="true" failOnWarning="true"
+         cacheDirectory=".phpunit.cache">
+    <testsuites>
+        <testsuite name="default">
+            <directory>tests</directory>
+        </testsuite>
+    </testsuites>
+    <coverage />
+    <source>
+        <include>
+            <directory suffix=".php">src</directory>
+        </include>
+    </source>
+</phpunit>

phpunit.xml

@@ -0,0 +1,9 @@
+<?php
+
+namespace CavePHP\Exceptions;
+
+use Exception;
+
+class CavePHPException extends Exception {
+    
+}

src/Exceptions/CavePHPException.php

@@ -0,0 +1,80 @@
+<?php
+
+namespace CavePHP\Pools;
+
+use CavePHP\Exceptions\CavePHPException;
+use Countable;
+
+abstract class Pool implements Countable {
+    private array $items = [];
+
+    abstract public function isInstance(object $item): bool;
+
+    public function __construct(array $items = []) {
+        $this->fill($items);
+    }
+
+    public function fill(array $items): void
+    {
+        foreach ($items as $item) {
+            if (!is_object($item) || !$this->isInstance($item)) {
+                throw new CavePHPException("This object is not supported by this collection");
+            }
+        }
+
+        $this->items = [...$this->items, ...$items];
+    }
+
+    public function add(mixed $item): void
+    {
+        $this->fill([$item]);
+    }
+
+    public function remove(mixed $element): void
+    {
+        $this->items = array_filter($this->items, static fn ($item) => $item !== $element);
+    }
+
+    public function filter(callable $callback): static
+    {
+        $that = clone $this;
+
+        $that->loop(static function (object $item) use ($that) {
+            $that->remove($item);
+        });
+
+        return $that;
+    }
+
+    public function loop(callable $callback): void
+    {
+        foreach ($this->items as $item) {
+            $callback($item);
+        }
+    }
+
+    public function find(callable $callback): ?object
+    {
+        foreach ($this->items as $item) {
+            if ($callback($item)) {
+                return $item;
+            }
+        }
+
+        return null;
+    }
+
+    public function reduce(callable $callback, mixed $initial = null): mixed
+    {
+        $reduced = $initial;
+
+        $this->loop(static fn ($reduced, $item) => $callback($reduced, $item));
+
+        return $reduced;
+    }
+
+    public function count(): int
+    {
+        return count($this->items);
+    }
+}

src/Pools/Pool.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace CavePHP\Server;
+
+use CavePHP\Utilities\EventEmitter;
+use React\Socket\ConnectionInterface;
+
+class Client extends EventEmitter
+{
+    public const RAW_DATA = 'raw_data';
+    public const PACKET = 'packet';
+
+    public function __construct(
+        protected readonly ConnectionInterface $connection
+    ) {
+        $this->setupEvents();
+    }
+
+    public function getIp(): string
+    {
+        return $this->connection->getRemoteAddress();
+    }
+
+    private function setupEvents(): void
+    {
+        $this->connection->on('data', function ($data) {
+            $this->emit('data', [$data]);
+        });
+    }
+}

src/Server/Client.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace CavePHP\Server\Logger;
+
+final class Color
+{
+    public const RED = "#ff695e";
+    public const RED_INVERTED = "#db2828";
+    public const ORANGE = "#ff851b";
+    public const ORANGE_INVERTED = "#f2711c";
+    public const YELLOW = "#ffe21f";
+    public const YELLOW_INVERTED = "#fbbd08";
+    public const OLIVE = "#d9e778";
+    public const OLIVE_INVERTED = "#b5cc18";
+    public const GREEN = "#2ecc40";
+    public const GREEN_INVERTED = "#21ba45";
+    public const TEAL = "#6dffff";
+    public const TEAL_INVERTED = "#00b5ad";
+    public const BLUE = "#54c8ff";
+    public const BLUE_INVERTED = "#2185d0";
+    public const VIOLET = "#a291fb";
+    public const VIOLET_INVERTED = "#6435c9";
+    public const PURPLE = "#dc73ff";
+    public const PURPLE_INVERTED = "#a333c8";
+    public const PINK = "#ff8edf";
+    public const PINK_INVERTED = "#e03997";
+    public const BROWN = "#d67c1c";
+    public const BROWN_INVERTED = "#a5673f";
+    public const GREY = "#dcddde";
+    public const GREY_INVERTED = "#767676";
+    public const BLACK = "#545454";
+    public const BLACK_INVERTED = "#1b1c1d";
+}

src/Server/Logger/Color.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace CavePHP\Server\Logger;
+
+use CavePHP\Server\Logger\Color;
+use Stringable;
+
+enum Level: string
+{
+    case ERROR = Color::RED_INVERTED;
+    case WARNING = Color::YELLOW_INVERTED;
+    case INFO = Color::BLUE_INVERTED;
+    case DEBUG = Color::BLACK;
+}