File Coverage

blib/lib/Class/Meta/Types/Perl.pm

Criterion	Covered	Total	%
statement	14	14	100.0
branch	2	2	100.0
condition	2	2	100.0
subroutine	3	3	100.0
pod			n/a
total	21	21	100.0

package Class::Meta::Types::Perl;

=head1 NAME

Class::Meta::Types::Perl - Perl data types

=head1 SYNOPSIS

  package MyApp::Thingy;
  use strict;
  use Class::Meta;
  use Class::Meta::Types::Perl;
  # OR...
  # use Class::Meta::Types::Perl 'affordance';
  # OR...
  # use Class::Meta::Types::Perl 'semi-affordance';

  BEGIN {
      # Create a Class::Meta object for this class.
      my $cm = Class::Meta->new( key => 'thingy' );

      # Add an integer attribute.
      $cm->add_attribute( name => 'my_hash',
                          type => 'hash' );
      $cm->build;
  }

=head1 DESCRIPTION

This module provides Perl data types for use with Class::Meta attributes.
Simply load it, then pass the name of one of its types to the
C method of a Class::Meta object. See
L for more information on using and
creating data types.

The validation checks for Class::Meta::Types::Perl are provided by the
Class::Meta::Type's support for object type validation, since Perl data types
are understood by C.

The data types created by Class::Meta::Types::Perl are:

=over

=item scalar

A simple scalar value. This can be anything, and has no validation checks.

=item scalarref

A scalar reference. C must return 'SCALAR'.

=item array

=item arrayref

A array reference. C must return 'ARRAY'.

=item hash

=item hashref

A hash reference. C must return 'HASH'.

=item code

=item coderef

=item closure

A code reference. Also known as a closure. C must return
'CODE'.

=back

=cut

use strict;
use Class::Meta::Type;
our $VERSION = '0.66';

sub import {
    my ($pkg, $builder) = @_;
    $builder ||= 'default';
    return if eval "Class::Meta::Type->new('array')";

    Class::Meta::Type->add(
        key     => "scalar",
        name    => "Scalar",
        desc    => "Scalar",
        builder => $builder,
    );

    Class::Meta::Type->add(
        key     => "scalarref",
        name    => "Scalar Reference",
        desc    => "Scalar reference",
        builder => $builder,
        check   => 'SCALAR',
    );

    Class::Meta::Type->add(
        key     => "array",
        name    => "Array Reference",
        desc    => "Array reference",
        alias   => 'arrayref',
        builder => $builder,
        check   => 'ARRAY',
    );

    Class::Meta::Type->add(
        key     => "hash",
        name    => "Hash Reference",
        desc    => "Hash reference",
        alias   => 'hashref',
        builder => $builder,
        check   => 'HASH',
    );

    Class::Meta::Type->add(
        key     => "code",
        name    => "Code Reference",
        desc    => "Code reference",
        alias   => [qw(coderef closure)],
        builder => $builder,
        check   => 'CODE',
    );
}

1;
__END__