Skip to content

Commit 6083de9

Browse files
loevgaardloevgaard
committed
first commit
0 parents  commit 6083de9

15 files changed

+554
-0
lines changed

‎.editorconfig

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
root = true
2+
3+
[*]
4+
indent_style = space
5+
indent_size = 4
6+
end_of_line = lf
7+
charset = utf-8
8+
trim_trailing_whitespace = true
9+
insert_final_newline = true
10+
11+
[*.md]
12+
trim_trailing_whitespace = false

‎.gitattributes

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
/tests export-ignore
2+
/.editorconfig export-ignore
3+
/.gitattributes export-ignore
4+
/.gitignore export-ignore
5+
/.github export-ignore
6+
/ecs.php export-ignore
7+
/infection.json.dist export-ignore
8+
/phpunit.xml.dist export-ignore
9+
/psalm.xml export-ignore
10+
/README.md export-ignore
11+
/composer-require-checker.json export-ignore
12+
/rector.php export-ignore

‎.github/workflows/build.yaml

+191
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,191 @@
1+
name: "build"
2+
on:
3+
push:
4+
branches:
5+
- "master"
6+
pull_request: ~
7+
workflow_dispatch: ~
8+
9+
jobs:
10+
coding-standards:
11+
name: "Coding Standards"
12+
13+
runs-on: "ubuntu-latest"
14+
15+
strategy:
16+
matrix:
17+
php-version:
18+
- "8.1"
19+
20+
dependencies:
21+
- "highest"
22+
23+
steps:
24+
- name: "Checkout"
25+
uses: "actions/checkout@v4"
26+
27+
- name: "Setup PHP, with composer and extensions"
28+
uses: "shivammathur/setup-php@v2"
29+
with:
30+
php-version: "${{ matrix.php-version }}"
31+
extensions: "${{ env.PHP_EXTENSIONS }}"
32+
coverage: "none"
33+
34+
- name: "Install composer dependencies"
35+
uses: "ramsey/composer-install@v2"
36+
with:
37+
dependency-versions: "${{ matrix.dependencies }}"
38+
39+
- name: "Validate composer"
40+
run: "composer validate --strict"
41+
42+
- name: "Check composer normalized"
43+
run: "composer normalize --dry-run"
44+
45+
- name: "Check style"
46+
run: "composer check-style"
47+
48+
- name: "Check code style according to PHP version"
49+
run: "vendor/bin/rector --dry-run"
50+
51+
dependency-analysis:
52+
name: "Dependency Analysis"
53+
54+
runs-on: "ubuntu-latest"
55+
56+
strategy:
57+
matrix:
58+
php-version:
59+
- "8.1"
60+
61+
dependencies:
62+
- "highest"
63+
64+
steps:
65+
- name: "Checkout"
66+
uses: "actions/checkout@v4"
67+
68+
- name: "Setup PHP, with composer and extensions"
69+
uses: "shivammathur/setup-php@v2"
70+
with:
71+
coverage: "none"
72+
extensions: "${{ env.PHP_EXTENSIONS }}"
73+
php-version: "${{ matrix.php-version }}"
74+
tools: "composer-require-checker, composer-unused"
75+
76+
- name: "Install composer dependencies"
77+
uses: "ramsey/composer-install@v2"
78+
with:
79+
dependency-versions: "${{ matrix.dependencies }}"
80+
81+
- name: "Run maglnet/composer-require-checker"
82+
run: "composer-require-checker check"
83+
84+
- name: "Run composer-unused/composer-unused"
85+
run: "composer-unused"
86+
87+
static-code-analysis:
88+
name: "Static Code Analysis"
89+
90+
runs-on: "ubuntu-latest"
91+
92+
strategy:
93+
matrix:
94+
php-version:
95+
- "8.1"
96+
97+
dependencies:
98+
- "highest"
99+
100+
steps:
101+
- name: "Checkout"
102+
uses: "actions/checkout@v4"
103+
104+
- name: "Setup PHP, with composer and extensions"
105+
uses: "shivammathur/setup-php@v2"
106+
with:
107+
php-version: "${{ matrix.php-version }}"
108+
extensions: "${{ env.PHP_EXTENSIONS }}"
109+
coverage: "none"
110+
111+
- name: "Install composer dependencies"
112+
uses: "ramsey/composer-install@v2"
113+
with:
114+
dependency-versions: "${{ matrix.dependencies }}"
115+
116+
- name: "Static analysis"
117+
run: "composer analyse"
118+
119+
unit-tests:
120+
name: "Unit tests"
121+
122+
runs-on: "ubuntu-latest"
123+
124+
strategy:
125+
matrix:
126+
php-version:
127+
- "8.1"
128+
129+
dependencies:
130+
- "highest"
131+
132+
steps:
133+
- name: "Checkout"
134+
uses: "actions/checkout@v4"
135+
136+
- name: "Setup PHP, with composer and extensions"
137+
uses: "shivammathur/setup-php@v2"
138+
with:
139+
php-version: "${{ matrix.php-version }}"
140+
extensions: "${{ env.PHP_EXTENSIONS }}"
141+
coverage: "pcov"
142+
143+
- name: "Set up problem matchers for phpunit/phpunit"
144+
run: "echo \"::add-matcher::${{ runner.tool_cache }}/phpunit.json\""
145+
146+
- name: "Install composer dependencies"
147+
uses: "ramsey/composer-install@v2"
148+
with:
149+
dependency-versions: "${{ matrix.dependencies }}"
150+
151+
- name: "Run phpunit (with code coverage)"
152+
run: "vendor/bin/phpunit --coverage-clover=.build/logs/clover.xml"
153+
154+
- name: "Send code coverage report to Codecov.io"
155+
uses: "codecov/codecov-action@v3"
156+
with:
157+
directory: ".build/logs"
158+
159+
mutation-tests:
160+
name: "Mutation tests"
161+
162+
runs-on: "ubuntu-latest"
163+
164+
strategy:
165+
matrix:
166+
php-version:
167+
- "8.1"
168+
169+
dependencies:
170+
- "highest"
171+
172+
steps:
173+
- name: "Checkout"
174+
uses: "actions/checkout@v4"
175+
176+
- name: "Setup PHP, with composer and extensions"
177+
uses: "shivammathur/setup-php@v2"
178+
with:
179+
coverage: "pcov"
180+
extensions: "${{ env.PHP_EXTENSIONS }}"
181+
php-version: "${{ matrix.php-version }}"
182+
183+
- name: "Install composer dependencies"
184+
uses: "ramsey/composer-install@v2"
185+
with:
186+
dependency-versions: "${{ matrix.dependencies }}"
187+
188+
- name: "Run infection"
189+
run: "vendor/bin/infection"
190+
env:
191+
STRYKER_DASHBOARD_API_KEY: "${{ secrets.STRYKER_DASHBOARD_API_KEY }}"

‎.gitignore

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
/vendor/
2+
/composer.lock
3+
/.phpunit.result.cache
4+
/phpunit.xml
5+
/.build/

‎LICENSE

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

‎README.md

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# PHP abstraction for identifying a browser client
2+
3+
[![Latest Version][ico-version]][link-packagist]
4+
[![Software License][ico-license]](LICENSE)
5+
[![Build Status][ico-github-actions]][link-github-actions]
6+
[![Code Coverage][ico-code-coverage]][link-code-coverage]
7+
[![Mutation testing][ico-infection]][link-infection]
8+
9+
## Installation
10+
11+
```bash
12+
composer require setono/client
13+
```
14+
15+
## Usage
16+
17+
TOOD
18+
19+
[ico-version]: https://poser.pugx.org/setono/client/v/stable
20+
[ico-license]: https://poser.pugx.org/setono/client/license
21+
[ico-github-actions]: https://github.com/setono/client/workflows/build/badge.svg
22+
[ico-code-coverage]: https://codecov.io/gh/setono/client/branch/master/graph/badge.svg
23+
[ico-infection]: https://img.shields.io/endpoint?style=flat&url=https%3A%2F%2Fbadge-api.stryker-mutator.io%2Fgithub.com%2Fsetono%2Fclient%2Fmaster
24+
25+
[link-packagist]: https://packagist.org/packages/setono/client
26+
[link-github-actions]: https://github.com/setono/client/actions
27+
[link-code-coverage]: https://codecov.io/gh/setono/client
28+
[link-infection]: https://dashboard.stryker-mutator.io/reports/github.com/setono/client/master

‎composer.json

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
{
2+
"name": "setono/client",
3+
"description": "PHP abstraction for identifying a browser client",
4+
"license": "MIT",
5+
"type": "library",
6+
"authors": [
7+
{
8+
"name": "Joachim Løvgaard",
9+
"email": "[email protected]"
10+
}
11+
],
12+
"require": {
13+
"php": ">=8.1"
14+
},
15+
"require-dev": {
16+
"infection/infection": "^0.27.10",
17+
"phpunit/phpunit": "^9.6.13",
18+
"psalm/plugin-phpunit": "^0.18.4",
19+
"ramsey/uuid": "^4.7",
20+
"setono/code-quality-pack": "^2.7",
21+
"symfony/uid": "^5.4 || ^6.4 || ^7.0"
22+
},
23+
"prefer-stable": true,
24+
"autoload": {
25+
"psr-4": {
26+
"Setono\\Client\\": "src/"
27+
}
28+
},
29+
"autoload-dev": {
30+
"psr-4": {
31+
"Setono\\Client\\": "tests/"
32+
}
33+
},
34+
"config": {
35+
"allow-plugins": {
36+
"dealerdirect/phpcodesniffer-composer-installer": false,
37+
"ergebnis/composer-normalize": true,
38+
"infection/extension-installer": true,
39+
"php-http/discovery": false
40+
},
41+
"sort-packages": true
42+
},
43+
"extra": {
44+
"branch-alias": {
45+
"dev-master": "1.0-dev"
46+
}
47+
},
48+
"scripts": {
49+
"analyse": "psalm",
50+
"check-style": "ecs check",
51+
"fix-style": "ecs check --fix",
52+
"phpunit": "phpunit",
53+
"rector": "rector"
54+
}
55+
}

‎ecs.php

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
use Symplify\EasyCodingStandard\Config\ECSConfig;
6+
7+
return static function (ECSConfig $config): void {
8+
$config->import('vendor/sylius-labs/coding-standard/ecs.php');
9+
$config->paths([
10+
'src', 'tests'
11+
]);
12+
};

‎infection.json.dist

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{
2+
"source": {
3+
"directories": [
4+
"src"
5+
]
6+
},
7+
"logs": {
8+
"text": "php://stderr",
9+
"github": true,
10+
"stryker": {
11+
"badge": "master"
12+
}
13+
},
14+
"minMsi": 46.88,
15+
"minCoveredMsi": 62.5
16+
}

‎phpunit.xml.dist

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
3+
xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd" bootstrap="vendor/autoload.php"
4+
colors="true" verbose="true">
5+
<coverage includeUncoveredFiles="true" processUncoveredFiles="true">
6+
<include>
7+
<directory suffix=".php">src/</directory>
8+
</include>
9+
</coverage>
10+
<testsuites>
11+
<testsuite name="Setono Client Test Suite">
12+
<directory>tests</directory>
13+
</testsuite>
14+
</testsuites>
15+
</phpunit>

0 commit comments

Comments
 (0)