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
Showing
20 changed files
with
163 additions
and
1,924 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 |
---|---|---|
@@ -1,4 +1,3 @@ | ||
service_name: travis-ci | ||
src_dir: . | ||
coverage_clover: clover.xml | ||
json_path: coveralls-upload.json |
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 @@ | ||
# Enforce Unix newlines | ||
* text=lf | ||
|
||
# Exclude unused files | ||
# see: https://redd.it/2jzp6k | ||
/tests export-ignore | ||
/.github export-ignore | ||
/.gitattributes export-ignore | ||
/.gitignore export-ignore | ||
/.*.yml export-ignore | ||
/phpcs.xml export-ignore | ||
/phpunit.xml.dist export-ignore | ||
/README.md export-ignore |
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,23 @@ | ||
# Contribution Guidelines | ||
We welcome you to report [issues](/../../issues) or submit [pull requests](/../../pulls). While the below guidelines are necessary to get code merged, you can | ||
submit pull requests that do not adhere to them and we will try to take care of them in our spare time. We are a smallish group of developers, | ||
though, so if you can make sure the build is passing 100%, that would be very useful. | ||
|
||
We recommend including details of your particular usecase(s) with any issues or pull requests. We love to hear how our libraries are being used | ||
and we can get things merged in quicker when we understand its expected usage. | ||
|
||
## Pull Requests | ||
Code changes should be sent through [GitHub Pull Requests](/../../pulls). Before submitting the pull request, make sure that phpunit reports success: | ||
|
||
### PHPUnit | ||
While the build does not strictly enforce 100% [PHPUnit](http://www.phpunit.de) code coverage, it will not allow coverage to drop below its current percentage. | ||
|
||
```sh | ||
./vendor/bin/phpunit --coverage-html coverage | ||
``` | ||
|
||
### PHP CodeSniffer | ||
The build will also not allow any errors for the [coding standard](http://chadicus.github.io/coding-standard/) | ||
|
||
```sh | ||
./vendor/bin/phpcs |
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,6 @@ | ||
## Expected Behavior | ||
|
||
## Actual Behavior | ||
|
||
## Steps to reproduce the behavior | ||
|
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,8 @@ | ||
Fixes # . | ||
|
||
#### What does this PR do? | ||
|
||
#### Checklist | ||
- [ ] Pull request contains a clear definition of changes | ||
- [ ] Tests (either unit, integration, or acceptance) written and passing | ||
- [ ] Relevant documentation produced and/or updated |
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 |
---|---|---|
@@ -1,3 +1,5 @@ | ||
/coverage/ | ||
/vendor/ | ||
/clover.xml | ||
composer.lock | ||
phpunit.xml |
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
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 |
---|---|---|
@@ -1,9 +1,18 @@ | ||
sudo: false | ||
language: php | ||
php: | ||
- 5.6 | ||
- 7 | ||
- hhvm | ||
install: composer install | ||
script: ./vendor/bin/phpunit --coverage-clover clover.xml | ||
after_success: sh -c 'if [ "$TRAVIS_PHP_VERSION" != "hhvm" ]; then ./vendor/bin/coveralls -v; fi' | ||
- 7.0 | ||
- 7.1 | ||
- 7.2 | ||
- nightly | ||
env: | ||
- PREFER_LOWEST="--prefer-lowest --prefer-stable" | ||
- PREFER_LOWEST="" | ||
matrix: | ||
fast_finish: true | ||
allow_failures: | ||
- php: nightly | ||
before_script: | ||
- composer update $PREFER_LOWEST | ||
script: | ||
- ./vendor/bin/phpunit --coverage-clover clover.xml | ||
after_success: ./vendor/bin/coveralls -v |
This file was deleted.
Oops, something went wrong.
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 @@ | ||
The MIT License (MIT) | ||
|
||
Copyright (c) 2017 Trader Interactive | ||
|
||
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. |
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 |
---|---|---|
@@ -1,50 +1,55 @@ | ||
# util-file-php | ||
[![Build Status](https://travis-ci.org/dominionenterprises/util-file-php.svg?branch=master)](https://travis-ci.org/dominionenterprises/util-file-php) | ||
[![Scrutinizer Code Quality](http://img.shields.io/scrutinizer/g/dominionenterprises/util-file-php.svg?style=flat)](https://scrutinizer-ci.com/g/dominionenterprises/util-file-php/) | ||
[![Coverage Status](https://coveralls.io/repos/dominionenterprises/util-file-php/badge.svg?branch=master&service=github)](https://coveralls.io/github/dominionenterprises/util-file-php?branch=master) | ||
|
||
[![Latest Stable Version](http://img.shields.io/packagist/v/dominionenterprises/util-file.svg?style=flat)](https://packagist.org/packages/dominionenterprises/util-file) | ||
[![Total Downloads](http://img.shields.io/packagist/dt/dominionenterprises/util-file.svg?style=flat)](https://packagist.org/packages/dominionenterprises/util-file) | ||
[![License](http://img.shields.io/packagist/l/dominionenterprises/util-file.svg?style=flat)](https://packagist.org/packages/dominionenterprises/util-file) | ||
[![Build Status](https://travis-ci.org/traderinteractive/util-file-php.svg?branch=master)](https://travis-ci.org/traderinteractive/util-file-php) | ||
[![Code Quality](https://scrutinizer-ci.com/g/traderinteractive/util-file-php/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/traderinteractive/util-file-php/?branch=master) | ||
[![Coverage Status](https://coveralls.io/repos/github/traderinteractive/util-file-php/badge.svg?branch=master)](https://coveralls.io/github/traderinteractive/util-file-php?branch=master) | ||
|
||
A collection of general util-fileities for making common programming tasks easier. | ||
[![Latest Stable Version](https://poser.pugx.org/traderinteractive/util-file/v/stable)](https://packagist.org/packages/traderinteractive/util-file) | ||
[![Latest Unstable Version](https://poser.pugx.org/traderinteractive/util-file/v/unstable)](https://packagist.org/packages/traderinteractive/util-file) | ||
[![License](https://poser.pugx.org/traderinteractive/util-file/license)](https://packagist.org/packages/traderinteractive/util-file) | ||
|
||
[![Total Downloads](https://poser.pugx.org/traderinteractive/util-file/downloads)](https://packagist.org/packages/traderinteractive/util-file) | ||
[![Monthly Downloads](https://poser.pugx.org/traderinteractive/util-file/d/monthly)](https://packagist.org/packages/traderinteractive/util-file) | ||
[![Daily Downloads](https://poser.pugx.org/traderinteractive/util-file/d/daily)](https://packagist.org/packages/traderinteractive/util-file) | ||
|
||
A collection of general file utilities for making common programming tasks easier. | ||
|
||
## Requirements | ||
|
||
util-file-php requires PHP 5.4 (or later). | ||
util-file-php requires PHP 7.0 (or later). | ||
|
||
##Composer | ||
To add the library as a local, per-project dependency use [Composer](http://getcomposer.org)! Simply add a dependency on | ||
`dominionenterprises/util-file` to your project's `composer.json` file such as: | ||
|
||
```json | ||
{ | ||
"require": { | ||
"dominionenterprises/util-file": "~1.0" | ||
} | ||
} | ||
`traderinteractive/util-file` to your project's `composer.json` file such as: | ||
|
||
```sh | ||
composer require traderinteractive/util-file | ||
``` | ||
##Documentation | ||
|
||
## Documentation | ||
|
||
Found in the [source](src) itself, take a look! | ||
|
||
##Contact | ||
## Contact | ||
|
||
Developers may be contacted at: | ||
|
||
* [Pull Requests](https://github.com/dominionenterprises/util-file-php/pulls) | ||
* [Issues](https://github.com/dominionenterprises/util-file-php/issues) | ||
* [Pull Requests](https://github.com/traderinteractive/util-file-php/pulls) | ||
* [Issues](https://github.com/traderinteractive/util-file-php/issues) | ||
|
||
## Project Build | ||
|
||
##Project Build | ||
With a checkout of the code get [Composer](http://getcomposer.org) in your PATH and run: | ||
|
||
```sh | ||
./build.php | ||
./vendor/bin/phpunit | ||
./vendor/bin/phpcs | ||
``` | ||
|
||
There is also a [docker](http://www.docker.com/)-based | ||
[fig](http://www.fig.sh/) configuration that will execute the build inside a | ||
docker container. This is an easy way to build the application: | ||
There is also a [docker](http://www.docker.com/)-based [fig](http://www.fig.sh/) configuration that will execute the build inside a docker container. This is an easy way to build the application: | ||
|
||
```sh | ||
fig run build | ||
``` | ||
|
||
For more information on our build process, read through out our [Contribution Guidelines](CONTRIBUTING.md). | ||
For more information on our build process, read through out our [Contribution Guidelines](.github/CONTRIBUTING.md). |
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
Oops, something went wrong.