package MooseX::Singleton;
-use Moose 0.74 ();
+use Moose 1.10 ();
use Moose::Exporter;
-use MooseX::Singleton::Object;
-use MooseX::Singleton::Meta::Class;
+use MooseX::Singleton::Role::Object;
+use MooseX::Singleton::Role::Meta::Class;
+use MooseX::Singleton::Role::Meta::Instance;
-our $VERSION = '0.16';
-$VERSION = eval $VERSION;
Moose::Exporter->setup_import_methods( also => 'Moose' );
sub init_meta {
shift;
- Moose->init_meta(
- @_,
- base_class => 'MooseX::Singleton::Object',
- metaclass => 'MooseX::Singleton::Meta::Class',
+ my %p = @_;
+
+ Moose->init_meta(%p);
+
+ my $caller = $p{for_class};
+
+ Moose::Util::MetaRole::apply_metaroles(
+ for => $caller,
+ class_metaroles => {
+ class => ['MooseX::Singleton::Role::Meta::Class'],
+ instance =>
+ ['MooseX::Singleton::Role::Meta::Instance'],
+ constructor =>
+ ['MooseX::Singleton::Role::Meta::Method::Constructor'],
+ },
);
-}
-1;
+ Moose::Util::MetaRole::apply_base_class_roles(
+ for_class => $caller,
+ roles =>
+ ['MooseX::Singleton::Role::Object'],
+ );
-__END__
+ return $caller->meta();
+}
-=pod
-=head1 NAME
+1;
-MooseX::Singleton - turn your Moose class into a singleton
+# ABSTRACT: turn your Moose class into a singleton
-=head1 VERSION
+__END__
-Version 0.16, released 24 May 08
+=pod
=head1 SYNOPSIS
L<Moose> class to a singleton.
All you should need to do to transform your class is to change C<use Moose> to
-C<use MooseX::Singleton>. This module uses a new class metaclass and instance
-metaclass, so if you're doing metamagic you may not be able to use this.
-
-C<MooseX::Singleton> gives your class an C<instance> method that can be used to
-get a handle on the singleton. It's actually just an alias for C<new>.
+C<use MooseX::Singleton>. This module uses metaclass roles to do its magic, so
+it should cooperate with most other C<MooseX> modules.
-Alternatively, C<< YourPackage->method >> should just work. This includes
-accessors.
+=head1 METHODS
-If you need to reset your class's singleton object for some reason (e.g.
-tests), you can call C<< YourPackage->_clear_instance >>.
+A singleton class will have the following additional methods:
-=head1 TODO
+=head2 Singleton->instance
-=over
+This returns the singleton instance for the given package. This method does
+I<not> accept any arguments. If the instance does not yet exist, it is created
+with its defaults values. This means that if your singleton requires
+arguments, calling C<instance> will die if the object has not already been
+initialized.
-=item Always more tests and doc
+=head2 Singleton->initialize(%args)
-=item Fix speed boost
+This method can be called I<only once per class>. It explicitly initializes
+the singleton object with the given arguments.
-C<instance> invokes C<new> every time C<< Package->method >> is called, which
-incurs a nontrivial runtime cost. I've implemented a short-circuit for this
-case, which does eliminate nearly all of the runtime cost. However, it's ugly
-and should be fixed in a more elegant way.
+=head2 Singleton->_clear_instance
-=back
-
-=head1 BUGS
+This clears the existing singleton instance for the class. Obviously, this is
+meant for use only inside the class itself.
-All complex software has bugs lurking in it, and this module is no
-exception. If you find a bug please either email me, or add the bug
-to cpan-RT.
+=head2 Singleton->new
-=head1 AUTHORS
+This method currently works like a hybrid of C<initialize> and
+C<instance>. However, calling C<new> directly will probably be deprecated in a
+future release. Instead, call C<initialize> or C<instance> as appropriate.
-Shawn M Moore E<lt>sartak@gmail.comE<gt>
+=head1 BUGS
-Dave Rolsky E<lt>autarch@urth.orgE<gt>
+Please report any bugs or feature requests to
+C<bug-moosex-singleton@rt.cpan.org>, or through the web interface at
+L<http://rt.cpan.org>. We will be notified, and then you'll automatically be
+notified of progress on your bug as we make changes.
=head1 SOME CODE STOLEN FROM
Ricardo SIGNES E<lt>rjbs@cpan.orgE<gt>
-=head1 COPYRIGHT AND LICENSE
-
-Copyright 2007, 2008 Infinity Interactive
-
-This program is free software; you can redistribute it and/or modify it under
-the same terms as Perl itself.
-
=cut