lib/MooseX/Singleton.pm

   1 package MooseX::Singleton;
   2
   3 use Moose 0.82 ();
   4 use Moose::Exporter;
   5 use MooseX::Singleton::Role::Object;
   6 use MooseX::Singleton::Role::Meta::Class;
   7 use MooseX::Singleton::Role::Meta::Instance;
   8
   9 our $VERSION = '0.21';
  10 $VERSION = eval $VERSION;
  11
  12 Moose::Exporter->setup_import_methods( also => 'Moose' );
  13
  14 sub init_meta {
  15     shift;
  16     my %p = @_;
  17
  18     Moose->init_meta(%p);
  19
  20     my $caller = $p{for_class};
  21
  22     Moose::Util::MetaRole::apply_metaclass_roles(
  23         for_class       => $caller,
  24         metaclass_roles => ['MooseX::Singleton::Role::Meta::Class'],
  25         instance_metaclass_roles =>
  26             ['MooseX::Singleton::Role::Meta::Instance'],
  27         constructor_class_roles =>
  28             ['MooseX::Singleton::Role::Meta::Method::Constructor'],
  29     );
  30
  31     Moose::Util::MetaRole::apply_base_class_roles(
  32         for_class => $caller,
  33         roles =>
  34             ['MooseX::Singleton::Role::Object'],
  35     );
  36
  37     return $caller->meta();
  38 }
  39
  40
  41 1;
  42
  43 __END__
  44
  45 =pod
  46
  47 =head1 NAME
  48
  49 MooseX::Singleton - turn your Moose class into a singleton
  50
  51 =head1 SYNOPSIS
  52
  53     package MyApp;
  54     use MooseX::Singleton;
  55
  56     has env => (
  57         is      => 'rw',
  58         isa     => 'HashRef[Str]',
  59         default => sub { \%ENV },
  60     );
  61
  62     package main;
  63
  64     delete MyApp->env->{PATH};
  65     my $instance = MyApp->instance;
  66     my $same = MyApp->instance;
  67
  68 =head1 DESCRIPTION
  69
  70 A singleton is a class that has only one instance in an application.
  71 C<MooseX::Singleton> lets you easily upgrade (or downgrade, as it were) your
  72 L<Moose> class to a singleton.
  73
  74 All you should need to do to transform your class is to change C<use Moose> to
  75 C<use MooseX::Singleton>. This module uses metaclass roles to do its magic, so
  76 it should cooperate with most other C<MooseX> modules.
  77
  78 =head1 METHODS
  79
  80 A singleton class will have the following additional methods:
  81
  82 =head2 Singleton->instance
  83
  84 This returns the singleton instance for the given package. This method does
  85 I<not> accept any arguments. If the instance does not yet exist, it is created
  86 with its defaults values. This means that if your singleton requires
  87 arguments, calling C<instance> will die if the object has not already been
  88 initialized.
  89
  90 =head2 Singleton->initialize(%args)
  91
  92 This method can be called I<only once per class>. It explicitly initializes
  93 the singleton object with the given arguments.
  94
  95 =head2 Singleton->_clear_instance
  96
  97 This clears the existing singleton instance for the class. Obviously, this is
  98 meant for use only inside the class itself.
  99
 100 =head1 BUGS
 101
 102 Please report any bugs or feature requests to
 103 C<bug-moosex-singleton@rt.cpan.org>, or through the web interface at
 104 L<http://rt.cpan.org>. We will be notified, and then you'll automatically be
 105 notified of progress on your bug as we make changes.
 106
 107 =head1 AUTHORS
 108
 109 Shawn M Moore E<lt>sartak@gmail.comE<gt>
 110
 111 Dave Rolsky E<lt>autarch@urth.orgE<gt>
 112
 113 =head1 SOME CODE STOLEN FROM
 114
 115 Anders Nor Berle E<lt>debolaz@gmail.comE<gt>
 116
 117 =head1 AND PATCHES FROM
 118
 119 Ricardo SIGNES E<lt>rjbs@cpan.orgE<gt>
 120
 121 =head1 COPYRIGHT AND LICENSE
 122
 123 Copyright 2007-2009 Infinity Interactive
 124
 125 This program is free software; you can redistribute it and/or modify it under
 126 the same terms as Perl itself.
 127
 128 =cut
 129