lib/Class/MOP/Module.pm

   1
   2 package Class::MOP::Module;
   3
   4 use strict;
   5 use warnings;
   6
   7 use Carp         'confess';
   8 use Scalar::Util 'blessed';
   9
  10 our $VERSION   = '0.81';
  11 $VERSION = eval $VERSION;
  12 our $AUTHORITY = 'cpan:STEVAN';
  13
  14 use base 'Class::MOP::Package';
  15
  16 sub version {
  17     my $self = shift;
  18     ${$self->get_package_symbol({ sigil => '$', type => 'SCALAR', name => 'VERSION' })};
  19 }
  20
  21 sub authority {
  22     my $self = shift;
  23     ${$self->get_package_symbol({ sigil => '$', type => 'SCALAR', name => 'AUTHORITY' })};
  24 }
  25
  26 sub identifier {
  27     my $self = shift;
  28     join '-' => (
  29         $self->name,
  30         ($self->version   || ()),
  31         ($self->authority || ()),
  32     );
  33 }
  34
  35 sub create {
  36     confess "The Class::MOP::Module->create method has been made a private object method.\n";
  37 }
  38
  39 sub _instantiate_module {
  40     my $self      = shift;
  41     my $version   = shift;
  42     my $authority = shift;
  43
  44     my $package_name = $self->name;
  45
  46     my $code = "package $package_name;";
  47
  48     $code .= "\$$package_name\:\:VERSION = '" . $version . "';"
  49         if defined $version;
  50     $code .= "\$$package_name\:\:AUTHORITY = '" . $authority . "';"
  51         if defined $authority;
  52
  53     eval $code;
  54     confess "creation of $package_name failed : $@" if $@;
  55 }
  56
  57 1;
  58
  59 __END__
  60
  61 =pod
  62
  63 =head1 NAME
  64
  65 Class::MOP::Module - Module Meta Object
  66
  67 =head1 DESCRIPTION
  68
  69 A module is essentially a L<Class::MOP::Package> with metadata, in our
  70 case the version and authority.
  71
  72 =head1 INHERITANCE
  73
  74 B<Class::MOP::Module> is a subclass of L<Class::MOP::Package>.
  75
  76 =head1 METHODS
  77
  78 =over 4
  79
  80 =item B<< $metamodule->version >>
  81
  82 This is a read-only attribute which returns the C<$VERSION> of the
  83 package, if one exists.
  84
  85 =item B<< $metamodule->authority >>
  86
  87 This is a read-only attribute which returns the C<$AUTHORITY> of the
  88 package, if one exists.
  89
  90 =item B<< $metamodule->identifier >>
  91
  92 This constructs a string which combines the name, version and
  93 authority.
  94
  95 =item B<< Class::MOP::Module->meta >>
  96
  97 This will return a L<Class::MOP::Class> instance for this class.
  98
  99 =back
 100
 101 =head1 AUTHORS
 102
 103 Stevan Little E<lt>stevan@iinteractive.comE<gt>
 104
 105 =head1 COPYRIGHT AND LICENSE
 106
 107 Copyright 2006-2009 by Infinity Interactive, Inc.
 108
 109 L<http://www.iinteractive.com>
 110
 111 This library is free software; you can redistribute it and/or modify
 112 it under the same terms as Perl itself.
 113
 114 =cut