lib/MooseX/Storage/Traits/OnlyWhenBuilt.pm

   1 package MooseX::Storage::Traits::OnlyWhenBuilt;
   2 use Moose::Role;
   3
   4 our $VERSION   = '0.20';
   5 our $AUTHORITY = 'cpan:STEVAN';
   6
   7 requires 'pack';
   8 requires 'unpack';
   9
  10 around 'pack' => sub {
  11     my ($orig, $self, %args) = @_;
  12     $args{engine_traits} ||= [];
  13     push(@{$args{engine_traits}}, 'OnlyWhenBuilt');
  14     $self->$orig(%args);
  15 };
  16
  17 around 'unpack' => sub {
  18     my ($orig, $self, $data, %args) = @_;
  19     $args{engine_traits} ||= [];
  20     push(@{$args{engine_traits}}, 'OnlyWhenBuilt');
  21     $self->$orig($data, %args);
  22 };
  23
  24 1;
  25
  26 __END__
  27
  28 =pod
  29
  30 =head1 NAME
  31
  32 MooseX::Storage::Traits::OnlyWhenBuilt - A custom trait to bypass serialization
  33
  34 =head1 SYNOPSIS
  35
  36
  37     {   package Point;
  38         use Moose;
  39         use MooseX::Storage;
  40
  41         with Storage( traits => [qw|OnlyWhenBuilt|] );
  42
  43         has 'x' => (is => 'rw', lazy_build => 1 );
  44         has 'y' => (is => 'rw', lazy_build => 1 );
  45         has 'z' => (is => 'rw', builder => '_build_z' );
  46
  47         sub _build_x { 3 }
  48         sub _build_y { expensive_computation() }
  49         sub _build_z { 3 }
  50
  51     }
  52
  53     my $p = Point->new( 'x' => 4 );
  54
  55     # the result of ->pack will contain:
  56     # { x => 4, z => 3 }
  57     $p->pack;
  58
  59 =head1 DESCRIPTION
  60
  61 Sometimes you don't want a particular attribute to be part of the
  62 serialization if it has not been built yet. If you invoke C<Storage()>
  63 as outlined in the C<Synopsis>, only attributes that have been built
  64 (ie, where the predicate returns 'true') will be serialized.
  65 This avoids any potentially expensive computations.
  66
  67 See the SYNOPSIS for a nice example that can be easily cargo-culted.
  68
  69 =head1 METHODS
  70
  71 =head2 Introspection
  72
  73 =over 4
  74
  75 =item B<meta>
  76
  77 =back
  78
  79 =head1 BUGS
  80
  81 All complex software has bugs lurking in it, and this module is no
  82 exception. If you find a bug please either email me, or add the bug
  83 to cpan-RT.
  84
  85 =head1 AUTHOR
  86
  87 Stevan Little E<lt>stevan.little@iinteractive.comE<gt>
  88
  89 =head1 COPYRIGHT AND LICENSE
  90
  91 Copyright 2007-2008 by Infinity Interactive, Inc.
  92
  93 L<http://www.iinteractive.com>
  94
  95 This library is free software; you can redistribute it and/or modify
  96 it under the same terms as Perl itself.
  97
  98 =cut