silverstripe-framework/tests/php/ORM/MapTest.php

<?php

namespace SilverStripe\ORM\Tests;

use SilverStripe\ORM\Map;
use SilverStripe\ORM\ArrayList;
use SilverStripe\Dev\SapphireTest;
use SilverStripe\ORM\Tests\DataObjectTest\Team;
use SilverStripe\ORM\Tests\DataObjectTest\TeamComment;

class MapTest extends SapphireTest
{

    // Borrow the model from DataObjectTest
    protected static $fixture_file = 'DataObjectTest.yml';

    public static function getExtraDataObjects()
    {
        return array_merge(
            DataObjectTest::$extra_data_objects,
            ManyManyListTest::$extra_data_objects
        );
    }

    public function testValues()
    {
        $list = TeamComment::get()->sort('Name');
        $map = new Map($list, 'Name', 'Comment');

        $this->assertEquals(
            [
            'This is a team comment by Bob',
            'This is a team comment by Joe',
            'Phil is a unique guy, and comments on team2'
            ],
            $map->values()
        );


        $map->push('Push', 'Item');

        $this->assertEquals(
            [
            'This is a team comment by Bob',
            'This is a team comment by Joe',
            'Phil is a unique guy, and comments on team2',
            'Item'
            ],
            $map->values()
        );

        $map = new Map(new ArrayList());
        $map->push('Push', 'Pushed value');

        $this->assertEquals(
            [
            'Pushed value'
            ],
            $map->values()
        );

        $map = new Map(new ArrayList());
        $map->unshift('Unshift', 'Unshift item');

        $this->assertEquals(
            [
            'Unshift item'
            ],
            $map->values()
        );
    }


    public function testArrayAccess()
    {
        $list = TeamComment::get();
        $map = new Map($list, 'Name', 'Comment');
        $this->assertEquals('This is a team comment by Joe', $map['Joe']);
        $this->assertNull($map['DoesntExist']);
    }

    public function testIteration()
    {
        $list = TeamComment::get()->sort('ID');
        $map = new Map($list, 'Name', 'Comment');
        $text = "";
        foreach ($map as $k => $v) {
            $text .= "$k: $v\n";
        }
        $this->assertEquals(
            "Joe: This is a team comment by Joe\n"
            . "Bob: This is a team comment by Bob\n"
            . "Phil: Phil is a unique guy, and comments on team2\n",
            $text
        );
    }

    public function testDefaultConfigIsIDAndTitle()
    {
        $list = Team::get();
        $map = new Map($list);
        $this->assertEquals('Team 1', $map[$this->idFromFixture(DataObjectTest\Team::class, 'team1')]);
    }

    public function testSetKeyFieldAndValueField()
    {
        $list = TeamComment::get();
        $map = new Map($list);
        $map->setKeyField('Name');
        $map->setValueField('Comment');
        $this->assertEquals('This is a team comment by Joe', $map['Joe']);
    }

    public function testToArray()
    {
        $list = TeamComment::get();
        $map = new Map($list, 'Name', 'Comment');
        $this->assertEquals(
            ["Joe" => "This is a team comment by Joe",
            "Bob" => "This is a team comment by Bob",
            "Phil" => "Phil is a unique guy, and comments on team2"],
            $map->toArray()
        );
    }

    public function testKeys()
    {
        $list = TeamComment::get()->sort('Name');
        $map = new Map($list, 'Name', 'Comment');
        $this->assertEquals(
            [
            'Bob',
            'Joe',
            'Phil'
            ],
            $map->keys()
        );

        $map->unshift('Unshift', 'Item');

        $this->assertEquals(
            [
            'Unshift',
            'Bob',
            'Joe',
            'Phil'
            ],
            $map->keys()
        );

        $map->push('Push', 'Item');

        $this->assertEquals(
            [
            'Unshift',
            'Bob',
            'Joe',
            'Phil',
            'Push'
            ],
            $map->keys()
        );

        $map = new Map(new ArrayList());
        $map->push('Push', 'Item');

        $this->assertEquals(
            [
            'Push'
            ],
            $map->keys()
        );

        $map = new Map(new ArrayList());
        $map->unshift('Unshift', 'Item');

        $this->assertEquals(
            [
            'Unshift'
            ],
            $map->keys()
        );
    }

    public function testMethodAsValueField()
    {
        $list = Team::get()->sort('Title');
        $map = new Map($list, 'ID', 'MyTitle');
        $this->assertEquals(
            [
            'Team Subteam 1',
            'Team Subteam 2',
            'Team Subteam 3',
            'Team Team 1',
            'Team Team 2',
            'Team Team 3'
            ],
            $map->values()
        );
    }

    public function testUnshift()
    {
        $list = TeamComment::get();
        $map = new Map($list, 'Name', 'Comment');

        $map->unshift(-1, '(All)');

        $this->assertEquals(
            [
            -1 => "(All)",
            "Joe" => "This is a team comment by Joe",
            "Bob" => "This is a team comment by Bob",
            "Phil" => "Phil is a unique guy, and comments on team2"],
            $map->toArray()
        );

        $map->unshift(0, '(Select)');

        $this->assertEquals('(All)', $map[-1]);
        $this->assertEquals('(Select)', $map[0]);

        $this->assertEquals(
            [
            0 => "(Select)",
            -1 => "(All)",
            "Joe" => "This is a team comment by Joe",
            "Bob" => "This is a team comment by Bob",
            "Phil" => "Phil is a unique guy, and comments on team2"],
            $map->toArray()
        );

        $map->unshift("Bob", "Replaced");
        $this->assertEquals(
            [
            "Bob" => "Replaced",
            0 => "(Select)",
            -1 => "(All)",
            "Joe" => "This is a team comment by Joe",
            "Phil" => "Phil is a unique guy, and comments on team2"],
            $map->toArray()
        );

        $map->unshift("Phil", "Replaced as well");
        $this->assertEquals(
            [
            "Phil" => "Replaced as well",
            "Bob" => "Replaced",
            0 => "(Select)",
            -1 => "(All)",
            "Joe" => "This is a team comment by Joe"],
            $map->toArray()
        );

        $map->unshift("Joe", "Replaced the last one");
        $this->assertEquals(
            [
            "Joe" => "Replaced the last one",
            "Phil" => "Replaced as well",
            "Bob" => "Replaced",
            0 => "(Select)",
            -1 => "(All)"],
            $map->toArray()
        );
    }

    public function testPush()
    {
        $list = TeamComment::get();
        $map = new Map($list, 'Name', 'Comment');

        $map->push(1, '(All)');

        $this->assertEquals(
            [
            "Joe" => "This is a team comment by Joe",
            "Bob" => "This is a team comment by Bob",
            "Phil" => "Phil is a unique guy, and comments on team2",
            1 => "(All)"
            ],
            $map->toArray()
        );
    }

    public function testCount()
    {
        $list = TeamComment::get();
        $map = new Map($list, 'Name', 'Comment');

        $this->assertEquals(3, $map->count());

        // pushing a new item should update the count
        $map->push(1, 'Item pushed');
        $this->assertEquals(4, $map->count());

        $map->unshift(2, 'Item shifted');
        $this->assertEquals(5, $map->count());

        $map = new Map(new ArrayList());
        $map->unshift('1', 'shifted');

        $this->assertEquals(1, $map->count());

        unset($map[1]);
        $this->assertEquals(0, $map->count());
    }

    public function testIterationWithUnshift()
    {
        $list = TeamComment::get()->sort('ID');
        $map = new Map($list, 'Name', 'Comment');
        $map->unshift(1, 'Unshifted');

        $text = "";

        foreach ($map as $k => $v) {
            $text .= "$k: $v\n";
        }

        $this->assertEquals(
            "1: Unshifted\n"
            . "Joe: This is a team comment by Joe\n"
            . "Bob: This is a team comment by Bob\n"
            . "Phil: Phil is a unique guy, and comments on team2\n",
            $text
        );
    }

    public function testIterationWithPush()
    {
        $list = TeamComment::get()->sort('ID');
        $map = new Map($list, 'Name', 'Comment');
        $map->push(1, 'Pushed');

        $text = "";

        foreach ($map as $k => $v) {
            $text .= "$k: $v\n";
        }

        $this->assertEquals(
            "Joe: This is a team comment by Joe\n"
            . "Bob: This is a team comment by Bob\n"
            . "Phil: Phil is a unique guy, and comments on team2\n"
            . "1: Pushed\n",
            $text
        );
    }

    public function testIterationWithEmptyListUnshifted()
    {
        $map = new Map(new ArrayList());
        $map->unshift('1', 'unshifted');

        $text = "";

        foreach ($map as $k => $v) {
            $text .= "$k: $v\n";
        }

        $this->assertEquals("1: unshifted\n", $text);
    }

    public function testIterationWithEmptyListPushed()
    {
        $map = new Map(new ArrayList());
        $map->push('1', 'pushed');

        $text = "";

        foreach ($map as $k => $v) {
            $text .= "$k: $v\n";
        }

        $this->assertEquals("1: pushed\n", $text);
    }
}