[gitmo/Moose-Autobox.git] / lib / Moose / Autobox / Array.pm

package Moose::Autobox::Array;
use Moose::Role 'with';
use Perl6::Junction;
use Moose::Autobox;

our $VERSION = '0.03';

with 'Moose::Autobox::Ref',
     'Moose::Autobox::List',
     'Moose::Autobox::Indexed';
    
## Array Interface

sub pop { 
    my ($array) = @_;    
    CORE::pop @$array; 
}

sub push { 
    my ($array, @rest) = @_;
    CORE::push @$array, @rest;  
    $array; 
}

sub unshift { 
    my ($array, @rest) = @_;    
    CORE::unshift @$array, @rest; 
    $array; 
}

sub delete { 
    my ($array, $index) = @_;    
    CORE::delete $array->[$index];
}

sub shift { 
    my ($array) = @_;    
    CORE::shift @$array; 
}    

sub slice {
    my ($array, $indicies) = @_;
    [ @{$array}[ @{$indicies} ] ];
} 

# NOTE: 
# sprintf args need to be reversed, 
# because the invocant is the array
sub sprintf { CORE::sprintf $_[1], @{$_[0]} }

## ::List interface implementation

sub head { $_[0]->[0] }
sub tail { [ @{$_[0]}[ 1 .. $#{$_[0]} ] ] }
 
sub length {
    my ($array) = @_;
    CORE::scalar @$array;
}

sub grep { 
    my ($array, $sub) = @_; 
    [ CORE::grep { $sub->($_) } @$array ]; 
}

sub map { 
    my ($array, $sub) = @_; 
    [ CORE::map { $sub->($_) } @$array ]; 
}

sub join { 
    my ($array, $sep) = @_;    
    $sep ||= ''; 
    CORE::join $sep, @$array; 
}

sub reverse { 
    my ($array) = @_;
    [ CORE::reverse @$array ];
}

sub sort { 
    my ($array, $sub) = @_;     
    $sub ||= sub { $a cmp $b }; 
    [ CORE::sort { $sub->($a, $b) } @$array ]; 
}    

## ::Indexed implementation

sub at {
    my ($array, $index) = @_;
    $array->[$index];
} 

sub put {
    my ($array, $index, $value) = @_;
    $array->[$index] = $value;
}

sub exists {
    my ($array, $index) = @_;    
    CORE::exists $array->[$index];    
}

sub keys { 
    my ($array) = @_;    
    [ 0 .. $#{$array} ];
}

sub values { 
    my ($array) = @_;    
    [ @$array ];
}

sub kv {
    my ($array) = @_;   
    $array->keys->map(sub { [ $_, $array->[$_] ] });
}

sub flatten {
    @{$_[0]}
}

## Junctions

sub all {
    my ($array) = @_;     
    return Perl6::Junction::all(@$array);
}

sub any {
    my ($array) = @_;     
    return Perl6::Junction::any(@$array);
}

sub none {
    my ($array) = @_;     
    return Perl6::Junction::none(@$array);
}

sub one {
    my ($array) = @_; 
    return Perl6::Junction::one(@$array);
}

## Print

sub print { CORE::print @{$_[0]} }
sub say   { CORE::print @{$_[0]}, "\n" }

1;

__END__

=pod

=head1 NAME 

Moose::Autobox::Array - the Array role

=head1 SYNOPOSIS

  use Moose::Autobox;
    
  [ 1..5 ]->isa('ARRAY'); # true
  [ a..z ]->does('Moose::Autobox::Array'); # true
  [ 0..2 ]->does('Moose::Autobox::List'); # true  
    
  print "Squares: " . [ 1 .. 10 ]->map(sub { $_ * $_ })->join(', ');
  
  print [ 1, 'number' ]->sprintf('%d is the loneliest %s');
  
  print ([ 1 .. 5 ]->any == 3) ? 'true' : 'false'; # prints 'true'

=head1 DESCRIPTION

This is a role to describe operations on the Array type. 

=head1 METHODS

=over 4

=item B<pop>

=item B<push ($value)>

=item B<shift>

=item B<unshift ($value)>

=item B<delete ($index)>

=item B<sprintf ($format_string)>

=item B<slice (@indices)>

=item B<flatten>

=back

=head2 Indexed implementation

=over 4

=item B<at ($index)>

=item B<put ($index, $value)>

=item B<exists ($index)>

=item B<keys>

=item B<values>

=item B<kv>

=back

=head2 List implementation

=over 4

=item B<head>

=item B<tail>

=item B<join (?$seperator)>

=item B<length>

=item B<map (\&block)>

=item B<grep (\&block)>

Note that, in both the above, $_ is in scope within the code block, as well as 
being passed as $_[0]. As per CORE::map and CORE::grep, $_ is an alias to 
the list value, so can be used to to modify the list, viz:

    use Moose::Autobox;

    my $foo = [1, 2, 3]; 
    $foo->map( sub {$_++} ); 
    print $foo->dump;

yields

   $VAR1 = [
             2,
             3,
             4
           ];
        
=item B<reverse>

=item B<sort (?\&block)>

=back

=head2 Junctions

=over 4

=item B<all>

=item B<any>

=item B<none>

=item B<one>

=back

=over 4

=item B<meta>

=item B<print>

=item B<say>

=back

=head1 BUGS

All complex software has bugs lurking in it, and this module is no 
exception. If you find a bug please either email me, or add the bug
to cpan-RT.

=head1 AUTHOR

Stevan Little E<lt>stevan@iinteractive.comE<gt>

=head1 COPYRIGHT AND LICENSE

Copyright 2006-2008 by Infinity Interactive, Inc.

L<http://www.iinteractive.com>

This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.

=cut
Commit	Line	Data
5f654d8e	1	package Moose::Autobox::Array;
5f654d8e	2	use Moose::Role 'with';
7fc99864	3	use Perl6::Junction;
7dad2765	4	use Moose::Autobox;
5f654d8e	5
7dad2765	6	our $VERSION = '0.03';
5f654d8e	7
e6bb88b0	8	with 'Moose::Autobox::Ref',
31d40d73	9	'Moose::Autobox::List',
31d40d73	10	'Moose::Autobox::Indexed';
6cf5bcf2	11
	12	## Array Interface
	13
	14	sub pop {
	15	my ($array) = @_;
	16	CORE::pop @$array;
	17	}
	18
	19	sub push {
	20	my ($array, @rest) = @_;
	21	CORE::push @$array, @rest;
	22	$array;
	23	}
	24
	25	sub unshift {
	26	my ($array, @rest) = @_;
	27	CORE::unshift @$array, @rest;
	28	$array;
	29	}
5f654d8e	30
6cf5bcf2	31	sub delete {
	32	my ($array, $index) = @_;
	33	CORE::delete $array->[$index];
	34	}
	35
	36	sub shift {
	37	my ($array) = @_;
	38	CORE::shift @$array;
c11e6a74	39	}
	40
	41	sub slice {
	42	my ($array, $indicies) = @_;
	43	[ @{$array}[ @{$indicies} ] ];
	44	}
6cf5bcf2	45
	46	# NOTE:
	47	# sprintf args need to be reversed,
	48	# because the invocant is the array
	49	sub sprintf { CORE::sprintf $_[1], @{$_[0]} }
	50
	51	## ::List interface implementation
	52
	53	sub head { $_[0]->[0] }
	54	sub tail { [ @{$_[0]}[ 1 .. $#{$_[0]} ] ] }
e6bb88b0	55
5f654d8e	56	sub length {
	57	my ($array) = @_;
	58	CORE::scalar @$array;
	59	}
	60
	61	sub grep {
	62	my ($array, $sub) = @_;
	63	[ CORE::grep { $sub->($_) } @$array ];
	64	}
	65
	66	sub map {
	67	my ($array, $sub) = @_;
	68	[ CORE::map { $sub->($_) } @$array ];
	69	}
	70
	71	sub join {
feffe00c	72	my ($array, $sep) = @_;
feffe00c	73	$sep \|\|= '';
5f654d8e	74	CORE::join $sep, @$array;
	75	}
	76
	77	sub reverse {
	78	my ($array) = @_;
e6bb88b0	79	[ CORE::reverse @$array ];
5f654d8e	80	}
	81
	82	sub sort {
	83	my ($array, $sub) = @_;
	84	$sub \|\|= sub { $a cmp $b };
	85	[ CORE::sort { $sub->($a, $b) } @$array ];
5dc78481	86	}
5dc78481	87
260cc81f	88	## ::Indexed implementation
5dc78481	89
260cc81f	90	sub at {
	91	my ($array, $index) = @_;
	92	$array->[$index];
	93	}
5dc78481	94
260cc81f	95	sub put {
	96	my ($array, $index, $value) = @_;
	97	$array->[$index] = $value;
	98	}
5dc78481	99
6cf5bcf2	100	sub exists {
	101	my ($array, $index) = @_;
	102	CORE::exists $array->[$index];
	103	}
5dc78481	104
	105	sub keys {
	106	my ($array) = @_;
	107	[ 0 .. $#{$array} ];
	108	}
	109
	110	sub values {
	111	my ($array) = @_;
	112	[ @$array ];
	113	}
	114
	115	sub kv {
	116	my ($array) = @_;
feffe00c	117	$array->keys->map(sub { [ $_, $array->[$_] ] });
5dc78481	118	}
e6bb88b0	119
2197a7c0	120	sub flatten {
	121	@{$_[0]}
	122	}
	123
7fc99864	124	## Junctions
	125
	126	sub all {
	127	my ($array) = @_;
aaf111de	128	return Perl6::Junction::all(@$array);
7fc99864	129	}
	130
	131	sub any {
	132	my ($array) = @_;
aaf111de	133	return Perl6::Junction::any(@$array);
7fc99864	134	}
	135
	136	sub none {
	137	my ($array) = @_;
aaf111de	138	return Perl6::Junction::none(@$array);
7fc99864	139	}
	140
	141	sub one {
	142	my ($array) = @_;
aaf111de	143	return Perl6::Junction::one(@$array);
7fc99864	144	}
7fc99864	145
3f4dd8b7	146	## Print
	147
	148	sub print { CORE::print @{$_[0]} }
	149	sub say { CORE::print @{$_[0]}, "\n" }
	150
5f654d8e	151	1;
31d40d73	152
	153	__END__
	154
	155	=pod
	156
	157	=head1 NAME
	158
	159	Moose::Autobox::Array - the Array role
	160
	161	=head1 SYNOPOSIS
	162
	163	use Moose::Autobox;
31d40d73	164
5272f13f	165	[ 1..5 ]->isa('ARRAY'); # true
	166	[ a..z ]->does('Moose::Autobox::Array'); # true
	167	[ 0..2 ]->does('Moose::Autobox::List'); # true
	168
31d40d73	169	print "Squares: " . [ 1 .. 10 ]->map(sub { $_ * $_ })->join(', ');
5272f13f	170
5272f13f	171	print [ 1, 'number' ]->sprintf('%d is the loneliest %s');
f6e003cc	172
f6e003cc	173	print ([ 1 .. 5 ]->any == 3) ? 'true' : 'false'; # prints 'true'
31d40d73	174
	175	=head1 DESCRIPTION
	176
8937074a	177	This is a role to describe operations on the Array type.
8937074a	178
260cc81f	179	=head1 METHODS
	180
	181	=over 4
	182
260cc81f	183	=item B<pop>
260cc81f	184
5272f13f	185	=item B<push ($value)>
260cc81f	186
	187	=item B<shift>
	188
5272f13f	189	=item B<unshift ($value)>
260cc81f	190
5272f13f	191	=item B<delete ($index)>
260cc81f	192
5272f13f	193	=item B<sprintf ($format_string)>
260cc81f	194
c11e6a74	195	=item B<slice (@indices)>
c11e6a74	196
2197a7c0	197	=item B<flatten>
2197a7c0	198
260cc81f	199	=back
260cc81f	200
5272f13f	201	=head2 Indexed implementation
260cc81f	202
	203	=over 4
	204
5272f13f	205	=item B<at ($index)>
260cc81f	206
5272f13f	207	=item B<put ($index, $value)>
260cc81f	208
5272f13f	209	=item B<exists ($index)>
260cc81f	210
	211	=item B<keys>
	212
260cc81f	213	=item B<values>
260cc81f	214
5272f13f	215	=item B<kv>
5272f13f	216
260cc81f	217	=back
260cc81f	218
5272f13f	219	=head2 List implementation
260cc81f	220
	221	=over 4
	222
	223	=item B<head>
	224
	225	=item B<tail>
	226
5272f13f	227	=item B<join (?$seperator)>
260cc81f	228
	229	=item B<length>
	230
5272f13f	231	=item B<map (\&block)>
260cc81f	232
5272f13f	233	=item B<grep (\&block)>
260cc81f	234
09a0196c	235	Note that, in both the above, $_ is in scope within the code block, as well as
	236	being passed as $_[0]. As per CORE::map and CORE::grep, $_ is an alias to
	237	the list value, so can be used to to modify the list, viz:
	238
	239	use Moose::Autobox;
	240
	241	my $foo = [1, 2, 3];
	242	$foo->map( sub {$_++} );
	243	print $foo->dump;
	244
	245	yields
	246
	247	$VAR1 = [
	248	2,
	249	3,
	250	4
	251	];
	252
260cc81f	253	=item B<reverse>
260cc81f	254
5272f13f	255	=item B<sort (?\&block)>
	256
	257	=back
	258
7fc99864	259	=head2 Junctions
	260
	261	=over 4
	262
	263	=item B<all>
	264
	265	=item B<any>
	266
	267	=item B<none>
	268
	269	=item B<one>
	270
	271	=back
	272
5272f13f	273	=over 4
	274
	275	=item B<meta>
260cc81f	276
3f4dd8b7	277	=item B<print>
	278
	279	=item B<say>
	280
260cc81f	281	=back
260cc81f	282
31d40d73	283	=head1 BUGS
	284
	285	All complex software has bugs lurking in it, and this module is no
	286	exception. If you find a bug please either email me, or add the bug
	287	to cpan-RT.
	288
	289	=head1 AUTHOR
	290
	291	Stevan Little E<lt>stevan@iinteractive.comE<gt>
	292
	293	=head1 COPYRIGHT AND LICENSE
	294
ea4e64bf	295	Copyright 2006-2008 by Infinity Interactive, Inc.
31d40d73	296
	297	L<http://www.iinteractive.com>
	298
	299	This library is free software; you can redistribute it and/or modify
	300	it under the same terms as Perl itself.
	301
f6e003cc	302	=cut