Started to make negative array indices work
[dbsrgits/DBM-Deep.git] / t / 04_array.t
1 ##
2 # DBM::Deep Test
3 ##
4 use strict;
5 use Test::More tests => 90;
6 use Test::Exception;
7
8 use_ok( 'DBM::Deep' );
9
10 ##
11 # basic file open
12 ##
13 unlink "t/test.db";
14 my $db = DBM::Deep->new(
15         file => "t/test.db",
16         type => DBM::Deep->TYPE_ARRAY
17 );
18 if ($db->error()) {
19         die "ERROR: " . $db->error();
20 }
21
22 TODO: {
23     local $TODO = "How is this test ever supposed to pass?";
24     ok( !$db->clear, "If the file has never been written to, clear() returns false" );
25 }
26
27 ##
28 # basic put/get/push
29 ##
30 $db->[0] = "elem1";
31 $db->push( "elem2" );
32 $db->put(2, "elem3");
33 $db->store(3, "elem4");
34 $db->unshift("elem0");
35
36 is( $db->[0], 'elem0', "Array get for shift works" );
37 is( $db->[1], 'elem1', "Array get for array set works" );
38 is( $db->[2], 'elem2', "Array get for push() works" );
39 is( $db->[3], 'elem3', "Array get for put() works" );
40 is( $db->[4], 'elem4', "Array get for store() works" );
41
42 is( $db->get(0), 'elem0', "get() for shift() works" );
43 is( $db->get(1), 'elem1', "get() for array set works" );
44 is( $db->get(2), 'elem2', "get() for push() works" );
45 is( $db->get(3), 'elem3', "get() for put() works" );
46 is( $db->get(4), 'elem4', "get() for store() works" );
47
48 is( $db->fetch(0), 'elem0', "fetch() for shift() works" );
49 is( $db->fetch(1), 'elem1', "fetch() for array set works" );
50 is( $db->fetch(2), 'elem2', "fetch() for push() works" );
51 is( $db->fetch(3), 'elem3', "fetch() for put() works" );
52 is( $db->fetch(4), 'elem4', "fetch() for store() works" );
53
54 is( $db->length, 5, "... and we have five elements" );
55
56 is( $db->[-1], $db->[4], "-1st index is 4th index" );
57 is( $db->[-2], $db->[3], "-2nd index is 3rd index" );
58 is( $db->[-3], $db->[2], "-3rd index is 2nd index" );
59 is( $db->[-4], $db->[1], "-4th index is 1st index" );
60 is( $db->[-5], $db->[0], "-5th index is 0th index" );
61 is( $db->[-6], undef, "-6th index is undef" );
62 is( $db->length, 5, "... and we have five elements after abortive -6 index lookup" );
63
64 my $popped = $db->pop;
65 is( $db->length, 4, "... and we have four after popping" );
66 is( $db->[0], 'elem0', "0th element still there after popping" );
67 is( $db->[1], 'elem1', "1st element still there after popping" );
68 is( $db->[2], 'elem2', "2nd element still there after popping" );
69 is( $db->[3], 'elem3', "3rd element still there after popping" );
70 is( $popped, 'elem4', "Popped value is correct" );
71
72 my $shifted = $db->shift;
73 is( $db->length, 3, "... and we have three after shifting" );
74 is( $db->[0], 'elem1', "0th element still there after shifting" );
75 is( $db->[1], 'elem2', "1st element still there after shifting" );
76 is( $db->[2], 'elem3', "2nd element still there after shifting" );
77 is( $shifted, 'elem0', "Shifted value is correct" );
78
79 ##
80 # delete
81 ##
82 my $deleted = $db->delete(0);
83 is( $db->length, 3, "... and we still have three after deleting" );
84 is( $db->[0], undef, "0th element now undef" );
85 is( $db->[1], 'elem2', "1st element still there after deleting" );
86 is( $db->[2], 'elem3', "2nd element still there after deleting" );
87 is( $deleted, 'elem1', "Deleted value is correct" );
88
89 is( $db->delete(99), undef, 'delete on an element not in the array returns undef' );
90 is( $db->length, 3, "... and we still have three after a delete on an out-of-range index" );
91
92 is( delete $db->[99], undef, 'DELETE on an element not in the array returns undef' );
93 is( $db->length, 3, "... and we still have three after a DELETE on an out-of-range index" );
94
95 is( $db->delete(-99), undef, 'delete on an element (neg) not in the array returns undef' );
96 is( $db->length, 3, "... and we still have three after a DELETE on an out-of-range negative index" );
97
98 is( delete $db->[-99], undef, 'DELETE on an element (neg) not in the array returns undef' );
99 is( $db->length, 3, "... and we still have three after a DELETE on an out-of-range negative index" );
100
101 $deleted = $db->delete(-2);
102 is( $db->length, 3, "... and we still have three after deleting" );
103 is( $db->[0], undef, "0th element still undef" );
104 TODO: {
105     local $TODO = "delete on a negative array element should work";
106     is( $db->[1], undef, "1st element now undef" );
107 }
108 is( $db->[2], 'elem3', "2nd element still there after deleting" );
109 TODO: {
110     local $TODO = "delete on a negative array element should return the deleted value";
111     is( $deleted, 'elem2', "Deleted value is correct" );
112 }
113
114 $db->[1] = 'elem2';
115
116 ##
117 # exists
118 ##
119 ok( $db->exists(1), "The 1st value exists" );
120 ok( !$db->exists(0), "The 0th value doesn't exists" );
121 ok( !$db->exists(22), "The 22nd value doesn't exists" );
122 TODO: {
123     local $TODO = "exists on negative values should work";
124     ok( $db->exists(-1), "The -1st value does exists" );
125 }
126 ok( !$db->exists(-22), "The -22nd value doesn't exists" );
127
128 ##
129 # clear
130 ##
131 ok( $db->clear(), "clear() returns true if the file was ever non-empty" );
132 is( $db->length(), 0, "After clear(), no more elements" );
133
134 is( $db->pop, undef, "pop on an empty array returns undef" );
135 is( $db->length(), 0, "After pop() on empty array, length is still 0" );
136
137 is( $db->shift, undef, "shift on an empty array returns undef" );
138 is( $db->length(), 0, "After shift() on empty array, length is still 0" );
139
140 is( $db->unshift( 1, 2, 3 ), 3, "unshift returns the number of elements in the array" );
141 is( $db->unshift( 1, 2, 3 ), 6, "unshift returns the number of elements in the array" );
142 is( $db->push( 1, 2, 3 ), 9, "push returns the number of elements in the array" );
143
144 is( $db->length(), 9, "After unshift and push on empty array, length is now 9" );
145
146 $db->clear;
147
148 ##
149 # multi-push
150 ##
151 $db->push( 'elem first', "elem middle", "elem last" );
152 is( $db->length, 3, "3-element push results in three elements" );
153 is($db->[0], "elem first", "First element is 'elem first'");
154 is($db->[1], "elem middle", "Second element is 'elem middle'");
155 is($db->[2], "elem last", "Third element is 'elem last'");
156
157 ##
158 # splice with length 1
159 ##
160 $db->splice( 1, 1, "middle A", "middle B" );
161 is($db->length(), 4);
162 is($db->[0], "elem first");
163 is($db->[1], "middle A");
164 is($db->[2], "middle B");
165 is($db->[3], "elem last");
166
167 ##
168 # splice with length of 0
169 ##
170 $db->splice( -1, 0, "middle C" );
171 is($db->length(), 5);
172 is($db->[0], "elem first");
173 is($db->[1], "middle A");
174 is($db->[2], "middle B");
175 is($db->[3], "middle C");
176 is($db->[4], "elem last");
177
178 ##
179 # splice with length of 3
180 ##
181 $db->splice( 1, 3, "middle ABC" );
182 is($db->length(), 3);
183 is($db->[0], "elem first");
184 is($db->[1], "middle ABC");
185 is($db->[2], "elem last");
186
187 # These tests verify that the hash methods cannot be called on arraytypes.
188 # They will be removed once the ARRAY and HASH types are refactored into their own classes.
189
190 $db->[0] = [ 1 .. 3 ];
191 $db->[1] = { a => 'foo' };
192 is( $db->[0]->length, 3, "Reuse of same space with array successful" );
193 is( $db->[1]->fetch('a'), 'foo', "Reuse of same space with hash successful" );