Tweaks
[gitmo/Mouse.git] / lib / Mouse / Exporter.pm
CommitLineData
db9fc237 1package Mouse::Exporter;
2use strict;
3use warnings;
4
08ee26f4 5use Carp ();
db9fc237 6
db9fc237 7my %SPEC;
8
57633577 9my $strict_bits;
10BEGIN{ $strict_bits = strict::bits(qw(subs refs vars)); }
1ff34b4c 11
8a3fa349 12my $warnings_extra_bits;
13BEGIN{ $warnings_extra_bits = warnings::bits(FATAL => 'recursion') }
14
0eb86915 15# it must be "require", because Mouse::Util depends on Mouse::Exporter,
16# which depends on Mouse::Util::import()
17require Mouse::Util;
18
1bd3c83e 19sub import{
8a3fa349 20 # strict->import;
21 $^H |= $strict_bits;
22 # warnings->import('all', FATAL => 'recursion');
23 ${^WARNING_BITS} |= $warnings::Bits{all};
24 ${^WARNING_BITS} |= $warnings_extra_bits;
1bd3c83e 25 return;
26}
27
0eb86915 28
db9fc237 29sub setup_import_methods{
30 my($class, %args) = @_;
31
32 my $exporting_package = $args{exporting_package} ||= caller();
33
e6dc493d 34 my($import, $unimport) = $class->build_import_methods(%args);
35
1194aede 36 Mouse::Util::install_subroutines($exporting_package,
37 import => $import,
38 unimport => $unimport,
39
40 export_to_level => sub {
41 my($package, $level, undef, @args) = @_; # the third argument is redundant
42 $package->import({ into_level => $level + 1 }, @args);
43 },
44 export => sub {
45 my($package, $into, @args) = @_;
46 $package->import({ into => $into }, @args);
47 },
48 );
e6dc493d 49 return;
50}
51
52sub build_import_methods{
230dd14a 53 my($self, %args) = @_;
e6dc493d 54
55 my $exporting_package = $args{exporting_package} ||= caller();
56
db9fc237 57 $SPEC{$exporting_package} = \%args;
58
59 # canonicalize args
60 my @export_from;
61 if($args{also}){
62 my %seen;
63 my @stack = ($exporting_package);
64
65 while(my $current = shift @stack){
66 push @export_from, $current;
67
68 my $also = $SPEC{$current}{also} or next;
0eb86915 69 push @stack, grep{ !$seen{$_}++ } ref($also) ? @{ $also } : $also;
db9fc237 70 }
71 }
72 else{
73 @export_from = ($exporting_package);
74 }
75
72dc2c9d 76 my %exports;
77 my @removables;
78 my @all;
79
80 my @init_meta_methods;
81
82 foreach my $package(@export_from){
83 my $spec = $SPEC{$package} or next;
1ff34b4c 84
72dc2c9d 85 if(my $as_is = $spec->{as_is}){
86 foreach my $thingy (@{$as_is}){
87 my($code_package, $code_name, $code);
88
89 if(ref($thingy)){
90 $code = $thingy;
91 ($code_package, $code_name) = Mouse::Util::get_code_info($code);
92 }
93 else{
72dc2c9d 94 $code_package = $package;
95 $code_name = $thingy;
1194aede 96 no strict 'refs';
72dc2c9d 97 $code = \&{ $code_package . '::' . $code_name };
98 }
99
100 push @all, $code_name;
101 $exports{$code_name} = $code;
102 if($code_package eq $package){
103 push @removables, $code_name;
1ff34b4c 104 }
105 }
db9fc237 106 }
1ff34b4c 107
72dc2c9d 108 if(my $init_meta = $package->can('init_meta')){
109 if(!grep{ $_ == $init_meta } @init_meta_methods){
110 push @init_meta_methods, $init_meta;
1ff34b4c 111 }
1ff34b4c 112 }
72dc2c9d 113 }
114 $args{EXPORTS} = \%exports;
115 $args{REMOVABLES} = \@removables;
1ff34b4c 116
72dc2c9d 117 $args{groups}{all} ||= \@all;
118
119 if(my $default_list = $args{groups}{default}){
120 my %default;
121 foreach my $keyword(@{$default_list}){
122 $default{$keyword} = $exports{$keyword}
08ee26f4 123 || Carp::confess(qq{The $exporting_package package does not export "$keyword"});
1ff34b4c 124 }
72dc2c9d 125 $args{DEFAULT} = \%default;
126 }
127 else{
128 $args{groups}{default} ||= \@all;
129 $args{DEFAULT} = $args{EXPORTS};
130 }
131
132 if(@init_meta_methods){
133 $args{INIT_META} = \@init_meta_methods;
db9fc237 134 }
135
e6dc493d 136 return (\&do_import, \&do_unimport);
db9fc237 137}
138
db9fc237 139
140# the entity of general import()
141sub do_import {
1ff34b4c 142 my($package, @args) = @_;
db9fc237 143
1ff34b4c 144 my $spec = $SPEC{$package}
08ee26f4 145 || Carp::confess("The package $package package does not use Mouse::Exporter");
db9fc237 146
147 my $into = _get_caller_package(ref($args[0]) ? shift @args : undef);
148
149 my @exports;
45bbec05 150 my @traits;
8cbcbb47 151
45bbec05 152 while(@args){
153 my $arg = shift @args;
1ff34b4c 154 if($arg =~ s/^-//){
45bbec05 155 if($arg eq 'traits'){
f12892e5 156 push @traits, ref($args[0]) ? @{shift(@args)} : shift(@args);
45bbec05 157 }
158 else {
159 Mouse::Util::not_supported("-$arg");
160 }
1ff34b4c 161 }
162 elsif($arg =~ s/^://){
1bd3c83e 163 my $group = $spec->{groups}{$arg}
08ee26f4 164 || Carp::confess(qq{The $package package does not export the group "$arg"});
db9fc237 165 push @exports, @{$group};
166 }
167 else{
168 push @exports, $arg;
169 }
170 }
171
4bef84ef 172 # strict->import;
173 $^H |= $strict_bits;
8a3fa349 174 # warnings->import('all', FATAL => 'recursion');
175 ${^WARNING_BITS} |= $warnings::Bits{all};
176 ${^WARNING_BITS} |= $warnings_extra_bits;
db9fc237 177
1ff34b4c 178 if($spec->{INIT_META}){
45bbec05 179 my $meta;
1ff34b4c 180 foreach my $init_meta(@{$spec->{INIT_META}}){
134f7bcb 181 $meta = $package->$init_meta(for_class => $into);
1ff34b4c 182 }
db9fc237 183
45bbec05 184 if(@traits){
185 my $type = (split /::/, ref $meta)[-1]; # e.g. "Class" for "My::Meta::Class"
186 @traits =
f12892e5 187 map{
188 ref($_) ? $_
189 : Mouse::Util::resolve_metaclass_alias($type => $_, trait => 1)
190 } @traits;
45bbec05 191
45bbec05 192 require Mouse::Util::MetaRole;
3d7c6ec9 193 Mouse::Util::MetaRole::apply_metaroles(
194 for => $into,
195 Mouse::Util::is_a_metarole($into->meta)
196 ? (role_metaroles => { role => \@traits })
197 : (class_metaroles => { class => \@traits }),
45bbec05 198 );
199 }
db9fc237 200 }
f12892e5 201 elsif(@traits){
202 Carp::confess("Cannot provide traits when $package does not have an init_meta() method");
203 }
db9fc237 204
1ff34b4c 205 if(@exports){
1194aede 206 my @export_table;
1ff34b4c 207 foreach my $keyword(@exports){
1194aede 208 push @export_table,
209 $keyword => ($spec->{EXPORTS}{$keyword}
08ee26f4 210 || Carp::confess(qq{The $package package does not export "$keyword"})
1194aede 211 );
1ff34b4c 212 }
1194aede 213 Mouse::Util::install_subroutines($into, @export_table);
1ff34b4c 214 }
215 else{
1194aede 216 Mouse::Util::install_subroutines($into, %{$spec->{DEFAULT}});
db9fc237 217 }
218 return;
219}
220
221# the entity of general unimport()
222sub do_unimport {
1ff34b4c 223 my($package, $arg) = @_;
db9fc237 224
1ff34b4c 225 my $spec = $SPEC{$package}
08ee26f4 226 || Carp::confess("The package $package does not use Mouse::Exporter");
db9fc237 227
228 my $from = _get_caller_package($arg);
229
230 my $stash = do{
231 no strict 'refs';
232 \%{$from . '::'}
233 };
234
235 for my $keyword (@{ $spec->{REMOVABLES} }) {
21df8e42 236 next if !exists $stash->{$keyword};
4ee3190e 237 my $gv = \$stash->{$keyword};
238 if(ref($gv) eq 'GLOB' && *{$gv}{CODE} == $spec->{EXPORTS}{$keyword}){ # make sure it is from us
239 delete $stash->{$keyword};
240 }
db9fc237 241 }
242 return;
243}
244
245sub _get_caller_package {
246 my($arg) = @_;
247
7ad9df77 248 # We need one extra level because it's called by import so there's a layer
249 # of indirection
db9fc237 250 if(ref $arg){
251 return defined($arg->{into}) ? $arg->{into}
7ad9df77 252 : defined($arg->{into_level}) ? scalar caller(1 + $arg->{into_level})
253 : scalar caller(1);
db9fc237 254 }
255 else{
7ad9df77 256 return scalar caller(1);
db9fc237 257 }
258}
259
99934a1b 260#sub _spec{ %SPEC }
261
db9fc237 2621;
db9fc237 263__END__
264
265=head1 NAME
266
8cbcbb47 267Mouse::Exporter - make an import() and unimport() just like Mouse.pm
db9fc237 268
a25ca8d6 269=head1 VERSION
270
b0d52f03 271This document describes Mouse version 0.73
a25ca8d6 272
db9fc237 273=head1 SYNOPSIS
274
7ad9df77 275 package MyApp::Mouse;
276
277 use Mouse ();
278 use Mouse::Exporter;
279
280 Mouse::Exporter->setup_import_methods(
281 as_is => [ 'has_rw', 'other_sugar', \&Some::Random::thing ],
282 also => 'Mouse',
283 );
284
8cbcbb47 285 sub has_rw {
7ad9df77 286 my $meta = caller->meta;
287 my ( $name, %options ) = @_;
288 $meta->add_attribute(
289 $name,
290 is => 'rw',
291 %options,
292 );
293 }
294
295 # then later ...
296 package MyApp::User;
297
298 use MyApp::Mouse;
299
300 has 'name';
301 has_rw 'size';
302 thing;
303
8cbcbb47 304 no MyApp::Mouse;
db9fc237 305
306=head1 DESCRIPTION
307
7ad9df77 308This module encapsulates the exporting of sugar functions in a
309C<Mouse.pm>-like manner. It does this by building custom C<import>,
310C<unimport> methods for your module, based on a spec you provide.
8cbcbb47 311
312Note that C<Mouse::Exporter> does not provide the C<with_meta> option,
313but you can easily get the metaclass by C<< caller->meta >> as L</SYNOPSIS> shows.
db9fc237 314
e6dc493d 315=head1 METHODS
316
317=head2 C<< setup_import_methods( ARGS ) >>
318
319=head2 C<< build_import_methods( ARGS ) -> (\&import, \&unimport) >>
320
db9fc237 321=head1 SEE ALSO
322
323L<Moose::Exporter>
324
5ea1528f 325=cut
326