/**
 * @param ThingInterface[] $things
 */
public function __construct(array $things)
{
    // no-op on production environment! :D
    assert(Assertion::allIsInstanceOf($things, ThingInterface::class));

    $this->things = $things;
}

@beberlei what do you think?

Is it possible validate the email (for example) only if it is filled?

Like the field is not required, but if populated check if is valid.

I just don't want to do something like:

if(!empty($value)) {
   Assert...
}

Hi,

I'm trying assert a valid date inside a class, but when I use the method Assertion::date, it throws an exception "No assertion Assertion#date exists." I'm using the "beberlei/assert": "^2.4" in composer.json and using PHP 5.3.

Do you know if is that because of the Assert's version I'm using?

Many thanks.

Following this scheme:

https://github.com/joel-costigliola/assertj-core/wiki/Using-assertj-assertions

I'm thinking about negated checks for the assertions eq and same (aka neq and notSame). What do you think about this additional methods? In my opinion these checks are quite common. Currently the only way to do a negated check is to catch the exception and proceed only in this case.

Maybe an extension similar to the magic __callStatic-nullOr{Method} as not{Method} could also make sense and would be a generic way?? Hmmmm...

We've started using the library in our domain and it's great. We use a lot of transfer objects which have their own validation and tehre is a large overlap, however it is not as extensive as this library.

Our existing framework for validating transfer objects uses annotations.

Is there a recommended way to do this? Would you accept a PR or would it be better suited to a separate project entirely to save on dependencies?

this library is very good for DDD, however at first sight is very hard for a newbie to see that

the last example on the readme poses an Assertion class but the name is too simple, not even YourOwnAssertion which even though is bad, is better than the Assertion example. Beyond this point perhaps one can show how the CustomAssertion is used in an example.

Make code base PSR-2 compatible.

I cant see any obvious way to override the exception class when using chain-able assertions as your Assertion subclass will be by-passed.

When checking method parameters i often want to check if it is a correct value of some constants that fit here. So i made a convenience method in my Assert subclass. The source is below, perhaps its useful for you to integrate in some way.

For example you can do:

public class C
{
const MODE_A = 1;
const MODE_B = 2;

const OTHER_XYZ = 'something';

public functio setMode($mode)
{
    Assert::that($mode)->inArray(Assert::Constants(__CLASS__, "MODE"));
}

}

/**
 * Gather constants having a certain prefix e.g. for validating against them
 *
 * @param mixed $objectOrClassname
 * @param string $prefix
 * @param mixed[] $exclude
 * @return mixed[]
 */
public static function Constants($objectOrClassname, $prefix, array $exclude = array())
{
    // Make array from mode constants for easy validation
    $class = new \ReflectionClass($objectOrClassname);
    $found = array();
    foreach ($class->getConstants() as $constName => $constValue)
    {
        if (mb_strpos($constName, $prefix, null) === 0)
        {
            if (!array_search($constValue, $exclude))
            {
                $found[] = $constValue;
            }
        }
    }
    return $found;
}

stringify method cannot be used in child classes because it is private.

Hi,
is there a way of testing if an array is associative with all the keys being a (non-empty) string? There are methods like keyIsset or keyExists but they need $key.

It would be great to use multibyte string functions in Assertion::minLength(), Assertion::maxLength(), etc. methods.

Numeric is not an option, because it cannot be float.

If I have a string with just space in it:

$blank = '         ';

And I use Assert::notEmpty($blank), the assertion doesn't fail.

json_last_error() returns 0 when json_decode-ing an empty string and when json_decode-ing null.

The result:

Assertion::isJsonString('');
Assertion::isJsonString(null);

both do not throw an exception

To me this looks like unwanted behavior. Can I send a PR for this?

Hi,

thanks a lot for this great library! I'm integrating it into many projects because I find my code much more readable.

There have been some changes and especially 'library/project based assertion subclass' are a feature I really would like to use. Do you think this is stable enough to release a v1.3 version?

Cheers,
Adrian

There are not* assertions for lots of methods, but there isn't one for notInArray. I need this assertion for a project I'm working on, and, at the moment, I'm having to do this manually unless there is a better way of doing it.

Would it be possible to add this assertion?

You should be able to subclass Assertion to change the exception message. A global configuration is explicitly avoided, because it could break other libraries.

Moar code:

/**
 *
 * @param string $file
 * @param array $modes
 * @throws Dispatcher_FilePermission_Exception
 */
public static function check( $file, array $modes, $notExistsOk = false )
{
    if( $notExistsOk && !file_exists( $file ) ){
        return true;
    }

    foreach( $modes as $mode ){
        switch( $mode ){
            case 'e':
                if( !file_exists( $file ) ){
                    throw new Dispatcher_FilePermission_Exception('path/file not found ' . $file );
                }
                break;
            case 'f':
                if( !is_file( $file ) ){
                    throw new Dispatcher_FilePermission_Exception('path is not a file ' . $file );
                }
                break;
            case 'd':
                if( !is_dir( $file ) ){
                    throw new Dispatcher_FilePermission_Exception('path is not a dir ' . $file );
                }
                break;
            case 'l':
                if( !is_link( $file ) ){
                    throw new Dispatcher_FilePermission_Exception('path is not a link ' . $file );
                }
                break;
            case 'r':
                if( !is_readable( $file ) ){
                    throw new Dispatcher_FilePermission_Exception('path not readable ' . $file );
                }
                break;
            case 'w':
                if( !is_writable( $file ) ){
                    throw new Dispatcher_FilePermission_Exception('path not writable ' . $file );
                }
                break;
            case 'x':
                if( !is_executable( $file ) ){
                    throw new Dispatcher_FilePermission_Exception('path/file not found ' . $file );
                }
                break;
            default:
                throw new Dispatcher_FilePermission_Exception( 'unknown mode ' . $mode );
        }
    }
}

The functions.php file is pulled in throught the Composer autoloader file mechanism: https://github.com/beberlei/assert/blob/master/composer.json#L20

If this package is used more than once in one PHP session (my use case is several WordPress plugins including it), this causes a fatal error:

Fatal error: Cannot redeclare Assert\that() [...]

I know that Composer should be used at the site level, not multiple times in one site. However, this could easily be fixed to allow for that use case, too, which would at least simplify the development process.

Hi guys, we wanted to be able to use the assertion library as constraints in the Symfony Validator and couldn't find anything to support this so we wrote our own. It's really just a generate that generates constraint classes and a wrapper to make them work in the validator component.

I thought you might be interested and we'd love some feedback.

https://github.com/MySchoolManagement/assert-constraint

Hi Benjamin,

With the new fluid API it's very easy to assert that a value is a positive integer or in some range of integers.

Assert\that($number)->nullOr()->integerish()->min(1);
Assert\that($number)->nullOr()->integerish()->range(1, 10);

The problem is that min, max, range and maybe other Assertions first assert that the value(s) is/are integer(s). Any integerish parameter that comes in through a controller will be a string, so those Assertions will fail. Doing a (int) typecast earier in the chain is an error prone approach.
(int) 'foobar' -> 0
Also we're loosing the dynamic typing, the Domain does not care if 5 comes in as an int or a string and you have the intergerish Assertion there for a reason.

Maybe if would be a good idea to add a boolean switch "acceptIntegerish" to those methods? Or the other way round, add a "strict" switch which defaults to true?
Other possibility would be to add sister Assertions like minIntegerish(), but I don't like that so much.

What do you think?

Best regards, Anton

The methodExists (and possibly others) are not chained correctly when used with \Assert\that(…):

<?php

class Greet {
    function hello() { return 'Hi!'; }
}

$greeter = new Greet();

echo method_exists($greeter, 'hello'); # => 1

\Assert\that($greeter)->methodExists('hello'); # => fails! Provided "hello" is not a valid object.

This way one can use this placeholders in custom messages without taking care of the arguments given first. The (obvious) downside is, that one needs to one which argument comes at which position, but the alternative seems to be a (custom) template system like str_replace("{{foo}}", "$foo", $message) 😉

\Assert\that($msg)
    ->length(42, 'The message must be 42, but it\'s %3$s');

Assertion::email('root@localhost'); throws exception yet is totally valid.

Is that possible somehow?

Hi,

I've got a few assertion methods I'd like share back. What are the conventions for the numbering of the error constants in Assert\Assertion?

Hello,

I think an assertion for valid dates is missing Assertion::date($value, $format).
Is anyone able to add this please? :)

Add PHP Coding Standards Fixer and it's configuration.

Is this the expected behaviour?

Assertion::url('http://localhost'); // AssertionFailedException

In the UrlValidator from the Symfony Validator Component localhost is accepted:
https://github.com/symfony/validator/blob/aee4547e354dca50b470ef2a84a2e2461a3569ba/Tests/Constraints/UrlValidatorTest.php#L82

Support for localhost was added in this PR: symfony/validator@5e60bee

If you want I can do a PR.

i think the github option should be defaulted to hidden, is a checkbox in the settings panel

e.g. http://t_rost.rosfirm.ru/ is valid URL, may be it's not corresponds to some specs but it works
replace
([\pL\pN\pS-]+\.)+[\pL]+ # a domain name
with
([\pL\pN\pS-_]+\.)+[\pL]+ # a domain name

There should be a dedicated license file

Currently need to verify the sum of two integers, but I wonder, if something like this (+, *, -, \, %) fits into the library itself like

\Assert\thatAll([$foo, $bar])->sum(42, 'The sum of foo and bar must be 42');

What do you think?

Hey Benjamin,

I'd like to create very light weight version of the fluent interface to assert for use in some code that is going be very heavily used in my app. Your license file states that the copyright notice needs to be retained. So, would you like the following retained?

<?php
/**
 * Assert
 *
 * LICENSE
 *
 * This source file is subject to the new BSD license that is bundled
 * with this package in the file LICENSE.txt.
 * If you did not receive a copy of the license and are unable to
 * obtain it through the world-wide-web, please send an email
 * to [email protected] so I can send you a copy immediately.
 */
namespace Assert;
/**
 * Assert library
 *
 * @author Benjamin Eberlei <[email protected]>
 *
*/

Hi

I'm trying to extend the assert class which I got to work.
When I want to use this with the \Assert\lazy() it does not work.

Can you please assist me?

Thanks

Mark

IMO meaning is obvious. Will open a PR if you +1 it.

I think it could be useful if it was possible to be able to pass a callable message instead of a string because sometimes the message creation can be time consuming. Is it good or bad idea? What do you think?

Hi,

I propose to change the function "boolean" who uses function is_bool by the function filter_var with the filter FILTER_VALIDATE_BOOLEAN who accepts more value than only true or false.

In the list of the assertions in the README file, the float() assertion is missing.

It could support both long format IP addresses and string format with filter_var

I was wondering if you would be up for a PR for parameterized strings.

Eg.:

<?php

try {
    Assert\Assertion::same("a", "b", "The left argument (%left%) should be the same as the right argument(%right%) but they are not the same.");
} catch (Assert\AssertionFailedException $e) {
    echo $e->getMessage();
    // Prints => The left argument (a) should be the same as the right argument(b) but they are not the same.
}

I use this library for a long time, and never had issues with it in Phpstorm, until now. Not a single method of the AssertionChain gets recognised anymore.

\Assert\that($name)->string(); // Method 'string' not found in class

I might have to redirect this issue to Phpstorm itself, since I'm not sure if I have this problem since a newer version of this library or since the Phpstorm 9 update. But I ask it here first, because the following snippet (which uses the same mechanics) works like a charm:

/**
 * @method Foo bar()
 */
class Foo {
}

/**
 * @return Foo
 */
function test()
{
    return new Foo();
}

test()->bar(); // method is recognised

It may look like

\Assert\ThatOneOf($someObject, 'Value must be string or object with method "__toString".')
    ->string()
    ->methodExists($someObject, '__toString')
    ->end();

This chain fails only if both assertions fails.
I know this check can be realize as it described in #83.

try {
    Assert::string($someObject);
} catch (AssertionFailedException $e) {
    Assert::methodExists($someObject, '__toString');
}

But if we need more assertions next looks better.

\Assert\ThatOneOf($x, '-30 < x < -20 || -10 < x < 10 || 20 < x < 30 || 40 < x < 50')
    ->range(-30, -20)
    ->range(-10,  10)
    ->range( 20,  30)
    ->range( 40,  50)
    ->end();

What do you think about it?

Hi.

Please can you tag/release master. The Date assertion is very useful and including a frozen version is so much nicer than shipping master.

If you are unable to continue maintenance, then I'm happy to take over.

http://joel-costigliola.github.io/assertj/assertj-core-features-highlight.html#soft-assertions

Currently, Assertion::alnum() tests that a value consists of alphabetic and numeric characters only and starts with a letter. I think this is misleading, as it is different to what ctype_alnum() does.

I think that alnum() should be changed to use ctype_alnum() internally, moreover helpers for the other ctype_*() functions should be implemented.

We can add another helper testing that a string starts with a letter: startsWithLetter (using ctype_alpha($string[0]) internally) - analogous to startsWith

What do you think?

Hi. Is there a reason why there is an assertion notNull but isNull/null assertion is missing? I know same can be used instead but it is also possible to use notSame instead of notNull. Looks like it's not consistent. But I believe there is a reason behind this. Or not?

There is no way to use a specific Assertion class when using the fluent api. So using fluent api andd an own excpetion type at the same time have a drawback to me. When changing the assertion a differnt exception will be thrown.

try {
    \My\Custom\Assertion::notNull(null);
    // throws \My\Custom\Assertion::$exceptionClass

    \Assert\that(null)->notNull();
    // throws \Assert\Assertion::$exceptionClass
}
catch(\My\Custom\AssertionFailedException $e) {
    // ...
}