decf151b671751c847ee0ab87272b6a4c989d0ef
[gitmo/Moose.git] / t / 070_native_traits / 010_trait_array.t
1 #!/usr/bin/perl
2
3 use strict;
4 use warnings;
5
6 use lib 't/lib';
7
8 use Moose ();
9 use Moose::Util::TypeConstraints;
10 use NoInlineAttribute;
11 use Test::More;
12 use Test::Fatal;
13 use Test::Moose;
14
15 {
16     my %handles = (
17         count    => 'count',
18         elements => 'elements',
19         is_empty => 'is_empty',
20         push     => 'push',
21         push_curried =>
22             [ push => 42, 84 ],
23         unshift => 'unshift',
24         unshift_curried =>
25             [ unshift => 42, 84 ],
26         pop           => 'pop',
27         shift         => 'shift',
28         get           => 'get',
29         get_curried   => [ get => 1 ],
30         set           => 'set',
31         set_curried_1 => [ set => 1 ],
32         set_curried_2 => [ set => ( 1, 98 ) ],
33         accessor      => 'accessor',
34         accessor_curried_1 => [ accessor => 1 ],
35         accessor_curried_2 => [ accessor => ( 1, 90 ) ],
36         clear          => 'clear',
37         delete         => 'delete',
38         delete_curried => [ delete => 1 ],
39         insert         => 'insert',
40         insert_curried => [ insert => ( 1, 101 ) ],
41         splice         => 'splice',
42         splice_curried_1   => [ splice => 1 ],
43         splice_curried_2   => [ splice => 1, 2 ],
44         splice_curried_all => [ splice => 1, 2, ( 3, 4, 5 ) ],
45         sort          => 'sort',
46         sort_curried  => [ sort => ( sub { $_[1] <=> $_[0] } ) ],
47         sort_in_place => 'sort_in_place',
48         sort_in_place_curried =>
49             [ sort_in_place => ( sub { $_[1] <=> $_[0] } ) ],
50         map           => 'map',
51         map_curried   => [ map => ( sub { $_ + 1 } ) ],
52         grep          => 'grep',
53         grep_curried  => [ grep => ( sub { $_ < 5 } ) ],
54         first         => 'first',
55         first_curried => [ first => ( sub { $_ % 2 } ) ],
56         join          => 'join',
57         join_curried => [ join => '-' ],
58         shuffle      => 'shuffle',
59         uniq         => 'uniq',
60         reduce       => 'reduce',
61         reduce_curried => [ reduce => ( sub { $_[0] * $_[1] } ) ],
62         natatime       => 'natatime',
63         natatime_curried => [ natatime => 2 ],
64     );
65
66     my $name = 'Foo1';
67
68     sub build_class {
69         my %attr = @_;
70
71         my $class = Moose::Meta::Class->create(
72             $name++,
73             superclasses => ['Moose::Object'],
74         );
75
76         my @traits = 'Array';
77         push @traits, 'NoInlineAttribute'
78             if delete $attr{no_inline};
79
80         $class->add_attribute(
81             _values => (
82                 traits  => \@traits,
83                 is      => 'rw',
84                 isa     => 'ArrayRef[Int]',
85                 default => sub { [] },
86                 handles => \%handles,
87                 clearer => '_clear_values',
88                 %attr,
89             ),
90         );
91
92         return ( $class->name, \%handles );
93     }
94 }
95
96 {
97     package Overloader;
98
99     use overload
100         '&{}' => sub { ${ $_[0] } },
101         bool  => sub {1};
102
103     sub new {
104         bless \$_[1], $_[0];
105     }
106 }
107
108 {
109     run_tests(build_class);
110     run_tests( build_class( lazy => 1, default => sub { [ 42, 84 ] } ) );
111     run_tests( build_class( trigger => sub { } ) );
112     run_tests( build_class( no_inline => 1 ) );
113
114     # Will force the inlining code to check the entire arrayref when it is modified.
115     subtype 'MyArrayRef', as 'ArrayRef', where { 1 };
116
117     run_tests( build_class( isa => 'MyArrayRef' ) );
118
119     coerce 'MyArrayRef', from 'ArrayRef', via { $_ };
120
121     run_tests( build_class( isa => 'MyArrayRef', coerce => 1 ) );
122 }
123
124 sub run_tests {
125     my ( $class, $handles ) = @_;
126
127     can_ok( $class, $_ ) for sort keys %{$handles};
128
129     with_immutable {
130         my $obj = $class->new( _values => [ 10, 12, 42 ] );
131
132         is_deeply(
133             $obj->_values, [ 10, 12, 42 ],
134             'values can be set in constructor'
135         );
136
137         ok( !$obj->is_empty, 'values is not empty' );
138         is( $obj->count, 3, 'count returns 3' );
139
140         like( exception { $obj->count(22) }, qr/Cannot call count with any arguments/, 'throws an error when passing an argument passed to count' );
141
142         is( exception { $obj->push( 1, 2, 3 ) }, undef, 'pushed three new values and lived' );
143
144         is( exception { $obj->push() }, undef, 'call to push without arguments lives' );
145
146         is( exception {
147             is( $obj->unshift( 101, 22 ), 8,
148                 'unshift returns size of the new array' );
149         }, undef, 'unshifted two values and lived' );
150
151         is_deeply(
152             $obj->_values, [ 101, 22, 10, 12, 42, 1, 2, 3 ],
153             'unshift changed the value of the array in the object'
154         );
155
156         is( exception { $obj->unshift() }, undef, 'call to unshift without arguments lives' );
157
158         is( $obj->pop, 3, 'pop returns the last value in the array' );
159
160         is_deeply(
161             $obj->_values, [ 101, 22, 10, 12, 42, 1, 2 ],
162             'pop changed the value of the array in the object'
163         );
164
165         like( exception { $obj->pop(42) }, qr/Cannot call pop with any arguments/, 'call to pop with arguments dies' );
166
167         is( $obj->shift, 101, 'shift returns the first value' );
168
169         like( exception { $obj->shift(42) }, qr/Cannot call shift with any arguments/, 'call to shift with arguments dies' );
170
171         is_deeply(
172             $obj->_values, [ 22, 10, 12, 42, 1, 2 ],
173             'shift changed the value of the array in the object'
174         );
175
176         is_deeply(
177             [ $obj->elements ], [ 22, 10, 12, 42, 1, 2 ],
178             'call to elements returns values as a list'
179         );
180
181         like( exception { $obj->elements(22) }, qr/Cannot call elements with any arguments/, 'throws an error when passing an argument passed to elements' );
182
183         $obj->_values( [ 1, 2, 3 ] );
184
185         is( $obj->get(0),      1, 'get values at index 0' );
186         is( $obj->get(1),      2, 'get values at index 1' );
187         is( $obj->get(2),      3, 'get values at index 2' );
188         is( $obj->get_curried, 2, 'get_curried returns value at index 1' );
189
190         like( exception { $obj->get() }, qr/Cannot call get without at least 1 argument/, 'throws an error when get is called without any arguments' );
191
192         like( exception { $obj->get( {} ) }, qr/The index passed to get must be an integer/, 'throws an error when get is called with an invalid argument' );
193
194         like( exception { $obj->get(2.2) }, qr/The index passed to get must be an integer/, 'throws an error when get is called with an invalid argument' );
195
196         like( exception { $obj->get('foo') }, qr/The index passed to get must be an integer/, 'throws an error when get is called with an invalid argument' );
197
198         like( exception { $obj->get_curried(2) }, qr/Cannot call get with more than 1 argument/, 'throws an error when get_curried is called with an argument' );
199
200         is( exception {
201             is( $obj->set( 1, 100 ), 100, 'set returns new value' );
202         }, undef, 'set value at index 1 lives' );
203
204         is( $obj->get(1), 100, 'get value at index 1 returns new value' );
205
206
207         like( exception { $obj->set( 1, 99, 42 ) }, qr/Cannot call set with more than 2 arguments/, 'throws an error when set is called with three arguments' );
208
209         is( exception { $obj->set_curried_1(99) }, undef, 'set_curried_1 lives' );
210
211         is( $obj->get(1), 99, 'get value at index 1 returns new value' );
212
213         like( exception { $obj->set_curried_1( 99, 42 ) }, qr/Cannot call set with more than 2 arguments/, 'throws an error when set_curried_1 is called with two arguments' );
214
215         is( exception { $obj->set_curried_2 }, undef, 'set_curried_2 lives' );
216
217         is( $obj->get(1), 98, 'get value at index 1 returns new value' );
218
219         like( exception { $obj->set_curried_2(42) }, qr/Cannot call set with more than 2 arguments/, 'throws an error when set_curried_2 is called with one argument' );
220
221         is(
222             $obj->accessor(1), 98,
223             'accessor with one argument returns value at index 1'
224         );
225
226         is( exception {
227             is( $obj->accessor( 1 => 97 ), 97, 'accessor returns new value' );
228         }, undef, 'accessor as writer lives' );
229
230         like(
231             exception {
232                 $obj->accessor;
233             },
234             qr/Cannot call accessor without at least 1 argument/,
235             'throws an error when accessor is called without arguments'
236         );
237
238         is(
239             $obj->get(1), 97,
240             'accessor set value at index 1'
241         );
242
243         like( exception { $obj->accessor( 1, 96, 42 ) }, qr/Cannot call accessor with more than 2 arguments/, 'throws an error when accessor is called with three arguments' );
244
245         is(
246             $obj->accessor_curried_1, 97,
247             'accessor_curried_1 returns expected value when called with no arguments'
248         );
249
250         is( exception { $obj->accessor_curried_1(95) }, undef, 'accessor_curried_1 as writer lives' );
251
252         is(
253             $obj->get(1), 95,
254             'accessor_curried_1 set value at index 1'
255         );
256
257         like( exception { $obj->accessor_curried_1( 96, 42 ) }, qr/Cannot call accessor with more than 2 arguments/, 'throws an error when accessor_curried_1 is called with two arguments' );
258
259         is( exception { $obj->accessor_curried_2 }, undef, 'accessor_curried_2 as writer lives' );
260
261         is(
262             $obj->get(1), 90,
263             'accessor_curried_2 set value at index 1'
264         );
265
266         like( exception { $obj->accessor_curried_2(42) }, qr/Cannot call accessor with more than 2 arguments/, 'throws an error when accessor_curried_2 is called with one argument' );
267
268         is( exception { $obj->clear }, undef, 'clear lives' );
269
270         ok( $obj->is_empty, 'values is empty after call to clear' );
271
272         is( exception {
273             is( $obj->shift, undef,
274                 'shift returns undef on an empty array' );
275         }, undef, 'shifted from an empty array and lived' );
276
277         $obj->set( 0 => 42 );
278
279         like( exception { $obj->clear(50) }, qr/Cannot call clear with any arguments/, 'throws an error when clear is called with an argument' );
280
281         ok(
282             !$obj->is_empty,
283             'values is not empty after failed call to clear'
284         );
285
286         like( exception { $obj->is_empty(50) }, qr/Cannot call is_empty with any arguments/, 'throws an error when is_empty is called with an argument' );
287
288         $obj->clear;
289         is(
290             $obj->push( 1, 5, 10, 42 ), 4,
291             'pushed 4 elements, got number of elements in the array back'
292         );
293
294         is( exception {
295             is( $obj->delete(2), 10, 'delete returns deleted value' );
296         }, undef, 'delete lives' );
297
298         is_deeply(
299             $obj->_values, [ 1, 5, 42 ],
300             'delete removed the specified element'
301         );
302
303         like( exception { $obj->delete( 2, 3 ) }, qr/Cannot call delete with more than 1 argument/, 'throws an error when delete is called with two arguments' );
304
305         is( exception { $obj->delete_curried }, undef, 'delete_curried lives' );
306
307         is_deeply(
308             $obj->_values, [ 1, 42 ],
309             'delete removed the specified element'
310         );
311
312         like( exception { $obj->delete_curried(2) }, qr/Cannot call delete with more than 1 argument/, 'throws an error when delete_curried is called with one argument' );
313
314         is( exception { $obj->insert( 1, 21 ) }, undef, 'insert lives' );
315
316         is_deeply(
317             $obj->_values, [ 1, 21, 42 ],
318             'insert added the specified element'
319         );
320
321         like( exception { $obj->insert( 1, 22, 44 ) }, qr/Cannot call insert with more than 2 arguments/, 'throws an error when insert is called with three arguments' );
322
323         is( exception {
324             is_deeply(
325                 [ $obj->splice( 1, 0, 2, 3 ) ],
326                 [],
327                 'return value of splice is empty list when not removing elements'
328             );
329         }, undef, 'splice lives' );
330
331         is_deeply(
332             $obj->_values, [ 1, 2, 3, 21, 42 ],
333             'splice added the specified elements'
334         );
335
336         is( exception {
337             is_deeply(
338                 [ $obj->splice( 1, 2, 99 ) ],
339                 [ 2, 3 ],
340                 'splice returns list of removed values'
341             );
342         }, undef, 'splice lives' );
343
344         is_deeply(
345             $obj->_values, [ 1, 99, 21, 42 ],
346             'splice added the specified elements'
347         );
348
349         like( exception { $obj->splice() }, qr/Cannot call splice without at least 1 argument/, 'throws an error when splice is called with no arguments' );
350
351         like( exception { $obj->splice( 1, 'foo', ) }, qr/The length argument passed to splice must be an integer/, 'throws an error when splice is called with an invalid length' );
352
353         is( exception { $obj->splice_curried_1( 2, 101 ) }, undef, 'splice_curried_1 lives' );
354
355         is_deeply(
356             $obj->_values, [ 1, 101, 42 ],
357             'splice added the specified elements'
358         );
359
360         is( exception { $obj->splice_curried_2(102) }, undef, 'splice_curried_2 lives' );
361
362         is_deeply(
363             $obj->_values, [ 1, 102 ],
364             'splice added the specified elements'
365         );
366
367         is( exception { $obj->splice_curried_all }, undef, 'splice_curried_all lives' );
368
369         is_deeply(
370             $obj->_values, [ 1, 3, 4, 5 ],
371             'splice added the specified elements'
372         );
373
374         is_deeply(
375             scalar $obj->splice( 1, 2 ),
376             4,
377             'splice in scalar context returns last element removed'
378         );
379
380         is_deeply(
381             scalar $obj->splice( 1, 0, 42 ),
382             undef,
383             'splice in scalar context returns undef when no elements are removed'
384         );
385
386         $obj->_values( [ 3, 9, 5, 22, 11 ] );
387
388         is_deeply(
389             [ $obj->sort ], [ 11, 22, 3, 5, 9 ],
390             'sort returns sorted values'
391         );
392
393         is_deeply(
394             [ $obj->sort( sub { $_[0] <=> $_[1] } ) ], [ 3, 5, 9, 11, 22 ],
395             'sort returns values sorted by provided function'
396         );
397
398         like( exception { $obj->sort(1) }, qr/The argument passed to sort must be a code reference/, 'throws an error when passing a non coderef to sort' );
399
400         like( exception {
401             $obj->sort( sub { }, 27 );
402         }, qr/Cannot call sort with more than 1 argument/, 'throws an error when passing two arguments to sort' );
403
404         $obj->_values( [ 3, 9, 5, 22, 11 ] );
405
406         $obj->sort_in_place;
407
408         is_deeply(
409             $obj->_values, [ 11, 22, 3, 5, 9 ],
410             'sort_in_place sorts values'
411         );
412
413         $obj->sort_in_place( sub { $_[0] <=> $_[1] } );
414
415         is_deeply(
416             $obj->_values, [ 3, 5, 9, 11, 22 ],
417             'sort_in_place with function sorts values'
418         );
419
420         like( exception {
421             $obj->sort_in_place( 27 );
422         }, qr/The argument passed to sort_in_place must be a code reference/, 'throws an error when passing a non coderef to sort_in_place' );
423
424         like( exception {
425             $obj->sort_in_place( sub { }, 27 );
426         }, qr/Cannot call sort_in_place with more than 1 argument/, 'throws an error when passing two arguments to sort_in_place' );
427
428         $obj->_values( [ 3, 9, 5, 22, 11 ] );
429
430         $obj->sort_in_place_curried;
431
432         is_deeply(
433             $obj->_values, [ 22, 11, 9, 5, 3 ],
434             'sort_in_place_curried sorts values'
435         );
436
437         like( exception { $obj->sort_in_place_curried(27) }, qr/Cannot call sort_in_place with more than 1 argument/, 'throws an error when passing one argument passed to sort_in_place_curried' );
438
439         $obj->_values( [ 1 .. 5 ] );
440
441         is_deeply(
442             [ $obj->map( sub { $_ + 1 } ) ],
443             [ 2 .. 6 ],
444             'map returns the expected values'
445         );
446
447         like( exception { $obj->map }, qr/Cannot call map without at least 1 argument/, 'throws an error when passing no arguments to map' );
448
449         like( exception {
450             $obj->map( sub { }, 2 );
451         }, qr/Cannot call map with more than 1 argument/, 'throws an error when passing two arguments to map' );
452
453         like( exception { $obj->map( {} ) }, qr/The argument passed to map must be a code reference/, 'throws an error when passing a non coderef to map' );
454
455         $obj->_values( [ 1 .. 5 ] );
456
457         is_deeply(
458             [ $obj->map_curried ],
459             [ 2 .. 6 ],
460             'map_curried returns the expected values'
461         );
462
463         like( exception {
464             $obj->map_curried( sub { } );
465         }, qr/Cannot call map with more than 1 argument/, 'throws an error when passing one argument passed to map_curried' );
466
467         $obj->_values( [ 2 .. 9 ] );
468
469         is_deeply(
470             [ $obj->grep( sub { $_ < 5 } ) ],
471             [ 2 .. 4 ],
472             'grep returns the expected values'
473         );
474
475         like( exception { $obj->grep }, qr/Cannot call grep without at least 1 argument/, 'throws an error when passing no arguments to grep' );
476
477         like( exception {
478             $obj->grep( sub { }, 2 );
479         }, qr/Cannot call grep with more than 1 argument/, 'throws an error when passing two arguments to grep' );
480
481         like( exception { $obj->grep( {} ) }, qr/The argument passed to grep must be a code reference/, 'throws an error when passing a non coderef to grep' );
482
483         my $overloader = Overloader->new( sub { $_ < 5 } );
484         is_deeply(
485             [ $obj->grep($overloader) ],
486             [ 2 .. 4 ],
487             'grep works with obj that overload code dereferencing'
488         );
489
490         is_deeply(
491             [ $obj->grep_curried ],
492             [ 2 .. 4 ],
493             'grep_curried returns the expected values'
494         );
495
496         like( exception {
497             $obj->grep_curried( sub { } );
498         }, qr/Cannot call grep with more than 1 argument/, 'throws an error when passing one argument passed to grep_curried' );
499
500         $obj->_values( [ 2, 4, 22, 99, 101, 6 ] );
501
502         is(
503             $obj->first( sub { $_ % 2 } ),
504             99,
505             'first returns expected value'
506         );
507
508         like( exception { $obj->first }, qr/Cannot call first without at least 1 argument/, 'throws an error when passing no arguments to first' );
509
510         like( exception {
511             $obj->first( sub { }, 2 );
512         }, qr/Cannot call first with more than 1 argument/, 'throws an error when passing two arguments to first' );
513
514         like( exception { $obj->first( {} ) }, qr/The argument passed to first must be a code reference/, 'throws an error when passing a non coderef to first' );
515
516         is(
517             $obj->first_curried,
518             99,
519             'first_curried returns expected value'
520         );
521
522         like( exception {
523             $obj->first_curried( sub { } );
524         }, qr/Cannot call first with more than 1 argument/, 'throws an error when passing one argument passed to first_curried' );
525
526         $obj->_values( [ 1 .. 4 ] );
527
528         is(
529             $obj->join('-'), '1-2-3-4',
530             'join returns expected result'
531         );
532
533         is(
534             $obj->join(q{}), '1234',
535             'join returns expected result when joining with empty string'
536         );
537
538         like( exception { $obj->join }, qr/Cannot call join without at least 1 argument/, 'throws an error when passing no arguments to join' );
539
540         like( exception { $obj->join( '-', 2 ) }, qr/Cannot call join with more than 1 argument/, 'throws an error when passing two arguments to join' );
541
542         like( exception { $obj->join( {} ) }, qr/The argument passed to join must be a string/, 'throws an error when passing a non string to join' );
543
544         is_deeply(
545             [ sort $obj->shuffle ],
546             [ 1 .. 4 ],
547             'shuffle returns all values (cannot check for a random order)'
548         );
549
550         like( exception { $obj->shuffle(2) }, qr/Cannot call shuffle with any arguments/, 'throws an error when passing an argument passed to shuffle' );
551
552         $obj->_values( [ 1 .. 4, 2, 5, 3, 7, 3, 3, 1 ] );
553
554         is_deeply(
555             [ $obj->uniq ],
556             [ 1 .. 4, 5, 7 ],
557             'uniq returns expected values (in original order)'
558         );
559
560         like( exception { $obj->uniq(2) }, qr/Cannot call uniq with any arguments/, 'throws an error when passing an argument passed to uniq' );
561
562         $obj->_values( [ 1 .. 5 ] );
563
564         is(
565             $obj->reduce( sub { $_[0] * $_[1] } ),
566             120,
567             'reduce returns expected value'
568         );
569
570         like( exception { $obj->reduce }, qr/Cannot call reduce without at least 1 argument/, 'throws an error when passing no arguments to reduce' );
571
572         like( exception {
573             $obj->reduce( sub { }, 2 );
574         }, qr/Cannot call reduce with more than 1 argument/, 'throws an error when passing two arguments to reduce' );
575
576         like( exception { $obj->reduce( {} ) }, qr/The argument passed to reduce must be a code reference/, 'throws an error when passing a non coderef to reduce' );
577
578         is(
579             $obj->reduce_curried,
580             120,
581             'reduce_curried returns expected value'
582         );
583
584         like( exception {
585             $obj->reduce_curried( sub { } );
586         }, qr/Cannot call reduce with more than 1 argument/, 'throws an error when passing one argument passed to reduce_curried' );
587
588         $obj->_values( [ 1 .. 6 ] );
589
590         my $it = $obj->natatime(2);
591         my @nat;
592         while ( my @v = $it->() ) {
593             push @nat, \@v;
594         }
595
596         is_deeply(
597             [ [ 1, 2 ], [ 3, 4 ], [ 5, 6 ] ],
598             \@nat,
599             'natatime returns expected iterator'
600         );
601
602         @nat = ();
603         $obj->natatime( 2, sub { push @nat, [@_] } );
604
605         is_deeply(
606             [ [ 1, 2 ], [ 3, 4 ], [ 5, 6 ] ],
607             \@nat,
608             'natatime with function returns expected value'
609         );
610
611         like( exception { $obj->natatime( {} ) }, qr/The n value passed to natatime must be an integer/, 'throws an error when passing a non integer to natatime' );
612
613         like( exception { $obj->natatime( 2, {} ) }, qr/The second argument passed to natatime must be a code reference/, 'throws an error when passing a non code ref to natatime' );
614
615         $it = $obj->natatime_curried();
616         @nat = ();
617         while ( my @v = $it->() ) {
618             push @nat, \@v;
619         }
620
621         is_deeply(
622             [ [ 1, 2 ], [ 3, 4 ], [ 5, 6 ] ],
623             \@nat,
624             'natatime_curried returns expected iterator'
625         );
626
627         @nat = ();
628         $obj->natatime_curried( sub { push @nat, [@_] } );
629
630         is_deeply(
631             [ [ 1, 2 ], [ 3, 4 ], [ 5, 6 ] ],
632             \@nat,
633             'natatime_curried with function returns expected value'
634         );
635
636         like( exception { $obj->natatime_curried( {} ) }, qr/The second argument passed to natatime must be a code reference/, 'throws an error when passing a non code ref to natatime_curried' );
637
638         if ( $class->meta->get_attribute('_values')->is_lazy ) {
639             my $obj = $class->new;
640
641             is( $obj->count, 2, 'count is 2 (lazy init)' );
642
643             $obj->_clear_values;
644
645             is_deeply(
646                 [ $obj->elements ], [ 42, 84 ],
647                 'elements contains default with lazy init'
648             );
649
650             $obj->_clear_values;
651
652             $obj->push(2);
653
654             is_deeply(
655                 $obj->_values, [ 42, 84, 2 ],
656                 'push works with lazy init'
657             );
658
659             $obj->_clear_values;
660
661             $obj->unshift( 3, 4 );
662
663             is_deeply(
664                 $obj->_values, [ 3, 4, 42, 84 ],
665                 'unshift works with lazy init'
666             );
667         }
668     }
669     $class;
670 }
671
672 done_testing;