bump Moose prereq to 0.94

[gitmo/MooseX-Singleton.git] / lib / MooseX / Singleton.pm

diff --git a/lib/MooseX/Singleton.pm b/lib/MooseX/Singleton.pm
index 4dee3cd..b73707e 100644 (file)
--- a/lib/MooseX/Singleton.pm
+++ b/lib/MooseX/Singleton.pm
@@ -1,24 +1,45 @@
 package MooseX::Singleton;
 
-use Moose ();
+use Moose 0.94 ();
 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.13';
+our $VERSION = '0.23';
 $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'],
+        },
     );
+
+    Moose::Util::MetaRole::apply_base_class_roles(
+        for_class => $caller,
+        roles =>
+            ['MooseX::Singleton::Role::Object'],
+    );
+
+    return $caller->meta();
 }
 
+
 1;
 
 __END__
@@ -29,10 +50,6 @@ __END__
 
 MooseX::Singleton - turn your Moose class into a singleton
 
-=head1 VERSION
-
-Version 0.08, released 24 May 08
-
 =head1 SYNOPSIS
 
     package MyApp;
@@ -57,34 +74,43 @@ C<MooseX::Singleton> lets you easily upgrade (or downgrade, as it were) your
 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<use MooseX::Singleton>. This module uses metaclass roles to do its magic, so
+it should cooperate with most other C<MooseX> modules.
+
+=head1 METHODS
+
+A singleton class will have the following additional methods:
 
-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>.
+=head2 Singleton->instance
 
-Alternatively, C<< YourPackage->method >> should just work. This includes
-accessors.
+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.
 
-=head1 TODO
+=head2 Singleton->initialize(%args)
 
-=over
+This method can be called I<only once per class>. It explicitly initializes
+the singleton object with the given arguments.
 
-=item Always more tests and doc
+=head2 Singleton->_clear_instance
 
-=item Fix speed boost
+This clears the existing singleton instance for the class. Obviously, this is
+meant for use only inside the class itself.
 
-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->new
 
-=back
+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.
 
 =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.
+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 AUTHORS
 
@@ -102,7 +128,7 @@ Ricardo SIGNES E<lt>rjbs@cpan.orgE<gt>
 
 =head1 COPYRIGHT AND LICENSE
 
-Copyright 2007, 2008 Infinity Interactive
+Copyright 2007-2009 Infinity Interactive
 
 This program is free software; you can redistribute it and/or modify it under
 the same terms as Perl itself.