FwlibTest\Db\CodeDictionaryTest

Complexity

Total Complexity

18

Size/Duplication

Total Lines	364
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

17 Methods

Rating	Name	Duplication	Size	Complexity
B	buildDbMock()	0	56	1
A	buildMock()	0	12	1
A	testAccessors()	0	13	1
A	testFixDictionaryIndex()	0	31	1
A	testGet()	0	18	1
A	testGetSingleColumn()	0	18	1
A	testGetSingleColumnWithInvalidColumn()	0	6	1
A	testGetSqlWithDbNotConnected()	0	7	1
A	testGetSqlWithNoTableName()	0	8	1
A	testGetSqlWithTable()	0	25	1
A	testSearch()	0	48	2
A	testSet()	0	7	1
A	testSetWithEmptyPk()	0	6	1
A	testSetWithEmptyRowInData()	0	6	1
A	testSetWithEmptyValue()	0	10	1
A	testSetWithNoColumn()	0	8	1
A	testSetWithPrimaryKeyNotInColumn()	0	8	1

<?php
namespace FwlibTest\Db;

use Fwlib\Bridge\Adodb;
use Fwlib\Db\CodeDictionary;
use Fwolf\Wrapper\PHPUnit\PHPUnitTestCase;
use PHPUnit_Framework_MockObject_MockObject as MockObject;

/**
 * @SuppressWarnings(PHPMD.TooManyMethods)
 *
 * @copyright   Copyright 2011-2015 Fwolf
 * @license     http://www.gnu.org/licenses/lgpl.html LGPL-3.0+
 */
class CodeDictionaryTest extends PHPUnitTestCase
{
    /**
     * Db mock return value
     *
     * @var bool
     */
    public static $isConnected;

    /**
     * @var bool
     */
    public static $isDbMysql;


    /**
     * @return  MockObject|Adodb
     */
    protected function buildDbMock()
    {
        $dbConn = $this->getMockBuilder(
            Adodb::class
        )
            ->setMethods([
                'getProfile',
                'getSqlDelimiter',
                'getSqlTruncate',
                'getSqlTransBegin',
                'getSqlTransCommit',
                'isConnected',
                'isDbMysql',
                'quoteValue',
            ])
            ->disableOriginalConstructor()
            ->getMock();

        $dbConn->expects($this->any())
            ->method('getProfile')
            ->will($this->returnValue(['lang' => '{profileLang}']));

        $dbConn->expects($this->any())
            ->method('getSqlDelimiter')
            ->will($this->returnValue("{sqlDelimiter}\n"));

        $dbConn->expects($this->any())
            ->method('getSqlTransBegin')
            ->will($this->returnValue("{sqlTransBegin}\n"));

        $dbConn->expects($this->any())
            ->method('getSqlTransCommit')
            ->will($this->returnValue("{sqlTransCommit}\n"));

        $dbConn->expects($this->any())
            ->method('getSqlTruncate')
            ->will($this->returnValue('{sqlTruncate}'));

        $dbConn->expects($this->any())
            ->method('isConnected')
            ->will($this->returnCallback(function () {
                return CodeDictionaryTest::$isConnected;
            }));

        $dbConn->expects($this->any())
            ->method('isDbMysql')
            ->will($this->returnCallback(function () {
                return CodeDictionaryTest::$isDbMysql;
            }));

        $dbConn->expects($this->any())
            ->method('quoteValue')
            ->will($this->returnValue('{quoteValue}'));

        return $dbConn;
    }


    /**
     * @return  MockObject|CodeDictionary
     */
    protected function buildMock()
    {
        $dictionary = new CodeDictionary();

        $dictionary->set([
            [123, 'a'],
            ['bac', 2],
            [321, 'c'],
        ]);

        return $dictionary;
    }


    public function testAccessors()
    {
        $dictionary = new CodeDictionary;

        $dictionary->setColumns(['a', 'b']);
        $this->assertEqualArray(['a', 'b'], $dictionary->getColumns());

        $dictionary->setPrimaryKey('a');
        $this->assertEquals('a', $dictionary->getPrimaryKey());

        $dictionary->setTable('dummyTable');
        $this->assertEquals('dummyTable', $dictionary->getTable());
    }


    public function testFixDictionaryIndex()
    {
        $arrayWithoutIndex = [
            [123, 'a'],
            ['bac', 2],
            [321, 'c'],
        ];
        $arrayWithIndex = [
            123   => [
                'code'  => 123,
                'title' => 'a',
            ],
            'bac' => [
                'code'  => 'bac',
                'title' => 2,
            ],
            321   => [
                'code'  => 321,
                'title' => 'c',
            ],
        ];

        $dictionary = $this->buildMock();

        // Simulate $dictionary define by assign value to it
        $this->reflectionSet($dictionary, 'dictionary', $arrayWithoutIndex);
        // Then call constructor to simulate new operate
        $this->reflectionCall($dictionary, '__construct');

        $this->assertEqualArray($arrayWithIndex, $dictionary->getAll());

The method getAll does only exist in Fwlib\Db\CodeDictionary, but not in PHPUnit_Framework_MockObject_MockObject.

    }


    public function testGet()
    {
        $dictionary = $this->buildMock();

        $this->assertEquals(null, $dictionary->get(null));

The method get does only exist in Fwlib\Db\CodeDictionary, but not in PHPUnit_Framework_MockObject_MockObject.

        $this->assertEquals(null, $dictionary->getMultiple([]));

The method getMultiple does only exist in Fwlib\Db\CodeDictionary, but not in PHPUnit_Framework_MockObject_MockObject.

        $this->assertEquals(null, $dictionary->get('notExistKey'));
        $this->assertEquals(
            ['notExistKey' => null],
            $dictionary->getMultiple(['notExistKey'])
        );
        $this->assertEquals('a', $dictionary->get(123));
        $this->assertEquals(2, $dictionary->get('bac'));
        $this->assertEquals(
            [123 => 'a', 321 => 'c'],
            $dictionary->getMultiple([123, 321])
        );
    }


    public function testGetSingleColumn()
    {
        $dictionary = $this->buildMock();
        $this->reflectionSet($dictionary, 'dictionary', []);

        $dictionary->setColumns(['a', 'b', 'c'])

The method setColumns does only exist in Fwlib\Db\CodeDictionary, but not in PHPUnit_Framework_MockObject_MockObject.

            ->setPrimaryKey('a')
            ->set([
                ['a' => 1, 'b' => 2, 'c' => 3],
                ['a' => 10, 'b' => 20, 'c' => 30],
                ['a' => 100, 'b' => 200, 'c' => 300],
            ]);

        $this->assertEqualArray(
            $dictionary->getSingleColumn('c'),

The method getSingleColumn does only exist in Fwlib\Db\CodeDictionary, but not in PHPUnit_Framework_MockObject_MockObject.

            [1 => 3, 10 => 30, 100 => 300]
        );
    }


    /**
     * @expectedException \Fwlib\Db\Exception\InvalidColumnException
     */
    public function testGetSingleColumnWithInvalidColumn()
    {
        $dictionary = $this->buildMock();

        $dictionary->getSingleColumn('notExist');

The method getSingleColumn does only exist in Fwlib\Db\CodeDictionary, but not in PHPUnit_Framework_MockObject_MockObject.

    }


    /**
     * @expectedException \Exception
     * @expectedExceptionMessage Database not connected
     */
    public function testGetSqlWithDbNotConnected()
    {
        $dictionary = $this->buildMock();
        self::$isConnected = false;

        $dictionary->getSql($this->buildDbMock());

It seems like $this->buildDbMock() targeting FwlibTest\Db\CodeDictionaryTest::buildDbMock() can also be of type object<PHPUnit_Framework_MockObject_MockObject>; however, Fwlib\Db\CodeDictionary::getSql() does only seem to accept object<Fwlib\Bridge\Adodb>, maybe add an additional type check?

The method getSql does only exist in Fwlib\Db\CodeDictionary, but not in PHPUnit_Framework_MockObject_MockObject.

    }


    public function testGetSqlWithNoTableName()
    {
        $dictionary = $this->buildMock();

        $dictionary->setTable('');

The method setTable does only exist in Fwlib\Db\CodeDictionary, but not in PHPUnit_Framework_MockObject_MockObject.

        $this->assertEmpty($dictionary->getSql($this->buildDbMock()));

It seems like $this->buildDbMock() targeting FwlibTest\Db\CodeDictionaryTest::buildDbMock() can also be of type object<PHPUnit_Framework_MockObject_MockObject>; however, Fwlib\Db\CodeDictionary::getSql() does only seem to accept object<Fwlib\Bridge\Adodb>, maybe add an additional type check?

The method getSql does only exist in Fwlib\Db\CodeDictionary, but not in PHPUnit_Framework_MockObject_MockObject.

    }


    public function testGetSqlWithTable()
    {
        $dictionary = $this->buildMock();

        self::$isConnected = true;
        self::$isDbMysql = true;

        /** @noinspection SpellCheckingInspection */
        $sqlExpected = 'SET NAMES \'{PROFILELANG}\'{sqlDelimiter}
{sqlTransBegin}
TRUNCATE TABLE code_dictionary{sqlDelimiter}
{sqlTransCommit}
{sqlTransBegin}
INSERT INTO code_dictionary (code, title) VALUES ({quoteValue}, {quoteValue}){sqlDelimiter}
INSERT INTO code_dictionary (code, title) VALUES ({quoteValue}, {quoteValue}){sqlDelimiter}
INSERT INTO code_dictionary (code, title) VALUES ({quoteValue}, {quoteValue}){sqlDelimiter}
{sqlTransCommit}
';

        $sql = $dictionary->getSql($this->buildDbMock());

It seems like $this->buildDbMock() targeting FwlibTest\Db\CodeDictionaryTest::buildDbMock() can also be of type object<PHPUnit_Framework_MockObject_MockObject>; however, Fwlib\Db\CodeDictionary::getSql() does only seem to accept object<Fwlib\Bridge\Adodb>, maybe add an additional type check?

The method getSql does only exist in Fwlib\Db\CodeDictionary, but not in PHPUnit_Framework_MockObject_MockObject.

        $this->assertEquals($sqlExpected, $sql);
        $this->assertEquals(3, preg_match_all('/INSERT INTO/', $sql, $match));
        $this->assertEquals(1, preg_match_all('/TRUNCATE/', $sql, $match));
    }


    public function testSearch()
    {
        $dictionary = $this->buildMock();
        $code = CodeDictionary::COL_CODE;
        $title = CodeDictionary::COL_TITLE;

        $this->assertEquals(
            ['bac' => [$code => 'bac', $title => 2]],
            $dictionary->search(function ($row) {

The method search does only exist in Fwlib\Db\CodeDictionary, but not in PHPUnit_Framework_MockObject_MockObject.

                return !is_numeric($row[CodeDictionary::COL_CODE]);
            })
        );

        $this->assertEquals(
            [
                123 => [$code => 123, $title => 'a'],
                321 => [$code => 321, $title => 'c'],
            ],
            $dictionary->search(function ($row) {

The method search does only exist in Fwlib\Db\CodeDictionary, but not in PHPUnit_Framework_MockObject_MockObject.

                return '2' == substr($row[CodeDictionary::COL_CODE], 1, 1);
            })
        );

        $this->assertEquals(
            [
                321 => [$code => 321, $title => 'c'],
            ],
            $dictionary->search(function ($row) {

The method search does only exist in Fwlib\Db\CodeDictionary, but not in PHPUnit_Framework_MockObject_MockObject.

                return 'c' == $row[CodeDictionary::COL_TITLE] &&
                '2' == substr($row[CodeDictionary::COL_CODE], 1, 1);
            })
        );

        // Search with assign cols
        $this->assertEquals(
            [321 => 'c'],
            $dictionary->search(function ($row) {

The method search does only exist in Fwlib\Db\CodeDictionary, but not in PHPUnit_Framework_MockObject_MockObject.

                return 'c' == $row[CodeDictionary::COL_TITLE];
            }, $title)
        );

        // Search on empty dictionary will return empty array
        $this->reflectionSet($dictionary, 'dictionary', []);
        $this->assertEqualArray(
            [],
            $dictionary->search('time')
        );
    }


    public function testSet()
    {
        $dictionary = $this->buildMock();

        $dictionary->set(['foo', 'bar']);

The method set does only exist in Fwlib\Db\CodeDictionary, but not in PHPUnit_Framework_MockObject_MockObject.

        $this->assertEquals(4, count($dictionary->getAll()));

The method getAll does only exist in Fwlib\Db\CodeDictionary, but not in PHPUnit_Framework_MockObject_MockObject.

    }


    /**
     * @expectedException \Exception
     * @expectedExceptionMessage Primary key value is empty or not set
     */
    public function testSetWithEmptyPk()
    {
        $dictionary = $this->buildMock();

        $dictionary->set(['', 'bar']);

The method set does only exist in Fwlib\Db\CodeDictionary, but not in PHPUnit_Framework_MockObject_MockObject.

    }


    /**
     * @expectedException \Exception
     * @expectedExceptionMessage contain all columns
     */
    public function testSetWithEmptyRowInData()
    {
        $dictionary = $this->buildMock();

        $dictionary->set([[null], ['foo', 'bar']]);

The method set does only exist in Fwlib\Db\CodeDictionary, but not in PHPUnit_Framework_MockObject_MockObject.

    }


    public function testSetWithEmptyValue()
    {
        $dictionary = $this->buildMock();

        $dictionaryBefore = $dictionary->getAll();

The method getAll does only exist in Fwlib\Db\CodeDictionary, but not in PHPUnit_Framework_MockObject_MockObject.

        $dictionary->set([]);

The method set does only exist in Fwlib\Db\CodeDictionary, but not in PHPUnit_Framework_MockObject_MockObject.

        $dictionaryAfter = $dictionary->getAll();

        $this->assertEqualArray($dictionaryBefore, $dictionaryAfter);
    }


    /**
     * @expectedException \Exception
     * @expectedExceptionMessage Dictionary column not defined
     */
    public function testSetWithNoColumn()
    {
        $dictionary = $this->buildMock();

        $dictionary->setColumns([]);

The method setColumns does only exist in Fwlib\Db\CodeDictionary, but not in PHPUnit_Framework_MockObject_MockObject.

        $dictionary->set(['foo' => 'bar']);

The method set does only exist in Fwlib\Db\CodeDictionary, but not in PHPUnit_Framework_MockObject_MockObject.

    }


    /**
     * @expectedException \Exception
     * @expectedExceptionMessage include primary key
     */
    public function testSetWithPrimaryKeyNotInColumn()
    {
        $dictionary = $this->buildMock();

        $dictionary->setPrimaryKey('notExistColumn');

The method setPrimaryKey does only exist in Fwlib\Db\CodeDictionary, but not in PHPUnit_Framework_MockObject_MockObject.

        $dictionary->set(['foo' => 'bar']);

The method set does only exist in Fwlib\Db\CodeDictionary, but not in PHPUnit_Framework_MockObject_MockObject.

    }
}