Merge branch 'basics' into 'master'

Added basic library structure

See merge request iserv/lib/zeit!1

.gitignore

@@ -0,0 +1,9 @@
+vendor/
+.idea/
+reports/
+coverage/
+tools/
+.php_cs.cache
+.phpunit.cache/
+composer.lock
+

.gitlab-ci.yml

@@ -0,0 +1,4 @@
+include:
+ - project: 'iserv-internal/git/ci'
+ file: '/iserv-library.yml'
+

.php_cs.dist

@@ -0,0 +1,66 @@
+<?php
+
+$finder = PhpCsFixer\Finder::create()
+ ->in(__DIR__)
+;
+
+return PhpCsFixer\Config::create()
+ ->setRules([
+ '@PSR2' => true,
+ 'array_syntax' => ['syntax' => 'short'],
+
+ /**
+ * PSR-12 based on the official pull request on Github
+ * @see https://github.com/FriendsOfPHP/PHP-CS-Fixer/pull/4943/files#diff-1e418beac3b4a9cf60ecd4ca4e2975a8R59
+ */
+ 'blank_line_after_opening_tag' => true,
+ 'braces' => [
+ // Added in later version
+ // 'allow_single_line_anonymous_class_with_empty_body' => true,
+ ],
+ 'compact_nullable_typehint' => true,
+ 'declare_equal_normalize' => true,
+ 'lowercase_cast' => true,
+ 'lowercase_static_reference' => true,
+ 'new_with_braces' => true,
+ 'no_blank_lines_after_class_opening' => true,
+ 'no_leading_import_slash' => true,
+ 'no_whitespace_in_blank_line' => true,
+ 'ordered_class_elements' => [
+ 'order' => [
+ 'use_trait',
+ ],
+ ],
+ 'ordered_imports' => [
+ 'imports_order' => [
+ 'class',
+ 'function',
+ 'const',
+ ],
+ 'sort_algorithm' => 'none',
+ ],
+ 'return_type_declaration' => true,
+ 'short_scalar_cast' => true,
+ 'single_blank_line_before_namespace' => true,
+ 'single_trait_insert_per_statement' => true,
+ 'ternary_operator_spaces' => true,
+ 'visibility_required' => [
+ 'elements' => [
+ 'const',
+ 'method',
+ 'property',
+ ],
+ ],
+
+ // More stricter rules than PSR-12
+ 'concat_space' => ['spacing' => 'one'],
+ 'method_argument_space' => ['on_multiline' => 'ensure_fully_multiline'],
+ 'no_empty_statement' => true,
+
+ // Those rules are in discussion whether or not the PSR include these
+ 'function_typehint_space' => true,
+ 'no_leading_namespace_whitespace' => true,
+ ])
+ ->setFinder($finder)
+ ;
+

CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+All notable changes to this project will be documented in this file, in reverse chronological order by release.
+
+## [Unreleased]
+
+### Added
+
+- Initial release of the IServ Zeit library.
+

README.md

@@ -1,2 +1,4 @@
-# Zeit
+# IServ Zeit Library
 
+[![coverage report](https://git.iserv.eu/iserv/lib/zeit/badges/master/coverage.svg)](https://git.iserv.eu/iserv/lib/zeit/commits/master)
+[![pipeline status](https://git.iserv.eu/iserv/lib/zeit/badges/master/pipeline.svg)](https://git.iserv.eu/iserv/lib/zeit/commits/master)

composer.json

@@ -0,0 +1,22 @@
+{
+ "name": "iserv/zeit",
+ "description": "An all purpose library for date and time handling.",
+ "type": "library",
+ "require": {
+ "php": ">=7.3"
+ },
+ "autoload": {
+ "psr-4": {
+ "IServ\\Library\\Zeit\\": "src/"
+ }
+ },
+ "repositories": [
+ {
+ "type": "composer",
+ "url": "https://composer.iserv.eu"
+ }
+ ],
+ "config": {
+ "sort-packages": true
+ }
+}

make.targets

@@ -0,0 +1,8 @@
+php
+phpunit
+psalm
+phpstan
+phpcsfixer
+debug
+help
+

phive.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phive xmlns="https://phar.io/phive">
+ <phar name="phpstan" version="^0.12" installed="0.12.82" location="./tools/phpstan.phar" copy="true"/>
+ <phar name="php-cs-fixer" version="^2.0" installed="2.18.4" location="./tools/php-cs-fixer.phar" copy="true"/>
+ <phar name="phpunit" version="^9.0" installed="9.5.3" location="./tools/phpunit.phar" copy="true"/>
+ <phar name="psalm" version="^4.0" installed="4.6.4" location="./tools/psalm.phar" copy="true"/>
+</phive>

phpstan.neon

@@ -0,0 +1,7 @@
+parameters:
+ paths:
+ - src
+ level: 5
+ inferPrivatePropertyTypeFromConstructor: true
+ reportUnmatchedIgnoredErrors: false
+

phpunit.xml

@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
+ xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.5/phpunit.xsd"
+ bootstrap="vendor/autoload.php"
+ cacheResultFile=".phpunit.cache/test-results"
+ executionOrder="depends,defects"
+ forceCoversAnnotation="true"
+ beStrictAboutCoversAnnotation="true"
+ beStrictAboutOutputDuringTests="true"
+ beStrictAboutTodoAnnotatedTests="true"
+ failOnRisky="true"
+ failOnWarning="true"
+ verbose="true">
+ <testsuites>
+ <testsuite name="default">
+ <directory suffix="Test.php">tests</directory>
+ </testsuite>
+ </testsuites>
+
+ <coverage cacheDirectory=".phpunit.cache/code-coverage"
+ processUncoveredFiles="true">
+ <include>
+ <directory suffix=".php">src</directory>
+ </include>
+ </coverage>
+</phpunit>

psalm.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0"?>
+<psalm
+ errorLevel="1"
+ resolveFromConfigFile="true"
+ xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
+ xmlns="https://getpsalm.org/schema/config"
+ xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
+>
+ <projectFiles>
+ <directory name="src" />
+ <ignoreFiles>
+ <directory name="vendor" />
+ </ignoreFiles>
+ </projectFiles>
+</psalm>

src/TestClass.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace IServ\Library\Zeit;
+
+final class TestClass
+{
+ public function returnsTrue(): bool
+ {
+ return true;
+ }
+}

tests/TestTest.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace IServ\Library\Zeit\Tests;
+
+use IServ\Library\Zeit\TestClass;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @covers \IServ\Library\Zeit\TestClass
+ */
+final class TestTest extends TestCase
+{
+ public function testTest(): void
+ {
+ $class = new TestClass();
+ $this->assertTrue($class->returnsTrue());
+ }
+}