Skip to content

Commit 6fa45ef

Browse files
PothercaPotherca
committed
Merge release v0.2.0
2 parents 443e03a + 9f77b42 commit 6fa45ef

17 files changed

+1849
-457
lines changed

‎.gitattributes‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
* text=auto
2+
3+
/tests export-ignore
4+
/.gitattributes export-ignore
5+
/.gitignore export-ignore
6+
/.travis.yml export-ignore
7+
/phpunit.xml.dist export-ignore
8+
/CHANGELOG.md export-ignore
9+
/README.md export-ignore

‎.gitignore‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@ build
22
vendor
33

44
composer.lock
5-
phpunit.xml
5+
phpunit.xml

‎.travis.yml‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
language: php
2+
3+
php:
4+
- 5.5
5+
- 5.6
6+
- 7.0
7+
- hhvm
8+
9+
sudo: false
10+
11+
matrix:
12+
allow_failures:
13+
- php: 7.0
14+
- php: hhvm
15+
16+
install:
17+
- composer install
18+
19+
script:
20+
- vendor/bin/phpunit --configuration build/phpunit.xml && cat build/testdox.txt build/coverage.txt
21+
22+
after_script:
23+
- php vendor/bin/coveralls -v

‎CHANGELOG.md‎

Lines changed: 32 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,42 @@
11
# Change Log
22
All notable changes to the `flysystem-github` project will be documented in this
3-
file. This project adheres to [Semantic Versioning](http://semver.org/).
3+
file. This project adheres to the [keep-a-changelog](http://keepachangelog.com/)
4+
and [Semantic Versioning](http://semver.org/) conventions.
45

5-
## 0.1.0 - 2015-07-18 - Read functionality
6+
<!--
7+
## [Unreleased][unreleased]
68
### Added
7-
Read functionality and Github API authentication have been implemented.
9+
### Changed
10+
### Deprecated
11+
### Removed
12+
### Fixed
13+
### Security
14+
-->
15+
16+
## v0.2.0 - 2015-07-21 - Improvements and UnitTests
17+
18+
### Added
19+
- Adds automated checks (a.k.a. unit-tests) for the Adapter, Client and Settings classes.
20+
- Adds various utility files for Travis builds, Coveralls and Composer
21+
22+
### Changed
23+
- Makes the PHPUnit configuration more strict
24+
- Renames the Client class to "Api"
25+
26+
## v0.1.0 - 2015-07-18 - Read functionality
27+
28+
### Added
29+
- Read functionality and Github API authentication have been implemented.
30+
31+
## v0.0.0 - 2015-05-11 - Project Setup
832

9-
## 0.0.0 - 2015-05-11 - Project Setup
1033
### Added
11-
Set up project basics like .gitignore file, PHPUnit Configuration file,
34+
- Set up project basics like .gitignore file, PHPUnit Configuration file,
1235
Contributing guidelines, Composer file stating dependencies, MIT License, README
1336
file and this CHANGELOG file.
1437

15-
[unreleased]: https://github.com/potherca/flystystem-github/compare/v0.1.0...HEAD
38+
[unreleased]: https://github.com/potherca/flystystem-github/compare/v0.2.0...HEAD
39+
[0.2.0]: https://github.com/potherca/flystystem-github/compare/v0.1.0...v0.2.0
1640
[0.1.0]: https://github.com/potherca/flystystem-github/compare/v0.0.0...v0.1.0
41+
[keep-a-changelog]: http://keepachangelog.com/
42+
[Semantic Versioning]: http://semver.org/

‎README.md‎

Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,11 @@
22

33
[![Latest Version](https://img.shields.io/github/release/potherca/flysystem-github.svg?style=flat-square)](https://github.com/potherca/flysystem-github/releases)
44
[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.md)
5-
[![Build Status](https://img.shields.io/travis/potherca/flysystem-github/master.svg?style=flat-square)](https://travis-ci.org/potherca/flysystem-github)
6-
[![Coverage Status](https://img.shields.io/scrutinizer/coverage/g/potherca/flysystem-github.svg?style=flat-square)](https://scrutinizer-ci.com/g/potherca/flysystem-github/code-structure)
5+
[![Build Status](https://img.shields.io/travis/potherca/flysystem-github.svg?style=flat-square)](https://travis-ci.org/potherca/flysystem-github)
6+
[![Coverage Status](https://coveralls.io/repos/potherca/flysystem-github/badge.svg)](https://coveralls.io/github/potherca/flysystem-github)
77
[![Quality Score](https://img.shields.io/scrutinizer/g/potherca/flysystem-github.svg?style=flat-square)](https://scrutinizer-ci.com/g/potherca/flysystem-github)
88
[![Total Downloads](https://img.shields.io/packagist/dt/potherca/flysystem-github.svg?style=flat-square)](https://packagist.org/packages/potherca/flysystem-github)
99

10-
1110
## Install
1211

1312
Via Composer
@@ -28,27 +27,27 @@ limit.
2827
### Basic Usage
2928

3029
```php
31-
use Github\Client as GithubClient;
30+
use Github\Client;
3231
use League\Flysystem\Filesystem;
33-
use Potherca\Flysystem\Github\Client;
32+
use Potherca\Flysystem\Github\Api;
3433
use Potherca\Flysystem\Github\GithubAdapter;
3534
use Potherca\Flysystem\Github\Settings;
3635

3736
$project = 'thephpleague/flysystem';
3837

3938
$settings = new Settings($project);
4039

41-
$client = new Client(new GithubClient(), $settings);
42-
$adapter = new GithubAdapter($client);
40+
$api = new Api(new Client(), $settings);
41+
$adapter = new GithubAdapter($api);
4342
$filesystem = new Filesystem($adapter);
4443
```
4544

4645
### Authentication
4746

4847
```php
49-
use Github\Client as GithubClient;
48+
use Github\Client;
5049
use League\Flysystem\Filesystem;
51-
use Potherca\Flysystem\Github\Client;
50+
use Potherca\Flysystem\Github\Api;
5251
use Potherca\Flysystem\Github\GithubAdapter;
5352
use Potherca\Flysystem\Github\Settings;
5453

@@ -58,19 +57,19 @@ $credentials = [Settings::AUTHENTICATE_USING_TOKEN, '83347e315b8bb4790a48ed6953a
5857

5958
$settings = new Settings($project, $credentials);
6059

61-
$client = new Client(new GithubClient(), $settings);
62-
$adapter = new GithubAdapter($client);
60+
$api = new Api(new Client(), $settings);
61+
$adapter = new GithubAdapter($api);
6362
$filesystem = new Filesystem($adapter);
6463
```
6564

6665
### Cache Usage
6766

6867
```php
69-
use Github\Client as GithubClient;
68+
use Github\Client;
7069
use Github\HttpClient\CachedHttpClient as CachedClient;
7170
use Github\HttpClient\Cache\FilesystemCache as Cache;
7271
use League\Flysystem\Filesystem;
73-
use Potherca\Flysystem\Github\Client;
72+
use Potherca\Flysystem\Github\Api;
7473
use Potherca\Flysystem\Github\GithubAdapter;
7574
use Potherca\Flysystem\Github\Settings;
7675

@@ -82,8 +81,8 @@ $cache = new Cache('/tmp/github-api-cache')
8281
$cacheClient = new CachedClient();
8382
$cacheClient->setCache($cache);
8483

85-
$client = new Client($cacheClient, $settings);
86-
$adapter = new GithubAdapter($client);
84+
$api = new Api($cacheClient, $settings);
85+
$adapter = new GithubAdapter($api);
8786
$filesystem = new Filesystem($adapter);
8887

8988
```
@@ -94,13 +93,17 @@ $filesystem = new Filesystem($adapter);
9493
$ composer test
9594
```
9695

96+
## Security
97+
98+
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
99+
97100
## Contributing
98101

99102
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
100103

101-
## Security
104+
## Change Log
102105

103-
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
106+
Please see [CHANGELOG](CHANGELOG.md) for details.
104107

105108
## Credits
106109

‎build/phpunit.xml‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<phpunit
3+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
4+
xsi:noNamespaceSchemaLocation="http://schema.phpunit.de/4.7/phpunit.xsd"
5+
6+
backupGlobals="false"
7+
beStrictAboutChangesToGlobalState="true"
8+
beStrictAboutOutputDuringTests="true"
9+
beStrictAboutTestSize="true"
10+
beStrictAboutTestsThatDoNotTestAnything="true"
11+
beStrictAboutTodoAnnotatedTests="true"
12+
bootstrap="../vendor/autoload.php"
13+
checkForUnintentionallyCoveredCode="true"
14+
colors="true"
15+
forceCoversAnnotation="true"
16+
verbose="true"
17+
>
18+
<testsuites>
19+
<testsuite name="Flysystem Github Adapter Test Suite">
20+
<directory>../tests</directory>
21+
</testsuite>
22+
</testsuites>
23+
<filter>
24+
<whitelist>
25+
<directory suffix=".php">src/</directory>
26+
</whitelist>
27+
</filter>
28+
<logging>
29+
<log type="testdox-text" target="testdox.txt"/>
30+
<log type="tap" target="report.tap"/>
31+
<log type="junit" target="report.junit.xml"/>
32+
<log type="coverage-clover" showUncoveredFiles="true" target="logs/clover.xml"/>
33+
<log type="coverage-text" showUncoveredFiles="true" target="coverage.txt"/>
34+
</logging>
35+
</phpunit>

‎composer.json‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,15 @@
2020
}
2121
],
2222
"require": {
23-
"php" : ">=5.3.0",
23+
"php" : ">=5.5",
2424
"knplabs/github-api": "^1.4",
2525
"league/flysystem": "^1.0"
2626
},
2727
"require-dev": {
28-
"phpunit/phpunit" : "4.*",
29-
"scrutinizer/ocular": "~1.1"
28+
"phpunit/phpunit" : "^4.7.7",
29+
"satooshi/php-coveralls": "^0.6.1",
30+
"scrutinizer/ocular": "^1.1",
31+
"whatthejeff/nyancat-phpunit-resultprinter": "^1.2"
3032
},
3133
"autoload": {
3234
"psr-4": {
@@ -40,7 +42,7 @@
4042
},
4143
"extra": {
4244
"branch-alias": {
43-
"dev-master": "1.0-dev"
45+
"dev-master": "0.2.0-dev"
4446
}
4547
},
4648
"scripts": {

‎phpunit.xml.dist‎

Lines changed: 24 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,25 @@
11
<?xml version="1.0" encoding="UTF-8"?>
2-
<phpunit bootstrap="vendor/autoload.php"
3-
backupGlobals="false"
4-
backupStaticAttributes="false"
5-
colors="true"
6-
verbose="true"
7-
convertErrorsToExceptions="true"
8-
convertNoticesToExceptions="true"
9-
convertWarningsToExceptions="true"
10-
processIsolation="false"
11-
stopOnFailure="false">
2+
<phpunit
3+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
4+
xsi:noNamespaceSchemaLocation="http://schema.phpunit.de/4.7/phpunit.xsd"
5+
6+
backupGlobals="false"
7+
beStrictAboutChangesToGlobalState="true"
8+
beStrictAboutOutputDuringTests="true"
9+
beStrictAboutTestSize="true"
10+
beStrictAboutTestsThatDoNotTestAnything="true"
11+
beStrictAboutTodoAnnotatedTests="true"
12+
bootstrap="vendor/autoload.php"
13+
checkForUnintentionallyCoveredCode="true"
14+
colors="true"
15+
forceCoversAnnotation="true"
16+
verbose="true"
17+
18+
printerFile="vendor/whatthejeff/nyancat-phpunit-resultprinter/src/NyanCat/PHPUnit/ResultPrinter.php"
19+
printerClass="NyanCat\PHPUnit\ResultPrinter"
20+
>
1221
<testsuites>
13-
<testsuite name="Potherca Test Suite">
22+
<testsuite name="Flysystem Github Adapter Test Suite">
1423
<directory>tests</directory>
1524
</testsuite>
1625
</testsuites>
@@ -20,10 +29,9 @@
2029
</whitelist>
2130
</filter>
2231
<logging>
23-
<log type="tap" target="build/report.tap"/>
24-
<log type="junit" target="build/report.junit.xml"/>
25-
<log type="coverage-html" target="build/coverage" charset="UTF-8" yui="true" highlight="true"/>
26-
<log type="coverage-text" target="build/coverage.txt"/>
27-
<log type="coverage-clover" target="build/logs/clover.xml"/>
32+
<log type="testdox-text" target="php://stdout"/>
33+
<log type="coverage-clover" showUncoveredFiles="true" target="build/logs/clover.xml"/>
34+
<log type="coverage-text" showUncoveredFiles="true" target="php://stdout"/>
35+
<log type="coverage-html" showUncoveredFiles="true" target="build/coverage" charset="UTF-8" yui="true" highlight="true"/>
2836
</logging>
2937
</phpunit>

0 commit comments

Comments
 (0)