ValidatorTest.php

<?php

/*
 * To change this license header, choose License Headers in Project Properties.
 * To change this template file, choose Tools | Templates
 * and open the template in the editor.
 */

use DVL\DVLValidator;
use DVL\Struct\Exceptions\FalseResultValidationException;
use DVL\Struct\Exceptions\BaseValidationException;
use DVL\Struct\Adapters\IAdapter;
use DVL\Struct\Exceptions\AdapterNotFoundException;

class TestCustomValidationException extends BaseValidationException {
}

class TestArrayConvertableObject {
    
    public $arr;
    
    function __construct($arr) {
        $this->arr = $arr;
    }
    
}

class TestArrayUnconvertableObject {
}

class TestArrayConvertableObjectAdapter implements IAdapter {
    
    public function convertToNativeVariable($variable) {
        return $variable->arr;
    }

    public function isConvertableVariable($variable) {
        return $variable instanceof TestArrayConvertableObject;
    }

}

/**
 * Description of ValidatorTests
 *
 * @author User
 */
class ValidatorTest extends PHPUnit_Framework_TestCase {
    
    private function processSuccessiveTestsArray($tests, $options = null) { 
        foreach ($tests as $expression => $data) {
            $this->assertTrue(
                    DVLValidator::sValidate($data, $expression, $options),
                    "Expression: \"$expression\"");
        }
    }
    
    private function processFailingTestsArray($tests, $options = null) {
        foreach ($tests as $expression => $data) {
            $this->assertFalse(
                    DVLValidator::sValidate($data, $expression, $options), 
                    "Expression: \"$expression\"");
        }
    }
    
    public function testValidatorBooleanOperations() {
                
        $this->processSuccessiveTestsArray(array(
            '1 == 1' => null,
            '1 != 2' => null,
            '1 >= 1' => null,
            '2 >= 1' => null,
            '1 <= 1' => null,
            '1 <= 2' => null,
            '3 > 2' => null,
            '3 < 4' => null,
            '1 in [ 1, 2, 3 ]' => null,
            '1 == 1 && 2 == 2' => null,
            '1 != 1 || 2 == 2' => null,
            '1 == 1 || 2 != 2' => null,
            '1 == 1 || 2 == 2' => null,
            '1 == "test" || 2 == 2' => null,
            'true' => null,
            '!false' => null,
        ));
        
        $this->processFailingTestsArray(array(
            '1 == 2' => null,
            '1 != 1' => null,
            '0 >= 1' => null,
            '1 <= 0' => null,
            '2 > 2' => null,
            '1 > 2' => null,
            '3 < 2' => null,
            '3 < 3' => null,
            '4 in [ 1, 2, 3 ]' => null,
            '1 == 0 && 2 == 2' => null,
            '1 == 0 && 1 == 2' => null,
            '1 == 1 && 1 == 2' => null,
            '1 != 1 || 2 != 2' => null,
            'false' => null,
            '!true' => null,
        ));
        
    }
    
    public function testValidatorArithmeticOperations() {
        
        $this->processSuccessiveTestsArray(array(
            '1 == 1' => null,
            '1 + 1 == 2' => null,
            '2 * 2 == 4' => null,
            '2 + 2 * 2 == 6' => null,
            '2 % 2 == 0' => null,
            '4 % 3 == 1' => null,
            '-1 < 0' => null,
            '-1 + 1 == 0' => null,
            '1.5 + 1.2 == 2.7' => null
        ));
        
        $this->processFailingTestsArray(array(
            '1 == 2' => null,
            '1 + 1 == 1' => null,
            '2 * 2 == 5' => null,
            '2 + 2 * 2 == 8' => null,
            '2 % 2 == 1' => null,
            '4 % 3 == 2' => null,
            '-1 > 0' => null,
            '-1 + 1 != 0' => null,
            '1.5 + 1.2 != 2.7' => null,
        ));
        
    }
    
    public function testValidatorVariableOperations() {
        
        $this->processSuccessiveTestsArray(array(
            'this == 1' => 1,
            'this + 1 == 2' => 1,
            'this * 2 == 4' => 2,
            '2 + this * 2 == 6' => 2,
            'this' => true,
            'this && true' => true,
            'this || false' => true,
            'false || this' => true,
        ));
        
        $this->processFailingTestsArray(array(
            'this != 1' => 1,
            '1 + this == 1' => 1,
            'this * 2 == 5' => 2,
            '2 + this * 2 != 6' => 2,
            'this' => false,
            'this && false' => true,
            'this || false' => false,
            'false || this' => false,
        ));
        
    }
    
    public function testValidatorVariableAccessors() {
        
        $this->processSuccessiveTestsArray(array(
            'this' => true,
            'this.key1' => array( 'key1' => true ),
            'this["111"]' => array( '111' => true ),
            'this["111"].key1' => array( '111' => array( 'key1' => true ) ),
            '$(this[i % 2 > 0]) value > 0' => array( -1, 1, -1, 1, -1, 1 ),
        ));
        
        $this->processFailingTestsArray(array(
            'this' => false,
            'this.key1' => 1,
            'this.key1' => array( 'key_not_one' => true ),
            'this["111"]' => array( '222' => true ),
            '$(this[i % 2 == 0]) value > 0' => array( -1, 1, -1, 1, -1, 1 ),
        ));
        
    }
    
    public function testValidatorFunctions() {
        
        $this->processSuccessiveTestsArray(array(
            'INT(this) == 1' => 1,
            '(INT(this)) this == 1' => 1,
            'INT(this) + 1 == 2' => 1,
            'BOOL(this)' => true,
            'ARRAY(this)' => [ 1, 2, 3 ],
            'COUNT(this) == 1' => array( 1 ),
            '$(KEYS(this)) value >= 0' => [ 1, 2, 3 ],
            'STRING("test") == "test"' => null,
            'STRLEN("test") == 4' => null,
            'IS_ASSOC(this)' => [ 'a' => 1, 'b' => 2, 'c' => 3 ],
            'IS_ARRAY(this)' => [ 1, 2, 3 ],
            'NATIVE_REGEX_MATCH("/.e.t/", "test")' => true,
            'TEST_FUNCTION1()' => true,
            'TEST_FUNCTION1(this)' => false,
            '!TEST_FUNCTION2()' => true,
            '!TEST_FUNCTION2(this)' => false,
            'TEST_FUNCTION3(true)' => null,
            'TEST_FUNCTION3(this)' => true,
            '!TEST_FUNCTION3(this)' => false,
            'TEST_FUNCTION3(this) + 1 == 2' => 1,
            '$(ARRAY(TEST_FUNCTION3(this))) value < 4' => [ 1, 2, 3 ],
        ), [ 
            'functions' => [
                'TEST_FUNCTION1' => function() { return true; },
                'TEST_FUNCTION2' => function() { return false; },
                'TEST_FUNCTION3' => function($var) { return $var; },
            ]
        ]);
                
        $this->processFailingTestsArray(array(
            'INT(this) == "test"' => 'test',
            '(INT(this)) this == "test"' => 'test',
            'INT(this) + 1 != 2' => 'test',
            'BOOL(this)' => 1,
            'ARRAY(this)' => 1,
            'COUNT(this) == 1' => 1,
            'COUNT(this) == 1' => array( 1, 2 ),
            '$(KEYS(this)) value >= 0' => 'test',
            'STRING(2) == "test"' => null,
            'STRLEN(4) == 4' => null,
            'IS_ASSOC(this)' => [ 1, 2, 3 ],
            'IS_ARRAY(this)' => [ 'a' => 1, 'b' => 2, 'c' => 3 ],
            'NATIVE_REGEX_MATCH(2, "test")' => true,
            'EXCEPTION_FUNCTION()' => null,
            '!TEST_FUNCTION1()' => true,
            '!TEST_FUNCTION1(this)' => true,
            'TEST_FUNCTION2()' => true,
            'TEST_FUNCTION2(this)' => true,
            'TEST_FUNCTION3(false)' => null,
            'TEST_FUNCTION3(this)' => false,
            '!TEST_FUNCTION3(this)' => true,
            'TEST_FUNCTION3(this) + 1 != 2' => 1,
            '$(ARRAY(TEST_FUNCTION3(this))) value < 4' => 1,
        ), [
            'functions' => [
                'TEST_FUNCTION1' => function() { return true; },
                'TEST_FUNCTION2' => function() { return false; },
                'TEST_FUNCTION3' => function($var) { return $var; },
                'EXCEPTION_FUNCTION' => function() { throw new FalseResultValidationException('test message'); }
            ]
        ]);
        
    }
    
    public function testValidatorControlStructures() {
        
        $this->processSuccessiveTestsArray(array(
            '{ this }' => true,
            '{ true, 1 == 1, this == 1 }' => 1,
            '(this) this > 1' => 2,
            '(this + 1) this == 2' => 1,
            '$(this) value > 0' => [ 1, 2, 3 ],
            '$(this : v) v > 0' => [ 1, 2, 3 ],
            '$(this : k => v) k > v' => [ 2 => 1, 4 => 3, 8 => 5 ],
            '$(this : k => v) { k % 2 == 0, v % 2 == 1 }' => [ 2 => 1, 4 => 3, 8 => 5 ],
            '$(this : k1 => v1) $(v1 : k2 => v2) { k1 > v2, k2 < v2 }' => [ 3 => [ 1, 2 ], 5 => [ 3, 4 ], 7 => [ 5, 6 ] ],
            '(this) ? true' => true,
            '(this) ? false : true' => false,
            '(this) ? true : false' => true,
            '(this + 1  > 1) ? false : true' => true,
        ));
        
        $this->processFailingTestsArray(array(
            '{ this }' => false,
            '{ true, 1 != 1, this == 1 }' => 1,
            '{ false, 1 == 1, this == 1 }' => 1,
            '{ true, 1 == 1, this < 1 }' => 1,
            '{ false, 1 != 1, this > 1 }' => 1,
            '(this) this == 1' => 2,
            '(this - 1) this != 0' => 1,
            '$(this) value < 0' => [ 1, 2, 3 ],
            '$(this : v) v == 0' => [ 1, 2, 3 ],
            '$(this : k => v) k < v' => [ 2 => 1, 4 => 3, 8 => 5 ],
            '$(this : k => v) { k % 2 > 0, v % 2 < 1 }' => [ 2 => 1, 4 => 3, 8 => 5 ],
            '$(this : k1 => v1) $(v1 : k2 => v2) { k1 < v2, k2 > v2 }' => [ 3 => [ 1, 2 ], 5 => [ 3, 4 ], 7 => [ 5, 6 ] ],
            '(this) ? false' => true,
            '(this) ? true : false' => false,
            '(this) ? false : true' => true,
            '(this + 1 > 1) ? true : false' => true,
        ));
        
    }
    
    public function testValidatorComplex() {

        $validator = new DVLValidator('{
            (INT(this.var_num)) {
                this > 0 @ "var_num must be positive" % "var_num_positive_tag",
                this < 30 @ "var_num must be less than 30, value = {this}"
            },
            (STRING(this.var_str)) {
                STRLEN(this) < 20,
                this[0] == "t"
            },
            (CUSTOM_ARRAY(this.var_arr)) {
                $(this) value > 0 @ "var_arr value \"{value}\" with key \"{key}\" must be positive",
                $(this[!(i % 2 > 0)]) value == 2,
                (KEYS(this)) {
                    $(this : k => v) v + k < 8 @ "key \"{k}\" value \"{v}\" error",
                    $(this) value >= 0
                }
            },
            (IS_ASSOC(this.var_assoc)) ? (this.var_assoc) {
                $(KEYS(this)) NATIVE_REGEX_MATCH("/key[0..9]+/", value)
            } : {
                IS_ARRAY(this.var_assoc)
            },
            (this.var_assoc) {
                $(this) INT(value) in [ 1, 2, 3, 4 ]
            },
            ARRAY(this.var_arr_convertable)
        }', array(
            'functions' => array(
                'CUSTOM_ARRAY' => function($var) {
                    if (!is_array($var)) {
                        throw new TestCustomValidationException();
                    }
                    return $var;
                }
            ),
        ));
            
        $validator->getAdapterManager()->registerAdapter(
            new TestArrayConvertableObjectAdapter()
        );
        
        $this->assertTrue($validator->validate(array(
            'var_num' => 5,
            'var_str' => 'test',
            'var_arr' => array( 2, 1, 2, 4 ),
            'var_assoc' => array(
                'key1' => 1,
                'key2' => 2,
                'key3' => 3,
                'key4' => 4,
            ),
            'var_arr_convertable' => new TestArrayConvertableObject(array( 1, 2 ))
        )));
        
        $validator->validate(array(
            'var_num' => 0
        ));
        $this->assertEquals('var_num must be positive', $validator->getLastErrorMessage());
        $this->assertEquals('var_num_positive_tag', $validator->getLastErrorTag());
        
        $validator->validate(array(
            'var_num' => 31
        ));
        $this->assertEquals('var_num must be less than 30, value = 31', $validator->getLastErrorMessage());
        
        $validator->validate(array(
            'var_num' => 5,
            'var_str' => 'test',
            'var_arr' => array( 2 => 2, 5 => 1, 8 => 2, 17 => 4 ),
        ));
        $this->assertEquals('key "2" value "8" error', $validator->getLastErrorMessage());
        
        $validator->validate(array(
            'var_num' => 5,
            'var_str' => 'test',
            'var_arr' => 1,
        ));
        $this->assertTrue($validator->getLastException()->getPrevious() instanceof TestCustomValidationException);
        
        try {
            $validator->validate(array(
                'var_num' => 5,
                'var_str' => 'test',
                'var_arr' => array( 2, 1, 2, 4 ),
                'var_assoc' => array(
                    'key1' => 1,
                    'key2' => 2,
                    'key3' => 3,
                    'key4' => 4,
                ),
                'var_arr_convertable' => new TestArrayUnconvertableObject()
            ));
            $this->fail();
        } catch (AdapterNotFoundException $e) {
            //That's how it should be
        }
        
    }
    
    public function testValidatorReadmeExample() {
        $validator = new DVLValidator('{
            STRLEN(this.first_name) < 64 @ "First name must be no longer than 64 symbols",
            STRLEN(this.last_name) < 64 @ "Last name must be no longer than 64 symbols",
            (this.age) {
                this > 20 @ "Not enough old" % "age_young",
                this < 100 @ "Too old" % "age_old"
            },
            $(this.professions) {
                (value == "composer") ?
                    (this.songs_written) this > 0 || this == "many" :
                    true,
                value in [
                    "musician",
                    "composer",
                    "singer",
                    "guitarist",
                    "drummer",
                    "bassist"
                ]
            },
            BAND_EXISTS(this.band_id)
        }', [
            'functions' => [
                'BAND_EXISTS' => function($id) {
                    return true;
                }
            ]
        ]);

        $this->assertTrue($validator->validate(array(
            'first_name' => 'Dexter',
            'last_name' => 'Holland',
            'age' => 49,
            'instrument' => 'microphone',
            'songs_written' => 'many',
            'professions' => array( 'musician', 'composer', 'singer' ),
            'band_id' => 'the_offspring'
        )));
    }
    
}