File: SetTest.php

package info (click to toggle)
php-ramsey-collection 2.0.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 612 kB
  • sloc: php: 3,239; xml: 31; makefile: 22
file content (184 lines) | stat: -rw-r--r-- 5,858 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
<?php

declare(strict_types=1);

namespace Ramsey\Collection\Test;

use Ramsey\Collection\AbstractSet;
use Ramsey\Collection\CollectionInterface;
use Ramsey\Collection\Set;
use Ramsey\Collection\Test\Mock\Foo;

/**
 * Tests for Set class.
 *
 * As Set is a Collection with no duplicated elements
 * it only test the expected behavior.
 */
class SetTest extends TestCase
{
    /** @var Set<int> */
    private Set $set;

    protected function setUp(): void
    {
        parent::setUp();

        $this->set = new Set('int');
    }

    public function testConstructorInheritance(): void
    {
        $this->assertInstanceOf(CollectionInterface::class, $this->set);
        $this->assertInstanceOf(AbstractSet::class, $this->set);
    }

    public function testConstructGetType(): void
    {
        $this->assertSame('int', $this->set->getType());
    }

    public function testConstructWithValues(): void
    {
        $expected = [2, 4, 6, 8];
        $localSet = new Set('int', $expected);
        $this->assertSame($expected, $localSet->toArray());
    }

    public function testAddDuplicates(): void
    {
        $this->assertTrue($this->set->add(100));
        $this->assertFalse($this->set->add(100));
        $this->assertSame([100], $this->set->toArray());
    }

    public function testOffsetSetDuplicates(): void
    {
        $this->set[] = 100;
        $this->set[] = 100;
        $this->assertSame([100], $this->set->toArray());
    }

    public function testUsingEqualButNotIdentical(): void
    {
        /** @var Set<Foo> $uniqueFoos */
        $uniqueFoos = new Set(Foo::class);

        // the comparisons are identical (===), not equal(==)
        $this->assertTrue($uniqueFoos->add(new Foo()));
        $this->assertTrue($uniqueFoos->add(new Foo()));
    }

    public function testUsingIdentical(): void
    {
        /** @var Set<Foo> $uniqueFoos */
        $uniqueFoos = new Set(Foo::class);

        // the comparisons are identical (===), not equal(==)
        $identical = new Foo();
        $this->assertTrue($uniqueFoos->add($identical));
        $this->assertFalse($uniqueFoos->add($identical));
    }

    public function testMergingSets(): void
    {
        /** @var Set<string> $set1 */
        $set1 = new Set('string', ['X', 'Y']);

        /** @var Set<string> $set2 */
        $set2 = new Set('string', ['Y', 'Z']);

        /** @var Set<string> $set3 */
        $set3 = $set1->merge($set2);

        $this->assertSame(['X', 'Y', 'Z'], $set3->toArray());
    }

    public function testMergingSetsOfObjects(): void
    {
        $obj1 = new Foo();
        $obj2 = new Foo();
        $obj3 = new Foo();

        $set1 = new Set(Foo::class, [$obj1, $obj2]);
        $set2 = new Set(Foo::class, [$obj2, $obj3]);
        $set3 = $set1->merge($set2);

        $this->assertSame([$obj1, $obj2, $obj3], $set3->toArray());
    }

    /**
     * Sets don't normally have keys...
     *
     * If a set has keys, when attempting to add a value that a set already
     * contains, even if the key is different, the new value cannot be added
     * because a set cannot contain duplicate values.
     *
     * In this test, the resulting merged set does not contain the "c" key
     * because the set already contains $obj2 when it attempts to add $obj2
     * again.
     */
    public function testMergingSetsOfObjectsWithKeysAlternate1(): void
    {
        $obj1 = new Foo();
        $obj2 = new Foo();
        $obj3 = new Foo();

        $set1 = new Set(Foo::class, ['a' => $obj1, 'b' => $obj2]);
        $set2 = new Set(Foo::class, ['c' => $obj2, 'd' => $obj3]);
        $set3 = $set1->merge($set2);

        $this->assertSame(['a' => $obj1, 'b' => $obj2, 'd' => $obj3], $set3->toArray());
    }

    /**
     * Sets don't normally have keys...
     *
     * According to standard array merging rules, later values for the same
     * string keys will overwrite previous ones. This rule is in effect here,
     * but with a set, this can also cause loss of data, depending on the order
     * of the values being merged.
     *
     * In this test, $obj2 does not appear in the merged collection because of
     * the order in which the merging occurs. First, $obj2 is found at key "b."
     * When merging the second set, we see $obj2 at key "c," but we find that
     * our set already contains $obj2, so we don't try to add it again. Then, we
     * merge $obj3 to the key "b," which overwrites $obj2.
     */
    public function testMergingSetsOfObjectsWithKeysAlternate2(): void
    {
        $obj1 = new Foo();
        $obj2 = new Foo();
        $obj3 = new Foo();

        $set1 = new Set(Foo::class, ['a' => $obj1, 'b' => $obj2]);
        $set2 = new Set(Foo::class, ['c' => $obj2, 'b' => $obj3]);
        $set3 = $set1->merge($set2);

        $this->assertSame(['a' => $obj1, 'b' => $obj3], $set3->toArray());
    }

    /**
     * Sets don't normally have keys...
     *
     * This test shows how order can affect behavior when merging. It is very
     * similar to {@see SetTest::testMergingSetsOfObjectsWithKeysAlternate2()},
     * but $set2 now contains keys "b" and "c" in alphabetical order, so when
     * merging, $obj3 is stored to key "b" and overwrites $obj2 that was
     * previously stored there. When we encounter key "c" (which also has $obj2),
     * this value no longer exists in the merged array, so can add it, and there
     * won't be a duplicate.
     */
    public function testMergingSetsOfObjectsWithKeysAlternate3(): void
    {
        $obj1 = new Foo();
        $obj2 = new Foo();
        $obj3 = new Foo();

        $set1 = new Set(Foo::class, ['a' => $obj1, 'b' => $obj2]);
        $set2 = new Set(Foo::class, ['b' => $obj3, 'c' => $obj2]);
        $set3 = $set1->merge($set2);

        $this->assertSame(['a' => $obj1, 'b' => $obj3, 'c' => $obj2], $set3->toArray());
    }
}