docs

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

diff --git a/lib/Moose/Autobox/Hash.pm b/lib/Moose/Autobox/Hash.pm
index f8766b9..ed23052 100644 (file)
--- a/lib/Moose/Autobox/Hash.pm
+++ b/lib/Moose/Autobox/Hash.pm
@@ -1,7 +1,7 @@
 package Moose::Autobox::Hash;
 use Moose::Role 'with';
 
-our $VERSION = '0.01';
+our $VERSION = '0.10';
 
 with 'Moose::Autobox::Ref',
      'Moose::Autobox::Indexed';
@@ -11,6 +11,22 @@ sub delete {
     CORE::delete $hash->{$key}; 
 }
 
+sub merge {
+    my ($left, $right) = @_;
+    Carp::confess "You must pass a hashref as argument to merge"
+        unless ref $right eq 'HASH';
+    return { %$left, %$right };
+}
+
+sub hslice {
+    my ($hash, $keys) = @_;
+    return { map { $_ => $hash->{$_} } @$keys };
+}
+
+sub flatten {
+    return %{$_[0]}
+}
+
 # ::Indexed implementation
 
 sub at {
@@ -43,6 +59,34 @@ sub kv {
     [ CORE::map { [ $_, $hash->{$_} ] } CORE::keys %$hash ];    
 }
 
+sub slice {
+    my ($hash, $keys) = @_;
+    return [ @{$hash}{@$keys} ];
+}
+
+sub each {
+    my ($hash, $sub) = @_;
+    for my $key (CORE::keys %$hash) {
+      $sub->($key, $hash->{$key});
+    }
+}
+
+sub each_key {
+    my ($hash, $sub) = @_;
+    $sub->($_) for CORE::keys %$hash;
+}
+
+sub each_value {
+    my ($hash, $sub) = @_;
+    $sub->($_) for CORE::values %$hash;
+}
+
+
+# End Indexed
+
+sub print   { CORE::print %{$_[0]} }
+sub say     { CORE::print %{$_[0]}, "\n" }
+
 1;
 
 __END__
@@ -56,23 +100,33 @@ Moose::Autobox::Hash - the Hash role
 =head1 SYNOPOSIS
 
   use Moose::Autobox;
-  use autobox;
   
-  { one => 1, two => 2 }->keys->join(', ')->print; # prints 'one, two'
+  print { one => 1, two => 2 }->keys->join(', '); # prints 'one, two'
 
 =head1 DESCRIPTION
 
+This is a role to describes a Hash value. 
+
 =head1 METHODS
 
 =over 4
 
-=item B<meta>
-
 =item B<delete>
 
+=item B<merge>
+
+Takes a hashref and returns a new hashref with right precedence
+shallow merging.
+
+=item B<hslice>
+
+Slices a hash but returns the keys and values as a new hashref.
+
+=item B<flatten>
+
 =back
 
-=head2 Indexed
+=head2 Indexed implementation
 
 =over 4
 
@@ -88,6 +142,24 @@ Moose::Autobox::Hash - the Hash role
 
 =item B<kv>
 
+=item B<slice>
+
+=item B<each>
+
+=item B<each_key>
+
+=item B<each_value>
+
+=back
+
+=over 4
+
+=item B<meta>
+
+=item B<print>
+
+=item B<say>
+
 =back
 
 =head1 BUGS
@@ -102,11 +174,12 @@ Stevan Little E<lt>stevan@iinteractive.comE<gt>
 
 =head1 COPYRIGHT AND LICENSE
 
-Copyright 2006 by Infinity Interactive, Inc.
+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
\ No newline at end of file
+=cut
+