t/04_array.t

   1 ##
   2 # DBM::Deep Test
   3 ##
   4 use strict;
   5 use Test::More tests => 128;
   6 use Test::Exception;
   7 use t::common qw( new_fh );
   8
   9 use_ok( 'DBM::Deep' );
  10
  11 my ($fh, $filename) = new_fh();
  12 my $db = DBM::Deep->new(
  13     file => $filename,
  14     fh => $fh,
  15     type => DBM::Deep->TYPE_ARRAY
  16 );
  17
  18 ##
  19 # basic put/get/push
  20 ##
  21 $db->[0] = "elem1";
  22 #$db->push( "elem2" );
  23 #$db->put(2, "elem3");
  24 #$db->store(3, "elem4");
  25 warn $db->_engine->_dump_file;
  26 $db->unshift("elem0");
  27 warn $db->_engine->_dump_file;
  28 __END__
  29
  30 is( $db->[0], 'elem0', "Array get for shift works" );
  31 is( $db->[1], 'elem1', "Array get for array set works" );
  32 is( $db->[2], 'elem2', "Array get for push() works" );
  33 is( $db->[3], 'elem3', "Array get for put() works" );
  34 is( $db->[4], 'elem4', "Array get for store() works" );
  35
  36 is( $db->get(0), 'elem0', "get() for shift() works" );
  37 is( $db->get(1), 'elem1', "get() for array set works" );
  38 is( $db->get(2), 'elem2', "get() for push() works" );
  39 is( $db->get(3), 'elem3', "get() for put() works" );
  40 is( $db->get(4), 'elem4', "get() for store() works" );
  41
  42 is( $db->fetch(0), 'elem0', "fetch() for shift() works" );
  43 is( $db->fetch(1), 'elem1', "fetch() for array set works" );
  44 is( $db->fetch(2), 'elem2', "fetch() for push() works" );
  45 is( $db->fetch(3), 'elem3', "fetch() for put() works" );
  46 is( $db->fetch(4), 'elem4', "fetch() for store() works" );
  47
  48 is( $db->length, 5, "... and we have five elements" );
  49
  50 is( $db->[-1], $db->[4], "-1st index is 4th index" );
  51 is( $db->[-2], $db->[3], "-2nd index is 3rd index" );
  52 is( $db->[-3], $db->[2], "-3rd index is 2nd index" );
  53 is( $db->[-4], $db->[1], "-4th index is 1st index" );
  54 is( $db->[-5], $db->[0], "-5th index is 0th index" );
  55
  56 # This is for Perls older than 5.8.0 because of is()'s prototype
  57 { my $v = $db->[-6]; is( $v, undef, "-6th index is undef" ); }
  58
  59 is( $db->length, 5, "... and we have five elements after abortive -6 index lookup" );
  60
  61 $db->[-1] = 'elem4.1';
  62 is( $db->[-1], 'elem4.1' );
  63 is( $db->[4], 'elem4.1' );
  64 is( $db->get(4), 'elem4.1' );
  65 is( $db->fetch(4), 'elem4.1' );
  66
  67 throws_ok {
  68     $db->[-6] = 'whoops!';
  69 } qr/Modification of non-creatable array value attempted, subscript -6/, "Correct error thrown";
  70
  71 my $popped = $db->pop;
  72 is( $db->length, 4, "... and we have four after popping" );
  73 is( $db->[0], 'elem0', "0th element still there after popping" );
  74 is( $db->[1], 'elem1', "1st element still there after popping" );
  75 is( $db->[2], 'elem2', "2nd element still there after popping" );
  76 is( $db->[3], 'elem3', "3rd element still there after popping" );
  77 is( $popped, 'elem4.1', "Popped value is correct" );
  78
  79 my $shifted = $db->shift;
  80 is( $db->length, 3, "... and we have three after shifting" );
  81 is( $db->[0], 'elem1', "0th element still there after shifting" );
  82 is( $db->[1], 'elem2', "1st element still there after shifting" );
  83 is( $db->[2], 'elem3', "2nd element still there after shifting" );
  84 is( $db->[3], undef, "There is no third element now" );
  85 is( $shifted, 'elem0', "Shifted value is correct" );
  86
  87 ##
  88 # delete
  89 ##
  90 my $deleted = $db->delete(0);
  91 is( $db->length, 3, "... and we still have three after deleting" );
  92 is( $db->[0], undef, "0th element now undef" );
  93 is( $db->[1], 'elem2', "1st element still there after deleting" );
  94 is( $db->[2], 'elem3', "2nd element still there after deleting" );
  95 is( $deleted, 'elem1', "Deleted value is correct" );
  96
  97 is( $db->delete(99), undef, 'delete on an element not in the array returns undef' );
  98 is( $db->length, 3, "... and we still have three after a delete on an out-of-range index" );
  99
 100 is( delete $db->[99], undef, 'DELETE on an element not in the array returns undef' );
 101 is( $db->length, 3, "... and we still have three after a DELETE on an out-of-range index" );
 102
 103 is( $db->delete(-99), undef, 'delete on an element (neg) not in the array returns undef' );
 104 is( $db->length, 3, "... and we still have three after a DELETE on an out-of-range negative index" );
 105
 106 is( delete $db->[-99], undef, 'DELETE on an element (neg) not in the array returns undef' );
 107 is( $db->length, 3, "... and we still have three after a DELETE on an out-of-range negative index" );
 108
 109 $deleted = $db->delete(-2);
 110 is( $db->length, 3, "... and we still have three after deleting" );
 111 is( $db->[0], undef, "0th element still undef" );
 112 is( $db->[1], undef, "1st element now undef" );
 113 is( $db->[2], 'elem3', "2nd element still there after deleting" );
 114 is( $deleted, 'elem2', "Deleted value is correct" );
 115
 116 $db->[1] = 'elem2';
 117
 118 ##
 119 # exists
 120 ##
 121 ok( $db->exists(1), "The 1st value exists" );
 122 ok( $db->exists(0), "The 0th value doesn't exist" );
 123 ok( !$db->exists(22), "The 22nd value doesn't exists" );
 124 ok( $db->exists(-1), "The -1st value does exists" );
 125 ok( !$db->exists(-22), "The -22nd value doesn't exists" );
 126
 127 ##
 128 # clear
 129 ##
 130 ok( $db->clear(), "clear() returns true if the file was ever non-empty" );
 131 is( $db->length(), 0, "After clear(), no more elements" );
 132
 133 is( $db->pop, undef, "pop on an empty array returns undef" );
 134 is( $db->length(), 0, "After pop() on empty array, length is still 0" );
 135
 136 is( $db->shift, undef, "shift on an empty array returns undef" );
 137 is( $db->length(), 0, "After shift() on empty array, length is still 0" );
 138
 139 is( $db->unshift( 1, 2, 3 ), 3, "unshift returns the number of elements in the array" );
 140 is( $db->unshift( 1, 2, 3 ), 6, "unshift returns the number of elements in the array" );
 141 is( $db->push( 1, 2, 3 ), 9, "push returns the number of elements in the array" );
 142
 143 is( $db->length(), 9, "After unshift and push on empty array, length is now 9" );
 144
 145 $db->clear;
 146
 147 ##
 148 # multi-push
 149 ##
 150 $db->push( 'elem first', "elem middle", "elem last" );
 151 is( $db->length, 3, "3-element push results in three elements" );
 152 is($db->[0], "elem first", "First element is 'elem first'");
 153 is($db->[1], "elem middle", "Second element is 'elem middle'");
 154 is($db->[2], "elem last", "Third element is 'elem last'");
 155
 156 ##
 157 # splice with length 1
 158 ##
 159 my @returned = $db->splice( 1, 1, "middle A", "middle B" );
 160 is( scalar(@returned), 1, "One element was removed" );
 161 is( $returned[0], 'elem middle', "... and it was correctly removed" );
 162 is($db->length(), 4);
 163 is($db->[0], "elem first");
 164 is($db->[1], "middle A");
 165 is($db->[2], "middle B");
 166 is($db->[3], "elem last");
 167
 168 ##
 169 # splice with length of 0
 170 ##
 171 @returned = $db->splice( -1, 0, "middle C" );
 172 is( scalar(@returned), 0, "No elements were removed" );
 173 is($db->length(), 5);
 174 is($db->[0], "elem first");
 175 is($db->[1], "middle A");
 176 is($db->[2], "middle B");
 177 is($db->[3], "middle C");
 178 is($db->[4], "elem last");
 179
 180 ##
 181 # splice with length of 3
 182 ##
 183 my $returned = $db->splice( 1, 3, "middle ABC" );
 184 is( $returned, 'middle C', "Just the last element was returned" );
 185 is($db->length(), 3);
 186 is($db->[0], "elem first");
 187 is($db->[1], "middle ABC");
 188 is($db->[2], "elem last");
 189
 190 @returned = $db->splice( 1 );
 191 is($db->length(), 1);
 192 is($db->[0], "elem first");
 193 is($returned[0], "middle ABC");
 194 is($returned[1], "elem last");
 195
 196 $db->push( @returned );
 197
 198 @returned = $db->splice( 1, -1 );
 199 is($db->length(), 2);
 200 is($db->[0], "elem first");
 201 is($db->[1], "elem last");
 202 is($returned[0], "middle ABC");
 203
 204 @returned = $db->splice;
 205 is( $db->length, 0 );
 206 is( $returned[0], "elem first" );
 207 is( $returned[1], "elem last" );
 208
 209 $db->[0] = [ 1 .. 3 ];
 210 $db->[1] = { a => 'foo' };
 211 is( $db->[0]->length, 3, "Reuse of same space with array successful" );
 212 is( $db->[1]->fetch('a'), 'foo', "Reuse of same space with hash successful" );
 213
 214 # Test autovivification
 215 $db->[9999]{bar} = 1;
 216 ok( $db->[9999] );
 217 cmp_ok( $db->[9999]{bar}, '==', 1 );
 218
 219 # Test failures
 220 throws_ok {
 221     $db->fetch( 'foo' );
 222 } qr/Cannot use 'foo' as an array index/, "FETCH fails on an illegal key";
 223
 224 throws_ok {
 225     $db->fetch();
 226 } qr/Cannot use an undefined array index/, "FETCH fails on an undefined key";
 227
 228 throws_ok {
 229     $db->store( 'foo', 'bar' );
 230 } qr/Cannot use 'foo' as an array index/, "STORE fails on an illegal key";
 231
 232 throws_ok {
 233     $db->store();
 234 } qr/Cannot use an undefined array index/, "STORE fails on an undefined key";
 235
 236 throws_ok {
 237     $db->delete( 'foo' );
 238 } qr/Cannot use 'foo' as an array index/, "DELETE fails on an illegal key";
 239
 240 throws_ok {
 241     $db->delete();
 242 } qr/Cannot use an undefined array index/, "DELETE fails on an undefined key";
 243
 244 throws_ok {
 245     $db->exists( 'foo' );
 246 } qr/Cannot use 'foo' as an array index/, "EXISTS fails on an illegal key";
 247
 248 throws_ok {
 249     $db->exists();
 250 } qr/Cannot use an undefined array index/, "EXISTS fails on an undefined key";
 251
 252 # Bug reported by Mike Schilli
 253 # Also, RT #29583 reported by HANENKAMP
 254 {
 255     my ($fh, $filename) = new_fh();
 256     my $db = DBM::Deep->new(
 257         file => $filename,
 258         fh => $fh,
 259         type => DBM::Deep->TYPE_ARRAY
 260     );
 261
 262     push @{$db}, 3, { foo => 1 };
 263     lives_ok {
 264         shift @{$db};
 265     } "Shift doesn't die moving references around";
 266     is( $db->[0]{foo}, 1, "Right hashref there" );
 267
 268     lives_ok {
 269         unshift @{$db}, [ 1 .. 3, [ 1 .. 3 ] ];
 270         unshift @{$db}, 1;
 271     } "Unshift doesn't die moving references around";
 272     is( $db->[1][3][1], 2, "Right arrayref there" );
 273     is( $db->[2]{foo}, 1, "Right hashref there" );
 274
 275     # Add test for splice moving references around
 276     lives_ok {
 277         splice @{$db}, 0, 0, 1 .. 3;
 278     } "Splice doesn't die moving references around";
 279     is( $db->[4][3][1], 2, "Right arrayref there" );
 280     is( $db->[5]{foo}, 1, "Right hashref there" );
 281 }