Skip to content

Commit 6059525

Browse files
authored
Merge pull request #19 from chadicus/master
Version 3
2 parents fe49102 + 3f770f6 commit 6059525

19 files changed

Lines changed: 236 additions & 2000 deletions

.coveralls.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
11
service_name: travis-ci
2-
src_dir: .
32
coverage_clover: clover.xml
43
json_path: coveralls-upload.json

.gitattributes

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Enforce Unix newlines
2+
* text=lf
3+
4+
# Exclude unused files
5+
# see: https://redd.it/2jzp6k
6+
/tests export-ignore
7+
/.github export-ignore
8+
/.gitattributes export-ignore
9+
/.gitignore export-ignore
10+
/.*.yml export-ignore
11+
/phpcs.xml export-ignore
12+
/phpunit.xml.dist export-ignore
13+
/README.md export-ignore

.github/CONTRIBUTING.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Contribution Guidelines
2+
We welcome you to report [issues](/../../issues) or submit [pull requests](/../../pulls). While the below guidelines are necessary to get code merged, you can
3+
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,
4+
though, so if you can make sure the build is passing 100%, that would be very useful.
5+
6+
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
7+
and we can get things merged in quicker when we understand its expected usage.
8+
9+
## Pull Requests
10+
Code changes should be sent through [GitHub Pull Requests](/../../pulls). Before submitting the pull request, make sure that phpunit reports success
11+
by running:
12+
```sh
13+
./vendor/bin/phpunit
14+
```
15+
And there are not coding standard violations by running
16+
```sh
17+
./vendor/bin/phpcs
18+
```
19+
20+
## Builds
21+
Our [Travis build](https://travis-ci.org/traderinteractive/util-file-php) executes [PHPUnit](http://www.phpunit.de) and uses [Coveralls](https://coveralls.io/) to enforce code coverage.
22+
While the build does not strictly enforce 100% code coverage, it will not allow coverage to drop below its current percentage.
23+
[Scrutinizer](https://scrutinizer-ci.com/) is used to ensure code quality and enforce the [coding standard](http://www.php-fig.org/psr/psr-2/).

.github/ISSUE_TEMPLATE.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
## Expected Behavior
2+
3+
## Actual Behavior
4+
5+
## Steps to reproduce the behavior
6+

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Fixes # .
2+
3+
#### What does this PR do?
4+
5+
#### Checklist
6+
- [ ] Pull request contains a clear definition of changes
7+
- [ ] Tests (either unit, integration, or acceptance) written and passing
8+
- [ ] Relevant documentation produced and/or updated

.gitignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
/vendor/
22
/coverage/
33
/clover.xml
4-
/nbproject/private/
4+
/nbproject/private/
5+
composer.lock
6+
phpunit.xml

.scrutinizer.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
filter:
22
excluded_paths:
33
- 'vendor/*'
4-
- 'tests/*'
54
before_commands:
65
- 'composer install'
76
tools:
87
php_analyzer: true
98
php_mess_detector: true
109
php_code_sniffer:
1110
config:
12-
standard: PSR1
11+
standard: PSR2
1312
sensiolabs_security_checker: true
1413
php_loc:
1514
excluded_dirs:
1615
- vendor
17-
- tests
1816
php_pdepend: true
1917
php_sim: true
18+
build_failure_conditions:
19+
- 'issues.label("coding-style").new.exists'

.travis.yml

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,19 @@
11
language: php
22
php:
33
- 7.0
4-
- 5.6
4+
- 7.1
5+
- 7.2
6+
- nightly
7+
env:
8+
- PREFER_LOWEST="--prefer-lowest --prefer-stable"
9+
- PREFER_LOWEST=""
10+
matrix:
11+
fast_finish: true
12+
allow_failures:
13+
- php: nightly
514
before_script:
615
- printf "\n" | pecl install imagick
7-
script: ./build.php
8-
after_script: ./vendor/bin/coveralls -v
16+
- composer update $PREFER_LOWEST
17+
script:
18+
- ./vendor/bin/phpunit --coverage-clover clover.xml
19+
after_success: ./vendor/bin/coveralls -v

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) 2013 Dominion Enterprises
3+
Copyright (c) 2017 Trader Interactive
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy of
66
this software and associated documentation files (the "Software"), to deal in

README.md

Lines changed: 52 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,55 @@
11
# image-util-php
2-
[![Build Status](http://img.shields.io/travis/dominionenterprises/image-util-php.svg?style=flat)](https://travis-ci.org/dominionenterprises/image-util-php)
3-
[![Scrutinizer Code Quality](http://img.shields.io/scrutinizer/g/dominionenterprises/image-util-php.svg?style=flat)](https://scrutinizer-ci.com/g/dominionenterprises/image-util-php/)
4-
[![Code Coverage](http://img.shields.io/coveralls/dominionenterprises/image-util-php.svg?style=flat)](https://coveralls.io/r/dominionenterprises/image-util-php)
52

6-
[![Latest Stable Version](http://img.shields.io/packagist/v/dominionenterprises/image-util.svg?style=flat)](https://packagist.org/packages/dominionenterprises/image-util)
7-
[![Total Downloads](http://img.shields.io/packagist/dt/dominionenterprises/image-util.svg?style=flat)](https://packagist.org/packages/dominionenterprises/image-util)
8-
[![License](http://img.shields.io/packagist/l/dominionenterprises/image-util.svg?style=flat)](https://packagist.org/packages/dominionenterprises/image-util)
3+
[![Build Status](https://travis-ci.org/traderinteractive/image-util-php.svg?branch=master)](https://travis-ci.org/traderinteractive/image-util-php)
4+
[![Code Quality](https://scrutinizer-ci.com/g/traderinteractive/image-util-php/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/traderinteractive/image-util-php/?branch=master)
5+
[![Coverage Status](https://coveralls.io/repos/github/traderinteractive/image-util-php/badge.svg?branch=master)](https://coveralls.io/github/traderinteractive/image-util-php?branch=master)
96

10-
General Image Utility Library
7+
[![Latest Stable Version](https://poser.pugx.org/traderinteractive/image-util/v/stable)](https://packagist.org/packages/traderinteractive/image-util)
8+
[![Latest Unstable Version](https://poser.pugx.org/traderinteractive/image-util/v/unstable)](https://packagist.org/packages/traderinteractive/image-util)
9+
[![License](https://poser.pugx.org/traderinteractive/image-util/license)](https://packagist.org/packages/traderinteractive/image-util)
10+
11+
[![Total Downloads](https://poser.pugx.org/traderinteractive/image-util/downloads)](https://packagist.org/packages/traderinteractive/image-util)
12+
[![Monthly Downloads](https://poser.pugx.org/traderinteractive/image-util/d/monthly)](https://packagist.org/packages/traderinteractive/image-util)
13+
[![Daily Downloads](https://poser.pugx.org/traderinteractive/image-util/d/daily)](https://packagist.org/packages/traderinteractive/image-util)
14+
15+
General Image Utility Library
16+
17+
## Requirements
18+
19+
image-util-php requires PHP 7.0 (or later).
20+
21+
## Composer
22+
To add the library as a local, per-project dependency use [Composer](http://getcomposer.org)! Simply add a dependency on
23+
`traderinteractive/image-util` to your project's `composer.json` file such as:
24+
25+
```sh
26+
composer require traderinteractive/image-util
27+
```
28+
29+
## Documentation
30+
31+
Found in the [source](src) itself, take a look!
32+
33+
## Contact
34+
35+
Developers may be contacted at:
36+
37+
* [Pull Requests](https://github.com/traderinteractive/image-util-php/pulls)
38+
* [Issues](https://github.com/traderinteractive/image-util-php/issues)
39+
40+
## Project Build
41+
42+
With a checkout of the code get [Composer](http://getcomposer.org) in your PATH and run:
43+
44+
```sh
45+
./vendor/bin/phpunit
46+
./vendor/bin/phpcs
47+
```
48+
49+
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:
50+
51+
```sh
52+
fig run build
53+
```
54+
55+
For more information on our build process, read through out our [Contribution Guidelines](.github/CONTRIBUTING.md).

0 commit comments

Comments
 (0)