File Coverage

blib/lib/MooseX/AttributeIndexes/Provider.pm

Criterion	Covered	Total	%
statement	13	13	100.0
branch			n/a
condition			n/a
subroutine	5	5	100.0
pod			n/a
total	18	18	100.0

use strict;
use warnings;

package MooseX::AttributeIndexes::Provider;
BEGIN {
  $MooseX::AttributeIndexes::Provider::AUTHORITY = 'cpan:KENTNL';
}
{
  $MooseX::AttributeIndexes::Provider::VERSION = '1.0.3';
}

# ABSTRACT: A role that advertises an object is capable of providing metadata.

# $Id:$
use Moose::Role;
use namespace::autoclean;



requires 'attribute_indexes';

1;

__END__

=pod

=head1 NAME

MooseX::AttributeIndexes::Provider - A role that advertises an object is capable of providing metadata.

=head1 VERSION

version 1.0.3

=head1 SYNOPSIS

  use Moose;
  with 'MooseX::AttributeIndexes::Provider';

  sub attribute_indexes {
    return {
      foo => 'bar',
    };
  }

=head1 WARNING

This code is alpha, and its interface is prone to change.

=head1 REQUIRES

=head2 C<attribute_indexes>

A sub that returns a hashref of index-name=>index-value entries
for the given object

=head1 AUTHORS

=over 4

=item *

Kent Fredric <[e-mail]>

=item *

Jesse Luehrs <[e-mail]>

=back

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2013 by Kent Fredric.

This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.

=cut