Class-Forward-0.100006000755001750001750 012200616255 15217 5ustar00anewkirkanewkirk000000000000README100644001750001750 1173512200616255 16207 0ustar00anewkirkanewkirk000000000000Class-Forward-0.100006NAME Class::Forward - Namespace Dispatch and Resolution VERSION version 0.100006 SYNOPSIS use Class::Forward; # create a resolution object my $res = Class::Forward->new(namespace => 'MyApp'); # returns MyApp::Data say $res->forward('data'); # returns a MyApp::Data instance my $data = $res->forward('data.new'); # returns the string /my_app/data my $string = $res->reverse('data.new'); # returns MyApp::Data say $res->forward($string); DESCRIPTION Class::Forward is designed to resolve Perl namespaces from shorthand (which is simply a file-path-like specification). Class::Forward can also be used to dispatch method calls using said shorthand. See the following exported functions for examples on how this can be used. EXPORTS clsf The exported function clsf is responsible for resolving your shorthand. The following is an example of how it functions: package App::Store; use CGI; use Class::Forward; clsf; # returns App::Store clsf './user'; # returns App::Store::User clsf './user.new', name => 'N30'; # return a new App::Store::User object clsf './user_profile.new'; # ... App::Store::UserProfile object clsf '../user'; # returns App::User clsf '//'; # returns App; (top of the calling class) clsf '//.new'; # returns a new App object clsf '//view'; # ... returns App::View clsf '//view.new'; # ... returns a new App::View object clsf '//view.new.render'; # ... dispatches methods in succession clsf 'cgi'; # returns App::Store::Cgi clsf '/cgi'; # returns Cgi (or CGI if already loaded) 1; The clsf function takes two arguments, the shorthand to be translated, and an optional list of arguments to be passed to the last method appended to the shorthand. clsr The exported function clsr is responsible for resolving your shorthand. The following is an example of how it functions: package App::Store; use CGI; use Class::Forward; clsr; # returns /app/store clsr './user'; # returns /app/store/user clsr './user.new', name => 'N30'; # returns /app/store/user clsr './user_profile'; # returns /app/store/user_profile clsr '../user'; # returns /app/user clsr '//'; # returns /app clsr '//.new'; # returns /app clsr '//view'; # returns /app/view clsr '//view.new'; # returns /app/view clsr '//view.new.render'; # returns /app/view clsr 'cgi'; # returns /app/store/cgi clsr '/cgi'; # returns /cgi 1; The clsr function takes three arguments, the shorthand to be translated (required), the offset (optional level of namespace nodes to omit left-to-right), and the delimiter to be used to generate the resulting path (defaults to forward-slash). METHODS new The new method is used to instantiate a new instance. namespace The namespace method is used to get/set the root namespace used as an anchor for all resolution requests. my $namespace = $self->namespace('MyApp'); forward The forward (or forward_lookup) method is used to resolve Perl namespaces from path-like shorthand. say $self->forward('example'); # given a default namespace of MyApp # prints MyApp::Example reverse The reverse method (or reverse_lookup) is used to generate path-like shorthand from Perl namespaces. say $self->reverse('Simple::Example'); # given a default namespace of MyApp # prints /my_app/simple/example say $self->reverse('Simple::Example', 1); # given a default namespace of MyApp # prints simple/example say $self->reverse('Simple::Example', 1, '_'); # given a default namespace of MyApp # prints simple_example SEE ALSO Class::Forward was designed to provide shorthand and easy access to class namespaces in an environment where you're dealing with a multitude of long well-named classes. In that vein, it provides an alternative to modules like aliased, aliased::factory, as, and the like, and also modules like Namespace::Dispatch which are similar enough to be mentioned but really address a completely different issue. AUTHOR Al Newkirk COPYRIGHT AND LICENSE This software is copyright (c) 2012 by Al Newkirk. This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. LICENSE100644001750001750 4364512200616255 16341 0ustar00anewkirkanewkirk000000000000Class-Forward-0.100006This software is copyright (c) 2012 by Al Newkirk. This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. Terms of the Perl programming language system itself a) the GNU General Public License as published by the Free Software Foundation; either version 1, or (at your option) any later version, or b) the "Artistic License" --- The GNU General Public License, Version 1, February 1989 --- This software is Copyright (c) 2012 by Al Newkirk. This is free software, licensed under: The GNU General Public License, Version 1, February 1989 GNU GENERAL PUBLIC LICENSE Version 1, February 1989 Copyright (C) 1989 Free Software Foundation, Inc. 51 Franklin St, Suite 500, Boston, MA 02110-1335 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The license agreements of most software companies try to keep users at the mercy of those companies. By contrast, our General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. The General Public License applies to the Free Software Foundation's software and to any other program whose authors commit to using it. You can use it for your programs, too. When we speak of free software, we are referring to freedom, not price. Specifically, the General Public License is designed to make sure that you have the freedom to give away or sell copies of free software, that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things. To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it. For example, if you distribute copies of a such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must tell them their rights. We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software. Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations. The precise terms and conditions for copying, distribution and modification follow. GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License Agreement applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any work containing the Program or a portion of it, either verbatim or with modifications. Each licensee is addressed as "you". 1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this General Public License and to the absence of any warranty; and give any other recipients of the Program a copy of this General Public License along with the Program. You may charge a fee for the physical act of transferring a copy. 2. You may modify your copy or copies of the Program or any portion of it, and copy and distribute such modifications under the terms of Paragraph 1 above, provided that you also do the following: a) cause the modified files to carry prominent notices stating that you changed the files and the date of any change; and b) cause the whole of any work that you distribute or publish, that in whole or in part contains the Program or any part thereof, either with or without modifications, to be licensed at no charge to all third parties under the terms of this General Public License (except that you may choose to grant warranty protection to some or all third parties, at your option). c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the simplest and most usual way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this General Public License. d) You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. Mere aggregation of another independent work with the Program (or its derivative) on a volume of a storage or distribution medium does not bring the other work under the scope of these terms. 3. You may copy and distribute the Program (or a portion or derivative of it, under Paragraph 2) in object code or executable form under the terms of Paragraphs 1 and 2 above provided that you also do one of the following: a) accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Paragraphs 1 and 2 above; or, b) accompany it with a written offer, valid for at least three years, to give any third party free (except for a nominal charge for the cost of distribution) a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Paragraphs 1 and 2 above; or, c) accompany it with the information you received as to where the corresponding source code may be obtained. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form alone.) Source code for a work means the preferred form of the work for making modifications to it. For an executable file, complete source code means all the source code for all modules it contains; but, as a special exception, it need not include source code for modules which are standard libraries that accompany the operating system on which the executable file runs, or for standard header files or definitions files that accompany that operating system. 4. You may not copy, modify, sublicense, distribute or transfer the Program except as expressly provided under this General Public License. Any attempt otherwise to copy, modify, sublicense, distribute or transfer the Program is void, and will automatically terminate your rights to use the Program under this License. However, parties who have received copies, or rights to use copies, from you under this General Public License will not have their licenses terminated so long as such parties remain in full compliance. 5. By copying, distributing or modifying the Program (or any work based on the Program) you indicate your acceptance of this license to do so, and all its terms and conditions. 6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. 7. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies a version number of the license which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the license, you may choose any version ever published by the Free Software Foundation. 8. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 9. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 10. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS Appendix: How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to humanity, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) 19yy This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 1, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301 USA Also add information on how to contact you by electronic and paper mail. If the program is interactive, make it output a short notice like this when it starts in an interactive mode: Gnomovision version 69, Copyright (C) 19xx name of author Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program. You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (a program to direct compilers to make passes at assemblers) written by James Hacker. , 1 April 1989 Ty Coon, President of Vice That's all there is to it! --- The Artistic License 1.0 --- This software is Copyright (c) 2012 by Al Newkirk. This is free software, licensed under: The Artistic License 1.0 The Artistic License Preamble The intent of this document is to state the conditions under which a Package may be copied, such that the Copyright Holder maintains some semblance of artistic control over the development of the package, while giving the users of the package the right to use and distribute the Package in a more-or-less customary fashion, plus the right to make reasonable modifications. Definitions: - "Package" refers to the collection of files distributed by the Copyright Holder, and derivatives of that collection of files created through textual modification. - "Standard Version" refers to such a Package if it has not been modified, or has been modified in accordance with the wishes of the Copyright Holder. - "Copyright Holder" is whoever is named in the copyright or copyrights for the package. - "You" is you, if you're thinking about copying or distributing this Package. - "Reasonable copying fee" is whatever you can justify on the basis of media cost, duplication charges, time of people involved, and so on. (You will not be required to justify it to the Copyright Holder, but only to the computing community at large as a market that must bear the fee.) - "Freely Available" means that no fee is charged for the item itself, though there may be fees involved in handling the item. It also means that recipients of the item may redistribute it under the same conditions they received it. 1. You may make and give away verbatim copies of the source form of the Standard Version of this Package without restriction, provided that you duplicate all of the original copyright notices and associated disclaimers. 2. You may apply bug fixes, portability fixes and other modifications derived from the Public Domain or from the Copyright Holder. A Package modified in such a way shall still be considered the Standard Version. 3. You may otherwise modify your copy of this Package in any way, provided that you insert a prominent notice in each changed file stating how and when you changed that file, and provided that you do at least ONE of the following: a) place your modifications in the Public Domain or otherwise make them Freely Available, such as by posting said modifications to Usenet or an equivalent medium, or placing the modifications on a major archive site such as ftp.uu.net, or by allowing the Copyright Holder to include your modifications in the Standard Version of the Package. b) use the modified Package only within your corporation or organization. c) rename any non-standard executables so the names do not conflict with standard executables, which must also be provided, and provide a separate manual page for each non-standard executable that clearly documents how it differs from the Standard Version. d) make other distribution arrangements with the Copyright Holder. 4. You may distribute the programs of this Package in object code or executable form, provided that you do at least ONE of the following: a) distribute a Standard Version of the executables and library files, together with instructions (in the manual page or equivalent) on where to get the Standard Version. b) accompany the distribution with the machine-readable source of the Package with your modifications. c) accompany any non-standard executables with their corresponding Standard Version executables, giving the non-standard executables non-standard names, and clearly documenting the differences in manual pages (or equivalent), together with instructions on where to get the Standard Version. d) make other distribution arrangements with the Copyright Holder. 5. You may charge a reasonable copying fee for any distribution of this Package. You may charge any fee you choose for support of this Package. You may not charge a fee for this Package itself. However, you may distribute this Package in aggregate with other (possibly commercial) programs as part of a larger (possibly commercial) software distribution provided that you do not advertise this Package as a product of your own. 6. The scripts and library files supplied as input to or produced as output from the programs of this Package do not automatically fall under the copyright of this Package, but belong to whomever generated them, and may be sold commercially, and may be aggregated with this Package. 7. C or perl subroutines supplied by you and linked into this Package shall not be considered part of this Package. 8. The name of the Copyright Holder may not be used to endorse or promote products derived from this software without specific prior written permission. 9. THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. The End Changes100644001750001750 1237012200616255 16616 0ustar00anewkirkanewkirk000000000000Class-Forward-0.100006================================================== Changes from 2012-08-08 00:00:00 +0000 to present. ================================================== --------------------------------------------- version 0.100006 at 2013-08-08 04:21:00 +0000 --------------------------------------------- Change: 4de4f8201293d2a9e62db600751ae205c93b3110 Author: Al Newkirk Date : 2013-08-08 00:20:49 +0000 added forward and reverse look method aliases --------------------------------------------- version 0.100005 at 2013-06-18 02:28:12 +0000 --------------------------------------------- Change: 33fc4b551564a6381d84bb1d04fdf2978f4cbbef Author: Al Newkirk Date : 2013-06-17 22:28:12 +0000 v0.100005 Change: 448f8fee5e27d03d873ff91ebf559363ea45b70c Author: Al Newkirk Date : 2013-06-17 22:27:56 +0000 updated the documentation Change: ed44059e2120e999a500de40ea3584063bc4874f Author: Al Newkirk Date : 2013-06-17 22:27:44 +0000 updated the documentation --------------------------------------------- version 0.100004 at 2013-06-18 01:40:39 +0000 --------------------------------------------- Change: 0c92420b9d96dff9dae468a0970d7dc99af81f52 Author: Al Newkirk Date : 2013-06-17 21:40:39 +0000 v0.100004 Change: 1e4618b4e615ec23b0829068f3d4a0db0e83b09c Author: Al Newkirk Date : 2013-06-17 21:40:19 +0000 updated the documentation Change: 365b72bcaaec2418190e8788c8bf6973b5cafb7c Author: Al Newkirk Date : 2013-06-14 02:55:45 +0000 updated the documentation examples --------------------------------------------- version 0.100003 at 2013-06-14 06:36:06 +0000 --------------------------------------------- Change: 6d8a90b1c5b1e91b94df57081882567196b07a3f Author: Al Newkirk Date : 2013-06-14 02:36:06 +0000 v0.100003 Change: 1a74ea96f7953d2d1e284cba7fc7fdbfd81d920d Author: Al Newkirk Date : 2013-06-14 02:35:42 +0000 fixed typo in the documentation that might confuse users Change: 6ab56e78b6e4c0090b61c94df1bbeda9d792f866 Author: Al Newkirk Date : 2013-06-14 02:35:21 +0000 fixed typo in the documentation that might confuse users --------------------------------------------- version 0.100002 at 2013-06-14 06:31:24 +0000 --------------------------------------------- Change: c52d120b6e7712340d857b1870b55f6dfd166d21 Author: Al Newkirk Date : 2013-06-14 02:31:24 +0000 v0.100002 Change: 3f1b4b786789fbbefe82b4c351af6bca0f1a349c Author: Al Newkirk Date : 2013-06-14 02:31:04 +0000 fixed typo in the documentation that might confuse users --------------------------------------------- version 0.100001 at 2013-06-14 06:27:59 +0000 --------------------------------------------- Change: eedeb57d3a3cf1ce210a852a518e981dac06d7b6 Author: Al Newkirk Date : 2013-06-14 02:27:59 +0000 v0.100001 Change: 94f7a4476a7defb73809d3fcc1bc2ea9c94468d7 Author: Al Newkirk Date : 2013-06-14 02:27:40 +0000 added new documentation --------------------------------------------- version 0.100000 at 2013-06-14 06:04:31 +0000 --------------------------------------------- Change: 0fef13a07f9d18509002b9e97683ca86e4ea70c4 Author: Al Newkirk Date : 2013-06-14 02:04:31 +0000 v0.100000 Change: 6f6c01101762aede0d4defa5f00daef835502f9d Author: Al Newkirk Date : 2013-06-14 02:04:01 +0000 added reverse resolution functionality for complete bi-directional resolution Change: dfb47a4bd994bda50481885407f63a2a6d99fd8d Author: Al Newkirk Date : 2012-09-08 03:41:04 +0000 fixed caching of methods with cachekey and namespace Change: ce939e1b7ca714a6ec55b6d16292f35399974a7c Author: Al Newkirk Date : 2012-09-04 14:32:03 +0000 removed generated package files Change: b618eb1bd20883e243703ce6183d11dc2fb354de Author: Al Newkirk Date : 2012-09-04 14:30:54 +0000 added caching to the class name resolution Change: 9e8f17101b666cf26f3a1c5a029097e9fd33f0db Author: Al Newkirk Date : 2012-08-19 16:03:55 +0000 fixed method capturing regex bug Change: 87c476aa0cd6b63baa4f67d8ab5ed36eab52f563 Author: Al Newkirk Date : 2012-08-19 07:03:27 +0000 corrected the synopsis, fixed/updated how shorthand is handle when no backspace indicator is found Change: 6bf4d903824bdd61deedf3f49e75bfdafee3c6a1 Author: Al Newkirk Date : 2012-08-13 23:31:54 +0000 ran spell-check, refactored the namespace resolution engine, and updated POD Change: b73a7a040f903cee8ec5b9945893673c74eb9597 Author: Al Newkirk Date : 2012-08-13 16:40:36 +0000 better synopsis Change: c75fd2191362929b38f9327bcbad0a3e6f4ec42b Author: Al Newkirk Date : 2012-08-13 03:45:22 +0000 CF gets OO syntax Change: f74d33efdbab5a9dfd07832a1ed30448d311a6c3 Author: Al Newkirk Date : 2012-08-12 15:18:53 +0000 initial commit ================ End of releases. ================ META.yml100644001750001750 112112200616255 16544 0ustar00anewkirkanewkirk000000000000Class-Forward-0.100006--- abstract: 'Namespace Dispatch and Resolution' author: - 'Al Newkirk ' build_requires: {} configure_requires: ExtUtils::MakeMaker: 6.30 dynamic_config: 0 generated_by: 'Dist::Zilla version 4.300034, CPAN::Meta::Converter version 2.130880' license: perl meta-spec: url: http://module-build.sourceforge.net/META-spec-v1.4.html version: 1.4 name: Class-Forward resources: bugtracker: https://github.com/alnewkirk/Class-Forward/issues homepage: http://search.cpan.org/dist/Class-Forward/ repository: git://github.com/alnewkirk/Class-Forward.git version: 0.100006 MANIFEST100644001750001750 17212200616255 16411 0ustar00anewkirkanewkirk000000000000Class-Forward-0.100006Changes LICENSE MANIFEST META.yml Makefile.PL README README.mkdn cpanfile lib/Class/Forward.pm t/00-load.t t/lib/MyApp.pm cpanfile100644001750001750 11012200616255 16754 0ustar00anewkirkanewkirk000000000000Class-Forward-0.100006 on 'configure' => sub { requires "ExtUtils::MakeMaker" => "6.30"; }; t000755001750001750 012200616255 15403 5ustar00anewkirkanewkirk000000000000Class-Forward-0.10000600-load.t100644001750001750 573212200616255 17073 0ustar00anewkirkanewkirk000000000000Class-Forward-0.100006/tBEGIN { use FindBin; use lib $FindBin::Bin . "/lib"; use lib $FindBin::Bin . "/../lib"; } use Test::More; use_ok 'Class::Forward'; { package main; use Test::More; use Class::Forward; use MyApp; my $last; sub clsf_ok { $last = clsf("$_[0]"); ok $_[1] eq $last, "$_[1] namespace translated OK"; } # simple namespace translation tests ok clsf(), "Class::Forward has a method named clsf"; clsf_ok 0 => "main"; clsf_ok((undef) => "main"); clsf_ok "//" => "main"; clsf_ok "./" => "main"; clsf_ok "/" => "main"; clsf_ok "main" => "main::Main"; clsf_ok "/test-more" => "Test::More"; clsf_ok "/class-forward" => "Class::Forward"; clsf_ok "/CLASS-FORWARD" => "Class::Forward"; clsf_ok "/my_app" => "MyApp"; ok "MyApp" eq ref clsf('my_app.new'), "Dipatched MyApp->new method call"; ok "Hello World" eq clsf('my_app.new.hello_world'), "Dipatched MyApp->new->hello_world method calls in succession"; } { package main; use Test::More; use Class::Forward; use MyApp; my $last; sub clsr_ok { my ($arg, $tar) = (shift, pop); $last = clsr("$arg", @_); ok $tar eq $last, "$tar namespace translated OK"; } # simple namespace reverse-translation tests ok clsr(), "Class::Forward has a method named clsr"; clsr_ok 0 => "/main"; clsr_ok((undef) => "/main"); clsr_ok "//" => "/main"; clsr_ok "./" => "/main"; clsr_ok "../../.././" => "/main"; clsr_ok "/" => "/main"; clsr_ok "main" => "/main/main"; clsr_ok "/test-more" => "/test/more"; clsr_ok "/class-forward" => "/class/forward"; clsr_ok "/CLASS-FORWARD" => "/class/forward"; clsr_ok "/my_app" => "/my_app"; clsr_ok "/my_app.new" => "/my_app"; clsr_ok "/my_app.new.can" => "/my_app"; clsr_ok "a" => "/main/a"; clsr_ok "a",0 => "/main/a"; clsr_ok "a",1 => "a"; clsr_ok "A::B::C",0 => "/main/a/b/c"; clsr_ok "A::B::C",1 => "a/b/c"; clsr_ok "A::B::C",2 => "b/c"; clsr_ok "/A::B::C",0 => "/a/b/c"; clsr_ok "/A::B::C",1 => "b/c"; clsr_ok "/A::B::C",0,'.' => ".a.b.c"; clsr_ok "/A::B::C",1,'.' => "b.c"; } { package MyApp::Person::Good; use Test::More; use Class::Forward; my $last; sub clsf_ok { $last = clsf("$_[0]"); ok $_[1] eq $last, "$_[1] namespace translated OK"; } # hierarchical namespace translation tests ok clsf(), "Class::Forward has a method named clsf"; clsf_ok "//" => "MyApp"; clsf_ok "./_man" => "MyApp::Person::Good::Man"; clsf_ok "/App" => "App"; ok scalar(keys(%{Class::Forward::CACHE})), "The cache appears to be in use"; } done_testing; Makefile.PL100644001750001750 247012200616255 17255 0ustar00anewkirkanewkirk000000000000Class-Forward-0.100006 use strict; use warnings; use ExtUtils::MakeMaker 6.30; my %WriteMakefileArgs = ( "ABSTRACT" => "Namespace Dispatch and Resolution", "AUTHOR" => "Al Newkirk ", "BUILD_REQUIRES" => {}, "CONFIGURE_REQUIRES" => { "ExtUtils::MakeMaker" => "6.30" }, "DISTNAME" => "Class-Forward", "EXE_FILES" => [], "LICENSE" => "perl", "NAME" => "Class::Forward", "PREREQ_PM" => {}, "TEST_REQUIRES" => {}, "VERSION" => "0.100006", "test" => { "TESTS" => "t/*.t" } ); unless ( eval { ExtUtils::MakeMaker->VERSION(6.63_03) } ) { my $tr = delete $WriteMakefileArgs{TEST_REQUIRES}; my $br = $WriteMakefileArgs{BUILD_REQUIRES}; for my $mod ( keys %$tr ) { if ( exists $br->{$mod} ) { $br->{$mod} = $tr->{$mod} if $tr->{$mod} > $br->{$mod}; } else { $br->{$mod} = $tr->{$mod}; } } } unless ( eval { ExtUtils::MakeMaker->VERSION(6.56) } ) { my $br = delete $WriteMakefileArgs{BUILD_REQUIRES}; my $pp = $WriteMakefileArgs{PREREQ_PM}; for my $mod ( keys %$br ) { if ( exists $pp->{$mod} ) { $pp->{$mod} = $br->{$mod} if $br->{$mod} > $pp->{$mod}; } else { $pp->{$mod} = $br->{$mod}; } } } delete $WriteMakefileArgs{CONFIGURE_REQUIRES} unless eval { ExtUtils::MakeMaker->VERSION(6.52) }; WriteMakefile(%WriteMakefileArgs); README.mkdn100644001750001750 1152512200616255 17134 0ustar00anewkirkanewkirk000000000000Class-Forward-0.100006# NAME Class::Forward - Namespace Dispatch and Resolution # VERSION version 0.100006 # SYNOPSIS use Class::Forward; # create a resolution object my $res = Class::Forward->new(namespace => 'MyApp'); # returns MyApp::Data say $res->forward('data'); # returns a MyApp::Data instance my $data = $res->forward('data.new'); # returns the string /my_app/data my $string = $res->reverse('data.new'); # returns MyApp::Data say $res->forward($string); # DESCRIPTION Class::Forward is designed to resolve Perl namespaces from shorthand (which is simply a file-path-like specification). Class::Forward can also be used to dispatch method calls using said shorthand. See the following exported functions for examples on how this can be used. # EXPORTS ## clsf The exported function clsf is responsible for resolving your shorthand. The following is an example of how it functions: package App::Store; use CGI; use Class::Forward; clsf; # returns App::Store clsf './user'; # returns App::Store::User clsf './user.new', name => 'N30'; # return a new App::Store::User object clsf './user_profile.new'; # ... App::Store::UserProfile object clsf '../user'; # returns App::User clsf '//'; # returns App; (top of the calling class) clsf '//.new'; # returns a new App object clsf '//view'; # ... returns App::View clsf '//view.new'; # ... returns a new App::View object clsf '//view.new.render'; # ... dispatches methods in succession clsf 'cgi'; # returns App::Store::Cgi clsf '/cgi'; # returns Cgi (or CGI if already loaded) 1; The clsf function takes two arguments, the shorthand to be translated, and an optional list of arguments to be passed to the last method appended to the shorthand. ## clsr The exported function clsr is responsible for resolving your shorthand. The following is an example of how it functions: package App::Store; use CGI; use Class::Forward; clsr; # returns /app/store clsr './user'; # returns /app/store/user clsr './user.new', name => 'N30'; # returns /app/store/user clsr './user_profile'; # returns /app/store/user_profile clsr '../user'; # returns /app/user clsr '//'; # returns /app clsr '//.new'; # returns /app clsr '//view'; # returns /app/view clsr '//view.new'; # returns /app/view clsr '//view.new.render'; # returns /app/view clsr 'cgi'; # returns /app/store/cgi clsr '/cgi'; # returns /cgi 1; The clsr function takes three arguments, the shorthand to be translated (required), the offset (optional level of namespace nodes to omit left-to-right), and the delimiter to be used to generate the resulting path (defaults to forward-slash). # METHODS ## new The new method is used to instantiate a new instance. ## namespace The namespace method is used to get/set the root namespace used as an anchor for all resolution requests. my $namespace = $self->namespace('MyApp'); ## forward The forward (or forward\_lookup) method is used to resolve Perl namespaces from path-like shorthand. say $self->forward('example'); # given a default namespace of MyApp # prints MyApp::Example ## reverse The reverse method (or reverse\_lookup) is used to generate path-like shorthand from Perl namespaces. say $self->reverse('Simple::Example'); # given a default namespace of MyApp # prints /my_app/simple/example say $self->reverse('Simple::Example', 1); # given a default namespace of MyApp # prints simple/example say $self->reverse('Simple::Example', 1, '_'); # given a default namespace of MyApp # prints simple_example # SEE ALSO Class::Forward was designed to provide shorthand and easy access to class namespaces in an environment where you're dealing with a multitude of long well-named classes. In that vein, it provides an alternative to modules like [aliased](http://search.cpan.org/perldoc?aliased), [aliased::factory](http://search.cpan.org/perldoc?aliased::factory), [as](http://search.cpan.org/perldoc?as), and the like, and also modules like [Namespace::Dispatch](http://search.cpan.org/perldoc?Namespace::Dispatch) which are similar enough to be mentioned but really address a completely different issue. # AUTHOR Al Newkirk # COPYRIGHT AND LICENSE This software is copyright (c) 2012 by Al Newkirk. This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. lib000755001750001750 012200616255 16151 5ustar00anewkirkanewkirk000000000000Class-Forward-0.100006/tMyApp.pm100644001750001750 17612200616255 17661 0ustar00anewkirkanewkirk000000000000Class-Forward-0.100006/t/libpackage MyApp; use strict; use warnings; sub new { bless {}, shift; } sub hello_world { return 'Hello World' } 1; Class000755001750001750 012200616255 16753 5ustar00anewkirkanewkirk000000000000Class-Forward-0.100006/libForward.pm100644001750001750 2211512200616255 21076 0ustar00anewkirkanewkirk000000000000Class-Forward-0.100006/lib/Class# ABSTRACT: Namespace Dispatch and Resolution package Class::Forward; use strict; use warnings; our $VERSION = '0.100006'; # VERSION use Exporter (); our @ISA = qw(Exporter); our @EXPORT = qw(clsf clsr); our %CACHE = (); sub clsf { return Class::Forward->new(namespace => (caller)[0])->forward(@_); } sub clsr { return Class::Forward->new(namespace => (caller)[0])->reverse(@_); } sub new { my $self = bless {}, (shift); my %args = @_ ? @_ : (); $self->{namespace} = $args{namespace} if defined $args{namespace}; return $self; } sub namespace { my ($self, $namespace) = @_; $self->{namespace} = $namespace if $namespace; return $self->{namespace}; } sub forward { my ($self, $shorthand, @arguments) = @_; my $namespace = $self->namespace() || (caller)[0] || 'main'; my $backspace; my $methods; my $myspace; my $class = ''; my @class = (); my @methods = (); my $CACHE_KEY = $shorthand; $CACHE_KEY .= "\@$namespace"; my $DATA = $CACHE{$CACHE_KEY} ||= do { if ($shorthand) { # capture path relativity notation $backspace = $1 if $shorthand =~ s/^((\.{1,2}\/){1,})//; $backspace = $1 if $shorthand =~ s/^(\/+)// && !$backspace; # capture method call notation ($methods) = $1 if $shorthand =~ s/((\.\w+){1,})$//; # convert shorthand to package notation $myspace = join "::", map { /_/ ? join '', map { ucfirst lc } split /_/, $_ : ucfirst $_ } split /(?:::|\-|\/)/, $shorthand; if ($backspace) { unless ($backspace =~ /^\/$/) { @class = split /::/, $namespace; if ($backspace =~ /^\/\/$/) { while (@class > 1) { pop @class; } } else { unless ($backspace =~ /^\.\/$/) { my @backspaces = $backspace =~ /\.\.\//g; for (@backspaces) { pop @class unless @class == 1; } } } } } else { push @class, $namespace; } push @class, split /::/, $myspace if $myspace; push @methods, grep /\w+/, split /\./, $methods if $methods; } push @class, $namespace if !@class; # build class namespace my $class = @class > 1 ? join('::', @class) : $class[0]; # leverage @INC to validate and possibly correct any case issues my $file = "$class.pm"; $file =~ s/::/\//g; unless ($INC{$file}) { # don't assume $#!+ my @matches = grep(/^$file/i, keys %INC); if (@matches == 1) { $class = $matches[0]; $class =~ s/\//::/g; $class =~ s/\.pm$//; } } # cache the results $CACHE{$CACHE_KEY} = { 'CLASS' => $class, 'METHODS' => [@methods] }; }; $class = $DATA->{'CLASS'}; @methods = @{$DATA->{'METHODS'}} if $DATA && ! @methods; # return result of method call(s) or class name if (@methods) { for (my $i = 0 ; $i < @methods ; $i++) { my $method = $methods[$i]; $class = $i == $#methods ? $class->$method(@arguments) : $class->$method; } return $class; } else { return $class; } } sub forward_lookup { goto \&forward } sub reverse { my ($self, $shorthand, $offset, $delimiter) = @_; $self->namespace((caller)[0] || 'main') unless $self->namespace; $shorthand =~ s/((\.\w+){1,})$// if $shorthand; $delimiter ||= '/'; my $result = $self->forward($shorthand); my @pieces = split /::/, $result; if (defined $offset and $offset >= 0) { if ($offset == 0) { unshift @pieces, ''; } else { shift @pieces for (1..$offset); } } else { unshift @pieces, ''; } return join $delimiter, map { if ($_) { s/([a-z])([A-Z])/$1_\l$2/g; lc } } @pieces; } sub reverse_lookup { goto \&reverse } 1; __END__ =pod =head1 NAME Class::Forward - Namespace Dispatch and Resolution =head1 VERSION version 0.100006 =head1 SYNOPSIS use Class::Forward; # create a resolution object my $res = Class::Forward->new(namespace => 'MyApp'); # returns MyApp::Data say $res->forward('data'); # returns a MyApp::Data instance my $data = $res->forward('data.new'); # returns the string /my_app/data my $string = $res->reverse('data.new'); # returns MyApp::Data say $res->forward($string); =head1 DESCRIPTION Class::Forward is designed to resolve Perl namespaces from shorthand (which is simply a file-path-like specification). Class::Forward can also be used to dispatch method calls using said shorthand. See the following exported functions for examples on how this can be used. =head1 EXPORTS =head2 clsf The exported function clsf is responsible for resolving your shorthand. The following is an example of how it functions: package App::Store; use CGI; use Class::Forward; clsf; # returns App::Store clsf './user'; # returns App::Store::User clsf './user.new', name => 'N30'; # return a new App::Store::User object clsf './user_profile.new'; # ... App::Store::UserProfile object clsf '../user'; # returns App::User clsf '//'; # returns App; (top of the calling class) clsf '//.new'; # returns a new App object clsf '//view'; # ... returns App::View clsf '//view.new'; # ... returns a new App::View object clsf '//view.new.render'; # ... dispatches methods in succession clsf 'cgi'; # returns App::Store::Cgi clsf '/cgi'; # returns Cgi (or CGI if already loaded) 1; The clsf function takes two arguments, the shorthand to be translated, and an optional list of arguments to be passed to the last method appended to the shorthand. =head2 clsr The exported function clsr is responsible for resolving your shorthand. The following is an example of how it functions: package App::Store; use CGI; use Class::Forward; clsr; # returns /app/store clsr './user'; # returns /app/store/user clsr './user.new', name => 'N30'; # returns /app/store/user clsr './user_profile'; # returns /app/store/user_profile clsr '../user'; # returns /app/user clsr '//'; # returns /app clsr '//.new'; # returns /app clsr '//view'; # returns /app/view clsr '//view.new'; # returns /app/view clsr '//view.new.render'; # returns /app/view clsr 'cgi'; # returns /app/store/cgi clsr '/cgi'; # returns /cgi 1; The clsr function takes three arguments, the shorthand to be translated (required), the offset (optional level of namespace nodes to omit left-to-right), and the delimiter to be used to generate the resulting path (defaults to forward-slash). =head1 METHODS =head2 new The new method is used to instantiate a new instance. =head2 namespace The namespace method is used to get/set the root namespace used as an anchor for all resolution requests. my $namespace = $self->namespace('MyApp'); =head2 forward The forward (or forward_lookup) method is used to resolve Perl namespaces from path-like shorthand. say $self->forward('example'); # given a default namespace of MyApp # prints MyApp::Example =head2 reverse The reverse method (or reverse_lookup) is used to generate path-like shorthand from Perl namespaces. say $self->reverse('Simple::Example'); # given a default namespace of MyApp # prints /my_app/simple/example say $self->reverse('Simple::Example', 1); # given a default namespace of MyApp # prints simple/example say $self->reverse('Simple::Example', 1, '_'); # given a default namespace of MyApp # prints simple_example =head1 SEE ALSO Class::Forward was designed to provide shorthand and easy access to class namespaces in an environment where you're dealing with a multitude of long well-named classes. In that vein, it provides an alternative to modules like L, L, L, and the like, and also modules like L which are similar enough to be mentioned but really address a completely different issue. =head1 AUTHOR Al Newkirk =head1 COPYRIGHT AND LICENSE This software is copyright (c) 2012 by Al Newkirk. This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. =cut