Skip to content

Commit

Permalink
Compatible with PHP 8.2
Browse files Browse the repository at this point in the history
  • Loading branch information
olvlvl committed Feb 15, 2023
1 parent 45dd587 commit 908b0b0
Show file tree
Hide file tree
Showing 52 changed files with 2,231 additions and 2,032 deletions.
8 changes: 2 additions & 6 deletions .editorconfig
Expand Up @@ -5,12 +5,8 @@ end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true
indent_style = tab
indent_style = space
indent_size = 4

[*.yml]
indent_style = space
[{*.yaml,*yml,*.neon}]
indent_size = 2

[*.md]
indent_style = space
6 changes: 5 additions & 1 deletion .gitattributes
@@ -1,9 +1,13 @@
.editorconfig
* text=auto

.editorconfig export-ignore
.gitattributes export-ignore
.github export-ignore
.gitignore export-ignore
docker-compose.yml export-ignore
Dockerfile export-ignore
Makefile export-ignore
phpcs.xml
phpstan.neon export-ignore
phpunit.xml export-ignore
tests/ export-ignore
21 changes: 21 additions & 0 deletions .github/workflows/code-style.yml
@@ -0,0 +1,21 @@
name: code-style

on:
- push
- pull_request

jobs:
phpcs:
runs-on: ubuntu-20.04
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Install PHP
uses: shivammathur/setup-php@v2
with:
coverage: none
php-version: "7.2"
ini-values: memory_limit=-1
tools: phpcs, cs2pr
- name: Run PHP Code Sniffer
run: phpcs -q --report=checkstyle | cs2pr
@@ -1,25 +1,20 @@
name: analyze
name: static-analysis

on:
push:
pull_request:
- push
- pull_request

jobs:
phpstan:
name: phpstan
runs-on: ubuntu-20.04
strategy:
matrix:
php-version:
- "7.2"
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Install PHP
uses: shivammathur/setup-php@v2
with:
coverage: none
php-version: "${{ matrix.php-version }}"
php-version: "7.2"
ini-values: memory_limit=-1
tools: composer:v2
- name: Cache dependencies
Expand All @@ -28,11 +23,10 @@ jobs:
path: |
~/.composer/cache
vendor
key: "php-${{ matrix.php-version }}"
restore-keys: "php-${{ matrix.php-version }}"
key: phpstan-deps

- name: Install dependencies
run: composer install --no-interaction --no-progress

- name: Analyze
run: vendor/bin/phpstan analyse
run: vendor/bin/phpstan
22 changes: 6 additions & 16 deletions .github/workflows/phpunit.yml → .github/workflows/test.yml
@@ -1,21 +1,18 @@
name: test

on:
push:
pull_request:
- push
- pull_request

jobs:
phpunit:
name: phpunit
runs-on: ubuntu-20.04
strategy:
matrix:
dependencies:
- lowest
- highest
php-version:
- "7.2"
- "7.4"
- "8.2"
steps:
- name: Checkout
uses: actions/checkout@v2
Expand All @@ -35,18 +32,11 @@ jobs:
key: "php-${{ matrix.php-version }}"
restore-keys: "php-${{ matrix.php-version }}"

- name: Install dependencies, lowest
if: ${{ matrix.dependencies == 'lowest' }}
run: composer update --prefer-lowest --no-interaction --no-progress

- name: Install dependencies, highest
if: ${{ matrix.dependencies == 'highest' }}
run: composer update --no-interaction --no-progress
- name: Install dependencies
run: composer install --no-interaction --no-progress

- name: Run PHPUnit
run: |
mkdir -p build/logs
vendor/bin/phpunit --coverage-clover build/logs/clover.xml
run: make test-coveralls

- name: Upload code coverage
if: ${{ matrix.php-version == '7.2' }}
Expand Down
13 changes: 13 additions & 0 deletions .scrutinizer.yml
@@ -0,0 +1,13 @@
build:
nodes:
analysis:
tests:
override:
- php-scrutinizer-run
image: default-bionic
environment:
php:
version: "7.2"
filter:
excluded_paths:
- 'tests/*'
132 changes: 132 additions & 0 deletions CODE_OF_CONDUCT.md
@@ -0,0 +1,132 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual identity
and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
overall community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
<olivier.laviale@gmail.com>.
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series
of actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within
the community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].

Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].

For answers to common questions about this code of conduct, see the FAQ at
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
at [https://www.contributor-covenant.org/translations][translations].

[homepage]: https://www.contributor-covenant.org
[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
[Mozilla CoC]: https://github.com/mozilla/diversity
[FAQ]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations
32 changes: 32 additions & 0 deletions CONTRIBUTING.md
@@ -0,0 +1,32 @@
# Contributing

Contributions are **welcome** and will be fully **credited**.

We accept contributions via Pull Requests.

## Pull Requests

- **Code style** — We're following a [Coding Standard][]. Check the code style with `make lint`.
- **Code health** — We're using [PHPStan][] to analyse the code, with maximum scrutiny. Check the code with `make lint`.
- **Add tests!** — Your contribution won't be accepted if it does not have tests.
- **Document any change in behaviour** — Make sure the `README.md` and any other relevant documentation are kept
up-to-date.
- **Consider our release cycle** — We follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not
an option.
- **Create feature branches** — We won't pull from your main branch.
- **One pull request per feature** — If you want to do more than one thing, send multiple pull requests.
- **Send coherent history** — Make sure each individual commit in your pull request is meaningful. If you had to make
multiple intermediate commits while developing, please [squash them][git-squash] before submitting.

## Running Tests

We provide a Docker container for local development. Run `make test-container` to create a new session. Inside the
container run `make test` to run the test suite. Alternatively, run `make test-coverage` for a breakdown of the code
coverage. The coverage report is available in `build/coverage/index.html`.

**Thanks for your contribution**!


[Coding Standard]: phpcs.xml
[git-squash]: http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages
[PHPStan]: https://phpstan.org/user-guide/getting-started
26 changes: 12 additions & 14 deletions Dockerfile
@@ -1,20 +1,18 @@
FROM php:7.2-alpine
ARG PHP_VERSION
FROM php:${PHP_VERSION}-cli-buster

RUN apk add --update --no-cache make $PHPIZE_DEPS && \
pecl install xdebug && \
docker-php-ext-enable xdebug

RUN echo $'\
xdebug.mode=coverage\n\
xdebug.remote_host=host.docker.internal\n\
' >> /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini

RUN echo $'\
RUN echo '\
display_errors=On\n\
error_reporting=E_ALL\n\
date.timezone=UTC\n\
' >> /usr/local/etc/php/conf.d/php.ini

ENV PHP_IDE_CONFIG serverName=icanboogie-tests
ENV COMPOSER_ALLOW_SUPERUSER 1

RUN curl -s https://raw.githubusercontent.com/composer/getcomposer.org/76a7060ccb93902cd7576b67264ad91c8a2700e2/web/installer | php -- --quiet && \
mv composer.phar /usr/local/bin/composer
RUN apt-get update && \
apt-get install unzip && \
curl -s https://raw.githubusercontent.com/composer/getcomposer.org/76a7060ccb93902cd7576b67264ad91c8a2700e2/web/installer | php -- --quiet && \
mv composer.phar /usr/local/bin/composer && \
echo 'export PATH="$HOME/.composer/vendor/bin:$PATH"\n' >> /root/.bashrc

RUN composer global require squizlabs/php_codesniffer
2 changes: 1 addition & 1 deletion LICENSE
@@ -1,7 +1,7 @@
The icanboogie/prototype package is free software.
It is released under the terms of the following BSD License.

Copyright (c) 2007-2021 by Olivier Laviale
Copyright (c) 2007-2023 by Olivier Laviale
All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
Expand Down
23 changes: 23 additions & 0 deletions MIGRATION.md
@@ -0,0 +1,23 @@
# Migration

## v5.x to v5.1

### New Requirements

None

### New features

None

### Backward Incompatible Changes

None

### Deprecated Features

None

### Other Changes

- Compatible with PHP 8.2

0 comments on commit 908b0b0

Please sign in to comment.