/ 
Astro-SIMBAD-Client-0.029
/ Astro::SIMBAD::Client::Meta

NAME

Astro::SIMBAD::Client::Meta - Information needed to build Astro::SIMBAD::Client

SYNOPSIS

use lib qw{ inc };
use Astro::SIMBAD::Client::Meta;
my $meta = Astro::SIMBAD::Client::Meta->new();
use YAML;
print "Required modules:\n", Dump(
    $meta->requires() );

DETAILS

This module centralizes information needed to build Astro::SIMBAD::Client. It is private to the Astro::SIMBAD::Client package, and may be changed or retracted without notice.

METHODS

This class supports the following public methods:

new

my $meta = Astro::Simbad::Client::Meta->new();

This method instantiates the class.

build_requires

use YAML;
print Dump( $meta->build_requires() );

This method computes and returns a reference to a hash describing the modules required to build the Astro::SIMBAD::Client package, suitable for use in a Build.PL build_requires key, or a Makefile.PL {META_MERGE}->{build_requires} or BUILD_REQUIRES key.

distribution

if ( $meta->distribution() ) {
    print "Making distribution\n";
} else {
    print "Not making distribution\n";
}

This method returns the value of the environment variable MAKING_MODULE_DISTRIBUTION at the time the object was instantiated.

requires

use YAML;
print Dump( $meta->requires() );

This method computes and returns a reference to a hash describing the modules required to run the Astro::SIMBAD::Client package, suitable for use in a Build.PL requires key, or a Makefile.PL PREREQ_PM key. Any additional arguments will be appended to the generated hash. In addition, unless distribution() is true, configuration-specific modules may be added.

requires_perl

print 'This package requires Perl ', $meta->requires_perl(), "\n";

This method returns the version of Perl required by the package.

ATTRIBUTES

This class has no public attributes.

ENVIRONMENT

MAKING_MODULE_DISTRIBUTION

This environment variable should be set to a true value if you are making a distribution. This ensures that no configuration-specific information makes it into META.yml.

SUPPORT

Support is by the author. Please file bug reports at http://rt.cpan.org, or in electronic mail to the author.

AUTHOR

Thomas R. Wyant, III wyant at cpan dot org

COPYRIGHT AND LICENSE

Copyright (C) 2010-2013 by Thomas R. Wyant, III

This program is free software; you can redistribute it and/or modify it under the same terms as Perl 5.10.0. For more details, see the full text of the licenses in the directory LICENSES.

This program is distributed in the hope that it will be useful, but without any warranty; without even the implied warranty of merchantability or fitness for a particular purpose.