X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=gitmo%2FMooseX-Singleton.git;a=blobdiff_plain;f=lib%2FMooseX%2FSingleton.pm;h=6b8a84bd4d0ce1e7904ac87610cdfc48a9cafe22;hp=c8c41235d5baa8d77ef2fb785c0624ef8ea3d6f9;hb=c77ec30d3f650b696438bc3dff1544f193efb54c;hpb=109b110b1d5969c8ae2ec7a5e5d86066f895d828 diff --git a/lib/MooseX/Singleton.pm b/lib/MooseX/Singleton.pm index c8c4123..6b8a84b 100644 --- a/lib/MooseX/Singleton.pm +++ b/lib/MooseX/Singleton.pm @@ -1,20 +1,130 @@ package MooseX::Singleton; -use Moose; -use MooseX::Singleton::Object; -use MooseX::Singleton::Meta::Class; -our $VERSION = 0.02; +use Moose 0.82 (); +use Moose::Exporter; +use MooseX::Singleton::Role::Object; +use MooseX::Singleton::Role::Meta::Class; +use MooseX::Singleton::Role::Meta::Instance; -sub import { - my $caller = caller; +our $VERSION = '0.21'; +$VERSION = eval $VERSION; - Moose::init_meta($caller, 'MooseX::Singleton::Object', 'MooseX::Singleton::Meta::Class'); +Moose::Exporter->setup_import_methods( also => 'Moose' ); - Moose->import({into => $caller}); - strict->import; - warnings->import; +sub init_meta { + shift; + my %p = @_; + Moose->init_meta(%p); + + my $caller = $p{for_class}; + + Moose::Util::MetaRole::apply_metaclass_roles( + for_class => $caller, + metaclass_roles => ['MooseX::Singleton::Role::Meta::Class'], + instance_metaclass_roles => + ['MooseX::Singleton::Role::Meta::Instance'], + constructor_class_roles => + ['MooseX::Singleton::Role::Meta::Method::Constructor'], + ); + + Moose::Util::MetaRole::apply_base_class_roles( + for_class => $caller, + roles => + ['MooseX::Singleton::Role::Object'], + ); + + return $caller->meta(); } + 1; +__END__ + +=pod + +=head1 NAME + +MooseX::Singleton - turn your Moose class into a singleton + +=head1 SYNOPSIS + + package MyApp; + use MooseX::Singleton; + + has env => ( + is => 'rw', + isa => 'HashRef[Str]', + default => sub { \%ENV }, + ); + + package main; + + delete MyApp->env->{PATH}; + my $instance = MyApp->instance; + my $same = MyApp->instance; + +=head1 DESCRIPTION + +A singleton is a class that has only one instance in an application. +C lets you easily upgrade (or downgrade, as it were) your +L class to a singleton. + +All you should need to do to transform your class is to change C to +C. 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 gives your class an C method that can be used to +get a handle on the singleton. It's actually just an alias for C. + +Alternatively, C<< YourPackage->method >> should just work. This includes +accessors. + +If you need to reset your class's singleton object for some reason (e.g. +tests), you can call C<< YourPackage->_clear_instance >>. + +=head1 TODO + +=over + +=item Always more tests and doc + +=item Fix speed boost + +C invokes C 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. + +=back + +=head1 BUGS + +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. + +=head1 AUTHORS + +Shawn M Moore Esartak@gmail.comE + +Dave Rolsky Eautarch@urth.orgE + +=head1 SOME CODE STOLEN FROM + +Anders Nor Berle Edebolaz@gmail.comE + +=head1 AND PATCHES FROM + +Ricardo SIGNES Erjbs@cpan.orgE + +=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 +