forked from webmozarts/assert
-
Notifications
You must be signed in to change notification settings - Fork 0
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
7 changed files
with
298 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 @@ | ||
/vendor/ | ||
composer.lock |
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,20 @@ | ||
language: php | ||
|
||
php: | ||
- 5.3 | ||
- 5.4 | ||
- 5.5 | ||
- 5.6 | ||
- 7.0 | ||
- hhvm | ||
|
||
matrix: | ||
allow_failures: | ||
- php: 7.0 | ||
|
||
before_script: composer install -n | ||
|
||
script: phpunit -v --coverage-clover=coverage.clover | ||
|
||
after_script: | ||
- sh -c 'if [ "$TRAVIS_PHP_VERSION" != "hhvm" ]; then wget https://scrutinizer-ci.com/ocular.phar && php ocular.phar code-coverage:upload --format=php-clover coverage.clover; fi;' |
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 @@ | ||
Changelog | ||
========= | ||
|
||
* 1.0.0-next (@release_date@) | ||
|
||
* first alpha release |
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,20 @@ | ||
The MIT License (MIT) | ||
|
||
Copyright (c) 2014 Bernhard Schussek | ||
|
||
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 |
---|---|---|
@@ -0,0 +1,204 @@ | ||
Webmozart Assert | ||
================ | ||
|
||
[![Build Status](https://travis-ci.org/webmozart/assert.svg?branch=master)](https://travis-ci.org/webmozart/assert) | ||
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/webmozart/assert/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/webmozart/assert/?branch=master) | ||
[![SensioLabsInsight](https://insight.sensiolabs.com/projects/bd5a6248-0756-47d4-840d-621a33e3da5b/mini.png)](https://insight.sensiolabs.com/projects/bd5a6248-0756-47d4-840d-621a33e3da5b) | ||
[![Latest Stable Version](https://poser.pugx.org/webmozart/assert/v/stable.svg)](https://packagist.org/packages/webmozart/assert) | ||
[![Total Downloads](https://poser.pugx.org/webmozart/assert/downloads.svg)](https://packagist.org/packages/webmozart/assert) | ||
[![Dependency Status](https://www.versioneye.com/php/webmozart:assert/1.0.0/badge.svg)](https://www.versioneye.com/php/webmozart:assert/1.0.0) | ||
|
||
Latest release: none | ||
|
||
PHP >= 5.3.9 | ||
|
||
This library contains efficient assertions to test the input and output of | ||
your methods. With these assertions, you can greatly reduce the amount of coding | ||
needed to write a safe implementation. | ||
|
||
All assertions in the [`Assert`] class throw an `\InvalidArgumentException` if | ||
they fail. | ||
|
||
Example | ||
------- | ||
|
||
```php | ||
use Webmozart\Assert\Assert; | ||
|
||
class Employee | ||
{ | ||
public function __construct($id) | ||
{ | ||
Assert::integer($id, 'The employee ID must be an integer. Got: %s'); | ||
Assert::greaterThan(0, 'The employee ID must be a positive integer. Got: %s'); | ||
} | ||
} | ||
``` | ||
|
||
If you create an employee with an invalid ID, an exception is thrown: | ||
|
||
```php | ||
new Employee('foobar'); | ||
// => InvalidArgumentException: | ||
// The employee ID must be an integer. Got: string | ||
|
||
new Employee(-10); | ||
// => InvalidArgumentException: | ||
// The employee ID must be a positive integer. Got: -10 | ||
``` | ||
|
||
Assertions | ||
---------- | ||
|
||
The [`Assert`] class provides the following assertions: | ||
|
||
### Type Assertions | ||
|
||
Method | Description | ||
----------------------------------------------- | -------------------------------------------------- | ||
`string($value, $message = '')` | Check that a value is a string | ||
`stringNotEmpty($value, $message = '')` | Check that a value is a non-empty string | ||
`integer($value, $message = '')` | Check that a value is an integer | ||
`integerish($value, $message = '')` | Check that a value casts to an integer | ||
`float($value, $message = '')` | Check that a value is a float | ||
`numeric($value, $message = '')` | Check that a value is numeric | ||
`boolean($value, $message = '')` | Check that a value is a boolean | ||
`scalar($value, $message = '')` | Check that a value is a scalar | ||
`resource($value, $type = null, $message = '')` | Check that a value is a resource | ||
`isCallable($value, $message = '')` | Check that a value is a callable | ||
`isArray($value, $message = '')` | Check that a value is an array | ||
`isTraversable($value, $message = '')` | Check that a value is an array or a `\Traversable` | ||
`isInstanceOf($value, $class, $message = '')` | Check that a value is an `instanceof` a class | ||
`notInstanceOf($value, $class, $message = '')` | Check that a value is not an `instanceof` a class | ||
|
||
### Comparison Assertions | ||
|
||
Method | Description | ||
----------------------------------------------- | -------------------------------------------------- | ||
`true($value, $message = '')` | Check that a value is `true` | ||
`false($value, $message = '')` | Check that a value is `false` | ||
`null($value, $message = '')` | Check that a value is `null` | ||
`notNull($value, $message = '')` | Check that a value is not `null` | ||
`isEmpty($value, $message = '')` | Check that a value is `empty()` | ||
`notEmpty($value, $message = '')` | Check that a value is not `empty()` | ||
`eq($value, $value2, $message = '')` | Check that a value equals another (`==`) | ||
`notEq($value, $value2, $message = '')` | Check that a value does not equal another (`!=`) | ||
`same($value, $value2, $message = '')` | Check that a value is identical to another (`===`) | ||
`notSame($value, $value2, $message = '')` | Check that a value is not identical to another (`!==`) | ||
`greaterThan($value, $value2, $message = '')` | Check that a value is greater than another | ||
`greaterThanEq($value, $value2, $message = '')` | Check that a value is greater than or equal to another | ||
`lessThan($value, $value2, $message = '')` | Check that a value is less than another | ||
`lessThanEq($value, $value2, $message = '')` | Check that a value is less than or equal to another | ||
`range($value, $min, $max, $message = '')` | Check that a value is within a range | ||
`oneOf($value, array $values, $message = '')` | Check that a value is one of a list of values | ||
|
||
### String Assertions | ||
|
||
You should check that a value is a string with `Assert::string()` before making | ||
any of the following assertions. | ||
|
||
Method | Description | ||
--------------------------------------------------- | -------------------------------------------------- | ||
`contains($value, $subString, $message = '')` | Check that a string contains a substring | ||
`startsWith($value, $prefix, $message = '')` | Check that a string has a prefix | ||
`startsWithLetter($value, $message = '')` | Check that a string starts with a letter | ||
`endsWith($value, $suffix, $message = '')` | Check that a string has a suffix | ||
`regex($value, $pattern, $message = '')` | Check that a string matches a regular expression | ||
`alpha($value, $message = '')` | Check that a string contains letters only | ||
`digits($value, $message = '')` | Check that a string contains digits only | ||
`alnum($value, $message = '')` | Check that a string contains letters and digits only | ||
`lower($value, $message = '')` | Check that a string contains lowercase characters only | ||
`upper($value, $message = '')` | Check that a string contains uppercase characters only | ||
`length($value, $length, $message = '')` | Check that a string has a certain number of characters | ||
`minLength($value, $min, $message = '')` | Check that a string has at least a certain number of characters | ||
`maxLength($value, $max, $message = '')` | Check that a string has at most a certain number of characters | ||
`lengthBetween($value, $min, $max, $message = '')` | Check that a string has a length in the given range | ||
|
||
### File Assertions | ||
|
||
Method | Description | ||
----------------------------------- | -------------------------------------------------- | ||
`fileExists($value, $message = '')` | Check that a value is an existing path | ||
`file($value, $message = '')` | Check that a value is an existing file | ||
`directory($value, $message = '')` | Check that a value is an existing directory | ||
`readable($value, $message = '')` | Check that a value is a readable path | ||
`writable($value, $message = '')` | Check that a value is a writable path | ||
|
||
### Class Assertions | ||
|
||
Method | Description | ||
---------------------------------------------------- | -------------------------------------------------- | ||
`classExists($value, $message = '')` | Check that a value is an existing class name | ||
`subclassOf($value, $class, $message = '')` | Check that a class is a subclass of another | ||
`implementsInterface($value, $class, $message = '')` | Check that a class implements an interface | ||
|
||
### Collection Assertions | ||
|
||
All of the above assertions can be prefixed with `all*()` to test the contents | ||
of an array or a `\Traversable`: | ||
|
||
```php | ||
Assert::allIsInstanceOf('Acme\Employee', $employees); | ||
``` | ||
|
||
### Nullable Assertions | ||
|
||
All of the above assertions can be prefixed with `nullOr*()` to run the | ||
assertion only if it the value is not `null`: | ||
|
||
```php | ||
Assert::nullOrString($middleName, 'The middle name must be a string or null. Got: %s'); | ||
``` | ||
|
||
Credits | ||
------- | ||
|
||
This package is heavily inspired by [beberlei/assert]. Compared to that, this | ||
package has tweaked exception messages that provide a nice output by default | ||
and can be easily customized. Changing the structure of the exception messages | ||
in [beberlei/assert] would have broken backwards compatibility with all | ||
libraries that currently use that package. | ||
|
||
Authors | ||
------- | ||
|
||
* [Bernhard Schussek] a.k.a. [@webmozart] | ||
* [The Community Contributors] | ||
|
||
Installation | ||
------------ | ||
|
||
Use [Composer] to install the package: | ||
|
||
``` | ||
$ composer require webmozart/assert@dev | ||
``` | ||
|
||
Contribute | ||
---------- | ||
|
||
Contributions to the package are always welcome! | ||
|
||
* Report any bugs or issues you find on the [issue tracker]. | ||
* You can grab the source code at the package's [Git repository]. | ||
|
||
Support | ||
------- | ||
|
||
If you are having problems, send a mail to [email protected] or shout out to | ||
[@webmozart] on Twitter. | ||
|
||
License | ||
------- | ||
|
||
All contents of this package are licensed under the [MIT license]. | ||
|
||
[beberlei/assert]: https://github.com/beberlei/assert | ||
[Composer]: https://getcomposer.org | ||
[Bernhard Schussek]: http://webmozarts.com | ||
[The Community Contributors]: https://github.com/webmozart/assert/graphs/contributors | ||
[issue tracker]: https://github.com/webmozart/assert | ||
[Git repository]: https://github.com/webmozart/assert | ||
[@webmozart]: https://twitter.com/webmozart | ||
[MIT license]: LICENSE | ||
[`Assert`]: src/Assert.php |
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,30 @@ | ||
{ | ||
"name": "webmozart/assert", | ||
"description": "Efficient assertions to validate the input/output of your methods.", | ||
"keywords": ["assert", "check", "validate"], | ||
"license": "MIT", | ||
"authors": [ | ||
{ | ||
"name": "Bernhard Schussek", | ||
"email": "[email protected]" | ||
} | ||
], | ||
"require": { | ||
"php": ">=5.3.9" | ||
}, | ||
"autoload": { | ||
"psr-4": { | ||
"Webmozart\\Assert\\": "src/" | ||
} | ||
}, | ||
"autoload-dev": { | ||
"psr-4": { | ||
"Webmozart\\Assert\\Tests\\": "tests/" | ||
} | ||
}, | ||
"extra": { | ||
"branch-alias": { | ||
"dev-master": "1.0-dev" | ||
} | ||
} | ||
} |
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,16 @@ | ||
<?xml version="1.0" encoding="UTF-8"?> | ||
|
||
<phpunit bootstrap="vendor/autoload.php" colors="true"> | ||
<testsuites> | ||
<testsuite name="Webmozart Assert Test Suite"> | ||
<directory suffix="Test.php">./tests/</directory> | ||
</testsuite> | ||
</testsuites> | ||
|
||
<!-- Whitelist for code coverage --> | ||
<filter> | ||
<whitelist> | ||
<directory suffix=".php">./src/</directory> | ||
</whitelist> | ||
</filter> | ||
</phpunit> |