init hexlet-phpunit project

Author: Екатерина Чмиль

.codeclimate

@@ -0,0 +1,10 @@
+engines:
+  duplication:
+    enabled: true
+    config:
+      languages:
+        - php
+  fixme:
+    enabled: true
+  phpmd:
+    enabled: true

.github/workflows/workflow.yml

@@ -0,0 +1,44 @@
+# Name of workflow
+name: PHP CI
+
+# Trigger the workflow on push or pull request
+on:
+  - push
+  - pull_request
+
+jobs:
+  build:
+
+    # The type of machine to run the job on
+    runs-on: ubuntu-latest
+
+    steps:
+        # Check-out repository under GitHub workspace
+        # https://github.com/actions/checkout
+      - uses: actions/checkout@v3
+        # Step's name
+      - name: Setup PHP
+        # Action gives to setup the PHP environment to test application
+        # https://github.com/shivammathur/setup-php
+        uses: shivammathur/setup-php@v2
+        with:
+          # Specify the PHP version
+          php-version: '8.2'
+      - name: Install
+        # Install project
+        run: make install
+      - name: Run linter
+        # Run Linter
+        run: make lint
+      # Publish code coverage on Code Climate
+      # https://github.com/paambaati/codeclimate-action
+      # NOTE: uncomment for using workflow
+      # - name: Run test & publish code coverage
+      #   uses: paambaati/codeclimate-action@v5
+      #   # Add Code Climate secret key
+      #   env:
+      #     CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
+      #   with:
+      #     coverageCommand: make test-coverage
+      #     coverageLocations: build/logs/clover.xml:clover
+      #     debug: true

.gitignore

@@ -0,0 +1,6 @@
+/vendor/
+logs
+*.swo
+*.swp
+*.cache
+build

.tool-versions

@@ -0,0 +1 @@
+php 8.2.10

Makefile

@@ -0,0 +1,21 @@
+install:
+	composer install
+
+console:
+	composer exec --verbose psysh
+
+lint:
+	composer exec --verbose phpcs -- --standard=PSR12 src tests
+	composer exec --verbose phpstan
+
+lint-fix:
+	composer exec --verbose phpcbf -- --standard=PSR12 src tests
+
+test:
+	composer exec --verbose phpunit tests
+
+test-coverage:
+	XDEBUG_MODE=coverage composer exec --verbose phpunit tests -- --coverage-clover build/logs/clover.xml
+
+test-coverage-text:
+	XDEBUG_MODE=coverage composer exec --verbose phpunit tests -- --coverage-text

README.md

@@ -0,0 +1,45 @@
+# php-package
+
+[![Github Actions Status](https://github.com/hexlet-boilerplates/php-package/workflows/PHP%20CI/badge.svg)](https://github.com/hexlet-boilerplates/php-package/actions)
+[![Code Climate](https://codeclimate.com/github/hexlet-boilerplates/php-package/badges/gpa.svg)](https://codeclimate.com/github/hexlet-boilerplates/php-package)
+[![Issue Count](https://codeclimate.com/github/hexlet-boilerplates/php-package/badges/issue_count.svg)](https://codeclimate.com/github/hexlet-boilerplates/php-package/issues)
+[![Test Coverage](https://codeclimate.com/github/hexlet-boilerplates/php-package/badges/coverage.svg)](https://codeclimate.com/github/hexlet-boilerplates/php-package/coverage)
+
+## Prerequisites
+
+* Linux, Macos, WSL
+* PHP >=8.2
+* Xdebug
+* Make
+* Git
+
+## Addons
+
+Use <http://psysh.org/>
+
+## Setup
+
+```bash
+git clone https://github.com/hexlet-boilerplates/php-package.git
+cd php-package
+make install
+```
+
+## Run tests
+
+```sh
+make test
+```
+
+## Test Coverage
+
+* see `phpunit.xml`
+* See [codeclimate documentation](https://docs.codeclimate.com/docs/configuring-test-coverage)
+* add `CC_TEST_REPORTER_ID` to workflow as SECRETS ENV VARIABLE (for safety)
+
+[![Hexlet Ltd. logo](https://raw.githubusercontent.com/Hexlet/assets/master/images/hexlet_logo128.png)](https://hexlet.io/?utm_source=github&utm_medium=link&utm_campaign=php-package)
+
+This repository is created and maintained by the team and the community of Hexlet, an educational project. [Read more about Hexlet](https://hexlet.io/?utm_source=github&utm_medium=link&utm_campaign=php-package).
+
+
+See most active contributors on [hexlet-friends](https://friends.hexlet.io/).

bin/php-package

@@ -0,0 +1,19 @@
+#!/usr/bin/env php
+
+<?php
+
+$autoloadPath1 = __DIR__ . '/../../../autoload.php';
+$autoloadPath2 = __DIR__ . '/../vendor/autoload.php';
+if (file_exists($autoloadPath1)) {
+    require_once $autoloadPath1;
+} else {
+    require_once $autoloadPath2;
+}
+
+echo 'what is your name?: ';
+$name = trim(fgets(STDIN));
+
+$user = new Php\Package\User($name);
+
+var_dump($user);
+

composer.json

@@ -0,0 +1,45 @@
+{
+  "name": "hexlet/php-package",
+  "bin": ["bin/php-package"],
+  "type": "library",
+  "authors": [
+    {
+      "name": "Kirill Mokevnin",
+      "email": "[email protected]"
+    }
+  ],
+  "description": "hexlet php-package",
+  "license": "MIT",
+  "scripts": {
+    "test": "phpunit tests"
+  },
+  "autoload": {
+    "psr-4": {
+      "Php\\Package\\": "src"
+    }
+  },
+  "autoload-dev": {
+    "psr-4": {
+      "Php\\Package\\Tests\\": "tests"
+    }
+  },
+  "require": {
+    "illuminate/collections": "^11.0",
+    "nesbot/carbon": "^3.0",
+    "symfony/string": "^7.0",
+    "phpstan/phpstan": "^1.10"
+  },
+  "require-dev": {
+    "psy/psysh": "@stable",
+    "phpstan/phpstan-phpunit": "^1.3",
+    "phpstan/extension-installer": "^1.3",
+    "symfony/var-dumper": "^7.0",
+    "phpunit/phpunit": "^11.0",
+    "squizlabs/php_codesniffer": "*"
+  },
+  "config": {
+    "allow-plugins": {
+      "phpstan/extension-installer": true
+    }
+  }
+}