aliased-0.31000755000765000024 012110505266 13336 5ustar00curtispoestaff000000000000aliased-0.31/Build.PL000444000765000024 71712110505266 14754 0ustar00curtispoestaff000000000000use strict; use warnings; use Module::Build; my $builder = Module::Build->new( module_name => 'aliased', license => 'perl', dist_author => 'Curtis "Ovid" Poe ', dist_version_from => 'lib/aliased.pm', requires => {}, build_requires => { 'Test::More' => 0, }, add_to_cleanup => [ 'aliased-*' ], create_makefile_pl => 'traditional', ); $builder->create_build_script(); aliased-0.31/Changes000444000765000024 152312110505266 14767 0ustar00curtispoestaff000000000000Revision history for Perl extension aka. 0.21 February 18, 2013 Bumped the number for a production release. 0.30_01 January 3, 2010 Added prefix() function. [rt#48289] Moved Test::More to build_requires [rt#48926] Moved author tests to xt/author 0.30 5 August, 2009 Applied changes from Florian Ragwitz to ensure that we preserve the name of the package the alias is defined in. 0.22 12 February, 2008 Preserve $SIG{__DIE__} behavior just as if aliased had not been used. 0.21 29 March, 2007 Applied $SIG{__DIE__} patch from Schwern and tightened up the test. 0.12 23 August, 2005 Add pod and pod coverage tests Added patch from Schwern to allow aliasing to a scalar 0.10 Wed Jan 5 Changed name to 'aka' due to general consensus on the module-authors list. aliased-0.31/Makefile.PL000444000765000024 50612110505266 15426 0ustar00curtispoestaff000000000000# Note: this file was auto-generated by Module::Build::Compat version 0.4003 use ExtUtils::MakeMaker; WriteMakefile ( 'NAME' => 'aliased', 'VERSION_FROM' => 'lib/aliased.pm', 'PREREQ_PM' => { 'Test::More' => 0 }, 'INSTALLDIRS' => 'site', 'EXE_FILES' => [], 'PL_FILES' => {} ) ; aliased-0.31/MANIFEST000444000765000024 63112110505266 14604 0ustar00curtispoestaff000000000000Build.PL Changes lib/aliased.pm Makefile.PL MANIFEST META.yml Module meta-data (added by MakeMaker) README t/aliased.t t/import.t t/sigdie.t t/export.t t/prefix.t t/lib/HasSigDie.pm t/lib/BadSigDie.pm t/lib/NoSigDie.pm t/lib/Really/Long/Module/Conflicting/Name.pm t/lib/Really/Long/Module/Name.pm t/lib/Really/Long/Name.pm t/lib/Really/Long/PackageName.pm xt/author/pod-coverage.t xt/author/pod.t META.json aliased-0.31/META.json000444000765000024 160212110505266 15113 0ustar00curtispoestaff000000000000{ "abstract" : "Use shorter versions of class names.", "author" : [ "Curtis \"Ovid\" Poe " ], "dynamic_config" : 1, "generated_by" : "Module::Build version 0.4003, CPAN::Meta::Converter version 2.120630", "license" : [ "perl_5" ], "meta-spec" : { "url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec", "version" : "2" }, "name" : "aliased", "prereqs" : { "build" : { "requires" : { "Test::More" : "0" } }, "configure" : { "requires" : { "Module::Build" : "0.40" } } }, "provides" : { "aliased" : { "file" : "lib/aliased.pm", "version" : "0.31" } }, "release_status" : "stable", "resources" : { "license" : [ "http://dev.perl.org/licenses/" ] }, "version" : "0.31" } aliased-0.31/META.yml000444000765000024 101712110505266 14743 0ustar00curtispoestaff000000000000--- abstract: 'Use shorter versions of class names.' author: - "Curtis \"Ovid\" Poe " build_requires: Test::More: 0 configure_requires: Module::Build: 0.40 dynamic_config: 1 generated_by: 'Module::Build version 0.4003, CPAN::Meta::Converter version 2.120630' license: perl meta-spec: url: http://module-build.sourceforge.net/META-spec-v1.4.html version: 1.4 name: aliased provides: aliased: file: lib/aliased.pm version: 0.31 resources: license: http://dev.perl.org/licenses/ version: 0.31 aliased-0.31/README000444000765000024 100112110505266 14343 0ustar00curtispoestaff000000000000aliased version 0.21 ================== INSTALLATION To install this module type the following: perl Makefile.PL make make test make install DEPENDENCIES This module requires these other modules and libraries: Test::Simple 0.50 COPYRIGHT AND LICENCE Copyright (C) 2005 by Curtis Poe This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.5 or, at your option, any later version of Perl 5 you may have available. aliased-0.31/lib000755000765000024 012110505266 14104 5ustar00curtispoestaff000000000000aliased-0.31/lib/aliased.pm000444000765000024 2262412110505266 16227 0ustar00curtispoestaff000000000000package aliased; our $VERSION = '0.31'; $VERSION = eval $VERSION; require Exporter; @ISA = qw(Exporter); @EXPORT = qw(alias prefix); use strict; sub _croak { require Carp; Carp::croak(@_); } sub import { my ( $class, $package, $alias, @import ) = @_; if ( @_ <= 1 ) { $class->export_to_level(1); return; } my $callpack = caller(0); _load_alias( $package, $callpack, @import ); _make_alias( $package, $callpack, $alias ); } sub _get_alias { my $package = shift; $package =~ s/.*(?:::|')//; return $package; } sub _make_alias { my ( $package, $callpack, $alias ) = @_; $alias ||= _get_alias($package); my $destination = $alias =~ /::/ ? $alias : "$callpack\::$alias"; no strict 'refs'; *{ $destination } = sub () { $package }; } sub _load_alias { my ( $package, $callpack, @import ) = @_; # We don't localize $SIG{__DIE__} here because we need to be careful about # restoring its value if there is a failure. Very, very tricky. my $sigdie = $SIG{__DIE__}; { my $code = @import == 0 ? "package $callpack; use $package;" : "package $callpack; use $package (\@import)"; eval $code; if ( my $error = $@ ) { $SIG{__DIE__} = $sigdie; _croak($error); } $sigdie = $SIG{__DIE__} if defined $SIG{__DIE__}; } # Make sure a global $SIG{__DIE__} makes it out of the localization. $SIG{__DIE__} = $sigdie if defined $sigdie; return $package; } sub alias { my ( $package, @import ) = @_; my $callpack = scalar caller(0); return _load_alias( $package, $callpack, @import ); } sub prefix { my ($class) = @_; return sub { my ($name) = @_; my $callpack = caller(0); if ( not @_ ) { return _load_alias( $class, $callpack ); } elsif ( @_ == 1 && defined $name ) { return _load_alias( "${class}::$name", $callpack ); } else { _croak("Too many arguments to prefix('$class')"); } }; } 1; __END__ =head1 NAME aliased - Use shorter versions of class names. =head1 VERSION 0.31 =head1 SYNOPSIS # Class name interface use aliased 'My::Company::Namespace::Customer'; my $cust = Customer->new; use aliased 'My::Company::Namespace::Preferred::Customer' => 'Preferred'; my $pref = Preferred->new; # Variable interface use aliased; my $Customer = alias "My::Other::Namespace::Customer"; my $cust = $Customer->new; my $Preferred = alias "My::Other::Namespace::Preferred::Customer"; my $pref = $Preferred->new; =head1 DESCRIPTION C is simple in concept but is a rather handy module. It loads the class you specify and exports into your namespace a subroutine that returns the class name. You can explicitly alias the class to another name or, if you prefer, you can do so implicitly. In the latter case, the name of the subroutine is the last part of the class name. Thus, it does something similar to the following: #use aliased 'Some::Annoyingly::Long::Module::Name::Customer'; use Some::Annoyingly::Long::Module::Name::Customer; sub Customer { return 'Some::Annoyingly::Long::Module::Name::Customer'; } my $cust = Customer->new; This module is useful if you prefer a shorter name for a class. It's also handy if a class has been renamed. (Some may object to the term "aliasing" because we're not aliasing one namespace to another, but it's a handy term. Just keep in mind that this is done with a subroutine and not with typeglobs and weird namespace munging.) Note that this is B for Cing OO modules. You cannot use this to load procedural modules. See the L section. Also, don't let the version number fool you. This code is ridiculously simple and is just fine for most use. =head2 Implicit Aliasing The most common use of this module is: use aliased 'Some::Module::name'; C will allow you to reference the class by the last part of the class name. Thus, C becomes C. It does this by exporting a subroutine into your namespace with the same name as the aliased name. This subroutine returns the original class name. For example: use aliased "Acme::Company::Customer"; my $cust = Customer->find($id); Note that any class method can be called on the shorter version of the class name, not just the constructor. =head2 Explicit Aliasing Sometimes two class names can cause a conflict (they both end with C for example), or you already have a subroutine with the same name as the aliased name. In that case, you can make an explicit alias by stating the name you wish to alias to: use aliased 'Original::Module::Name' => 'NewName'; Here's how we use C to avoid conflicts: use aliased "Really::Long::Name"; use aliased "Another::Really::Long::Name" => "Aname"; my $name = Name->new; my $aname = Aname->new; You can even alias to a different package: use aliased "Another::Really::Long::Name" => "Another::Name"; my $aname = Another::Name->new; Messing around with different namespaces is a really bad idea and you probably don't want to do this. However, it might prove handy if the module you are using has been renamed. If the interface has not changed, this allows you to use the new module by only changing one line of code. use aliased "New::Module::Name" => "Old::Module::Name"; my $thing = Old::Module::Name->new; =head2 Import Lists Sometimes, even with an OO module, you need to specify extra arguments when using the module. When this happens, simply use L followed by the import list: Snippet 1: use Some::Module::Name qw/foo bar/; my $o = Some::Module::Name->some_class_method; Snippet 2 (equivalent to snippet 1): use aliased 'Some::Module::Name' => 'Name', qw/foo bar/; my $o = Name->some_class_method; B: remember, you cannot use import lists with L. As a result, you may simply prefer to only use L as a matter of style. =head2 alias() This function is only exported if you specify C with no import list. use aliased; my $alias = alias($class); my $alias = alias($class, @imports); alias() is an alternative to C which uses less magic and avoids some of the ambiguities. Like C it Cs the $class (pass in @imports, if given) but instead of providing an C constant it simply returns a scalar set to the $class name. my $thing = alias("Some::Thing::With::A::Long::Name"); # Just like Some::Thing::With::A::Long::Name->method $thing->method; The use of a scalar instead of a constant avoids any possible ambiguity when aliasing two similar names: # No ambiguity despite the fact that they both end with "Name" my $thing = alias("Some::Thing::With::A::Long::Name"); my $other = alias("Some::Other::Thing::With::A::Long::Name"); and there is no magic constant exported into your namespace. The only caveat is loading of the $class happens at run time. If $class exports anything you might want to ensure it is loaded at compile time with: my $thing; BEGIN { $thing = alias("Some::Thing"); } However, since OO classes rarely export this should not be necessary. =head2 prefix() (experimental) This function is only exported if you specify C with no import list. use aliased; Sometimes you find you have a ton of packages in the same top-level namespace and you want to alias them, but only use them on demand. For example: # instead of: MailVerwaltung::Client::Exception::REST::Response->throw() my $error = prefix('MailVerwaltung::Client::Exception'); $error->('REST::Response')->throw(); # same as above $error->()->throw; # same as MailVerwaltung::Client::Exception->throw =head2 Why OO Only? Some people have asked why this code only support object-oriented modules (OO). If I were to support normal subroutines, I would have to allow the following syntax: use aliased 'Some::Really::Long::Module::Name'; my $data = Name::data(); That causes a serious problem. The only (reasonable) way it can be done is to handle the aliasing via typeglobs. Thus, instead of a subroutine that provides the class name, we alias one package to another (as the L module does.) However, we really don't want to simply alias one package to another and wipe out namespaces willy-nilly. By merely exporting a single subroutine to a namespace, we minimize the issue. Fortunately, this doesn't seem to be that much of a problem. Non-OO modules generally support exporting of the functions you need and this eliminates the need for a module such as this. =head1 EXPORT This modules exports a subroutine with the same name as the "aliased" name. =head1 BUGS There are no known bugs in this module, but feel free to email me reports. =head1 SEE ALSO The L module. =head1 THANKS Many thanks to Rentrak, Inc. (http://www.rentrak.com/) for graciously allowing me to replicate the functionality of some of their internal code. =head1 AUTHOR Curtis Poe, C<< ovid [at] cpan [dot] org >> =head1 COPYRIGHT AND LICENSE Copyright (C) 2005 by Curtis "Ovid" Poe This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.5 or, at your option, any later version of Perl 5 you may have available. =cut aliased-0.31/t000755000765000024 012110505266 13601 5ustar00curtispoestaff000000000000aliased-0.31/t/aliased.t000555000765000024 364512110505266 15540 0ustar00curtispoestaff000000000000#!/usr/bin/perl -w use warnings; use strict; use Test::More tests => 18; BEGIN { chdir 't' if -d 't'; unshift @INC => '../lib', 'lib/'; require_ok 'aliased' or die; ok !defined &main::echo, '... and exported functions should not (yet) be in our namespace'; } ok !defined &alias, 'aliased() should not be exported by default'; eval "use aliased"; is $@, '', '... trying to use aliased without a package name should not fail'; can_ok __PACKAGE__, 'alias'; eval "use aliased 'No::Such::Module'"; ok $@, 'Trying to use aliased with a module it cannot load should fail'; like $@, qr{Can't locate No/Such/Module.pm in \@INC}, '... and it should have an appropriate error message'; use aliased 'Really::Long::Module::Name'; my $name = Name->new; isa_ok $name, 'Really::Long::Module::Name', '... and the object it returns'; use aliased 'Really::Long::Module::Conflicting::Name' => 'C::Name', "echo"; ok defined &main::echo, '... and import items should be handled correctly'; is_deeply [ echo( [ 1, 2 ], 3 ) ], [ [ 1, 2 ], 3 ], '... and exhibit the correct behavior'; ok $name = C::Name->new, 'We should be able to alias to different packages, even though that is really stupid'; isa_ok $name, 'Really::Long::Module::Conflicting::Name', '... and the object returned'; use aliased 'Really::Long::PackageName' => 'PackageName', qw/foo bar baz/; ok defined &PackageName, 'We should be able to pass an array ref as an import list'; foreach my $method (qw/foo bar baz/) { no strict 'refs'; is &$method, $method, '... and it should behave as expected'; } { package My::Package; use Test::More; use aliased 'Really::Long::Module::Name'; my $name = Name->new; isa_ok $name, 'Really::Long::Module::Name', '... a short alias works in a package'; use aliased 'Really::Long::Module::Name' => 'A::Name'; $name = A::Name->new; isa_ok $name, 'Really::Long::Module::Name', '... a long alias works in a package'; } aliased-0.31/t/export.t000444000765000024 42112110505266 15421 0ustar00curtispoestaff000000000000#!/usr/bin/perl -w use warnings; use strict; use Test::More; use B; use lib "t/lib"; use aliased 'Really::Long::Module::Name'; my $cv = B::svref_2object(\&Name); is($cv->GV->STASH->NAME, 'aliased', 'installed symbol was compiled in the aliased package'); done_testing; aliased-0.31/t/import.t000444000765000024 120012110505266 15426 0ustar00curtispoestaff000000000000#!/usr/bin/perl -w use warnings; use strict; use Test::More tests => 5; #use Test::More qw/no_plan/; BEGIN { chdir 't' if -d 't'; unshift @INC => '../lib', 'lib/'; use_ok 'aliased' or die "Could not use aliased"; } ok defined &alias, 'alias() should be imported into our namespace'; ok my $alias = alias("Really::Long::Name"), 'aliasing to a scalar should succeed'; is $alias->thing(2), 4, '... and it should return the correct results'; { package Foo::Bar; ::alias( "Really::Long::Module::Conflicting::Name", "echo" ); ::is_deeply [ echo("foo") ], ["foo"], '... and it should still allow importing'; } aliased-0.31/t/prefix.t000444000765000024 134412110505266 15422 0ustar00curtispoestaff000000000000#!/usr/bin/perl -w use warnings; use strict; use Test::More tests => 6; use aliased; ok defined &prefix, 'prefix() should be in our namespace if we ask for it'; ok defined &alias, 'alias() should be in our namespace if we ask for it'; { package Foo; sub checkit { 'foo checkit' } } { package Foo::Bar; sub checkit { 'foobar checkit' } } BEGIN { @INC{qw} = (1,1); } ok my $foo = prefix('Foo'), 'Calling prefix should succeed'; is ref $foo, 'CODE', '... returning a code ref'; is $foo->()->checkit, 'foo checkit', '... and called directly, returns the correct class'; is $foo->('Bar')->checkit, 'foobar checkit', '... and if called with a subpackage name, should also return the correct class'; aliased-0.31/t/sigdie.t000444000765000024 247512110505266 15377 0ustar00curtispoestaff000000000000#!/usr/bin/perl -w use warnings; use strict; use lib "t/lib"; BEGIN { # Ensure nothing else has loaded a $SIG{__DIE__} die if $SIG{__DIE__}; } # Test::Builder might have a $SIG{__DIE__}, too so we # make sure it is effected by any aliased bug, too. use aliased "Test::More"; use aliased "HasSigDie"; plan(tests => 9); is ref $SIG{__DIE__}, "CODE", '$SIG{__DIE__} handlers should not be destroyed'; is $SIG{__DIE__}->(), 'whee!', '... and should behave as expected'; eval "use aliased 'BadSigDie'"; is ref $SIG{__DIE__}, "CODE", 'A bad load should not break $SIG{__DIE__} handlers'; is $SIG{__DIE__}->(), 'whee!', '... and they should retain their value'; eval "use aliased 'NoSigDie'"; is ref $SIG{__DIE__}, "CODE", 'Loading code without sigdie handlers should succeed'; is $SIG{__DIE__}->(), 'whee!', '... and the sigdie handlers should retain their value'; { local $SIG{__DIE__}; delete $INC{'NoSigDie.pm'}; eval "use aliased 'NoSigDie' => 'NoSigDie2'"; ok ! ref $SIG{__DIE__}, 'Loading code without sigdie handlers should succeed'; delete $INC{'HasSigDie.pm'}; eval "use aliased 'HasSigDie' => 'HasSigDie2'"; is ref $SIG{__DIE__}, "CODE", 'New $SIG{__DIE__} handlers should be loaded'; is $SIG{__DIE__}->(), 'whee!', '... and should behave as expected'; } aliased-0.31/t/lib000755000765000024 012110505266 14347 5ustar00curtispoestaff000000000000aliased-0.31/t/lib/BadSigDie.pm000444000765000024 43312110505266 16575 0ustar00curtispoestaff000000000000package BadSigDie; use strict; use warnings; # make sure this gets loaded before the compile BEGIN { $SIG{__DIE__} = sub { my $error = shift; CORE::die($error) if $error =~ /syntax error/i; return 'bad sig die'; }; } # Unmatched right curly } 1; aliased-0.31/t/lib/HasSigDie.pm000444000765000024 15112110505266 16617 0ustar00curtispoestaff000000000000package HasSigDie; use strict; use warnings; BEGIN { $SIG{__DIE__} = sub { return 'whee!' }; } 1; aliased-0.31/t/lib/NoSigDie.pm000444000765000024 6112110505266 16440 0ustar00curtispoestaff000000000000package NoSigDie; use strict; use warnings; 1; aliased-0.31/t/lib/Really000755000765000024 012110505266 15577 5ustar00curtispoestaff000000000000aliased-0.31/t/lib/Really/Long000755000765000024 012110505266 16476 5ustar00curtispoestaff000000000000aliased-0.31/t/lib/Really/Long/Name.pm000444000765000024 10012110505266 20020 0ustar00curtispoestaff000000000000package Really::Long::Name; sub thing { return $_[1] + 2 } 1; aliased-0.31/t/lib/Really/Long/PackageName.pm000444000765000024 31712110505266 21306 0ustar00curtispoestaff000000000000package Really::Long::PackageName; sub import { my ($class, @methods) = @_; my $caller = caller(0); foreach my $method (@methods) { *{"${caller}::$method"} = sub { $method } } } 1; aliased-0.31/t/lib/Really/Long/Module000755000765000024 012110505266 17723 5ustar00curtispoestaff000000000000aliased-0.31/t/lib/Really/Long/Module/Name.pm000444000765000024 10712110505266 21254 0ustar00curtispoestaff000000000000package Really::Long::Module::Name; sub new { bless {} => shift } 1; aliased-0.31/t/lib/Really/Long/Module/Conflicting000755000765000024 012110505266 22162 5ustar00curtispoestaff000000000000aliased-0.31/t/lib/Really/Long/Module/Conflicting/Name.pm000444000765000024 40512110505266 23514 0ustar00curtispoestaff000000000000package Really::Long::Module::Conflicting::Name; sub import { my ($class, @args) = @_; my $callpack = caller(0); no strict 'refs'; *{"${callpack}::echo"} = sub { @_ } if $args[0] eq 'echo'; } sub new { bless {} => shift } sub echo { @_ } 1; aliased-0.31/xt000755000765000024 012110505266 13771 5ustar00curtispoestaff000000000000aliased-0.31/xt/author000755000765000024 012110505266 15273 5ustar00curtispoestaff000000000000aliased-0.31/xt/author/pod-coverage.t000444000765000024 25512110505266 20152 0ustar00curtispoestaff000000000000#!perl -T use Test::More; eval "use Test::Pod::Coverage 1.04"; plan skip_all => "Test::Pod::Coverage 1.04 required for testing POD coverage" if $@; all_pod_coverage_ok(); aliased-0.31/xt/author/pod.t000444000765000024 21412110505266 16354 0ustar00curtispoestaff000000000000#!perl -T use Test::More; eval "use Test::Pod 1.14"; plan skip_all => "Test::Pod 1.14 required for testing POD" if $@; all_pod_files_ok();