TypeTest.php

<?php
/**
 * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
 * Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
 *
 * Licensed under The MIT License
 * For full copyright and license information, please see the LICENSE.txt
 * Redistributions of files must retain the above copyright notice.
 *
 * @copyright     Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
 * @link          http://cakephp.org CakePHP(tm) Project
 * @since         3.0.0
 * @license       http://www.opensource.org/licenses/mit-license.php MIT License
 */
namespace Cake\Test\TestCase\Database;

use Cake\Database\Type;
use Cake\TestSuite\TestCase;
use PDO;

/**
 * Mock class for testing type registering
 *
 */
class FooType extends \Cake\Database\Type
{

}

/**
 * Tests Type class
 */
class TypeTest extends TestCase
{

    /**
     * Original type map
     *
     * @var array
     */
    protected $_originalMap = [];

    /**
     * Backup original Type class state
     *
     * @return void
     */
    public function setUp()
    {
        $this->_originalMap = Type::map();
        parent::setUp();
    }

    /**
     * Restores Type class state
     *
     * @return void
     */
    public function tearDown()
    {
        parent::tearDown();

        Type::map($this->_originalMap);
    }

    /**
     * Tests Type class is able to instantiate basic types
     *
     * @dataProvider basicTypesProvider
     * @return void
     */
    public function testBuildBasicTypes($name)
    {
        $type = Type::build($name);
        $this->assertInstanceOf('Cake\Database\Type', $type);
        $this->assertEquals($name, $type->getName());
    }

    /**
     * provides a basics type list to be used as data provided for a test
     *
     * @return void
     */
    public function basicTypesProvider()
    {
        return [
            ['string'],
            ['text'],
            ['boolean']
        ];
    }

    /**
     * Tests trying to build an unknown type throws exception
     *
     * @expectedException \InvalidArgumentException
     * @return void
     */
    public function testBuildUnknownType()
    {
        Type::build('foo');
    }

    /**
     * Tests that once a type with a name is instantiated, the reference is kept
     * for future use
     *
     * @return void
     */
    public function testInstanceRecycling()
    {
        $type = Type::build('integer');
        $this->assertSame($type, Type::build('integer'));
    }

    /**
     * Tests new types can be registered and built
     *
     * @return void
     */
    public function testMapAndBuild()
    {
        $map = Type::map();
        $this->assertNotEmpty($map);
        $this->assertFalse(isset($map['foo']));

        $fooType = __NAMESPACE__ . '\FooType';
        Type::map('foo', $fooType);
        $map = Type::map();
        $this->assertEquals($fooType, $map['foo']);
        $this->assertEquals($fooType, Type::map('foo'));

        $type = Type::build('foo');
        $this->assertInstanceOf($fooType, $type);
        $this->assertEquals('foo', $type->getName());
    }

    /**
     * Tests clear function in conjunction with map
     *
     * @return void
     */
    public function testClear()
    {
        $map = Type::map();
        $this->assertNotEmpty($map);

        $type = Type::build('float');
        Type::clear();

        $this->assertEmpty(Type::map());
        Type::map($map);
        $this->assertEquals($map, Type::map());

        $this->assertNotSame($type, Type::build('float'));
    }

    /**
     * Tests bigintegers from database are converted correctly to PHP
     *
     * @return void
     */
    public function testBigintegerToPHP()
    {
        $this->skipIf(
            PHP_INT_SIZE === 4,
            'This test requires a php version compiled for 64 bits'
        );
        $type = Type::build('biginteger');
        $integer = time() * time();
        $driver = $this->getMock('\Cake\Database\Driver');
        $this->assertSame($integer, $type->toPHP($integer, $driver));
        $this->assertSame($integer, $type->toPHP('' . $integer, $driver));
        $this->assertSame(3, $type->toPHP(3.57, $driver));
    }

    /**
     * Tests bigintegers from PHP are converted correctly to statement value
     *
     * @return void
     */
    public function testBigintegerToStatement()
    {
        $type = Type::build('biginteger');
        $integer = time() * time();
        $driver = $this->getMock('\Cake\Database\Driver');
        $this->assertEquals(PDO::PARAM_INT, $type->toStatement($integer, $driver));
    }

    /**
     * Tests string from database are converted correctly to PHP
     *
     * @return void
     */
    public function testStringToPHP()
    {
        $type = Type::build('string');
        $string = 'foo';
        $driver = $this->getMock('\Cake\Database\Driver');
        $this->assertEquals('foo', $type->toPHP($string, $driver));
        $this->assertEquals('3', $type->toPHP(3, $driver));
        $this->assertEquals('3.14159', $type->toPHP(3.14159, $driver));
        $this->assertEquals('', $type->toPHP([3, 'elf'], $driver));
    }

    /**
     * Tests integers from PHP are converted correctly to statement value
     *
     * @return void
     */
    public function testStringToStatement()
    {
        $type = Type::build('string');
        $string = '3';
        $driver = $this->getMock('\Cake\Database\Driver');
        $this->assertEquals(PDO::PARAM_STR, $type->toStatement($string, $driver));
    }

    /**
     * Tests integers from database are converted correctly to PHP
     *
     * @return void
     */
    public function testTextToPHP()
    {
        $type = Type::build('string');
        $string = 'foo';
        $driver = $this->getMock('\Cake\Database\Driver');
        $this->assertEquals('foo', $type->toPHP($string, $driver));
        $this->assertEquals('3', $type->toPHP(3, $driver));
        $this->assertEquals('3.14159', $type->toPHP(3.14159, $driver));
        $this->assertEquals('', $type->toPHP([2, 3], $driver));
    }

    /**
     * Tests integers from PHP are converted correctly to statement value
     *
     * @return void
     */
    public function testTextToStatement()
    {
        $type = Type::build('string');
        $string = '3';
        $driver = $this->getMock('\Cake\Database\Driver');
        $this->assertEquals(PDO::PARAM_STR, $type->toStatement($string, $driver));
    }

    /**
     * Test convertring booleans to database types.
     *
     * @return void
     */
    public function testBooleanToDatabase()
    {
        $type = Type::build('boolean');
        $driver = $this->getMock('\Cake\Database\Driver');

        $this->assertTrue($type->toDatabase(true, $driver));
        $this->assertFalse($type->toDatabase(false, $driver));
        $this->assertTrue($type->toDatabase(1, $driver));
        $this->assertFalse($type->toDatabase(0, $driver));
        $this->assertTrue($type->toDatabase('1', $driver));
        $this->assertFalse($type->toDatabase('0', $driver));
        $this->assertTrue($type->toDatabase([1, 2], $driver));
    }

    /**
     * Test convertring booleans to PDO types.
     *
     * @return void
     */
    public function testBooleanToStatement()
    {
        $type = Type::build('boolean');
        $driver = $this->getMock('\Cake\Database\Driver');

        $this->assertEquals(PDO::PARAM_BOOL, $type->toStatement(true, $driver));
        $this->assertEquals(PDO::PARAM_BOOL, $type->toStatement(false, $driver));
    }

    /**
     * Test convertring string booleans to PHP values.
     *
     * @return void
     */
    public function testBooleanToPHP()
    {
        $type = Type::build('boolean');
        $driver = $this->getMock('\Cake\Database\Driver');

        $this->assertTrue($type->toPHP(true, $driver));
        $this->assertTrue($type->toPHP(1, $driver));
        $this->assertTrue($type->toPHP('1', $driver));
        $this->assertTrue($type->toPHP('TRUE', $driver));
        $this->assertTrue($type->toPHP('true', $driver));

        $this->assertFalse($type->toPHP(false, $driver));
        $this->assertFalse($type->toPHP(0, $driver));
        $this->assertFalse($type->toPHP('0', $driver));
        $this->assertFalse($type->toPHP('FALSE', $driver));
        $this->assertFalse($type->toPHP('false', $driver));
        $this->assertTrue($type->toPHP(['2', '3'], $driver));
    }

    /**
     * Test marshalling booleans
     *
     * @return void
     */
    public function testBooleanMarshal()
    {
        $type = Type::build('boolean');
        $this->assertTrue($type->marshal(true));
        $this->assertTrue($type->marshal(1));
        $this->assertTrue($type->marshal('1'));
        $this->assertTrue($type->marshal('true'));

        $this->assertFalse($type->marshal('false'));
        $this->assertFalse($type->marshal('0'));
        $this->assertFalse($type->marshal(0));
        $this->assertFalse($type->marshal(''));
        $this->assertFalse($type->marshal('invalid'));
        $this->assertTrue($type->marshal(['2', '3']));
    }


    /**
     * Tests uuid from database are converted correctly to PHP
     *
     * @return void
     */
    public function testUuidToPHP()
    {
        $type = Type::build('uuid');
        $string = 'abc123-de456-fg789';
        $driver = $this->getMock('\Cake\Database\Driver');
        $this->assertEquals($string, $type->toPHP($string, $driver));
        $this->assertEquals('3', $type->toPHP(3, $driver));
        $this->assertEquals('3.14159', $type->toPHP(3.14159, $driver));
    }

    /**
     * Tests integers from PHP are converted correctly to statement value
     *
     * @return void
     */
    public function testUuidToStatement()
    {
        $type = Type::build('uuid');
        $string = 'abc123-def456-ghi789';
        $driver = $this->getMock('\Cake\Database\Driver');
        $this->assertEquals(PDO::PARAM_STR, $type->toStatement($string, $driver));
    }

    /**
     * Tests decimal from database are converted correctly to PHP
     *
     * @return void
     */
    public function testDecimalToPHP()
    {
        $type = Type::build('decimal');
        $driver = $this->getMock('\Cake\Database\Driver');

        $this->assertSame(3.14159, $type->toPHP('3.14159', $driver));
        $this->assertSame(3.14159, $type->toPHP(3.14159, $driver));
        $this->assertSame(3.0, $type->toPHP(3, $driver));
        $this->assertSame(1, $type->toPHP(['3', '4'], $driver));
    }

    /**
     * Tests integers from PHP are converted correctly to statement value
     *
     * @return void
     */
    public function testDecimalToStatement()
    {
        $type = Type::build('decimal');
        $string = '12.55';
        $driver = $this->getMock('\Cake\Database\Driver');
        $this->assertEquals(PDO::PARAM_STR, $type->toStatement($string, $driver));
    }
}