first commit

Author: yosrib

.gitattributes

@@ -0,0 +1,6 @@
+# Exclude non-essential files from dist
+.github export-ignore
+tests export-ignore
+index.html export-ignore
+phpmd.xml.dist export-ignore
+phpunit.xml.dist export-ignore

.gitignore

@@ -0,0 +1,10 @@
+.idea
+
+/vendor/
+composer.lock
+
+.phpunit.result.cache
+
+.docker
+Dockerfile
+docker-compose.yaml

Command/HelloCommand.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace Devgine\Demo\Command;
+
+use Symfony\Component\Console\Attribute\AsCommand;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+#[AsCommand(
+    name: 'devgine:demo:hello',
+    description: 'Hello command'
+)]
+class HelloCommand extends Command
+{
+    /** @SuppressWarnings(PHPMD.UnusedFormalParameter) */
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        $output->writeln('<info>Devgine demo is installed.</info>');
+
+        return Command::SUCCESS;
+    }
+}

Tests/Command/HelloCommandTest.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace Devgine\Demo\Tests\Command;
+
+use Devgine\Demo\Command\HelloCommand;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Console\Application;
+use Symfony\Component\Console\Tester\CommandTester;
+
+class HelloCommandTest extends TestCase
+{
+    public function testExecute()
+    {
+        $application = new Application();
+        $application->add(new HelloCommand());
+        $command = $application->find('devgine:demo:hello');
+        $commandTester = new CommandTester($command);
+
+        $code = $commandTester->execute([]);
+
+        $this->assertEquals(0, $code);
+        $this->assertStringContainsString('Devgine demo is installed.', $commandTester->getDisplay());
+    }
+}

composer.json

@@ -0,0 +1,27 @@
+{
+    "name": "devgine/demo",
+    "description": "demo project",
+    "type": "library",
+    "keywords": ["demo"],
+    "homepage": "https://github.com/devgine/demo-repository",
+    "require": {
+        "php": ">=8.1",
+        "symfony/console": "^6.1"
+    },
+    "license": "MIT",
+    "autoload": {
+        "psr-4": {
+            "Devgine\\Demo\\": ""
+        },
+        "exclude-from-classmap": [
+            "/Tests/"
+        ]
+    },
+    "authors": [
+        {
+            "name": "Yosri BAHRI",
+            "email": "[email protected]"
+        }
+    ],
+    "minimum-stability": "dev"
+}

phpmd.xml.dist

@@ -0,0 +1,29 @@
+<?xml version="1.0"?>
+<ruleset name="Devgine demo PHPMD rule set"
+         xmlns="http://pmd.sf.net/ruleset/1.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://pmd.sf.net/ruleset/1.0.0
+                     http://pmd.sf.net/ruleset_xml_schema.xsd"
+         xsi:noNamespaceSchemaLocation="
+                     http://pmd.sf.net/ruleset_xml_schema.xsd">
+    <description>Devgine demo rules</description>
+
+    <rule ref="rulesets/cleancode.xml">
+        <exclude name="StaticAccess" />
+    </rule>
+    <rule ref="rulesets/codesize.xml" />
+    <rule ref="rulesets/codesize.xml/CyclomaticComplexity">
+        <priority>1</priority>
+        <properties>
+            <property name="reportLevel" value="7" />
+        </properties>
+    </rule>
+    <rule ref="rulesets/naming.xml">
+        <exclude name="ShortVariable" />
+    </rule>
+    <rule ref="rulesets/design.xml" />
+    <rule ref="rulesets/controversial.xml" />
+    <rule ref="rulesets/unusedcode.xml" />
+
+    <exclude-pattern>**/vendor/**</exclude-pattern>
+</ruleset>

phpunit.xml.dist

@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!-- https://phpunit.readthedocs.io/en/latest/configuration.html -->
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
+         backupGlobals="false"
+         colors="true"
+         bootstrap="vendor/autoload.php"
+         convertDeprecationsToExceptions="false"
+>
+    <php>
+        <ini name="display_errors" value="1" />
+        <ini name="error_reporting" value="-1" />
+    </php>
+
+    <testsuites>
+        <testsuite name="Unit test suite">
+            <directory>./tests</directory>
+        </testsuite>
+    </testsuites>
+
+    <coverage processUncoveredFiles="true">
+        <include>
+            <directory suffix=".php">src</directory>
+        </include>
+    </coverage>
+</phpunit>