File Coverage

=head1 NAME

Test::YAML::Meta::Version - Validation of META.yml specification elements.

=head1 SYNOPSIS

  use Test::YAML::Meta::Version;

=head1 DESCRIPTION

This module was written to ensure that a META.yml file, provided with a 
standard distribution uploaded to CPAN, meets the specifications that are 
slowly being introduced to module uploads, via the use of 
L<ExtUtils::MakeMaker>, L<Module::Build> and L<Module::Install>.

This module is meant to be used together with L<Test::YAML::Meta>, however
the code is self contained enough that you can access it directly.

=head1 ABSTRACT

Validation of META.yml specification elements.

=cut

=head1 CLASS CONSTRUCTOR

=over

=item * new( yaml => $yaml [, spec => $version] )

The constructor must be passed a valid YAML data structure. 

Optionally you may also provide a specification version. This version is then
use to ensure that the given YAML data structure meets the respective 
specification definition. If no version is provided the module will attempt to 
deduce the appropriate specification version from the data structure itself.

=back

=cut

=head1 METHODS

=head2 Main Methods

=over

=item * parse()

Using the YAML data structure provided with the constructure, attempts to 
parse and validate according to the appropriate specification definition.

Returns 1 if any errors found, otherwise returns 0.

=item * errors()

Returns a list of the errors found during parsing.

=back

=cut

=head2 Check Methods

=over

=item * check_map($spec,$data)

Checks whether a map (or hash) part of the YAML data structure conforms to the 
appropriate specification definition.

=item * check_list($spec,$data)

Checks whether a list (or array) part of the YAML data structure conforms to 
the appropriate specification definition.

=back

=cut

=head2 Validator Methods

=over

=item * header($self,$key,$value)

Validates that the YAML header is valid.

Note: No longer used as we now read the YAML data structure, not the file.

=item * url($self,$key,$value)

Validates that a given value is in an acceptable URL format

=item * urlspec($self,$key,$value)

Validates that the URL to a META.yml specification is a known one.

=item * string_or_undef($self,$key,$value)

Validates that the value is either a string or an undef value. Bit of a 
catchall function for parts of the data structure that are completely user
defined.

=item * string($self,$key,$value)

Validates that a string exists for the given key.

=item * file($self,$key,$value)

Validate that a file is passed for the given key. This may be made more
thorough in the future. For now it acts like \&string.

=item * exversion($self,$key,$value)

Validates a list of versions, e.g. '<= 5, >=2, ==3, !=4, >1, <6, 0'.

=item * version($self,$key,$value)

Validates a single version string. Versions of the type '5.8.8' and '0.00_00'
are both valid.

=item * boolean($self,$key,$value)

Validates for a boolean value. Currently these values are '1', '0', 'true', 
'false', however the latter 2 may be removed.

=item * license($self,$key,$value)

Validates that the given value represents an known license type.

=item * resource($self,$key,$value)

Validates that the given key is in CamelCase, to indicate a user defined 
keyword.

=item * word($self,$key,$value)

Validates that key is in an acceptable format for the META.yml specification,
i.e. any in the character class [-_a-z].

=item * module($self,$key,$value)

Validates that a given key is in an acceptable module name format, e.g. 
'Test::YAML::Meta::Version'.

=back

=cut