File Coverage

blib/lib/Package/New/Dump.pm

Criterion	Covered	Total	%
statement	35	35	100.0
branch	6	6	100.0
condition			n/a
subroutine	9	9	100.0
pod	1	1	100.0
total	51	51	100.0

package Package::New::Dump;
use base qw{Package::New};
use strict;
use warnings;

our $VERSION='0.10';

=head1 NAME

Package::New::Dump - Simple base package from which to inherit

=head1 SYNOPSIS

  package My::Package;
  use base qw{Package::New::Dump}; #provides new, initialize and dump

=head1 DESCRIPTION

The Package::New::Dump object provides a consistent object constructor for objects.

=head1 RECOMMENDATIONS

I recommend using this package only during development and reverting back to L when in full production

=head1 USAGE

=head1 CONSTRUCTOR

See L

=cut

=head1 METHODS

=head2 dump

Returns the object serialized by L

=cut

sub dump {
  my $self  = shift;
  my $depth = shift;
  $depth    = 2 unless defined $depth;
  local $@;
  eval 'use Data::Dumper qw{}';
  my $error = $@;
  if ($error) {
    return wantarray ? () : '';
  } else {
    my $d = Data::Dumper->new([$self]);
    $d->Maxdepth($depth);
    return $d->Dump;
  }
}

=head1 AUTHOR

  Michael R. Davis

=head1 COPYRIGHT

This program is free software licensed under the...

  The BSD License

The full text of the license can be found in the LICENSE file included with this module.

=head1 SEE ALSO

=cut

1;