File Coverage

blib/lib/MooseX/Attribute/LazyInflator.pm

Criterion	Covered	Total	%
statement	21	21	100.0
branch			n/a
condition			n/a
subroutine	7	7	100.0
pod			n/a
total	28	28	100.0

#
# This file is part of MooseX-Attribute-Deflator
#
# This software is Copyright (c) 2012 by Moritz Onken.
#
# This is free software, licensed under:
#
#   The (three-clause) BSD License
#
package MooseX::Attribute::LazyInflator;
{
  $MooseX::Attribute::LazyInflator::VERSION = '2.1.11'; # TRIAL
}

# ABSTRACT: Lazy inflate attributes on access for better performance

use Moose();
use MooseX::Attribute::Deflator ();
use Moose::Exporter;
use Moose::Util ();
use MooseX::Attribute::LazyInflator::Meta::Role::Attribute;
use MooseX::Attribute::LazyInflator::Meta::Role::ApplicationToClass;
use MooseX::Attribute::LazyInflator::Meta::Role::ApplicationToRole;

Moose::Exporter->setup_import_methods(
    Moose->VERSION < 1.9900
    ? (
        class_metaroles => {
            constructor => [
'MooseX::Attribute::LazyInflator::Meta::Role::Method::Constructor'
            ],
        } )
    : (),
    role_metaroles => {
          role => ['MooseX::Attribute::LazyInflator::Meta::Role::Role'],
          application_to_class =>
            ['MooseX::Attribute::LazyInflator::Meta::Role::ApplicationToClass'],
          application_to_role =>
            ['MooseX::Attribute::LazyInflator::Meta::Role::ApplicationToRole'],
    },
    base_class_roles => ['MooseX::Attribute::LazyInflator::Role::Class'] );

Moose::Util::_create_alias( 'Attribute', 'LazyInflator', 1,
                     'MooseX::Attribute::LazyInflator::Meta::Role::Attribute' );

1;



=pod

=head1 NAME

MooseX::Attribute::LazyInflator - Lazy inflate attributes on access for better performance

=head1 VERSION

version 2.1.11

=head1 SYNOPSIS

  package Test;

  use Moose;
  use MooseX::Attribute::LazyInflator;
  # Load default deflators and inflators
  use MooseX::Attribute::Deflator::Moose;

  has hash => ( is => 'rw',
               isa => 'HashRef',
               traits => ['LazyInflator'] );

  package main;

  my $obj = Test->new( hash => '{"foo":"bar"}' );
  # Attribute 'hash' is being inflated to a HashRef on access
  $obj->hash;

=head1 DESCRIPTION

Using C<coerce> will inflate an object on construction even if it is not needed.
This has the advantage, that type constraints are being called but on the other hand
it is rather slow.

This module will defer object inflation and constraint validation until it is first accessed.
Furthermore the advantages of C<inflate> apply as well.

=head1 SEE ALSO

=over 8

=item L<MooseX::Attribute::LazyInflator::Role::Class>

=item MooseX::Attribute::LazyInflator::Meta::Role::Method::Accessor>

=item L<MooseX::Attribute::LazyInflator::Meta::Role::Method::Constructor>

=item L<MooseX::Attribute::Deflator/inflate>

=back

=head1 AUTHOR

Moritz Onken

=head1 COPYRIGHT AND LICENSE

This software is Copyright (c) 2012 by Moritz Onken.

This is free software, licensed under:

  The (three-clause) BSD License

=cut


__END__