t/04_array.t

   1 ##
   2 # DBM::Deep Test
   3 ##
   4 use strict;
   5 use Test::More tests => 107;
   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 $db->[-1] = 'elem4.1';
  65 is( $db->[-1], 'elem4.1' );
  66 is( $db->[4], 'elem4.1' );
  67 is( $db->get(4), 'elem4.1' );
  68 is( $db->fetch(4), 'elem4.1' );
  69
  70 throws_ok {
  71     $db->[-6] = 'whoops!';
  72 } qr/Modification of non-creatable array value attempted, subscript -6/, "Correct error thrown";
  73
  74 my $popped = $db->pop;
  75 is( $db->length, 4, "... and we have four after popping" );
  76 is( $db->[0], 'elem0', "0th element still there after popping" );
  77 is( $db->[1], 'elem1', "1st element still there after popping" );
  78 is( $db->[2], 'elem2', "2nd element still there after popping" );
  79 is( $db->[3], 'elem3', "3rd element still there after popping" );
  80 is( $popped, 'elem4.1', "Popped value is correct" );
  81
  82 my $shifted = $db->shift;
  83 is( $db->length, 3, "... and we have three after shifting" );
  84 is( $db->[0], 'elem1', "0th element still there after shifting" );
  85 is( $db->[1], 'elem2', "1st element still there after shifting" );
  86 is( $db->[2], 'elem3', "2nd element still there after shifting" );
  87 is( $shifted, 'elem0', "Shifted value is correct" );
  88
  89 ##
  90 # delete
  91 ##
  92 my $deleted = $db->delete(0);
  93 is( $db->length, 3, "... and we still have three after deleting" );
  94 is( $db->[0], undef, "0th element now undef" );
  95 is( $db->[1], 'elem2', "1st element still there after deleting" );
  96 is( $db->[2], 'elem3', "2nd element still there after deleting" );
  97 is( $deleted, 'elem1', "Deleted value is correct" );
  98
  99 is( $db->delete(99), undef, 'delete on an element not in the array returns undef' );
 100 is( $db->length, 3, "... and we still have three after a delete on an out-of-range index" );
 101
 102 is( delete $db->[99], undef, 'DELETE on an element not in the array returns undef' );
 103 is( $db->length, 3, "... and we still have three after a DELETE on an out-of-range index" );
 104
 105 is( $db->delete(-99), undef, 'delete on an element (neg) not in the array returns undef' );
 106 is( $db->length, 3, "... and we still have three after a DELETE on an out-of-range negative index" );
 107
 108 is( delete $db->[-99], undef, 'DELETE on an element (neg) not in the array returns undef' );
 109 is( $db->length, 3, "... and we still have three after a DELETE on an out-of-range negative index" );
 110
 111 $deleted = $db->delete(-2);
 112 is( $db->length, 3, "... and we still have three after deleting" );
 113 is( $db->[0], undef, "0th element still undef" );
 114 is( $db->[1], undef, "1st element now undef" );
 115 is( $db->[2], 'elem3', "2nd element still there after deleting" );
 116 is( $deleted, 'elem2', "Deleted value is correct" );
 117
 118 $db->[1] = 'elem2';
 119
 120 ##
 121 # exists
 122 ##
 123 ok( $db->exists(1), "The 1st value exists" );
 124 ok( !$db->exists(0), "The 0th value doesn't exists" );
 125 ok( !$db->exists(22), "The 22nd value doesn't exists" );
 126 ok( $db->exists(-1), "The -1st value does exists" );
 127 ok( !$db->exists(-22), "The -22nd value doesn't exists" );
 128
 129 ##
 130 # clear
 131 ##
 132 ok( $db->clear(), "clear() returns true if the file was ever non-empty" );
 133 is( $db->length(), 0, "After clear(), no more elements" );
 134
 135 is( $db->pop, undef, "pop on an empty array returns undef" );
 136 is( $db->length(), 0, "After pop() on empty array, length is still 0" );
 137
 138 is( $db->shift, undef, "shift on an empty array returns undef" );
 139 is( $db->length(), 0, "After shift() on empty array, length is still 0" );
 140
 141 is( $db->unshift( 1, 2, 3 ), 3, "unshift returns the number of elements in the array" );
 142 is( $db->unshift( 1, 2, 3 ), 6, "unshift returns the number of elements in the array" );
 143 is( $db->push( 1, 2, 3 ), 9, "push returns the number of elements in the array" );
 144
 145 is( $db->length(), 9, "After unshift and push on empty array, length is now 9" );
 146
 147 $db->clear;
 148
 149 ##
 150 # multi-push
 151 ##
 152 $db->push( 'elem first', "elem middle", "elem last" );
 153 is( $db->length, 3, "3-element push results in three elements" );
 154 is($db->[0], "elem first", "First element is 'elem first'");
 155 is($db->[1], "elem middle", "Second element is 'elem middle'");
 156 is($db->[2], "elem last", "Third element is 'elem last'");
 157
 158 ##
 159 # splice with length 1
 160 ##
 161 my @returned = $db->splice( 1, 1, "middle A", "middle B" );
 162 is( scalar(@returned), 1, "One element was removed" );
 163 is( $returned[0], 'elem middle', "... and it was correctly removed" );
 164 is($db->length(), 4);
 165 is($db->[0], "elem first");
 166 is($db->[1], "middle A");
 167 is($db->[2], "middle B");
 168 is($db->[3], "elem last");
 169
 170 ##
 171 # splice with length of 0
 172 ##
 173 @returned = $db->splice( -1, 0, "middle C" );
 174 is( scalar(@returned), 0, "No elements were removed" );
 175 is($db->length(), 5);
 176 is($db->[0], "elem first");
 177 is($db->[1], "middle A");
 178 is($db->[2], "middle B");
 179 is($db->[3], "middle C");
 180 is($db->[4], "elem last");
 181
 182 ##
 183 # splice with length of 3
 184 ##
 185 my $returned = $db->splice( 1, 3, "middle ABC" );
 186 is( $returned, 'middle C', "Just the last element was returned" );
 187 is($db->length(), 3);
 188 is($db->[0], "elem first");
 189 is($db->[1], "middle ABC");
 190 is($db->[2], "elem last");
 191
 192 @returned = $db->splice( 1 );
 193 is($db->length(), 1);
 194 is($db->[0], "elem first");
 195 is($returned[0], "middle ABC");
 196 is($returned[1], "elem last");
 197
 198 $db->push( @returned );
 199
 200 @returned = $db->splice( 1, -1 );
 201 is($db->length(), 2);
 202 is($db->[0], "elem first");
 203 is($db->[1], "elem last");
 204 is($returned[0], "middle ABC");
 205
 206 # These tests verify that the hash methods cannot be called on arraytypes.
 207 # They will be removed once the ARRAY and HASH types are refactored into their own classes.
 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" );