facebook / facebook-php-sdk-v4

tests/GraphNodes/CollectionTest.php

<?php
/**
 * Copyright 2016 Facebook, Inc.
 *
 * You are hereby granted a non-exclusive, worldwide, royalty-free license to
 * use, copy, modify, and distribute this software in source code or binary
 * form for use in connection with the web services and APIs provided by
 * Facebook.
 *
 * As with any software that integrates with the Facebook platform, your use
 * of this software is subject to the Facebook Developer Principles and
 * Policies [http://developers.facebook.com/policy/]. This copyright notice
 * shall be included in all copies or substantial portions of the software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 *
 */
namespace Facebook\Tests\GraphNodes;

use Facebook\GraphNodes\Collection;

class CollectionTest extends \PHPUnit_Framework_TestCase
{

    public function testAnExistingPropertyCanBeAccessed()

This method seems to be duplicated in your project.

    {
        $graphNode = new Collection(['foo' => 'bar']);

        $field = $graphNode->getField('foo');
        $this->assertEquals('bar', $field);

        // @todo v6: Remove this assertion
        $property = $graphNode->getProperty('foo');

The method Facebook\GraphNodes\Collection::getProperty() has been deprecated with message: 5.0.0 getProperty() has been renamed to getField()

        $this->assertEquals('bar', $property);
    }

    public function testAMissingPropertyWillReturnNull()
    {
        $graphNode = new Collection(['foo' => 'bar']);
        $field = $graphNode->getField('baz');

        $this->assertNull($field, 'Expected the property to return null.');
    }

    public function testAMissingPropertyWillReturnTheDefault()

This method seems to be duplicated in your project.

    {
        $graphNode = new Collection(['foo' => 'bar']);

        $field = $graphNode->getField('baz', 'faz');
        $this->assertEquals('faz', $field);

        // @todo v6: Remove this assertion
        $property = $graphNode->getProperty('baz', 'faz');

The method Facebook\GraphNodes\Collection::getProperty() has been deprecated with message: 5.0.0 getProperty() has been renamed to getField()

        $this->assertEquals('faz', $property);
    }

    public function testFalseDefaultsWillReturnSameType()
    {
        $graphNode = new Collection(['foo' => 'bar']);

        $field = $graphNode->getField('baz', '');
        $this->assertSame('', $field);

        $field = $graphNode->getField('baz', 0);
        $this->assertSame(0, $field);

        $field = $graphNode->getField('baz', false);
        $this->assertSame(false, $field);
    }

    public function testTheKeysFromTheCollectionCanBeReturned()
    {
        $graphNode = new Collection([
            'key1' => 'foo',
            'key2' => 'bar',
            'key3' => 'baz',
        ]);

        $fieldNames = $graphNode->getFieldNames();
        $this->assertEquals(['key1', 'key2', 'key3'], $fieldNames);

        // @todo v6: Remove this assertion
        $propertyNames = $graphNode->getPropertyNames();

The method Facebook\GraphNodes\Collection::getPropertyNames() has been deprecated with message: 5.0.0 getPropertyNames() has been renamed to getFieldNames()

        $this->assertEquals(['key1', 'key2', 'key3'], $propertyNames);
    }

    public function testAnArrayCanBeInjectedViaTheConstructor()
    {
        $collection = new Collection(['foo', 'bar']);
        $this->assertEquals(['foo', 'bar'], $collection->asArray());
    }

    public function testACollectionCanBeConvertedToProperJson()
    {
        $collection = new Collection(['foo', 'bar', 123]);

        $collectionAsString = $collection->asJson();

        $this->assertEquals('["foo","bar",123]', $collectionAsString);
    }

    public function testACollectionCanBeCounted()
    {
        $collection = new Collection(['foo', 'bar', 'baz']);

        $collectionCount = count($collection);

        $this->assertEquals(3, $collectionCount);
    }

    public function testACollectionCanBeAccessedAsAnArray()
    {
        $collection = new Collection(['foo' => 'bar', 'faz' => 'baz']);

        $this->assertEquals('bar', $collection['foo']);
        $this->assertEquals('baz', $collection['faz']);
    }

    public function testACollectionCanBeIteratedOver()
    {
        $collection = new Collection(['foo' => 'bar', 'faz' => 'baz']);

        $this->assertInstanceOf('IteratorAggregate', $collection);

        $newArray = [];

        foreach ($collection as $k => $v) {
            $newArray[$k] = $v;
        }

        $this->assertEquals(['foo' => 'bar', 'faz' => 'baz'], $newArray);
    }
}