-
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 9f56d00
Showing
31 changed files
with
1,579 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
github: canvural | ||
custom: https://www.paypal.me/canvural |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,223 @@ | ||
name: "Tests" | ||
|
||
on: ['push', 'pull_request'] | ||
|
||
env: | ||
MIN_COVERED_MSI: 88 | ||
MIN_MSI: 86 | ||
REQUIRED_PHP_EXTENSIONS: "json" | ||
INFECTION_BADGE_API_KEY: ${{ secrets.INFECTION_BADGE_API_KEY }} | ||
|
||
jobs: | ||
coding-standards: | ||
name: "Coding Standards" | ||
|
||
runs-on: "ubuntu-latest" | ||
|
||
strategy: | ||
matrix: | ||
php: [7.2, 7.3, 7.4] | ||
dependencies: [locked] | ||
|
||
steps: | ||
- name: "Checkout" | ||
uses: "actions/checkout@v2" | ||
|
||
- name: "Install PHP with extensions" | ||
uses: "shivammathur/setup-php@v2" | ||
with: | ||
coverage: "none" | ||
extensions: "${{ env.REQUIRED_PHP_EXTENSIONS }}" | ||
php-version: "${{ matrix.php }}" | ||
|
||
- name: "Validate composer.json and composer.lock" | ||
run: "composer validate --strict" | ||
|
||
- name: "Determine composer cache directory" | ||
id: "determine-composer-cache-directory" | ||
run: "echo \"::set-output name=directory::$(composer config cache-dir)\"" | ||
|
||
- name: "Cache dependencies installed with composer" | ||
uses: "actions/cache@v2" | ||
with: | ||
path: "${{ steps.determine-composer-cache-directory.outputs.directory }}" | ||
key: "php-${{ matrix.php }}-composer-${{ matrix.dependencies }}-${{ hashFiles('composer.lock') }}" | ||
restore-keys: "php-${{ matrix.php }}-composer-${{ matrix.dependencies }}-" | ||
|
||
- name: "Install lowest dependencies from composer.json" | ||
if: "matrix.dependencies == 'lowest'" | ||
run: "composer update --no-interaction --no-progress --no-suggest --prefer-lowest" | ||
|
||
- name: "Install locked dependencies from composer.lock" | ||
if: "matrix.dependencies == 'locked'" | ||
run: "composer install --no-interaction --no-progress --no-suggest" | ||
|
||
- name: "Install highest dependencies from composer.json" | ||
if: "matrix.dependencies == 'highest'" | ||
run: "composer update --no-interaction --no-progress --no-suggest" | ||
|
||
- name: "Run phpcs" | ||
run: "composer codestyle" | ||
|
||
static-code-analysis: | ||
name: "Static Code Analysis" | ||
|
||
runs-on: "ubuntu-latest" | ||
|
||
strategy: | ||
matrix: | ||
php: [7.2, 7.3, 7.4] | ||
|
||
dependencies: [locked] | ||
|
||
steps: | ||
- name: "Checkout" | ||
uses: "actions/checkout@v2" | ||
|
||
- name: "Install PHP with extensions" | ||
uses: "shivammathur/setup-php@v2" | ||
with: | ||
coverage: "none" | ||
extensions: "${{ env.REQUIRED_PHP_EXTENSIONS }}" | ||
php-version: "${{ matrix.php }}" | ||
|
||
- name: "Determine composer cache directory" | ||
id: "determine-composer-cache-directory" | ||
run: "echo \"::set-output name=directory::$(composer config cache-dir)\"" | ||
|
||
- name: "Cache dependencies installed with composer" | ||
uses: "actions/cache@v2" | ||
with: | ||
path: "${{ steps.determine-composer-cache-directory.outputs.directory }}" | ||
key: "php-${{ matrix.php }}-composer-${{ matrix.dependencies }}-${{ hashFiles('composer.lock') }}" | ||
restore-keys: "php-${{ matrix.php }}-composer-${{ matrix.dependencies }}-" | ||
|
||
- name: "Install lowest dependencies from composer.json" | ||
if: "matrix.dependencies == 'lowest'" | ||
run: "composer update --no-interaction --no-progress --no-suggest --prefer-lowest" | ||
|
||
- name: "Install locked dependencies from composer.lock" | ||
if: "matrix.dependencies == 'locked'" | ||
run: "composer install --no-interaction --no-progress --no-suggest" | ||
|
||
- name: "Install highest dependencies from composer.json" | ||
if: "matrix.dependencies == 'highest'" | ||
run: "composer update --no-interaction --no-progress --no-suggest" | ||
|
||
- name: "Create cache directory for phpstan/phpstan" | ||
run: "mkdir -p .build/phpstan" | ||
|
||
- name: "Cache cache directory for phpstan/phpstan" | ||
uses: "actions/cache@v2" | ||
with: | ||
path: ".build/phpstan" | ||
key: "php-${{ matrix.php }}-phpstan-${{ github.sha }}" | ||
restore-keys: "php-${{ matrix.php }}-phpstan-" | ||
|
||
- name: "Run phpstan/phpstan" | ||
run: "composer phpstan" | ||
|
||
tests: | ||
name: "Tests" | ||
|
||
runs-on: "ubuntu-latest" | ||
|
||
strategy: | ||
matrix: | ||
php: [7.2, 7.3, 7.4] | ||
|
||
dependencies: | ||
- "lowest" | ||
- "locked" | ||
- "highest" | ||
|
||
steps: | ||
- name: "Checkout" | ||
uses: "actions/checkout@v2" | ||
|
||
- name: "Install PHP with extensions" | ||
uses: "shivammathur/setup-php@v2" | ||
with: | ||
coverage: "none" | ||
extensions: "${{ env.REQUIRED_PHP_EXTENSIONS }}" | ||
php-version: "${{ matrix.php }}" | ||
|
||
- name: "Determine composer cache directory" | ||
id: "determine-composer-cache-directory" | ||
run: "echo \"::set-output name=directory::$(composer config cache-dir)\"" | ||
|
||
- name: "Cache dependencies installed with composer" | ||
uses: "actions/cache@v2" | ||
with: | ||
path: "${{ steps.determine-composer-cache-directory.outputs.directory }}" | ||
key: "php-${{ matrix.php }}-composer-${{ matrix.dependencies }}-${{ hashFiles('composer.lock') }}" | ||
restore-keys: "php-${{ matrix.php }}-composer-${{ matrix.dependencies }}-" | ||
|
||
- name: "Install lowest dependencies from composer.json" | ||
if: "matrix.dependencies == 'lowest'" | ||
run: "composer update --no-interaction --no-progress --no-suggest --prefer-lowest" | ||
|
||
- name: "Install locked dependencies from composer.lock" | ||
if: "matrix.dependencies == 'locked'" | ||
run: "composer install --no-interaction --no-progress --no-suggest" | ||
|
||
- name: "Install highest dependencies from composer.json" | ||
if: "matrix.dependencies == 'highest'" | ||
run: "composer update --no-interaction --no-progress --no-suggest" | ||
|
||
- name: "Run all tests" | ||
run: "composer test" | ||
|
||
code-coverage: | ||
name: "Code Coverage" | ||
|
||
runs-on: "ubuntu-latest" | ||
|
||
strategy: | ||
matrix: | ||
php: [7.2, 7.3, 7.4] | ||
|
||
dependencies: | ||
- "locked" | ||
|
||
steps: | ||
- name: "Checkout" | ||
uses: "actions/checkout@v2" | ||
|
||
- name: "Install PHP with extensions" | ||
uses: "shivammathur/setup-php@v2" | ||
with: | ||
coverage: "pcov" | ||
extensions: "${{ env.REQUIRED_PHP_EXTENSIONS }}" | ||
php-version: "${{ matrix.php }}" | ||
|
||
- name: "Determine composer cache directory" | ||
id: "determine-composer-cache-directory" | ||
run: "echo \"::set-output name=directory::$(composer config cache-dir)\"" | ||
|
||
- name: "Cache dependencies installed with composer" | ||
uses: "actions/cache@v2" | ||
with: | ||
path: "${{ steps.determine-composer-cache-directory.outputs.directory }}" | ||
key: "php-${{ matrix.php }}-composer-${{ matrix.dependencies }}-${{ hashFiles('composer.lock') }}" | ||
restore-keys: "php-${{ matrix.php }}-composer-${{ matrix.dependencies }}-" | ||
|
||
- name: "Install lowest dependencies from composer.json" | ||
if: "matrix.dependencies == 'lowest'" | ||
run: "composer update --no-interaction --no-progress --no-suggest --prefer-lowest" | ||
|
||
- name: "Install locked dependencies from composer.lock" | ||
if: "matrix.dependencies == 'locked'" | ||
run: "composer install --no-interaction --no-progress --no-suggest" | ||
|
||
- name: "Install highest dependencies from composer.json" | ||
if: "matrix.dependencies == 'highest'" | ||
run: "composer update --no-interaction --no-progress --no-suggest" | ||
|
||
- name: "Collect code coverage with pcov and phpunit/phpunit" | ||
run: "composer test-coverage" | ||
|
||
- name: "Send code coverage report to Codecov.io" | ||
env: | ||
CODECOV_TOKEN: "${{ secrets.CODECOV_TOKEN }}" | ||
run: "bash <(curl -s https://codecov.io/bash)" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
.build | ||
.phpcs-cache | ||
composer.lock | ||
vendor | ||
coverage | ||
.phpunit.result.cache | ||
.idea |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# Changelog | ||
|
||
All notable changes to this project will be documented in this file. | ||
|
||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). | ||
|
||
## Unreleased | ||
|
||
## 0.1.0 - 2020-06-20 | ||
|
||
Initial release | ||
|
||
[Unreleased]: https://github.com/nunomaduro/larastan/compare/v0.1.0...HEAD |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,79 @@ | ||
# Contributing | ||
|
||
Contributions are **welcome** and will be fully **credited**. | ||
|
||
Please read and understand the contribution guide before creating an issue or pull request. | ||
|
||
## Etiquette | ||
|
||
This project is open source, and as such, the maintainers give their free time to build and maintain the source code | ||
held within. They make the code freely available in the hope that it will be of use to other developers. It would be | ||
extremely unfair for them to suffer abuse or anger for their hard work. | ||
|
||
Please be considerate towards maintainers when raising issues or presenting pull requests. Let's show the | ||
world that developers are civilized and selfless people. | ||
|
||
It's the duty of the maintainer to ensure that all submissions to the project are of sufficient | ||
quality to benefit the project. Many developers have different skillsets, strengths, and weaknesses. Respect the maintainer's decision, and do not be upset or abusive if your submission is not used. | ||
|
||
## Viability | ||
|
||
When requesting or submitting new features, first consider whether it might be useful to others. Open | ||
source projects are used by many developers, who may have entirely different needs to your own. Think about | ||
whether or not your feature is likely to be used by other users of the project. | ||
|
||
## Procedure | ||
|
||
Before filing an issue: | ||
|
||
- Attempt to replicate the problem, to ensure that it wasn't a coincidental incident. | ||
- Check to make sure your feature suggestion isn't already present within the project. | ||
- Check the pull requests tab to ensure that the bug doesn't have a fix in progress. | ||
- Check the pull requests tab to ensure that the feature isn't already in progress. | ||
|
||
Before submitting a pull request: | ||
|
||
- Check the codebase to ensure that your feature doesn't already exist. | ||
- Check the pull requests to ensure that another person hasn't already submitted the feature or fix. | ||
|
||
## Requirements | ||
|
||
If the project maintainer has any additional requirements, you will find them listed here. | ||
|
||
### Coding Standards | ||
|
||
We are using [`squizlabs/PHP_CodeSniffer`](https://github.com/squizlabs/PHP_CodeSniffer) to enforce coding standards in PHP files. | ||
|
||
Run | ||
|
||
``` | ||
$ composer codestyle | ||
``` | ||
|
||
to find any coding standard violations. | ||
|
||
### Static Code Analysis | ||
|
||
We are using [`phpstan/phpstan`](https://github.com/phpstan/phpstan) to statically analyze the code. | ||
|
||
Run | ||
|
||
``` | ||
$ composer phpstan | ||
``` | ||
|
||
to run a static code analysis. | ||
|
||
### Tests | ||
|
||
We are using [`phpunit/phpunit`](https://github.com/sebastianbergmann/phpunit) to drive the development. | ||
|
||
Run | ||
|
||
``` | ||
$ composer test | ||
``` | ||
|
||
to run all the tests. | ||
|
||
**Happy coding**! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) [2020] [Can Vural] | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
Oops, something went wrong.