summaryrefslogtreecommitdiff
path: root/lib/Sub
diff options
context:
space:
mode:
authorLorry Tar Creator <lorry-tar-importer@lorry>2013-10-28 18:09:08 +0000
committerLorry Tar Creator <lorry-tar-importer@lorry>2013-10-28 18:09:08 +0000
commit1f3ec55911f841590a62ed06becc2bd9131a5fc4 (patch)
treec5cc7c17e75fff9f97efbd575d464cb9da4f60e9 /lib/Sub
downloadSub-Exporter-Progressive-tarball-master.tar.gz
Sub-Exporter-Progressive-0.001011HEADSub-Exporter-Progressive-0.001011master
Diffstat (limited to 'lib/Sub')
-rw-r--r--lib/Sub/Exporter/Progressive.pm158
1 files changed, 158 insertions, 0 deletions
diff --git a/lib/Sub/Exporter/Progressive.pm b/lib/Sub/Exporter/Progressive.pm
new file mode 100644
index 0000000..0ee231a
--- /dev/null
+++ b/lib/Sub/Exporter/Progressive.pm
@@ -0,0 +1,158 @@
+package Sub::Exporter::Progressive;
+
+use strict;
+use warnings;
+
+our $VERSION = '0.001011';
+
+use Carp ();
+use List::Util ();
+
+sub import {
+ my ($self, @args) = @_;
+
+ my $inner_target = caller;
+ my $export_data = sub_export_options($inner_target, @args);
+
+ my $full_exporter;
+ no strict 'refs';
+ @{"${inner_target}::EXPORT_OK"} = @{$export_data->{exports}};
+ @{"${inner_target}::EXPORT"} = @{$export_data->{defaults}};
+ %{"${inner_target}::EXPORT_TAGS"} = %{$export_data->{tags}};
+ *{"${inner_target}::import"} = sub {
+ use strict;
+ my ($self, @args) = @_;
+
+ if (List::Util::first { ref || !m/ \A [:-]? \w+ \z /xm } @args) {
+ Carp::croak 'your usage of Sub::Exporter::Progressive requires Sub::Exporter to be installed'
+ unless eval { require Sub::Exporter };
+ $full_exporter ||= Sub::Exporter::build_exporter($export_data->{original});
+
+ goto $full_exporter;
+ } elsif (defined(my $num = List::Util::first { !ref and m/^\d/ } @args)) {
+ die "cannot export symbols with a leading digit: '$num'";
+ } else {
+ require Exporter;
+ s/ \A - /:/xm for @args;
+ @_ = ($self, @args);
+ goto \&Exporter::import;
+ }
+ };
+ return;
+}
+
+my $too_complicated = <<'DEATH';
+You are using Sub::Exporter::Progressive, but the features your program uses from
+Sub::Exporter cannot be implemented without Sub::Exporter, so you might as well
+just use vanilla Sub::Exporter
+DEATH
+
+sub sub_export_options {
+ my ($inner_target, $setup, $options) = @_;
+
+ my @exports;
+ my @defaults;
+ my %tags;
+
+ if ($setup eq '-setup') {
+ my %options = %$options;
+
+ OPTIONS:
+ for my $opt (keys %options) {
+ if ($opt eq 'exports') {
+
+ Carp::croak $too_complicated if ref $options{exports} ne 'ARRAY';
+ @exports = @{$options{exports}};
+ Carp::croak $too_complicated if List::Util::first { ref } @exports;
+
+ } elsif ($opt eq 'groups') {
+ %tags = %{$options{groups}};
+ for my $tagset (values %tags) {
+ Carp::croak $too_complicated if List::Util::first { / \A - (?! all \b ) /x || ref } @{$tagset};
+ }
+ @defaults = @{$tags{default} || [] };
+ } else {
+ Carp::croak $too_complicated;
+ }
+ }
+ @{$_} = map { / \A [:-] all \z /x ? @exports : $_ } @{$_} for \@defaults, values %tags;
+ $tags{all} ||= [ @exports ];
+ my %exports = map { $_ => 1 } @exports;
+ my @errors = grep { not $exports{$_} } @defaults;
+ Carp::croak join(', ', @errors) . " is not exported by the $inner_target module\n" if @errors;
+ }
+
+ return {
+ exports => \@exports,
+ defaults => \@defaults,
+ original => $options,
+ tags => \%tags,
+ };
+}
+
+1;
+
+=encoding utf8
+
+=head1 NAME
+
+Sub::Exporter::Progressive - Only use Sub::Exporter if you need it
+
+=head1 SYNOPSIS
+
+ package Syntax::Keyword::Gather;
+
+ use Sub::Exporter::Progressive -setup => {
+ exports => [qw( break gather gathered take )],
+ groups => {
+ default => [qw( break gather gathered take )],
+ },
+ };
+
+ # elsewhere
+
+ # uses Exporter for speed
+ use Syntax::Keyword::Gather;
+
+ # somewhere else
+
+ # uses Sub::Exporter for features
+ use Syntax::Keyword::Gather 'gather', take => { -as => 'grab' };
+
+=head1 DESCRIPTION
+
+L<Sub::Exporter> is an incredibly powerful module, but with that power comes
+great responsibility, er- as well as some runtime penalties. This module
+is a C<Sub::Exporter> wrapper that will let your users just use L<Exporter>
+if all they are doing is picking exports, but use C<Sub::Exporter> if your
+users try to use C<Sub::Exporter>'s more advanced features, like
+renaming exports, if they try to use them.
+
+Note that this module will export C<@EXPORT>, C<@EXPORT_OK> and
+C<%EXPORT_TAGS> package variables for C<Exporter> to work. Additionally, if
+your package uses advanced C<Sub::Exporter> features like currying, this module
+will only ever use C<Sub::Exporter>, so you might as well use it directly.
+
+=head1 AUTHOR
+
+frew - Arthur Axel Schmidt (cpan:FREW) <frioux+cpan@gmail.com>
+
+=head1 CONTRIBUTORS
+
+ilmari - Dagfinn Ilmari Mannsåker (cpan:ILMARI) <ilmari@ilmari.org>
+
+mst - Matt S. Trout (cpan:MSTROUT) <mst@shadowcat.co.uk>
+
+leont - Leon Timmermans (cpan:LEONT) <leont@cpan.org>
+
+=head1 COPYRIGHT
+
+Copyright (c) 2012 the Sub::Exporter::Progressive L</AUTHOR> and
+L</CONTRIBUTORS> as listed above.
+
+=head1 LICENSE
+
+This library is free software and may be distributed under the same terms
+as perl itself.
+
+=cut