Alt-0.19/0000755000175000017500000000000012450352301010654 5ustar ingyingyAlt-0.19/META.yml0000644000175000017500000000124012450352301012122 0ustar ingyingy--- abstract: 'Alternate Module Implementations' author: - 'Ingy döt Net ' build_requires: Test::Exception: '0' configure_requires: ExtUtils::MakeMaker: '0' dynamic_config: 0 generated_by: 'Dist::Zilla version 5.029, CPAN::Meta::Converter version 2.143240' license: perl meta-spec: url: http://module-build.sourceforge.net/META-spec-v1.4.html version: '1.4' name: Alt no_index: directory: - inc - t - xt - example requires: perl: v5.8.1 resources: bugtracker: https://github.com/ingydotnet/alt-pm/issues homepage: https://github.com/ingydotnet/alt-pm repository: https://github.com/ingydotnet/alt-pm.git version: '0.19' Alt-0.19/LICENSE0000644000175000017500000004365612450352301011677 0ustar ingyingyThis software is copyright (c) 2014 by Ingy döt Net. 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) 2014 by Ingy döt Net. 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) 2014 by Ingy döt Net. 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 Alt-0.19/Makefile.PL0000644000175000017500000000202212450352301012622 0ustar ingyingy # This file was automatically generated by Dist::Zilla::Plugin::MakeMaker v5.029. use strict; use warnings; use 5.008001; use ExtUtils::MakeMaker; my %WriteMakefileArgs = ( "ABSTRACT" => "Alternate Module Implementations", "AUTHOR" => "Ingy d\x{f6}t Net ", "CONFIGURE_REQUIRES" => { "ExtUtils::MakeMaker" => 0 }, "DISTNAME" => "Alt", "EXE_FILES" => [], "LICENSE" => "perl", "MIN_PERL_VERSION" => "5.008001", "NAME" => "Alt", "PREREQ_PM" => {}, "TEST_REQUIRES" => { "Test::Exception" => 0 }, "VERSION" => "0.19", "test" => { "TESTS" => "t/*.t" } ); my %FallbackPrereqs = ( "ExtUtils::MakeMaker" => 0, "Test::Exception" => 0 ); unless ( eval { ExtUtils::MakeMaker->VERSION(6.63_03) } ) { delete $WriteMakefileArgs{TEST_REQUIRES}; delete $WriteMakefileArgs{BUILD_REQUIRES}; $WriteMakefileArgs{PREREQ_PM} = \%FallbackPrereqs; } delete $WriteMakefileArgs{CONFIGURE_REQUIRES} unless eval { ExtUtils::MakeMaker->VERSION(6.52) }; WriteMakefile(%WriteMakefileArgs); Alt-0.19/README0000644000175000017500000001263312450352301011541 0ustar ingyingyNAME Alt - Alternate Module Implementations SYNOPSIS PERL_ALT_INSTALL=OVERWRITE cpanm Alt::IO::All::Redux DESCRIPTION "Alt::" is the namespace for alternate implementations of CPAN modules. The purpose of the Alt module is to provide documentation explaining the Alt concept, how it works, and guidelines for using it well. THE PROBLEM For a given piece of software, CPAN only allows for one implementation of a given module/distribution name. GitHub on the other hand, is not limited this way. Any author can make a fork, since GitHub repos are namespaced by author id. On CPAN, even the author(s) of the module in question is limited by this, as they cannot release newer or older forks of their code, without introducing a new name. THE SOLUTION A module "Foo::Bar" is distributed on CPAN as "Foo-Bar". It may have submodules like "Foo::Bar::Baz". To make an alternate CPAN version, leave everything exactly the same, except distribute the new version as "Alt-Foo-Bar-AltIdentifier". When a user installs your module like so: PERL_ALT_INSTALL=OVERWRITE cpanm Alt::Foo::Bar::better they will get your version of the Foo::Bar framework (Foo::Bar, Foo::Bar::Baz). Obviously, this completely overlays the old Foo::Bar install, but that's the whole idea. The user isn't surprised by this because they just asked for an Alternate implementation. If they don't like it, they can simply reinstall the original Foo-Bar, or try some other alternate. ALT BEST PRACTICES This idea is new, and the details should be sorted out through proper discussions. Pull requests welcome. Here are the basic guidelines for best using the Alt namespace: Name Creation Names for alternate modules should be minted like this: "Alt-$Original_Dist_Name-$phrase" For instance, if MSTROUT wants to make an alternate IO-All distribution to have it be Moo-based, he might call it: Alt-IO-All-Moo He might also just call it: Alt-IO-All-MSTROUT By having 'Alt' at the start, it guarantees that it does not mess with future IO::All development. The "phrase" at the end can be anything unique to CPAN, but should describe the spirit of the alternate. If the alternate is meant to be short-lived, it can just be the author's CPAN id. Makefile.PL Changes Due to experience with problems, it is important to make your Alt module not install without explicit direction. You can accomplish this easily in a Makefile.PL, with something like this: my $alt = $ENV{PERL_ALT_INSTALL} || ''; $WriteMakefileArgs{DESTDIR} = $alt ? $alt eq 'OVERWRITE' ? '' : $alt : 'no-install-alt'; Similar techniques should be available for other module release frameworks. Module for CPAN Indexing You will need to provide a module like "Alt::IO::All::MSTROUT" so that CPAN will index something that can cause your distribution to get installed by people: PERL_ALT_INSTALL=OVERWRITE cpanm Alt::IO::All::MSTROUT Since you are adding this module, you should add some doc to it explaining your alternate version's improvements. The Alt:: module can be as simple as this: package Alt::IO::All::MSTROUT; our $VERSION = '0.01'; no_index It is important to use the "no_index" directive on the modules you are providing an alternates for. This is especially important if you are the author of the original, as PAUSE will reindex CPAN to your Alt- version which defeats the purpose. Even if you are not the same author, it will make your index reports not show failures. Versioning It is important to not declare a $VERSION in any of the modules that you are providing alternates for. This will help ensure that your alternate module does not satisfy the version requirements for something that wants the real module. If you want to depend on the alternate versions, then set the dependency on the "Alt::" module. NOTE: If you provide an alternate Foo::Bar (with no VERSION) it will satisfy the version requirements for someone who requires "Foo::Bar => 0". In a sense, depending on version 0 means that alternates are OK. "use" the Alt You should add this line to your alternate modules: use Alt::IO::All::MSTROUT; That way the Alt:: module gets loaded any time you "use IO::All" (with the alternate version installed). This gives debugging clues since the Alt:: module is now in %INC. Other Concerns If you have em, I(ngy) would like to know them. Discuss on #toolchain on irc.perl.org for now. WHENCE ALT? The Alt- concept was thought up by Ingy as he tried to figure out how to revamp the somewhat popular IO::All and YAML.pm modules. Alternates can now be released and alpha/beta tested, while the originals remain stable. When Alt-IO-All-new is "community approved" it can replace IO-All. If people want the old code, they can can install Alt-IO-All-old. AUTHOR Ingy döt Net COPYRIGHT Copyright 2012-2014. Ingy döt Net. See Alt-0.19/t/0000755000175000017500000000000012450352301011117 5ustar ingyingyAlt-0.19/t/lib/0000755000175000017500000000000012450352301011665 5ustar ingyingyAlt-0.19/t/lib/Foo.pm0000644000175000017500000000005312450352301012744 0ustar ingyingypackage Foo; use constant ALT => 'one'; 1; Alt-0.19/t/lib/Alt/0000755000175000017500000000000012450352301012405 5ustar ingyingyAlt-0.19/t/lib/Alt/Foo.pm0000644000175000017500000000011412450352301013462 0ustar ingyingypackage Alt::Foo; # this Alt is badly named (no phrase) use Alt::Assert; 1; Alt-0.19/t/lib/Alt/Bar/0000755000175000017500000000000012450352301013111 5ustar ingyingyAlt-0.19/t/lib/Alt/Bar/one.pm0000644000175000017500000000010512450352301014224 0ustar ingyingypackage Alt::Bar::one; # Bar does not define ALT use Alt::Assert; 1; Alt-0.19/t/lib/Alt/Bar/two.pm0000644000175000017500000000014112450352301014254 0ustar ingyingypackage Alt::Bar::two; # Bar does not define ALT but it's okay since we don't use Alt::Assert 1; Alt-0.19/t/lib/Alt/Foo/0000755000175000017500000000000012450352301013130 5ustar ingyingyAlt-0.19/t/lib/Alt/Foo/one.pm0000644000175000017500000000010112450352301014237 0ustar ingyingypackage Alt::Foo::one; # this alt is correct use Alt::Assert; 1; Alt-0.19/t/lib/Alt/Baz/0000755000175000017500000000000012450352301013121 5ustar ingyingyAlt-0.19/t/lib/Alt/Baz/one.pm0000644000175000017500000000010712450352301014236 0ustar ingyingypackage Alt::Baz::one; # Baz defines incorrect ALT use Alt::Assert; 1; Alt-0.19/t/lib/Baz.pm0000644000175000017500000000010612450352301012734 0ustar ingyingypackage Baz; # define an incorrect ALT use constant ALT => 'blah'; 1; Alt-0.19/t/lib/Bar.pm0000644000175000017500000000004612450352301012727 0ustar ingyingypackage Bar; # does not define ALT 1; Alt-0.19/t/000-require-modules.t0000644000175000017500000000042212450352301014721 0ustar ingyingy# This test does a basic `use` check on all the code. use Test::More; use File::Find; sub test { s{^lib/(.*)\.pm$}{$1} or return; s{/}{::}g; ok eval("require $_; 1"), "require $_;$@"; } find { wanted => \&test, no_chdir => 1, }, 'lib'; done_testing; Alt-0.19/t/release-pod-syntax.t0000644000175000017500000000045612450352301015035 0ustar ingyingy#!perl BEGIN { unless ($ENV{RELEASE_TESTING}) { require Test::More; Test::More::plan(skip_all => 'these tests are for release candidate testing'); } } # This file was automatically generated by Dist::Zilla::Plugin::PodSyntaxTests. use Test::More; use Test::Pod 1.41; all_pod_files_ok(); Alt-0.19/t/assert.t0000644000175000017500000000130212450352301012601 0ustar ingyingy#!perl use strict; use warnings; use FindBin '$Bin'; use lib "$Bin/lib"; use Test::Exception; use Test::More; sub use_ { my $mod = shift; my $modpm = $mod; $modpm =~ s!::!/!g; $modpm .= ".pm"; require $modpm; if (@_) { $mod->import(@_); } else { $mod->import; } } sub no_ { my $mod = shift; $mod->unimport; } lives_ok { use_ "Alt::Foo::one" }; dies_ok { use_ "Alt::Foo" } "incorrect alt name -> dies"; dies_ok { use_ "Alt::Bar::one" } "ALT not defined -> dies"; lives_ok { use_ "Alt::Bar::two" } "no assert"; dies_ok { Alt::Bar::two->assert } "assert via assert()"; dies_ok { use_ "Alt::Baz::one" } "incorrect ALT -> dies"; done_testing; Alt-0.19/t/alt.t0000644000175000017500000000011312450352301012057 0ustar ingyingyuse Test::More tests => 1; pass 'This module explains the Alt namespace'; Alt-0.19/lib/0000755000175000017500000000000012450352301011422 5ustar ingyingyAlt-0.19/lib/Alt/0000755000175000017500000000000012450352301012142 5ustar ingyingyAlt-0.19/lib/Alt/Assert.pod0000644000175000017500000000334612450352301014115 0ustar ingyingy=pod =for comment DO NOT EDIT. This Pod was generated by Swim v0.1.31. See http://github.com/ingydotnet/swim-pm#readme =encoding utf8 =head1 NAME Alt::Assert - Assert alternate module implementation =head1 SYNOPSIS Assuming there is a CPAN module Foo::Bar and mst wants to write an ALTernate called Alt::Foo::Bar::MSTROUT. In mst's Foo::Bar, there is the following line: use constant ALT => 'MSTROUT'; In the alt module: package Alt::Foo::Bar::MSTROUT; use Alt::Assert; # imports assert() 1; Users use mst's Foo::Bar as normal, just like they would use the original Foo::Bar: use Foo::Bar -various => [qw(weird import)], {API=>'things'}; or: require Foo::Bar; If they want to assert they have the mst version, they can: use Foo::Bar -various => [qw(weird import)], {API=>'things'}; use Alt::Foo::Bar::MSTROUT; or: require Foo::Bar; require Alt::Foo::Bar::MSTROUT; Alt::Foo::Bar::MSTROUT->assert; =head1 DESCRIPTION Alt::Assert can be used to assert that the loaded module is the wanted alternate implementation. Using the Synopsis' example, there can be different Foo::Bar installed, either from the original distribution, or from one of the alternate ones. Each alternate might be slightly incompatible with the original. The existence of Alt::Foo::Bar::MSTROUT in the installation does not necessarily ensure that the installed Foo::Bar is from the same alternate distribution, since an installer can replace Foo::Bar from another distribution. That is why one might need to do this assertion. =head1 SEE ALSO =over =item * L =back =head1 AUTHOR Ingy döt Net =head1 COPYRIGHT Copyright 2012-2014. Ingy döt Net. See L =cut Alt-0.19/lib/Alt/Assert.pm0000644000175000017500000000170712450352301013746 0ustar ingyingyuse strict; use warnings; package Alt::Assert; sub assert { my $self = shift; my $mod = shift || caller(); my ($orig, $phrase) = $mod =~ /^Alt::(\w+(?:::\w+)*)::(\w+)$/ or die "Bad syntax in alternate module name '$mod', should be ". "Alt::::\n"; my $origf = $orig; $origf =~ s!::!/!g; $origf .= ".pm"; require $origf; # if user hasn't loaded the module, load it for them defined(&{"$orig\::ALT"}) or die "$orig does not define ALT, might not be from the same ". "distribution as $mod\n"; my $alt = $orig->ALT; $alt eq $phrase or die "$orig has ALT set to '$alt' instead of '$phrase', ". "might not be from the same distribution as $mod\n"; } sub import { my $self = shift; my $caller = caller(); # export assert() { no strict; *{"$caller\::assert"} = \&assert; } $self->assert($caller); } 1; Alt-0.19/lib/Alt.pod0000644000175000017500000001243712450352301012655 0ustar ingyingy=pod =for comment DO NOT EDIT. This Pod was generated by Swim v0.1.31. See http://github.com/ingydotnet/swim-pm#readme =encoding utf8 =head1 NAME Alt - Alternate Module Implementations =for html alt-pm =head1 SYNOPSIS PERL_ALT_INSTALL=OVERWRITE cpanm Alt::IO::All::Redux =head1 DESCRIPTION C is the namespace for alternate implementations of CPAN modules. The purpose of the L module is to provide documentation explaining the Alt concept, how it works, and guidelines for using it well. =head1 THE PROBLEM For a given piece of software, CPAN only allows for one implementation of a given module/distribution name. GitHub on the other hand, is not limited this way. Any author can make a fork, since GitHub repos are namespaced by author id. On CPAN, even the author(s) of the module in question is limited by this, as they cannot release newer or older forks of their code, without introducing a new name. =head1 THE SOLUTION A module C is distributed on CPAN as C. It may have submodules like C. To make an alternate CPAN version, leave everything exactly the same, except distribute the new version as C. When a user installs your module like so: PERL_ALT_INSTALL=OVERWRITE cpanm Alt::Foo::Bar::better they will get your version of the Foo::Bar framework (Foo::Bar, Foo::Bar::Baz). Obviously, this completely overlays the old Foo::Bar install, but that's the whole idea. The user isn't surprised by this because they just asked for an Bernate implementation. If they don't like it, they can simply reinstall the original Foo-Bar, or try some other alternate. =head1 ALT BEST PRACTICES This idea is new, and the details should be sorted out through proper discussions. Pull requests welcome. Here are the basic guidelines for best using the Alt namespace: =over =item Name Creation Names for alternate modules should be minted like this: "Alt-$Original_Dist_Name-$phrase" For instance, if MSTROUT wants to make an alternate IO-All distribution to have it be Moo-based, he might call it: Alt-IO-All-Moo He might also just call it: Alt-IO-All-MSTROUT By having 'Alt' at the start, it guarantees that it does not mess with future IO::All development. The "phrase" at the end can be anything unique to CPAN, but should describe the spirit of the alternate. If the alternate is meant to be short-lived, it can just be the author's CPAN id. =item Makefile.PL Changes Due to experience with L problems, it is important to make your Alt module B install without explicit direction. You can accomplish this easily in a Makefile.PL, with something like this: my $alt = $ENV{PERL_ALT_INSTALL} || ''; $WriteMakefileArgs{DESTDIR} = $alt ? $alt eq 'OVERWRITE' ? '' : $alt : 'no-install-alt'; Similar techniques should be available for other module release frameworks. =item Module for CPAN Indexing You will need to provide a module like C so that CPAN will index something that can cause your distribution to get installed by people: PERL_ALT_INSTALL=OVERWRITE cpanm Alt::IO::All::MSTROUT Since you are adding this module, you should add some doc to it explaining your alternate version's improvements. The Alt:: module can be as simple as this: package Alt::IO::All::MSTROUT; our $VERSION = '0.01'; =item no_index It is important to use the C directive on the modules you are providing an alternates for. This is especially important if you are the author of the original, as PAUSE will reindex CPAN to your Alt- version which defeats the purpose. Even if you are not the same author, it will make your index reports not show failures. =item Versioning It is important to not declare a C<$VERSION> in any of the modules that you are providing alternates for. This will help ensure that your alternate module does not satisfy the version requirements for something that wants the real module. If you want to depend on the alternate versions, then set the dependency on the C module. NOTE: If you provide an alternate Foo::Bar (with no VERSION) it B satisfy the version requirements for someone who requires C<< Foo::Bar => 0 >>. In a sense, depending on version 0 means that alternates are OK. =item C the Alt You should add this line to your alternate modules: use Alt::IO::All::MSTROUT; That way the Alt:: module gets loaded any time you C (with the alternate version installed). This gives debugging clues since the Alt:: module is now in C<%INC>. =item Other Concerns If you have em, I(ngy) would like to know them. Discuss on #toolchain on irc.perl.org for now. =back =head1 WHENCE ALT? The Alt- concept was thought up by Ingy as he tried to figure out how to revamp the somewhat popular IO::All and YAML.pm modules. Alternates can now be released and alpha/beta tested, while the originals remain stable. When Alt-IO-All-new is "community approved" it can replace IO-All. If people want the old code, they can can install Alt-IO-All-old. =head1 AUTHOR Ingy döt Net =head1 COPYRIGHT Copyright 2012-2014. Ingy döt Net. See L =cut Alt-0.19/lib/Alt.pm0000644000175000017500000000004412450352301012476 0ustar ingyingypackage Alt; our $VERSION = '0.19'; Alt-0.19/MANIFEST0000644000175000017500000000064712450352301012014 0ustar ingyingy# This file was automatically generated by Dist::Zilla::Plugin::Manifest v5.029. CONTRIBUTING Changes LICENSE MANIFEST META.json META.yml Makefile.PL README lib/Alt.pm lib/Alt.pod lib/Alt/Assert.pm lib/Alt/Assert.pod t/000-require-modules.t t/alt.t t/assert.t t/lib/Alt/Bar/one.pm t/lib/Alt/Bar/two.pm t/lib/Alt/Baz/one.pm t/lib/Alt/Foo.pm t/lib/Alt/Foo/one.pm t/lib/Bar.pm t/lib/Baz.pm t/lib/Foo.pm t/release-pod-syntax.t Alt-0.19/Changes0000644000175000017500000000243212450352301012150 0ustar ingyingy0.19 Mon Dec 29 14:24:59 PST 2014 - Add PERL_ALT_INSTALL to docs 0.18 Mon Dec 29 08:03:15 PST 2014 - Update docs regarding versioning 0.17 Sun Dec 28 19:50:06 PST 2014 - Update docs with new best practices 0.16 Sat Aug 16 14:52:27 PDT 2014 - Fix Meta copyright 0.15 Sat Aug 16 14:41:50 PDT 2014 - Change Meta email 0.14 Sat Aug 16 10:42:42 PDT 2014 - Meta 0.0.2 0.13 Fri Aug 15 19:51:14 PDT 2014 - Add t/000-require-modules.t 0.12 Fri Aug 15 17:50:02 PDT 2014 - Add t/000-compile-modules.t 0.11 Sat Aug 2 09:55:57 PDT 2014 - Fix Copyright years. 0.10 Thu Jul 31 10:35:30 PDT 2014 - Fix Pod encoding bug. dolmen++ 0.09 Wed Jul 30 15:33:29 PDT 2014 - Fix Meta and add Contributing - Switch IRC to 0.08 Tue Jul 1 10:59:19 PDT 2014 - Trying the reindex again. Unfortunately messed up last time. 0.07 Mon Jun 23 15:23:36 PDT 2014 - Attempt to reindex after deleting 0.05 and waiting 3 days. 0.06 Wed Jun 18 10:51:06 PDT 2014 - Add test prereq Test::Exception 0.05 Sun Jun 15 14:06:36 PDT 2014 - Switch to Zilla-Dist 0.04 Wed Jul 25 21:08:53 PDT 2012 - Add no_index advice to the doc. 0.03 Sun Jul 15 15:45:27 PDT 2012 - Change POD encoding to utf8 0.02 Sun Jul 15 15:12:46 PDT 2012 - Wrote the first real doc revision. 0.01 Sun Jul 15 13:15:49 PDT 2012 - First release. Alt-0.19/CONTRIBUTING0000644000175000017500000000234112450352301012506 0ustar ingyingyContributing ============ The "Alt" Project needs your help! Please consider being a contributor. This file contains instructions that will help you be an effective contributor to the Project. GitHub ------ The code for this Project is hosted at GitHub. The URL is: https://github.com/ingydotnet/alt-pm You can get the code with this command: git clone https://github.com/ingydotnet/alt-pm If you've found a bug or a missing feature that you would like the author to know about, report it here: https://github.com/ingydotnet/alt-pm/issues or fix it and submit a pull request here: https://github.com/ingydotnet/alt-pm/pulls See these links for help on interacting with GitHub: * https://help.github.com/ * https://help.github.com/articles/creating-a-pull-request Zilla::Dist ----------- This Project uses Zilla::Dist to prepare it for publishing to CPAN. Read: https://metacpan.org/pod/Zilla::Dist::Contributing for up-to-date instructions on what contributors like yourself need to know to use it. IRC --- Alt has an IRC channel where you can find real people to help you: irc.freenode.net#pkg Join the channel. Join the team! Thanks in advance, Ingy döt Net # This file generated by Zilla-Dist-0.0.180 Alt-0.19/META.json0000644000175000017500000000247412450352301012304 0ustar ingyingy{ "abstract" : "Alternate Module Implementations", "author" : [ "Ingy döt Net " ], "dynamic_config" : 0, "generated_by" : "Dist::Zilla version 5.029, CPAN::Meta::Converter version 2.143240", "license" : [ "perl_5" ], "meta-spec" : { "url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec", "version" : "2" }, "name" : "Alt", "no_index" : { "directory" : [ "inc", "t", "xt", "example" ] }, "prereqs" : { "configure" : { "requires" : { "ExtUtils::MakeMaker" : "0" } }, "develop" : { "requires" : { "Test::Pod" : "1.41" } }, "runtime" : { "requires" : { "perl" : "v5.8.1" } }, "test" : { "requires" : { "Test::Exception" : "0" } } }, "release_status" : "stable", "resources" : { "bugtracker" : { "web" : "https://github.com/ingydotnet/alt-pm/issues" }, "homepage" : "https://github.com/ingydotnet/alt-pm", "repository" : { "type" : "git", "url" : "https://github.com/ingydotnet/alt-pm.git", "web" : "https://github.com/ingydotnet/alt-pm" } }, "version" : "0.19" }