From d74e28cfc858fbad9105c1723240577fe635b573 Mon Sep 17 00:00:00 2001 From: Packit Date: Sep 24 2020 10:30:59 +0000 Subject: perl-Module-Package-0.30 base --- diff --git a/Changes b/Changes new file mode 100644 index 0000000..cb854b9 --- /dev/null +++ b/Changes @@ -0,0 +1,113 @@ +--- +version: 0.30 +date: Thu Oct 6 10:37:01 EDT 2011 +changes: +- Patch from tobyink++ to support user side plugins +--- +version: 0.29 +date: Sun Sep 25 22:21:20 CEST 2011 +changes: +- Put a error message on a die statement. +- Released from Liz++ and Wendy++'s garage. +--- +version: 0.28 +date: Sat Aug 20 18:20:15 CEST 2011 +changes: +- skip author requires for modules that have a Module::Install plugin +--- +version: 0.27 +date: Fri Aug 19 20:57:02 EEST 2011 +changes: +- Add Gloom Support +--- +version: 0.26 +date: Sun Jul 3 19:54:14 EDT 2011 +changes: +- Support Test::Common updating +--- +version: 0.25 +date: Tue Jun 14 00:10:30 EST 2011 +changes: +- Only guess the module name on the author side +--- +version: 0.24 +date: Mon Jun 13 18:12:51 EST 2011 +changes: +- Allow for unicode package names +--- +version: 0.23 +date: Sun Jun 12 03:48:23 EST 2011 +changes: +- Allow requires_from after requires +- Add modules to @known_author_only +--- +version: 0.22 +date: Tue Jun 7 17:37:16 EST 2011 +changes: +- Fix new bug on clean perl installs. +- Since we no longer load inc::Module::Install, we need to put 'inc' on @INC. +- Add =encoding to Tutorial +--- +version: 0.21 +date: Mon Jun 6 02:10:28 EST 2011 +changes: +- audreyt++ found the elusive bootstrapping bug. +- Allow $PM and $POD to be preset. +--- +version: 0.20 +date: Sun Jun 5 02:32:35 EST 2011 +changes: +- Add pkg/manifest.skip to MANIFEST.SKIP +- Add a debugging dump for mystery M:I 1.00 situation. +- Support install_share. +--- +version: 0.19 +date: Tue May 31 20:25:05 EST 2011 +changes: +- Hopefully fix the non-upgrable bootstrapping bugs. +- Added xt test to assure that it works. +--- +version: 0.18 +date: Mon May 30 20:35:50 EST 2011 +changes: +- Added post_WriteAll hook. +--- +version: 0.17 +date: Mon May 30 15:11:20 EST 2011 +changes: +- Fixed a stupid user side bug. +- Add an xt test to make sure we can really make installable stuff. +--- +version: 0.16 +date: Sun May 29 18:04:20 EST 2011 +changes: +- More refactoring, documentation and functionality +- Solidfied $PM and $POD +- Tempered the 'final' methods +- Added audreyt++ VERSION hack to the 0.11 viral bug fix. +- Made a better version check +- Added Module::Install 1.01 requirement +- Added requires_from to options +- Added $AUTHOR_ONLY support +--- +version: 0.15 +date: Sun May 29 00:07:13 EST 2011 +changes: +- Another fix to try to get a stable first release. +--- +version: 0.14 +date: Sat May 28 14:55:50 EST 2011 +changes: +- Fixed a terrible showstopper bootstrapping bug +--- +version: 0.12 +date: Sat May 28 04:11:28 EST 2011 +changes: +- Major refactoring... don't even know where to begin. +--- +version: 0.11 +date: Wed May 18 14:09:55 EST 2011 +changes: +- First Release +- This module is the rename/replacement for Package/inc::Package. +- Package was at 0.10 at the switch, so starting with 0.11. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..598664f --- /dev/null +++ b/LICENSE @@ -0,0 +1,377 @@ +This software is copyright (c) 2011 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) 2011 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. + 59 Temple Place, Suite 330, Boston, MA 02111-1307, 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307, 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) 2011 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 + diff --git a/MANIFEST b/MANIFEST new file mode 100644 index 0000000..45978bc --- /dev/null +++ b/MANIFEST @@ -0,0 +1,27 @@ +Changes +inc/Module/Install.pm +inc/Module/Install/Base.pm +inc/Module/Install/Can.pm +inc/Module/Install/Fetch.pm +inc/Module/Install/GithubMeta.pm +inc/Module/Install/Makefile.pm +inc/Module/Install/Metadata.pm +inc/Module/Install/Package.pm +inc/Module/Install/Win32.pm +inc/Module/Install/WriteAll.pm +inc/Module/Package.pm +lib/inc/Module/Package.pm +lib/inc/Module/Package.pod +lib/Module/Install/Package.pm +lib/Module/Install/Package.pod +lib/Module/Package.pm +lib/Module/Package.pod +lib/Module/Package/Plugin.pm +lib/Module/Package/Plugin.pod +lib/Module/Package/Tutorial.pod +LICENSE +Makefile.PL +MANIFEST This list of files +META.yml +README +t/use_ok.t diff --git a/META.yml b/META.yml new file mode 100644 index 0000000..a184ce8 --- /dev/null +++ b/META.yml @@ -0,0 +1,35 @@ +--- +abstract: 'Postmodern Perl Module Packaging' +author: + - 'Ingy döt Net ' +build_requires: + ExtUtils::MakeMaker: 6.42 +configure_requires: + ExtUtils::MakeMaker: 6.42 +distribution_type: module +generated_by: 'Module::Install version 1.01' +license: perl +meta-spec: + url: http://module-build.sourceforge.net/META-spec-v1.4.html + version: 1.4 +module_name: Module::Package +name: Module-Package +no_index: + directory: + - inc + - t + - xt +requires: + Cwd: 0 + File::Find: 0 + IO::All: 0.41 + Module::Install: 1.01 + Module::Install::AuthorRequires: 0.02 + Module::Install::ManifestSkip: 0.19 + Moo: 0.009008 + perl: 5.8.3 +resources: + homepage: http://github.com/ingydotnet/module-package-pm/tree + license: http://dev.perl.org/licenses/ + repository: git://github.com/ingydotnet/module-package-pm.git +version: 0.30 diff --git a/Makefile.PL b/Makefile.PL new file mode 100644 index 0000000..93b5ed5 --- /dev/null +++ b/Makefile.PL @@ -0,0 +1,6 @@ +use inc::Module::Package 'Ingy:modern 0.17'; + +# The default module 'lib/Module/Package.pm' has to be very strict +# and minimal, so we get much of the package info from here: +perl_version_from 'lib/Module/Package/Plugin.pm'; +requires_from 'lib/Module/Package/Plugin.pm'; diff --git a/README b/README new file mode 100644 index 0000000..f972ef1 --- /dev/null +++ b/README @@ -0,0 +1,171 @@ +NAME + Module::Package - Postmodern Perl Module Packaging + +SYNOPSIS + In your "Makefile.PL": + + use inc::Module::Package; + + or one of these invocations: + + # These two are functionally the same as above: + use inc::Module::Package ':basic'; + use inc::Module::Package 'Plugin:basic'; + + # With Module::Package::Catalyst plugin options + use inc::Module::Package 'Catalyst'; + + # With Module::Package::Catalyst::common inline plugin class + use inc::Module::Package 'Catalyst:common'; + + # Pass options to the Module::Package::Ingy::modern constructor + use inc::Module::Package 'Ingy:modern', + option1 => 'value1', + option2 => 'value2'; + +DESCRIPTION + This module is a dropin replacement for Module::Install. It does + everything Module::Install does, but just a bit better. + + Actually this module is simply a wrapper around Module::Install. It + attempts to drastically reduce what goes in a Makefile.PL, while at the + same time, fixing many of the problems that people have had with + Module::Install (and other module frameworks) over the years. + +PROPAGANDA + Module::Install took Makefile.PL authoring from a black art to a small + set of powerful and reusable instructions. It allowed packaging gurus to + take their fancy tricks and make them into one liners for the rest of + us. + + As the number of plugins has grown over the years, using Module::Install + has itself become a bit of a black art. It's become hard to know all the + latest tricks, put them in the correct order, and make sure you always + use the correct sets for your various Perl modules. + + Added to this is the fact that there are a few problems in + Module::Install design and general usage that are hard to fix and deploy + with certainty that it will work in all cases. + + This is where Module::Package steps in. Module::Package is the next + logical step in Makefile.PL authoring. It allows gurus to create well + tested sets of Module::Install directives, and lets the rest of us use + Makefile.PLs that are one line long. For example: + + use inc::Module::Package 'Catalyst:widget'; + + could be the one line Makefile.PL for a Catalyst widget (whatever that + is) module distribution. Assuming someone creates a module called + Module::Package::Catalyst, with an inline class called + Module::Package::Catalyst::widget that inherited from + Module::Package::Plugin. + + Module::Package is pragmatic. Even though you can do everything in one + line, you are still able to make any Module::Install calls as usual. + Also you can pass parameters to the Module::Package plugin. + + use inc::Module::Package 'Catalyst:widget', + deps_list => 0, + some_cataylst_thing => '...'; + + # All Module::Install plugins still work! + requires 'Some::Module' => 3.14; + + This allows Module::Package::Catalyst to be configurable, even on the + properties like "deps_list" that are inherited from + Module::Package::Plugin. + + The point here is that with Module::Package, module packaging just got a + whole lot more powerful and simple. A rare combination! + +FEATURES + Module::Package has many advantages over vanilla Module::Install. + + Smaller Makefile.PL Files + In the majority of cases you can reduce your Makefile.PL to a single + command. The core Module::Package invokes the Module::Install plugins + that it thinks you want. You can also name the Module::Package plugin + that does exactly the plugins you want. + + Reduces Module::Install Bloat + Somewhere Module::Install development went awry, and allowed modules + that only have useful code for an author, to be bundled into a + distribution. Over time, this has created a lot of wasted space on CPAN + mirrors. Module::Package fixes this. + + Collaborator Plugin Discovery + An increasing problem with Module::Install is that when people check out + your module source from a repository, they don't know which + Module::Install plugin modules you have used. That's because the + Makefile.PL only requires the function names, not the module names that + they come from. + + Many people have realized this problem, and worked around it in various + suboptimal ways. Module::Package manages this problem for you. + + Feature Grouping and Reuse + Module::Install has lots of plugins. Although it is possible with plain + Module::Install, nobody seems to make plugins that group other plugins. + This also might introduce subtle problems of using groups with other + groups. + + Module::Package has object oriented plugins whose main purpose is to + create these groups. They inherit base functionality, subclass it to + their design goals and can define options for the user to tweak how they + will operate. + +USAGE + The basic anatomy of a Makefile.PL call to Module::Package is: + + use inc::Module::Package 'PluginName:flavor ', + $option1 => $value1; + + The "inc::Module::Package" part uses the Module::Install "inc" + bootstrapping trick. + + "PluginName:flavor" (note the single ':') resolves to the inline class + "Module::Package::PluginName::flavor", within the module + "Module::Package::PluginName". Module::Package::PluginName::flavor must + be a subclass of Module::Package::Plugin. + + An optional version can be used after the plugin name. + + Optional key/value pairs can follow the Plugin specification. They are + used to pass information to the plugin. See Plugin docs for more + details. + + If ":flavor" is omitted, the class Module::Package::PluginName is used. + The idea is that you can create a single module with many different + plugin styles. + + If "PluginName" is omitted, then ":flavor" is used against + Module::Package::Plugin. These are a set of common plugin classes that + you can use. + + If "PluginName:flavor" is omitted altogether, it is the same as saying + 'Plugin:basic'. Note that you need to specify the ':basic' plugin if you + want to also pass it options. + +STATUS + This is still an early release. We are still shaking out the bugs. You + might want to hold off for a bit longer before using Module::Package for + important modules. + +SEE ALSO + * Module::Package::Plugin + + * Module::Install::Package + + * Module::Package::Tutorial + +AUTHOR + Ingy döt Net + +COPYRIGHT AND LICENSE + Copyright (c) 2011. Ingy döt Net. + + This program is free software; you can redistribute it and/or modify it + under the same terms as Perl itself. + + See http://www.perl.com/perl/misc/Artistic.html + diff --git a/inc/Module/Install.pm b/inc/Module/Install.pm new file mode 100644 index 0000000..74caf9c --- /dev/null +++ b/inc/Module/Install.pm @@ -0,0 +1,470 @@ +#line 1 +package Module::Install; + +# For any maintainers: +# The load order for Module::Install is a bit magic. +# It goes something like this... +# +# IF ( host has Module::Install installed, creating author mode ) { +# 1. Makefile.PL calls "use inc::Module::Install" +# 2. $INC{inc/Module/Install.pm} set to installed version of inc::Module::Install +# 3. The installed version of inc::Module::Install loads +# 4. inc::Module::Install calls "require Module::Install" +# 5. The ./inc/ version of Module::Install loads +# } ELSE { +# 1. Makefile.PL calls "use inc::Module::Install" +# 2. $INC{inc/Module/Install.pm} set to ./inc/ version of Module::Install +# 3. The ./inc/ version of Module::Install loads +# } + +use 5.005; +use strict 'vars'; +use Cwd (); +use File::Find (); +use File::Path (); + +use vars qw{$VERSION $MAIN}; +BEGIN { + # All Module::Install core packages now require synchronised versions. + # This will be used to ensure we don't accidentally load old or + # different versions of modules. + # This is not enforced yet, but will be some time in the next few + # releases once we can make sure it won't clash with custom + # Module::Install extensions. + $VERSION = '1.01'; + + # Storage for the pseudo-singleton + $MAIN = undef; + + *inc::Module::Install::VERSION = *VERSION; + @inc::Module::Install::ISA = __PACKAGE__; + +} + +sub import { + my $class = shift; + my $self = $class->new(@_); + my $who = $self->_caller; + + #------------------------------------------------------------- + # all of the following checks should be included in import(), + # to allow "eval 'require Module::Install; 1' to test + # installation of Module::Install. (RT #51267) + #------------------------------------------------------------- + + # Whether or not inc::Module::Install is actually loaded, the + # $INC{inc/Module/Install.pm} is what will still get set as long as + # the caller loaded module this in the documented manner. + # If not set, the caller may NOT have loaded the bundled version, and thus + # they may not have a MI version that works with the Makefile.PL. This would + # result in false errors or unexpected behaviour. And we don't want that. + my $file = join( '/', 'inc', split /::/, __PACKAGE__ ) . '.pm'; + unless ( $INC{$file} ) { die <<"END_DIE" } + +Please invoke ${\__PACKAGE__} with: + + use inc::${\__PACKAGE__}; + +not: + + use ${\__PACKAGE__}; + +END_DIE + + # This reportedly fixes a rare Win32 UTC file time issue, but + # as this is a non-cross-platform XS module not in the core, + # we shouldn't really depend on it. See RT #24194 for detail. + # (Also, this module only supports Perl 5.6 and above). + eval "use Win32::UTCFileTime" if $^O eq 'MSWin32' && $] >= 5.006; + + # If the script that is loading Module::Install is from the future, + # then make will detect this and cause it to re-run over and over + # again. This is bad. Rather than taking action to touch it (which + # is unreliable on some platforms and requires write permissions) + # for now we should catch this and refuse to run. + if ( -f $0 ) { + my $s = (stat($0))[9]; + + # If the modification time is only slightly in the future, + # sleep briefly to remove the problem. + my $a = $s - time; + if ( $a > 0 and $a < 5 ) { sleep 5 } + + # Too far in the future, throw an error. + my $t = time; + if ( $s > $t ) { die <<"END_DIE" } + +Your installer $0 has a modification time in the future ($s > $t). + +This is known to create infinite loops in make. + +Please correct this, then run $0 again. + +END_DIE + } + + + # Build.PL was formerly supported, but no longer is due to excessive + # difficulty in implementing every single feature twice. + if ( $0 =~ /Build.PL$/i ) { die <<"END_DIE" } + +Module::Install no longer supports Build.PL. + +It was impossible to maintain duel backends, and has been deprecated. + +Please remove all Build.PL files and only use the Makefile.PL installer. + +END_DIE + + #------------------------------------------------------------- + + # To save some more typing in Module::Install installers, every... + # use inc::Module::Install + # ...also acts as an implicit use strict. + $^H |= strict::bits(qw(refs subs vars)); + + #------------------------------------------------------------- + + unless ( -f $self->{file} ) { + foreach my $key (keys %INC) { + delete $INC{$key} if $key =~ /Module\/Install/; + } + + local $^W; + require "$self->{path}/$self->{dispatch}.pm"; + File::Path::mkpath("$self->{prefix}/$self->{author}"); + $self->{admin} = "$self->{name}::$self->{dispatch}"->new( _top => $self ); + $self->{admin}->init; + @_ = ($class, _self => $self); + goto &{"$self->{name}::import"}; + } + + local $^W; + *{"${who}::AUTOLOAD"} = $self->autoload; + $self->preload; + + # Unregister loader and worker packages so subdirs can use them again + delete $INC{'inc/Module/Install.pm'}; + delete $INC{'Module/Install.pm'}; + + # Save to the singleton + $MAIN = $self; + + return 1; +} + +sub autoload { + my $self = shift; + my $who = $self->_caller; + my $cwd = Cwd::cwd(); + my $sym = "${who}::AUTOLOAD"; + $sym->{$cwd} = sub { + my $pwd = Cwd::cwd(); + if ( my $code = $sym->{$pwd} ) { + # Delegate back to parent dirs + goto &$code unless $cwd eq $pwd; + } + unless ($$sym =~ s/([^:]+)$//) { + # XXX: it looks like we can't retrieve the missing function + # via $$sym (usually $main::AUTOLOAD) in this case. + # I'm still wondering if we should slurp Makefile.PL to + # get some context or not ... + my ($package, $file, $line) = caller; + die <<"EOT"; +Unknown function is found at $file line $line. +Execution of $file aborted due to runtime errors. + +If you're a contributor to a project, you may need to install +some Module::Install extensions from CPAN (or other repository). +If you're a user of a module, please contact the author. +EOT + } + my $method = $1; + if ( uc($method) eq $method ) { + # Do nothing + return; + } elsif ( $method =~ /^_/ and $self->can($method) ) { + # Dispatch to the root M:I class + return $self->$method(@_); + } + + # Dispatch to the appropriate plugin + unshift @_, ( $self, $1 ); + goto &{$self->can('call')}; + }; +} + +sub preload { + my $self = shift; + unless ( $self->{extensions} ) { + $self->load_extensions( + "$self->{prefix}/$self->{path}", $self + ); + } + + my @exts = @{$self->{extensions}}; + unless ( @exts ) { + @exts = $self->{admin}->load_all_extensions; + } + + my %seen; + foreach my $obj ( @exts ) { + while (my ($method, $glob) = each %{ref($obj) . '::'}) { + next unless $obj->can($method); + next if $method =~ /^_/; + next if $method eq uc($method); + $seen{$method}++; + } + } + + my $who = $self->_caller; + foreach my $name ( sort keys %seen ) { + local $^W; + *{"${who}::$name"} = sub { + ${"${who}::AUTOLOAD"} = "${who}::$name"; + goto &{"${who}::AUTOLOAD"}; + }; + } +} + +sub new { + my ($class, %args) = @_; + + delete $INC{'FindBin.pm'}; + { + # to suppress the redefine warning + local $SIG{__WARN__} = sub {}; + require FindBin; + } + + # ignore the prefix on extension modules built from top level. + my $base_path = Cwd::abs_path($FindBin::Bin); + unless ( Cwd::abs_path(Cwd::cwd()) eq $base_path ) { + delete $args{prefix}; + } + return $args{_self} if $args{_self}; + + $args{dispatch} ||= 'Admin'; + $args{prefix} ||= 'inc'; + $args{author} ||= ($^O eq 'VMS' ? '_author' : '.author'); + $args{bundle} ||= 'inc/BUNDLES'; + $args{base} ||= $base_path; + $class =~ s/^\Q$args{prefix}\E:://; + $args{name} ||= $class; + $args{version} ||= $class->VERSION; + unless ( $args{path} ) { + $args{path} = $args{name}; + $args{path} =~ s!::!/!g; + } + $args{file} ||= "$args{base}/$args{prefix}/$args{path}.pm"; + $args{wrote} = 0; + + bless( \%args, $class ); +} + +sub call { + my ($self, $method) = @_; + my $obj = $self->load($method) or return; + splice(@_, 0, 2, $obj); + goto &{$obj->can($method)}; +} + +sub load { + my ($self, $method) = @_; + + $self->load_extensions( + "$self->{prefix}/$self->{path}", $self + ) unless $self->{extensions}; + + foreach my $obj (@{$self->{extensions}}) { + return $obj if $obj->can($method); + } + + my $admin = $self->{admin} or die <<"END_DIE"; +The '$method' method does not exist in the '$self->{prefix}' path! +Please remove the '$self->{prefix}' directory and run $0 again to load it. +END_DIE + + my $obj = $admin->load($method, 1); + push @{$self->{extensions}}, $obj; + + $obj; +} + +sub load_extensions { + my ($self, $path, $top) = @_; + + my $should_reload = 0; + unless ( grep { ! ref $_ and lc $_ eq lc $self->{prefix} } @INC ) { + unshift @INC, $self->{prefix}; + $should_reload = 1; + } + + foreach my $rv ( $self->find_extensions($path) ) { + my ($file, $pkg) = @{$rv}; + next if $self->{pathnames}{$pkg}; + + local $@; + my $new = eval { local $^W; require $file; $pkg->can('new') }; + unless ( $new ) { + warn $@ if $@; + next; + } + $self->{pathnames}{$pkg} = + $should_reload ? delete $INC{$file} : $INC{$file}; + push @{$self->{extensions}}, &{$new}($pkg, _top => $top ); + } + + $self->{extensions} ||= []; +} + +sub find_extensions { + my ($self, $path) = @_; + + my @found; + File::Find::find( sub { + my $file = $File::Find::name; + return unless $file =~ m!^\Q$path\E/(.+)\.pm\Z!is; + my $subpath = $1; + return if lc($subpath) eq lc($self->{dispatch}); + + $file = "$self->{path}/$subpath.pm"; + my $pkg = "$self->{name}::$subpath"; + $pkg =~ s!/!::!g; + + # If we have a mixed-case package name, assume case has been preserved + # correctly. Otherwise, root through the file to locate the case-preserved + # version of the package name. + if ( $subpath eq lc($subpath) || $subpath eq uc($subpath) ) { + my $content = Module::Install::_read($subpath . '.pm'); + my $in_pod = 0; + foreach ( split //, $content ) { + $in_pod = 1 if /^=\w/; + $in_pod = 0 if /^=cut/; + next if ($in_pod || /^=cut/); # skip pod text + next if /^\s*#/; # and comments + if ( m/^\s*package\s+($pkg)\s*;/i ) { + $pkg = $1; + last; + } + } + } + + push @found, [ $file, $pkg ]; + }, $path ) if -d $path; + + @found; +} + + + + + +##################################################################### +# Common Utility Functions + +sub _caller { + my $depth = 0; + my $call = caller($depth); + while ( $call eq __PACKAGE__ ) { + $depth++; + $call = caller($depth); + } + return $call; +} + +# Done in evals to avoid confusing Perl::MinimumVersion +eval( $] >= 5.006 ? <<'END_NEW' : <<'END_OLD' ); die $@ if $@; +sub _read { + local *FH; + open( FH, '<', $_[0] ) or die "open($_[0]): $!"; + my $string = do { local $/; }; + close FH or die "close($_[0]): $!"; + return $string; +} +END_NEW +sub _read { + local *FH; + open( FH, "< $_[0]" ) or die "open($_[0]): $!"; + my $string = do { local $/; }; + close FH or die "close($_[0]): $!"; + return $string; +} +END_OLD + +sub _readperl { + my $string = Module::Install::_read($_[0]); + $string =~ s/(?:\015{1,2}\012|\015|\012)/\n/sg; + $string =~ s/(\n)\n*__(?:DATA|END)__\b.*\z/$1/s; + $string =~ s/\n\n=\w+.+?\n\n=cut\b.+?\n+/\n\n/sg; + return $string; +} + +sub _readpod { + my $string = Module::Install::_read($_[0]); + $string =~ s/(?:\015{1,2}\012|\015|\012)/\n/sg; + return $string if $_[0] =~ /\.pod\z/; + $string =~ s/(^|\n=cut\b.+?\n+)[^=\s].+?\n(\n=\w+|\z)/$1$2/sg; + $string =~ s/\n*=pod\b[^\n]*\n+/\n\n/sg; + $string =~ s/\n*=cut\b[^\n]*\n+/\n\n/sg; + $string =~ s/^\n+//s; + return $string; +} + +# Done in evals to avoid confusing Perl::MinimumVersion +eval( $] >= 5.006 ? <<'END_NEW' : <<'END_OLD' ); die $@ if $@; +sub _write { + local *FH; + open( FH, '>', $_[0] ) or die "open($_[0]): $!"; + foreach ( 1 .. $#_ ) { + print FH $_[$_] or die "print($_[0]): $!"; + } + close FH or die "close($_[0]): $!"; +} +END_NEW +sub _write { + local *FH; + open( FH, "> $_[0]" ) or die "open($_[0]): $!"; + foreach ( 1 .. $#_ ) { + print FH $_[$_] or die "print($_[0]): $!"; + } + close FH or die "close($_[0]): $!"; +} +END_OLD + +# _version is for processing module versions (eg, 1.03_05) not +# Perl versions (eg, 5.8.1). +sub _version ($) { + my $s = shift || 0; + my $d =()= $s =~ /(\.)/g; + if ( $d >= 2 ) { + # Normalise multipart versions + $s =~ s/(\.)(\d{1,3})/sprintf("$1%03d",$2)/eg; + } + $s =~ s/^(\d+)\.?//; + my $l = $1 || 0; + my @v = map { + $_ . '0' x (3 - length $_) + } $s =~ /(\d{1,3})\D?/g; + $l = $l . '.' . join '', @v if @v; + return $l + 0; +} + +sub _cmp ($$) { + _version($_[0]) <=> _version($_[1]); +} + +# Cloned from Params::Util::_CLASS +sub _CLASS ($) { + ( + defined $_[0] + and + ! ref $_[0] + and + $_[0] =~ m/^[^\W\d]\w*(?:::\w+)*\z/s + ) ? $_[0] : undef; +} + +1; + +# Copyright 2008 - 2011 Adam Kennedy. diff --git a/inc/Module/Install/Base.pm b/inc/Module/Install/Base.pm new file mode 100644 index 0000000..d3662c9 --- /dev/null +++ b/inc/Module/Install/Base.pm @@ -0,0 +1,83 @@ +#line 1 +package Module::Install::Base; + +use strict 'vars'; +use vars qw{$VERSION}; +BEGIN { + $VERSION = '1.01'; +} + +# Suspend handler for "redefined" warnings +BEGIN { + my $w = $SIG{__WARN__}; + $SIG{__WARN__} = sub { $w }; +} + +#line 42 + +sub new { + my $class = shift; + unless ( defined &{"${class}::call"} ) { + *{"${class}::call"} = sub { shift->_top->call(@_) }; + } + unless ( defined &{"${class}::load"} ) { + *{"${class}::load"} = sub { shift->_top->load(@_) }; + } + bless { @_ }, $class; +} + +#line 61 + +sub AUTOLOAD { + local $@; + my $func = eval { shift->_top->autoload } or return; + goto &$func; +} + +#line 75 + +sub _top { + $_[0]->{_top}; +} + +#line 90 + +sub admin { + $_[0]->_top->{admin} + or + Module::Install::Base::FakeAdmin->new; +} + +#line 106 + +sub is_admin { + ! $_[0]->admin->isa('Module::Install::Base::FakeAdmin'); +} + +sub DESTROY {} + +package Module::Install::Base::FakeAdmin; + +use vars qw{$VERSION}; +BEGIN { + $VERSION = $Module::Install::Base::VERSION; +} + +my $fake; + +sub new { + $fake ||= bless(\@_, $_[0]); +} + +sub AUTOLOAD {} + +sub DESTROY {} + +# Restore warning handler +BEGIN { + $SIG{__WARN__} = $SIG{__WARN__}->(); +} + +1; + +#line 159 diff --git a/inc/Module/Install/Can.pm b/inc/Module/Install/Can.pm new file mode 100644 index 0000000..276409a --- /dev/null +++ b/inc/Module/Install/Can.pm @@ -0,0 +1,81 @@ +#line 1 +package Module::Install::Can; + +use strict; +use Config (); +use File::Spec (); +use ExtUtils::MakeMaker (); +use Module::Install::Base (); + +use vars qw{$VERSION @ISA $ISCORE}; +BEGIN { + $VERSION = '1.01'; + @ISA = 'Module::Install::Base'; + $ISCORE = 1; +} + +# check if we can load some module +### Upgrade this to not have to load the module if possible +sub can_use { + my ($self, $mod, $ver) = @_; + $mod =~ s{::|\\}{/}g; + $mod .= '.pm' unless $mod =~ /\.pm$/i; + + my $pkg = $mod; + $pkg =~ s{/}{::}g; + $pkg =~ s{\.pm$}{}i; + + local $@; + eval { require $mod; $pkg->VERSION($ver || 0); 1 }; +} + +# check if we can run some command +sub can_run { + my ($self, $cmd) = @_; + + my $_cmd = $cmd; + return $_cmd if (-x $_cmd or $_cmd = MM->maybe_command($_cmd)); + + for my $dir ((split /$Config::Config{path_sep}/, $ENV{PATH}), '.') { + next if $dir eq ''; + my $abs = File::Spec->catfile($dir, $_[1]); + return $abs if (-x $abs or $abs = MM->maybe_command($abs)); + } + + return; +} + +# can we locate a (the) C compiler +sub can_cc { + my $self = shift; + my @chunks = split(/ /, $Config::Config{cc}) or return; + + # $Config{cc} may contain args; try to find out the program part + while (@chunks) { + return $self->can_run("@chunks") || (pop(@chunks), next); + } + + return; +} + +# Fix Cygwin bug on maybe_command(); +if ( $^O eq 'cygwin' ) { + require ExtUtils::MM_Cygwin; + require ExtUtils::MM_Win32; + if ( ! defined(&ExtUtils::MM_Cygwin::maybe_command) ) { + *ExtUtils::MM_Cygwin::maybe_command = sub { + my ($self, $file) = @_; + if ($file =~ m{^/cygdrive/}i and ExtUtils::MM_Win32->can('maybe_command')) { + ExtUtils::MM_Win32->maybe_command($file); + } else { + ExtUtils::MM_Unix->maybe_command($file); + } + } + } +} + +1; + +__END__ + +#line 156 diff --git a/inc/Module/Install/Fetch.pm b/inc/Module/Install/Fetch.pm new file mode 100644 index 0000000..093cb7a --- /dev/null +++ b/inc/Module/Install/Fetch.pm @@ -0,0 +1,93 @@ +#line 1 +package Module::Install::Fetch; + +use strict; +use Module::Install::Base (); + +use vars qw{$VERSION @ISA $ISCORE}; +BEGIN { + $VERSION = '1.01'; + @ISA = 'Module::Install::Base'; + $ISCORE = 1; +} + +sub get_file { + my ($self, %args) = @_; + my ($scheme, $host, $path, $file) = + $args{url} =~ m|^(\w+)://([^/]+)(.+)/(.+)| or return; + + if ( $scheme eq 'http' and ! eval { require LWP::Simple; 1 } ) { + $args{url} = $args{ftp_url} + or (warn("LWP support unavailable!\n"), return); + ($scheme, $host, $path, $file) = + $args{url} =~ m|^(\w+)://([^/]+)(.+)/(.+)| or return; + } + + $|++; + print "Fetching '$file' from $host... "; + + unless (eval { require Socket; Socket::inet_aton($host) }) { + warn "'$host' resolve failed!\n"; + return; + } + + return unless $scheme eq 'ftp' or $scheme eq 'http'; + + require Cwd; + my $dir = Cwd::getcwd(); + chdir $args{local_dir} or return if exists $args{local_dir}; + + if (eval { require LWP::Simple; 1 }) { + LWP::Simple::mirror($args{url}, $file); + } + elsif (eval { require Net::FTP; 1 }) { eval { + # use Net::FTP to get past firewall + my $ftp = Net::FTP->new($host, Passive => 1, Timeout => 600); + $ftp->login("anonymous", 'anonymous@example.com'); + $ftp->cwd($path); + $ftp->binary; + $ftp->get($file) or (warn("$!\n"), return); + $ftp->quit; + } } + elsif (my $ftp = $self->can_run('ftp')) { eval { + # no Net::FTP, fallback to ftp.exe + require FileHandle; + my $fh = FileHandle->new; + + local $SIG{CHLD} = 'IGNORE'; + unless ($fh->open("|$ftp -n")) { + warn "Couldn't open ftp: $!\n"; + chdir $dir; return; + } + + my @dialog = split(/\n/, <<"END_FTP"); +open $host +user anonymous anonymous\@example.com +cd $path +binary +get $file $file +quit +END_FTP + foreach (@dialog) { $fh->print("$_\n") } + $fh->close; + } } + else { + warn "No working 'ftp' program available!\n"; + chdir $dir; return; + } + + unless (-f $file) { + warn "Fetching failed: $@\n"; + chdir $dir; return; + } + + return if exists $args{size} and -s $file != $args{size}; + system($args{run}) if exists $args{run}; + unlink($file) if $args{remove}; + + print(((!exists $args{check_for} or -e $args{check_for}) + ? "done!" : "failed! ($!)"), "\n"); + chdir $dir; return !$?; +} + +1; diff --git a/inc/Module/Install/GithubMeta.pm b/inc/Module/Install/GithubMeta.pm new file mode 100644 index 0000000..9a9f860 --- /dev/null +++ b/inc/Module/Install/GithubMeta.pm @@ -0,0 +1,50 @@ +#line 1 +package Module::Install::GithubMeta; + +use strict; +use warnings; +use Cwd; +use base qw(Module::Install::Base); +use vars qw($VERSION); + +$VERSION = '0.10'; + +sub githubmeta { + my $self = shift; + return unless $Module::Install::AUTHOR; + return unless _under_git(); + return unless $self->can_run('git'); + return unless my ($git_url) = `git remote show -n origin` =~ /URL: (.*)$/m; + return unless $git_url =~ /github\.com/; # Not a Github repository + my $http_url = $git_url; + $git_url =~ s![\w\-]+\@([^:]+):!git://$1/!; + $http_url =~ s![\w\-]+\@([^:]+):!http://$1/!; + $http_url =~ s!\.git$!/tree!; + $self->repository( $git_url ); + $self->homepage( $http_url ) unless $self->homepage(); + return 1; +} + +sub _under_git { + return 1 if -e '.git'; + my $cwd = getcwd; + my $last = $cwd; + my $found = 0; + while (1) { + chdir '..' or last; + my $current = getcwd; + last if $last eq $current; + $last = $current; + if ( -e '.git' ) { + $found = 1; + last; + } + } + chdir $cwd; + return $found; +} + +'Github'; +__END__ + +#line 108 diff --git a/inc/Module/Install/Makefile.pm b/inc/Module/Install/Makefile.pm new file mode 100644 index 0000000..4c71003 --- /dev/null +++ b/inc/Module/Install/Makefile.pm @@ -0,0 +1,415 @@ +#line 1 +package Module::Install::Makefile; + +use strict 'vars'; +use ExtUtils::MakeMaker (); +use Module::Install::Base (); +use Fcntl qw/:flock :seek/; + +use vars qw{$VERSION @ISA $ISCORE}; +BEGIN { + $VERSION = '1.01'; + @ISA = 'Module::Install::Base'; + $ISCORE = 1; +} + +sub Makefile { $_[0] } + +my %seen = (); + +sub prompt { + shift; + + # Infinite loop protection + my @c = caller(); + if ( ++$seen{"$c[1]|$c[2]|$_[0]"} > 3 ) { + die "Caught an potential prompt infinite loop ($c[1]|$c[2]|$_[0])"; + } + + # In automated testing or non-interactive session, always use defaults + if ( ($ENV{AUTOMATED_TESTING} or -! -t STDIN) and ! $ENV{PERL_MM_USE_DEFAULT} ) { + local $ENV{PERL_MM_USE_DEFAULT} = 1; + goto &ExtUtils::MakeMaker::prompt; + } else { + goto &ExtUtils::MakeMaker::prompt; + } +} + +# Store a cleaned up version of the MakeMaker version, +# since we need to behave differently in a variety of +# ways based on the MM version. +my $makemaker = eval $ExtUtils::MakeMaker::VERSION; + +# If we are passed a param, do a "newer than" comparison. +# Otherwise, just return the MakeMaker version. +sub makemaker { + ( @_ < 2 or $makemaker >= eval($_[1]) ) ? $makemaker : 0 +} + +# Ripped from ExtUtils::MakeMaker 6.56, and slightly modified +# as we only need to know here whether the attribute is an array +# or a hash or something else (which may or may not be appendable). +my %makemaker_argtype = ( + C => 'ARRAY', + CONFIG => 'ARRAY', +# CONFIGURE => 'CODE', # ignore + DIR => 'ARRAY', + DL_FUNCS => 'HASH', + DL_VARS => 'ARRAY', + EXCLUDE_EXT => 'ARRAY', + EXE_FILES => 'ARRAY', + FUNCLIST => 'ARRAY', + H => 'ARRAY', + IMPORTS => 'HASH', + INCLUDE_EXT => 'ARRAY', + LIBS => 'ARRAY', # ignore '' + MAN1PODS => 'HASH', + MAN3PODS => 'HASH', + META_ADD => 'HASH', + META_MERGE => 'HASH', + PL_FILES => 'HASH', + PM => 'HASH', + PMLIBDIRS => 'ARRAY', + PMLIBPARENTDIRS => 'ARRAY', + PREREQ_PM => 'HASH', + CONFIGURE_REQUIRES => 'HASH', + SKIP => 'ARRAY', + TYPEMAPS => 'ARRAY', + XS => 'HASH', +# VERSION => ['version',''], # ignore +# _KEEP_AFTER_FLUSH => '', + + clean => 'HASH', + depend => 'HASH', + dist => 'HASH', + dynamic_lib=> 'HASH', + linkext => 'HASH', + macro => 'HASH', + postamble => 'HASH', + realclean => 'HASH', + test => 'HASH', + tool_autosplit => 'HASH', + + # special cases where you can use makemaker_append + CCFLAGS => 'APPENDABLE', + DEFINE => 'APPENDABLE', + INC => 'APPENDABLE', + LDDLFLAGS => 'APPENDABLE', + LDFROM => 'APPENDABLE', +); + +sub makemaker_args { + my ($self, %new_args) = @_; + my $args = ( $self->{makemaker_args} ||= {} ); + foreach my $key (keys %new_args) { + if ($makemaker_argtype{$key}) { + if ($makemaker_argtype{$key} eq 'ARRAY') { + $args->{$key} = [] unless defined $args->{$key}; + unless (ref $args->{$key} eq 'ARRAY') { + $args->{$key} = [$args->{$key}] + } + push @{$args->{$key}}, + ref $new_args{$key} eq 'ARRAY' + ? @{$new_args{$key}} + : $new_args{$key}; + } + elsif ($makemaker_argtype{$key} eq 'HASH') { + $args->{$key} = {} unless defined $args->{$key}; + foreach my $skey (keys %{ $new_args{$key} }) { + $args->{$key}{$skey} = $new_args{$key}{$skey}; + } + } + elsif ($makemaker_argtype{$key} eq 'APPENDABLE') { + $self->makemaker_append($key => $new_args{$key}); + } + } + else { + if (defined $args->{$key}) { + warn qq{MakeMaker attribute "$key" is overriden; use "makemaker_append" to append values\n}; + } + $args->{$key} = $new_args{$key}; + } + } + return $args; +} + +# For mm args that take multiple space-seperated args, +# append an argument to the current list. +sub makemaker_append { + my $self = shift; + my $name = shift; + my $args = $self->makemaker_args; + $args->{$name} = defined $args->{$name} + ? join( ' ', $args->{$name}, @_ ) + : join( ' ', @_ ); +} + +sub build_subdirs { + my $self = shift; + my $subdirs = $self->makemaker_args->{DIR} ||= []; + for my $subdir (@_) { + push @$subdirs, $subdir; + } +} + +sub clean_files { + my $self = shift; + my $clean = $self->makemaker_args->{clean} ||= {}; + %$clean = ( + %$clean, + FILES => join ' ', grep { length $_ } ($clean->{FILES} || (), @_), + ); +} + +sub realclean_files { + my $self = shift; + my $realclean = $self->makemaker_args->{realclean} ||= {}; + %$realclean = ( + %$realclean, + FILES => join ' ', grep { length $_ } ($realclean->{FILES} || (), @_), + ); +} + +sub libs { + my $self = shift; + my $libs = ref $_[0] ? shift : [ shift ]; + $self->makemaker_args( LIBS => $libs ); +} + +sub inc { + my $self = shift; + $self->makemaker_args( INC => shift ); +} + +sub _wanted_t { +} + +sub tests_recursive { + my $self = shift; + my $dir = shift || 't'; + unless ( -d $dir ) { + die "tests_recursive dir '$dir' does not exist"; + } + my %tests = map { $_ => 1 } split / /, ($self->tests || ''); + require File::Find; + File::Find::find( + sub { /\.t$/ and -f $_ and $tests{"$File::Find::dir/*.t"} = 1 }, + $dir + ); + $self->tests( join ' ', sort keys %tests ); +} + +sub write { + my $self = shift; + die "&Makefile->write() takes no arguments\n" if @_; + + # Check the current Perl version + my $perl_version = $self->perl_version; + if ( $perl_version ) { + eval "use $perl_version; 1" + or die "ERROR: perl: Version $] is installed, " + . "but we need version >= $perl_version"; + } + + # Make sure we have a new enough MakeMaker + require ExtUtils::MakeMaker; + + if ( $perl_version and $self->_cmp($perl_version, '5.006') >= 0 ) { + # MakeMaker can complain about module versions that include + # an underscore, even though its own version may contain one! + # Hence the funny regexp to get rid of it. See RT #35800 + # for details. + my $v = $ExtUtils::MakeMaker::VERSION =~ /^(\d+\.\d+)/; + $self->build_requires( 'ExtUtils::MakeMaker' => $v ); + $self->configure_requires( 'ExtUtils::MakeMaker' => $v ); + } else { + # Allow legacy-compatibility with 5.005 by depending on the + # most recent EU:MM that supported 5.005. + $self->build_requires( 'ExtUtils::MakeMaker' => 6.42 ); + $self->configure_requires( 'ExtUtils::MakeMaker' => 6.42 ); + } + + # Generate the MakeMaker params + my $args = $self->makemaker_args; + $args->{DISTNAME} = $self->name; + $args->{NAME} = $self->module_name || $self->name; + $args->{NAME} =~ s/-/::/g; + $args->{VERSION} = $self->version or die <<'EOT'; +ERROR: Can't determine distribution version. Please specify it +explicitly via 'version' in Makefile.PL, or set a valid $VERSION +in a module, and provide its file path via 'version_from' (or +'all_from' if you prefer) in Makefile.PL. +EOT + + $DB::single = 1; + if ( $self->tests ) { + my @tests = split ' ', $self->tests; + my %seen; + $args->{test} = { + TESTS => (join ' ', grep {!$seen{$_}++} @tests), + }; + } elsif ( $Module::Install::ExtraTests::use_extratests ) { + # Module::Install::ExtraTests doesn't set $self->tests and does its own tests via harness. + # So, just ignore our xt tests here. + } elsif ( -d 'xt' and ($Module::Install::AUTHOR or $ENV{RELEASE_TESTING}) ) { + $args->{test} = { + TESTS => join( ' ', map { "$_/*.t" } grep { -d $_ } qw{ t xt } ), + }; + } + if ( $] >= 5.005 ) { + $args->{ABSTRACT} = $self->abstract; + $args->{AUTHOR} = join ', ', @{$self->author || []}; + } + if ( $self->makemaker(6.10) ) { + $args->{NO_META} = 1; + #$args->{NO_MYMETA} = 1; + } + if ( $self->makemaker(6.17) and $self->sign ) { + $args->{SIGN} = 1; + } + unless ( $self->is_admin ) { + delete $args->{SIGN}; + } + if ( $self->makemaker(6.31) and $self->license ) { + $args->{LICENSE} = $self->license; + } + + my $prereq = ($args->{PREREQ_PM} ||= {}); + %$prereq = ( %$prereq, + map { @$_ } # flatten [module => version] + map { @$_ } + grep $_, + ($self->requires) + ); + + # Remove any reference to perl, PREREQ_PM doesn't support it + delete $args->{PREREQ_PM}->{perl}; + + # Merge both kinds of requires into BUILD_REQUIRES + my $build_prereq = ($args->{BUILD_REQUIRES} ||= {}); + %$build_prereq = ( %$build_prereq, + map { @$_ } # flatten [module => version] + map { @$_ } + grep $_, + ($self->configure_requires, $self->build_requires) + ); + + # Remove any reference to perl, BUILD_REQUIRES doesn't support it + delete $args->{BUILD_REQUIRES}->{perl}; + + # Delete bundled dists from prereq_pm, add it to Makefile DIR + my $subdirs = ($args->{DIR} || []); + if ($self->bundles) { + my %processed; + foreach my $bundle (@{ $self->bundles }) { + my ($mod_name, $dist_dir) = @$bundle; + delete $prereq->{$mod_name}; + $dist_dir = File::Basename::basename($dist_dir); # dir for building this module + if (not exists $processed{$dist_dir}) { + if (-d $dist_dir) { + # List as sub-directory to be processed by make + push @$subdirs, $dist_dir; + } + # Else do nothing: the module is already present on the system + $processed{$dist_dir} = undef; + } + } + } + + unless ( $self->makemaker('6.55_03') ) { + %$prereq = (%$prereq,%$build_prereq); + delete $args->{BUILD_REQUIRES}; + } + + if ( my $perl_version = $self->perl_version ) { + eval "use $perl_version; 1" + or die "ERROR: perl: Version $] is installed, " + . "but we need version >= $perl_version"; + + if ( $self->makemaker(6.48) ) { + $args->{MIN_PERL_VERSION} = $perl_version; + } + } + + if ($self->installdirs) { + warn qq{old INSTALLDIRS (probably set by makemaker_args) is overriden by installdirs\n} if $args->{INSTALLDIRS}; + $args->{INSTALLDIRS} = $self->installdirs; + } + + my %args = map { + ( $_ => $args->{$_} ) } grep {defined($args->{$_} ) + } keys %$args; + + my $user_preop = delete $args{dist}->{PREOP}; + if ( my $preop = $self->admin->preop($user_preop) ) { + foreach my $key ( keys %$preop ) { + $args{dist}->{$key} = $preop->{$key}; + } + } + + my $mm = ExtUtils::MakeMaker::WriteMakefile(%args); + $self->fix_up_makefile($mm->{FIRST_MAKEFILE} || 'Makefile'); +} + +sub fix_up_makefile { + my $self = shift; + my $makefile_name = shift; + my $top_class = ref($self->_top) || ''; + my $top_version = $self->_top->VERSION || ''; + + my $preamble = $self->preamble + ? "# Preamble by $top_class $top_version\n" + . $self->preamble + : ''; + my $postamble = "# Postamble by $top_class $top_version\n" + . ($self->postamble || ''); + + local *MAKEFILE; + open MAKEFILE, "+< $makefile_name" or die "fix_up_makefile: Couldn't open $makefile_name: $!"; + eval { flock MAKEFILE, LOCK_EX }; + my $makefile = do { local $/; }; + + $makefile =~ s/\b(test_harness\(\$\(TEST_VERBOSE\), )/$1'inc', /; + $makefile =~ s/( -I\$\(INST_ARCHLIB\))/ -Iinc$1/g; + $makefile =~ s/( "-I\$\(INST_LIB\)")/ "-Iinc"$1/g; + $makefile =~ s/^(FULLPERL = .*)/$1 "-Iinc"/m; + $makefile =~ s/^(PERL = .*)/$1 "-Iinc"/m; + + # Module::Install will never be used to build the Core Perl + # Sometimes PERL_LIB and PERL_ARCHLIB get written anyway, which breaks + # PREFIX/PERL5LIB, and thus, install_share. Blank them if they exist + $makefile =~ s/^PERL_LIB = .+/PERL_LIB =/m; + #$makefile =~ s/^PERL_ARCHLIB = .+/PERL_ARCHLIB =/m; + + # Perl 5.005 mentions PERL_LIB explicitly, so we have to remove that as well. + $makefile =~ s/(\"?)-I\$\(PERL_LIB\)\1//g; + + # XXX - This is currently unused; not sure if it breaks other MM-users + # $makefile =~ s/^pm_to_blib\s+:\s+/pm_to_blib :: /mg; + + seek MAKEFILE, 0, SEEK_SET; + truncate MAKEFILE, 0; + print MAKEFILE "$preamble$makefile$postamble" or die $!; + close MAKEFILE or die $!; + + 1; +} + +sub preamble { + my ($self, $text) = @_; + $self->{preamble} = $text . $self->{preamble} if defined $text; + $self->{preamble}; +} + +sub postamble { + my ($self, $text) = @_; + $self->{postamble} ||= $self->admin->postamble; + $self->{postamble} .= $text if defined $text; + $self->{postamble} +} + +1; + +__END__ + +#line 541 diff --git a/inc/Module/Install/Metadata.pm b/inc/Module/Install/Metadata.pm new file mode 100644 index 0000000..af2332a --- /dev/null +++ b/inc/Module/Install/Metadata.pm @@ -0,0 +1,716 @@ +#line 1 +package Module::Install::Metadata; + +use strict 'vars'; +use Module::Install::Base (); + +use vars qw{$VERSION @ISA $ISCORE}; +BEGIN { + $VERSION = '1.01'; + @ISA = 'Module::Install::Base'; + $ISCORE = 1; +} + +my @boolean_keys = qw{ + sign +}; + +my @scalar_keys = qw{ + name + module_name + abstract + version + distribution_type + tests + installdirs +}; + +my @tuple_keys = qw{ + configure_requires + build_requires + requires + recommends + bundles + resources +}; + +my @resource_keys = qw{ + homepage + bugtracker + repository +}; + +my @array_keys = qw{ + keywords + author +}; + +*authors = \&author; + +sub Meta { shift } +sub Meta_BooleanKeys { @boolean_keys } +sub Meta_ScalarKeys { @scalar_keys } +sub Meta_TupleKeys { @tuple_keys } +sub Meta_ResourceKeys { @resource_keys } +sub Meta_ArrayKeys { @array_keys } + +foreach my $key ( @boolean_keys ) { + *$key = sub { + my $self = shift; + if ( defined wantarray and not @_ ) { + return $self->{values}->{$key}; + } + $self->{values}->{$key} = ( @_ ? $_[0] : 1 ); + return $self; + }; +} + +foreach my $key ( @scalar_keys ) { + *$key = sub { + my $self = shift; + return $self->{values}->{$key} if defined wantarray and !@_; + $self->{values}->{$key} = shift; + return $self; + }; +} + +foreach my $key ( @array_keys ) { + *$key = sub { + my $self = shift; + return $self->{values}->{$key} if defined wantarray and !@_; + $self->{values}->{$key} ||= []; + push @{$self->{values}->{$key}}, @_; + return $self; + }; +} + +foreach my $key ( @resource_keys ) { + *$key = sub { + my $self = shift; + unless ( @_ ) { + return () unless $self->{values}->{resources}; + return map { $_->[1] } + grep { $_->[0] eq $key } + @{ $self->{values}->{resources} }; + } + return $self->{values}->{resources}->{$key} unless @_; + my $uri = shift or die( + "Did not provide a value to $key()" + ); + $self->resources( $key => $uri ); + return 1; + }; +} + +foreach my $key ( grep { $_ ne "resources" } @tuple_keys) { + *$key = sub { + my $self = shift; + return $self->{values}->{$key} unless @_; + my @added; + while ( @_ ) { + my $module = shift or last; + my $version = shift || 0; + push @added, [ $module, $version ]; + } + push @{ $self->{values}->{$key} }, @added; + return map {@$_} @added; + }; +} + +# Resource handling +my %lc_resource = map { $_ => 1 } qw{ + homepage + license + bugtracker + repository +}; + +sub resources { + my $self = shift; + while ( @_ ) { + my $name = shift or last; + my $value = shift or next; + if ( $name eq lc $name and ! $lc_resource{$name} ) { + die("Unsupported reserved lowercase resource '$name'"); + } + $self->{values}->{resources} ||= []; + push @{ $self->{values}->{resources} }, [ $name, $value ]; + } + $self->{values}->{resources}; +} + +# Aliases for build_requires that will have alternative +# meanings in some future version of META.yml. +sub test_requires { shift->build_requires(@_) } +sub install_requires { shift->build_requires(@_) } + +# Aliases for installdirs options +sub install_as_core { $_[0]->installdirs('perl') } +sub install_as_cpan { $_[0]->installdirs('site') } +sub install_as_site { $_[0]->installdirs('site') } +sub install_as_vendor { $_[0]->installdirs('vendor') } + +sub dynamic_config { + my $self = shift; + unless ( @_ ) { + warn "You MUST provide an explicit true/false value to dynamic_config\n"; + return $self; + } + $self->{values}->{dynamic_config} = $_[0] ? 1 : 0; + return 1; +} + +sub perl_version { + my $self = shift; + return $self->{values}->{perl_version} unless @_; + my $version = shift or die( + "Did not provide a value to perl_version()" + ); + + # Normalize the version + $version = $self->_perl_version($version); + + # We don't support the really old versions + unless ( $version >= 5.005 ) { + die "Module::Install only supports 5.005 or newer (use ExtUtils::MakeMaker)\n"; + } + + $self->{values}->{perl_version} = $version; +} + +sub all_from { + my ( $self, $file ) = @_; + + unless ( defined($file) ) { + my $name = $self->name or die( + "all_from called with no args without setting name() first" + ); + $file = join('/', 'lib', split(/-/, $name)) . '.pm'; + $file =~ s{.*/}{} unless -e $file; + unless ( -e $file ) { + die("all_from cannot find $file from $name"); + } + } + unless ( -f $file ) { + die("The path '$file' does not exist, or is not a file"); + } + + $self->{values}{all_from} = $file; + + # Some methods pull from POD instead of code. + # If there is a matching .pod, use that instead + my $pod = $file; + $pod =~ s/\.pm$/.pod/i; + $pod = $file unless -e $pod; + + # Pull the different values + $self->name_from($file) unless $self->name; + $self->version_from($file) unless $self->version; + $self->perl_version_from($file) unless $self->perl_version; + $self->author_from($pod) unless @{$self->author || []}; + $self->license_from($pod) unless $self->license; + $self->abstract_from($pod) unless $self->abstract; + + return 1; +} + +sub provides { + my $self = shift; + my $provides = ( $self->{values}->{provides} ||= {} ); + %$provides = (%$provides, @_) if @_; + return $provides; +} + +sub auto_provides { + my $self = shift; + return $self unless $self->is_admin; + unless (-e 'MANIFEST') { + warn "Cannot deduce auto_provides without a MANIFEST, skipping\n"; + return $self; + } + # Avoid spurious warnings as we are not checking manifest here. + local $SIG{__WARN__} = sub {1}; + require ExtUtils::Manifest; + local *ExtUtils::Manifest::manicheck = sub { return }; + + require Module::Build; + my $build = Module::Build->new( + dist_name => $self->name, + dist_version => $self->version, + license => $self->license, + ); + $self->provides( %{ $build->find_dist_packages || {} } ); +} + +sub feature { + my $self = shift; + my $name = shift; + my $features = ( $self->{values}->{features} ||= [] ); + my $mods; + + if ( @_ == 1 and ref( $_[0] ) ) { + # The user used ->feature like ->features by passing in the second + # argument as a reference. Accomodate for that. + $mods = $_[0]; + } else { + $mods = \@_; + } + + my $count = 0; + push @$features, ( + $name => [ + map { + ref($_) ? ( ref($_) eq 'HASH' ) ? %$_ : @$_ : $_ + } @$mods + ] + ); + + return @$features; +} + +sub features { + my $self = shift; + while ( my ( $name, $mods ) = splice( @_, 0, 2 ) ) { + $self->feature( $name, @$mods ); + } + return $self->{values}->{features} + ? @{ $self->{values}->{features} } + : (); +} + +sub no_index { + my $self = shift; + my $type = shift; + push @{ $self->{values}->{no_index}->{$type} }, @_ if $type; + return $self->{values}->{no_index}; +} + +sub read { + my $self = shift; + $self->include_deps( 'YAML::Tiny', 0 ); + + require YAML::Tiny; + my $data = YAML::Tiny::LoadFile('META.yml'); + + # Call methods explicitly in case user has already set some values. + while ( my ( $key, $value ) = each %$data ) { + next unless $self->can($key); + if ( ref $value eq 'HASH' ) { + while ( my ( $module, $version ) = each %$value ) { + $self->can($key)->($self, $module => $version ); + } + } else { + $self->can($key)->($self, $value); + } + } + return $self; +} + +sub write { + my $self = shift; + return $self unless $self->is_admin; + $self->admin->write_meta; + return $self; +} + +sub version_from { + require ExtUtils::MM_Unix; + my ( $self, $file ) = @_; + $self->version( ExtUtils::MM_Unix->parse_version($file) ); + + # for version integrity check + $self->makemaker_args( VERSION_FROM => $file ); +} + +sub abstract_from { + require ExtUtils::MM_Unix; + my ( $self, $file ) = @_; + $self->abstract( + bless( + { DISTNAME => $self->name }, + 'ExtUtils::MM_Unix' + )->parse_abstract($file) + ); +} + +# Add both distribution and module name +sub name_from { + my ($self, $file) = @_; + if ( + Module::Install::_read($file) =~ m/ + ^ \s* + package \s* + ([\w:]+) + \s* ; + /ixms + ) { + my ($name, $module_name) = ($1, $1); + $name =~ s{::}{-}g; + $self->name($name); + unless ( $self->module_name ) { + $self->module_name($module_name); + } + } else { + die("Cannot determine name from $file\n"); + } +} + +sub _extract_perl_version { + if ( + $_[0] =~ m/ + ^\s* + (?:use|require) \s* + v? + ([\d_\.]+) + \s* ; + /ixms + ) { + my $perl_version = $1; + $perl_version =~ s{_}{}g; + return $perl_version; + } else { + return; + } +} + +sub perl_version_from { + my $self = shift; + my $perl_version=_extract_perl_version(Module::Install::_read($_[0])); + if ($perl_version) { + $self->perl_version($perl_version); + } else { + warn "Cannot determine perl version info from $_[0]\n"; + return; + } +} + +sub author_from { + my $self = shift; + my $content = Module::Install::_read($_[0]); + if ($content =~ m/ + =head \d \s+ (?:authors?)\b \s* + ([^\n]*) + | + =head \d \s+ (?:licen[cs]e|licensing|copyright|legal)\b \s* + .*? copyright .*? \d\d\d[\d.]+ \s* (?:\bby\b)? \s* + ([^\n]*) + /ixms) { + my $author = $1 || $2; + + # XXX: ugly but should work anyway... + if (eval "require Pod::Escapes; 1") { + # Pod::Escapes has a mapping table. + # It's in core of perl >= 5.9.3, and should be installed + # as one of the Pod::Simple's prereqs, which is a prereq + # of Pod::Text 3.x (see also below). + $author =~ s{ E<( (\d+) | ([A-Za-z]+) )> } + { + defined $2 + ? chr($2) + : defined $Pod::Escapes::Name2character_number{$1} + ? chr($Pod::Escapes::Name2character_number{$1}) + : do { + warn "Unknown escape: E<$1>"; + "E<$1>"; + }; + }gex; + } + elsif (eval "require Pod::Text; 1" && $Pod::Text::VERSION < 3) { + # Pod::Text < 3.0 has yet another mapping table, + # though the table name of 2.x and 1.x are different. + # (1.x is in core of Perl < 5.6, 2.x is in core of + # Perl < 5.9.3) + my $mapping = ($Pod::Text::VERSION < 2) + ? \%Pod::Text::HTML_Escapes + : \%Pod::Text::ESCAPES; + $author =~ s{ E<( (\d+) | ([A-Za-z]+) )> } + { + defined $2 + ? chr($2) + : defined $mapping->{$1} + ? $mapping->{$1} + : do { + warn "Unknown escape: E<$1>"; + "E<$1>"; + }; + }gex; + } + else { + $author =~ s{E}{<}g; + $author =~ s{E}{>}g; + } + $self->author($author); + } else { + warn "Cannot determine author info from $_[0]\n"; + } +} + +#Stolen from M::B +my %license_urls = ( + perl => 'http://dev.perl.org/licenses/', + apache => 'http://apache.org/licenses/LICENSE-2.0', + apache_1_1 => 'http://apache.org/licenses/LICENSE-1.1', + artistic => 'http://opensource.org/licenses/artistic-license.php', + artistic_2 => 'http://opensource.org/licenses/artistic-license-2.0.php', + lgpl => 'http://opensource.org/licenses/lgpl-license.php', + lgpl2 => 'http://opensource.org/licenses/lgpl-2.1.php', + lgpl3 => 'http://opensource.org/licenses/lgpl-3.0.html', + bsd => 'http://opensource.org/licenses/bsd-license.php', + gpl => 'http://opensource.org/licenses/gpl-license.php', + gpl2 => 'http://opensource.org/licenses/gpl-2.0.php', + gpl3 => 'http://opensource.org/licenses/gpl-3.0.html', + mit => 'http://opensource.org/licenses/mit-license.php', + mozilla => 'http://opensource.org/licenses/mozilla1.1.php', + open_source => undef, + unrestricted => undef, + restrictive => undef, + unknown => undef, +); + +sub license { + my $self = shift; + return $self->{values}->{license} unless @_; + my $license = shift or die( + 'Did not provide a value to license()' + ); + $license = __extract_license($license) || lc $license; + $self->{values}->{license} = $license; + + # Automatically fill in license URLs + if ( $license_urls{$license} ) { + $self->resources( license => $license_urls{$license} ); + } + + return 1; +} + +sub _extract_license { + my $pod = shift; + my $matched; + return __extract_license( + ($matched) = $pod =~ m/ + (=head \d \s+ L(?i:ICEN[CS]E|ICENSING)\b.*?) + (=head \d.*|=cut.*|)\z + /xms + ) || __extract_license( + ($matched) = $pod =~ m/ + (=head \d \s+ (?:C(?i:OPYRIGHTS?)|L(?i:EGAL))\b.*?) + (=head \d.*|=cut.*|)\z + /xms + ); +} + +sub __extract_license { + my $license_text = shift or return; + my @phrases = ( + '(?:under )?the same (?:terms|license) as (?:perl|the perl (?:\d )?programming language)' => 'perl', 1, + '(?:under )?the terms of (?:perl|the perl programming language) itself' => 'perl', 1, + 'Artistic and GPL' => 'perl', 1, + 'GNU general public license' => 'gpl', 1, + 'GNU public license' => 'gpl', 1, + 'GNU lesser general public license' => 'lgpl', 1, + 'GNU lesser public license' => 'lgpl', 1, + 'GNU library general public license' => 'lgpl', 1, + 'GNU library public license' => 'lgpl', 1, + 'GNU Free Documentation license' => 'unrestricted', 1, + 'GNU Affero General Public License' => 'open_source', 1, + '(?:Free)?BSD license' => 'bsd', 1, + 'Artistic license 2\.0' => 'artistic_2', 1, + 'Artistic license' => 'artistic', 1, + 'Apache (?:Software )?license' => 'apache', 1, + 'GPL' => 'gpl', 1, + 'LGPL' => 'lgpl', 1, + 'BSD' => 'bsd', 1, + 'Artistic' => 'artistic', 1, + 'MIT' => 'mit', 1, + 'Mozilla Public License' => 'mozilla', 1, + 'Q Public License' => 'open_source', 1, + 'OpenSSL License' => 'unrestricted', 1, + 'SSLeay License' => 'unrestricted', 1, + 'zlib License' => 'open_source', 1, + 'proprietary' => 'proprietary', 0, + ); + while ( my ($pattern, $license, $osi) = splice(@phrases, 0, 3) ) { + $pattern =~ s#\s+#\\s+#gs; + if ( $license_text =~ /\b$pattern\b/i ) { + return $license; + } + } + return ''; +} + +sub license_from { + my $self = shift; + if (my $license=_extract_license(Module::Install::_read($_[0]))) { + $self->license($license); + } else { + warn "Cannot determine license info from $_[0]\n"; + return 'unknown'; + } +} + +sub _extract_bugtracker { + my @links = $_[0] =~ m#L<( + https?\Q://rt.cpan.org/\E[^>]+| + https?\Q://github.com/\E[\w_]+/[\w_]+/issues| + https?\Q://code.google.com/p/\E[\w_\-]+/issues/list + )>#gx; + my %links; + @links{@links}=(); + @links=keys %links; + return @links; +} + +sub bugtracker_from { + my $self = shift; + my $content = Module::Install::_read($_[0]); + my @links = _extract_bugtracker($content); + unless ( @links ) { + warn "Cannot determine bugtracker info from $_[0]\n"; + return 0; + } + if ( @links > 1 ) { + warn "Found more than one bugtracker link in $_[0]\n"; + return 0; + } + + # Set the bugtracker + bugtracker( $links[0] ); + return 1; +} + +sub requires_from { + my $self = shift; + my $content = Module::Install::_readperl($_[0]); + my @requires = $content =~ m/^use\s+([^\W\d]\w*(?:::\w+)*)\s+(v?[\d\.]+)/mg; + while ( @requires ) { + my $module = shift @requires; + my $version = shift @requires; + $self->requires( $module => $version ); + } +} + +sub test_requires_from { + my $self = shift; + my $content = Module::Install::_readperl($_[0]); + my @requires = $content =~ m/^use\s+([^\W\d]\w*(?:::\w+)*)\s+([\d\.]+)/mg; + while ( @requires ) { + my $module = shift @requires; + my $version = shift @requires; + $self->test_requires( $module => $version ); + } +} + +# Convert triple-part versions (eg, 5.6.1 or 5.8.9) to +# numbers (eg, 5.006001 or 5.008009). +# Also, convert double-part versions (eg, 5.8) +sub _perl_version { + my $v = $_[-1]; + $v =~ s/^([1-9])\.([1-9]\d?\d?)$/sprintf("%d.%03d",$1,$2)/e; + $v =~ s/^([1-9])\.([1-9]\d?\d?)\.(0|[1-9]\d?\d?)$/sprintf("%d.%03d%03d",$1,$2,$3 || 0)/e; + $v =~ s/(\.\d\d\d)000$/$1/; + $v =~ s/_.+$//; + if ( ref($v) ) { + # Numify + $v = $v + 0; + } + return $v; +} + +sub add_metadata { + my $self = shift; + my %hash = @_; + for my $key (keys %hash) { + warn "add_metadata: $key is not prefixed with 'x_'.\n" . + "Use appopriate function to add non-private metadata.\n" unless $key =~ /^x_/; + $self->{values}->{$key} = $hash{$key}; + } +} + + +###################################################################### +# MYMETA Support + +sub WriteMyMeta { + die "WriteMyMeta has been deprecated"; +} + +sub write_mymeta_yaml { + my $self = shift; + + # We need YAML::Tiny to write the MYMETA.yml file + unless ( eval { require YAML::Tiny; 1; } ) { + return 1; + } + + # Generate the data + my $meta = $self->_write_mymeta_data or return 1; + + # Save as the MYMETA.yml file + print "Writing MYMETA.yml\n"; + YAML::Tiny::DumpFile('MYMETA.yml', $meta); +} + +sub write_mymeta_json { + my $self = shift; + + # We need JSON to write the MYMETA.json file + unless ( eval { require JSON; 1; } ) { + return 1; + } + + # Generate the data + my $meta = $self->_write_mymeta_data or return 1; + + # Save as the MYMETA.yml file + print "Writing MYMETA.json\n"; + Module::Install::_write( + 'MYMETA.json', + JSON->new->pretty(1)->canonical->encode($meta), + ); +} + +sub _write_mymeta_data { + my $self = shift; + + # If there's no existing META.yml there is nothing we can do + return undef unless -f 'META.yml'; + + # We need Parse::CPAN::Meta to load the file + unless ( eval { require Parse::CPAN::Meta; 1; } ) { + return undef; + } + + # Merge the perl version into the dependencies + my $val = $self->Meta->{values}; + my $perl = delete $val->{perl_version}; + if ( $perl ) { + $val->{requires} ||= []; + my $requires = $val->{requires}; + + # Canonize to three-dot version after Perl 5.6 + if ( $perl >= 5.006 ) { + $perl =~ s{^(\d+)\.(\d\d\d)(\d*)}{join('.', $1, int($2||0), int($3||0))}e + } + unshift @$requires, [ perl => $perl ]; + } + + # Load the advisory META.yml file + my @yaml = Parse::CPAN::Meta::LoadFile('META.yml'); + my $meta = $yaml[0]; + + # Overwrite the non-configure dependency hashs + delete $meta->{requires}; + delete $meta->{build_requires}; + delete $meta->{recommends}; + if ( exists $val->{requires} ) { + $meta->{requires} = { map { @$_ } @{ $val->{requires} } }; + } + if ( exists $val->{build_requires} ) { + $meta->{build_requires} = { map { @$_ } @{ $val->{build_requires} } }; + } + + return $meta; +} + +1; diff --git a/inc/Module/Install/Package.pm b/inc/Module/Install/Package.pm new file mode 100644 index 0000000..47d5178 --- /dev/null +++ b/inc/Module/Install/Package.pm @@ -0,0 +1,323 @@ +#line 1 +## +# name: Module::Install::Package +# abstract: Module::Install support for Module::Package +# author: Ingy döt Net +# license: perl +# copyright: 2011 +# see: +# - Module::Package + +# This module contains the Module::Package logic that must be available to +# both the Author and the End User. Author-only logic goes in a +# Module::Package::Plugin subclass. +package Module::Install::Package; +use strict; +use Module::Install::Base; +use vars qw'@ISA $VERSION'; +@ISA = 'Module::Install::Base'; +$VERSION = '0.30'; + +#-----------------------------------------------------------------------------# +# XXX BOOTBUGHACK +# This is here to try to get us out of Module-Package-0.11 cpantesters hell... +# Remove this when the situation has blown over. +sub pkg { + *inc::Module::Package::VERSION = sub { $VERSION }; + my $self = shift; + $self->module_package_internals_init($@); +} + +#-----------------------------------------------------------------------------# +# We allow the author to specify key/value options after the plugin. These +# options need to be available both at author time and install time. +#-----------------------------------------------------------------------------# +# OO accessor for command line options: +sub package_options { + @_>1?($_[0]->{package_options}=$_[1]):$_[0]->{package_options}} + +my $default_options = { + deps_list => 1, + install_bin => 1, + install_share => 1, + manifest_skip => 1, + requires_from => 1, +}; + +#-----------------------------------------------------------------------------# +# Module::Install plugin directives. Use long, ugly names to not pollute the +# Module::Install plugin namespace. These are only intended to be called from +# Module::Package. +#-----------------------------------------------------------------------------# + +# Module::Package starts off life as a normal call to this Module::Install +# plugin directive: +my $module_install_plugin; +my $module_package_plugin; +my $module_package_dist_plugin; +# XXX ARGVHACK This @argv thing is a temporary fix for an ugly bug somewhere in the +# Wikitext module usage. +my @argv; +sub module_package_internals_init { + my $self = $module_install_plugin = shift; + my ($plugin_spec, %options) = @_; + $self->package_options({%$default_options, %options}); + + if ($module_install_plugin->is_admin) { + $module_package_plugin = $self->_load_plugin($plugin_spec); + $module_package_plugin->mi($module_install_plugin); + $module_package_plugin->version_check($VERSION); + } + else { + $module_package_dist_plugin = $self->_load_dist_plugin($plugin_spec); + $module_package_dist_plugin->mi($module_install_plugin) if ref $module_package_dist_plugin; + } + # NOTE - This is the point in time where the body of Makefile.PL runs... + return; + + sub INIT { + return unless $module_install_plugin; + return if $Module::Package::ERROR; + eval { + if ($module_install_plugin->is_admin) { + $module_package_plugin->initial(); + $module_package_plugin->main(); + } + else { + $module_install_plugin->_initial(); + $module_package_dist_plugin->_initial() if ref $module_package_dist_plugin; + $module_install_plugin->_main(); + $module_package_dist_plugin->_main() if ref $module_package_dist_plugin; + } + }; + if ($@) { + $Module::Package::ERROR = $@; + die $@; + } + @argv = @ARGV; # XXX ARGVHACK + } + + # If this Module::Install plugin was used (by Module::Package) then wrap + # up any loose ends. This will get called after Makefile.PL has completed. + sub END { + @ARGV = @argv; # XXX ARGVHACK + return unless $module_install_plugin; + return if $Module::Package::ERROR; + $module_package_plugin + ? do { + $module_package_plugin->final; + $module_package_plugin->replicate_module_package; + } + : do { + $module_install_plugin->_final; + $module_package_dist_plugin->_final() if ref $module_package_dist_plugin; + } + } +} + +# Module::Package, Module::Install::Package and Module::Package::Plugin +# must all have the same version. Seems wise. +sub module_package_internals_version_check { + my ($self, $version) = @_; + return if $version < 0.1800001; # XXX BOOTBUGHACK!! + die <<"..." unless $version == $VERSION; + +Error! Something has gone awry: + Module::Package version=$version is using + Module::Install::Package version=$VERSION +If you are the author of this module, try upgrading Module::Package. +Otherwise, please notify the author of this error. + +... +} + +# Find and load the author side plugin: +sub _load_plugin { + my ($self, $spec, $namespace) = @_; + $spec ||= ''; + $namespace ||= 'Module::Package'; + my $version = ''; + $Module::Package::plugin_version = 0; + if ($spec =~ s/\s+(\S+)\s*//) { + $version = $1; + $Module::Package::plugin_version = $version; + } + my ($module, $plugin) = + not($spec) ? ('Plugin', "Plugin::basic") : + ($spec =~ /^\w(\w|::)*$/) ? ($spec, $spec) : + ($spec =~ /^:(\w+)$/) ? ('Plugin', "Plugin::$1") : + ($spec =~ /^(\S*\w):(\w+)$/) ? ($1, "$1::$2") : + die "$spec is invalid"; + $module = "${namespace}::${module}"; + $plugin = "${namespace}::${plugin}"; + eval "use $module $version (); 1" or die $@; + return $plugin->new(); +} + +# Find and load the user side plugin: +sub _load_dist_plugin { + my ($self, $spec, $namespace) = @_; + $spec ||= ''; + $namespace ||= 'Module::Package::Dist'; + my $r = eval { $self->_load_plugin($spec, $namespace); }; + return $r if ref $r; + return; +} + +#-----------------------------------------------------------------------------# +# These are the user side analogs to the author side plugin API calls. +# Prefix with '_' to not pollute Module::Install plugin space. +#-----------------------------------------------------------------------------# +sub _initial { + my ($self) = @_; +} + +sub _main { + my ($self) = @_; +} + +# NOTE These must match Module::Package::Plugin::final. +sub _final { + my ($self) = @_; + $self->_all_from; + $self->_requires_from; + $self->_install_bin; + $self->_install_share; + $self->_WriteAll; +} + +#-----------------------------------------------------------------------------# +# This section is where all the useful code bits go. These bits are needed by +# both Author and User side runs. +#-----------------------------------------------------------------------------# + +my $all_from = 0; +sub _all_from { + my $self = shift; + return if $all_from++; + return if $self->name; + my $file = shift || "$main::PM" or die "all_from has no file"; + $self->all_from($file); +} + +my $requires_from = 0; +sub _requires_from { + my $self = shift; + return if $requires_from++; + return unless $self->package_options->{requires_from}; + my $file = shift || "$main::PM" or die "requires_from has no file"; + $self->requires_from($main::PM) +} + +my $install_bin = 0; +sub _install_bin { + my $self = shift; + return if $install_bin++; + return unless $self->package_options->{install_bin}; + return unless -d 'bin'; + my @bin; + File::Find::find(sub { + return unless -f $_; + push @bin, $File::Find::name; + }, 'bin'); + $self->install_script($_) for @bin; +} + +my $install_share = 0; +sub _install_share { + my $self = shift; + return if $install_share++; + return unless $self->package_options->{install_share}; + return unless -d 'share'; + $self->install_share; +} + +my $WriteAll = 0; +sub _WriteAll { + my $self = shift; + return if $WriteAll++; + $self->WriteAll(@_); +} + +# Base package for Module::Package plugin distributed components. +package Module::Package::Dist; + +sub new { + my ($class, %args) = @_; + bless \%args, $class; +} + +sub mi { + @_ > 1 ? ($_[0]->{mi}=$_[1]) : $_[0]->{mi}; +} + +sub _initial { + my ($self) = @_; +} + +sub _main { + my ($self) = @_; +} + +sub _final { + my ($self) = @_; +} + +1; + +#-----------------------------------------------------------------------------# +# Take a guess at the primary .pm and .pod files for 'all_from', and friends. +# Put them in global magical vars in the main:: namespace. +#-----------------------------------------------------------------------------# +package Module::Package::PM; +use overload '""' => sub { + $_[0]->guess_pm unless @{$_[0]}; + return $_[0]->[0]; +}; +sub set { $_[0]->[0] = $_[1] } +sub guess_pm { + my $pm = ''; + my $self = shift; + if (-e 'META.yml') { + open META, 'META.yml' or die "Can't open 'META.yml' for input:\n$!"; + my $meta = do { local $/; }; + close META; + $meta =~ /^module_name: (\S+)$/m + or die "Can't get module_name from META.yml"; + $pm = $1; + $pm =~ s!::!/!g; + $pm = "lib/$pm.pm"; + } + else { + require File::Find; + my @array = (); + File::Find::find(sub { + return unless /\.pm$/; + my $name = $File::Find::name; + my $num = ($name =~ s!/+!/!g); + my $ary = $array[$num] ||= []; + push @$ary, $name; + }, 'lib'); + shift @array while @array and not defined $array[0]; + die "Can't guess main module" unless @array; + (($pm) = sort @{$array[0]}) or + die "Can't guess main module"; + } + my $pmc = $pm . 'c'; + $pm = $pmc if -e $pmc; + $self->set($pm); +} +$main::PM = bless [$main::PM ? ($main::PM) : ()], __PACKAGE__; + +package Module::Package::POD; +use overload '""' => sub { + return $_[0]->[0] if @{$_[0]}; + (my $pod = "$main::PM") =~ s/\.pm/.pod/ + or die "Module::Package's \$main::PM value should end in '.pm'"; + return -e $pod ? $pod : ''; +}; +sub set { $_[0][0] = $_[1] } +$main::POD = bless [$main::POD ? ($main::POD) : ()], __PACKAGE__; + +1; + diff --git a/inc/Module/Install/Win32.pm b/inc/Module/Install/Win32.pm new file mode 100644 index 0000000..3139a63 --- /dev/null +++ b/inc/Module/Install/Win32.pm @@ -0,0 +1,64 @@ +#line 1 +package Module::Install::Win32; + +use strict; +use Module::Install::Base (); + +use vars qw{$VERSION @ISA $ISCORE}; +BEGIN { + $VERSION = '1.01'; + @ISA = 'Module::Install::Base'; + $ISCORE = 1; +} + +# determine if the user needs nmake, and download it if needed +sub check_nmake { + my $self = shift; + $self->load('can_run'); + $self->load('get_file'); + + require Config; + return unless ( + $^O eq 'MSWin32' and + $Config::Config{make} and + $Config::Config{make} =~ /^nmake\b/i and + ! $self->can_run('nmake') + ); + + print "The required 'nmake' executable not found, fetching it...\n"; + + require File::Basename; + my $rv = $self->get_file( + url => 'http://download.microsoft.com/download/vc15/Patch/1.52/W95/EN-US/Nmake15.exe', + ftp_url => 'ftp://ftp.microsoft.com/Softlib/MSLFILES/Nmake15.exe', + local_dir => File::Basename::dirname($^X), + size => 51928, + run => 'Nmake15.exe /o > nul', + check_for => 'Nmake.exe', + remove => 1, + ); + + die <<'END_MESSAGE' unless $rv; + +------------------------------------------------------------------------------- + +Since you are using Microsoft Windows, you will need the 'nmake' utility +before installation. It's available at: + + http://download.microsoft.com/download/vc15/Patch/1.52/W95/EN-US/Nmake15.exe + or + ftp://ftp.microsoft.com/Softlib/MSLFILES/Nmake15.exe + +Please download the file manually, save it to a directory in %PATH% (e.g. +C:\WINDOWS\COMMAND\), then launch the MS-DOS command line shell, "cd" to +that directory, and run "Nmake15.exe" from there; that will create the +'nmake.exe' file needed by this module. + +You may then resume the installation process described in README. + +------------------------------------------------------------------------------- +END_MESSAGE + +} + +1; diff --git a/inc/Module/Install/WriteAll.pm b/inc/Module/Install/WriteAll.pm new file mode 100644 index 0000000..1f724a7 --- /dev/null +++ b/inc/Module/Install/WriteAll.pm @@ -0,0 +1,63 @@ +#line 1 +package Module::Install::WriteAll; + +use strict; +use Module::Install::Base (); + +use vars qw{$VERSION @ISA $ISCORE}; +BEGIN { + $VERSION = '1.01'; + @ISA = qw{Module::Install::Base}; + $ISCORE = 1; +} + +sub WriteAll { + my $self = shift; + my %args = ( + meta => 1, + sign => 0, + inline => 0, + check_nmake => 1, + @_, + ); + + $self->sign(1) if $args{sign}; + $self->admin->WriteAll(%args) if $self->is_admin; + + $self->check_nmake if $args{check_nmake}; + unless ( $self->makemaker_args->{PL_FILES} ) { + # XXX: This still may be a bit over-defensive... + unless ($self->makemaker(6.25)) { + $self->makemaker_args( PL_FILES => {} ) if -f 'Build.PL'; + } + } + + # Until ExtUtils::MakeMaker support MYMETA.yml, make sure + # we clean it up properly ourself. + $self->realclean_files('MYMETA.yml'); + + if ( $args{inline} ) { + $self->Inline->write; + } else { + $self->Makefile->write; + } + + # The Makefile write process adds a couple of dependencies, + # so write the META.yml files after the Makefile. + if ( $args{meta} ) { + $self->Meta->write; + } + + # Experimental support for MYMETA + if ( $ENV{X_MYMETA} ) { + if ( $ENV{X_MYMETA} eq 'JSON' ) { + $self->Meta->write_mymeta_json; + } else { + $self->Meta->write_mymeta_yaml; + } + } + + return 1; +} + +1; diff --git a/inc/Module/Package.pm b/inc/Module/Package.pm new file mode 100644 index 0000000..7ea98a9 --- /dev/null +++ b/inc/Module/Package.pm @@ -0,0 +1,71 @@ +#line 1 +## +# name: Module::Package +# abstract: Postmodern Perl Module Packaging +# author: Ingy döt Net +# license: perl +# copyright: 2011 +# see: +# - Module::Package::Plugin +# - Module::Install::Package +# - Module::Package::Tutorial + +package Module::Package; +use 5.005; +use strict; + +BEGIN { + $Module::Package::VERSION = '0.30'; + $inc::Module::Package::VERSION ||= $Module::Package::VERSION; + @inc::Module::Package::ISA = __PACKAGE__; +} + +sub import { + my $class = shift; + $INC{'inc/Module/Install.pm'} = __FILE__; + unshift @INC, 'inc' unless $INC[0] eq 'inc'; + eval "use Module::Install 1.01 (); 1" or $class->error($@); + + package main; + Module::Install->import(); + eval { + module_package_internals_version_check($Module::Package::VERSION); + module_package_internals_init(@_); + }; + if ($@) { + $Module::Package::ERROR = $@; + die $@; + } +} + +# XXX Remove this when things are stable. +sub error { + my ($class, $error) = @_; + if (-e 'inc' and not -e 'inc/.author') { + require Data::Dumper; + $Data::Dumper::Sortkeys = 1; + my $dump1 = Data::Dumper::Dumper(\%INC); + my $dump2 = Data::Dumper::Dumper(\@INC); + die <<"..."; +This should not have happened. Hopefully this dump will explain the problem: + +inc::Module::Package: $inc::Module::Package::VERSION +Module::Package: $Module::Package::VERSION +inc::Module::Install: $inc::Module::Install::VERSION +Module::Install: $Module::Install::VERSION + +Error: $error + +%INC: +$dump1 +\@INC: +$dump2 +... + } + else { + die $error; + } +} + +1; + diff --git a/lib/Module/Install/Package.pm b/lib/Module/Install/Package.pm new file mode 100644 index 0000000..628c789 --- /dev/null +++ b/lib/Module/Install/Package.pm @@ -0,0 +1,329 @@ +## +# name: Module::Install::Package +# abstract: Module::Install support for Module::Package +# author: Ingy döt Net +# license: perl +# copyright: 2011 +# see: +# - Module::Package + +# This module contains the Module::Package logic that must be available to +# both the Author and the End User. Author-only logic goes in a +# Module::Package::Plugin subclass. +package Module::Install::Package; +use strict; +use Module::Install::Base; +use vars qw'@ISA $VERSION'; +@ISA = 'Module::Install::Base'; +$VERSION = '0.30'; + +#-----------------------------------------------------------------------------# +# XXX BOOTBUGHACK +# This is here to try to get us out of Module-Package-0.11 cpantesters hell... +# Remove this when the situation has blown over. +sub pkg { + *inc::Module::Package::VERSION = sub { $VERSION }; + my $self = shift; + $self->module_package_internals_init($@); +} + +#-----------------------------------------------------------------------------# +# We allow the author to specify key/value options after the plugin. These +# options need to be available both at author time and install time. +#-----------------------------------------------------------------------------# +# OO accessor for command line options: +sub package_options { + @_>1?($_[0]->{package_options}=$_[1]):$_[0]->{package_options}} + +my $default_options = { + deps_list => 1, + install_bin => 1, + install_share => 1, + manifest_skip => 1, + requires_from => 1, +}; + +#-----------------------------------------------------------------------------# +# Module::Install plugin directives. Use long, ugly names to not pollute the +# Module::Install plugin namespace. These are only intended to be called from +# Module::Package. +#-----------------------------------------------------------------------------# + +# Module::Package starts off life as a normal call to this Module::Install +# plugin directive: +my $module_install_plugin; +my $module_package_plugin; +my $module_package_dist_plugin; +# XXX ARGVHACK This @argv thing is a temporary fix for an ugly bug somewhere in the +# Wikitext module usage. +my @argv; +sub module_package_internals_init { + my $self = $module_install_plugin = shift; + my ($plugin_spec, %options) = @_; + $self->package_options({%$default_options, %options}); + + if ($module_install_plugin->is_admin) { + $module_package_plugin = $self->_load_plugin($plugin_spec); + $module_package_plugin->mi($module_install_plugin); + $module_package_plugin->version_check($VERSION); + } + else { + $module_package_dist_plugin = $self->_load_dist_plugin($plugin_spec); + $module_package_dist_plugin->mi($module_install_plugin) if ref $module_package_dist_plugin; + } + # NOTE - This is the point in time where the body of Makefile.PL runs... + return; + + sub INIT { + return unless $module_install_plugin; + return if $Module::Package::ERROR; + eval { + if ($module_install_plugin->is_admin) { + $module_package_plugin->initial(); + $module_package_plugin->main(); + } + else { + $module_install_plugin->_initial(); + $module_package_dist_plugin->_initial() if ref $module_package_dist_plugin; + $module_install_plugin->_main(); + $module_package_dist_plugin->_main() if ref $module_package_dist_plugin; + } + }; + if ($@) { + $Module::Package::ERROR = $@; + die $@; + } + @argv = @ARGV; # XXX ARGVHACK + } + + # If this Module::Install plugin was used (by Module::Package) then wrap + # up any loose ends. This will get called after Makefile.PL has completed. + sub END { + @ARGV = @argv; # XXX ARGVHACK + return unless $module_install_plugin; + return if $Module::Package::ERROR; + $module_package_plugin + ? do { + $module_package_plugin->final; + $module_package_plugin->replicate_module_package; + } + : do { + $module_install_plugin->_final; + $module_package_dist_plugin->_final() if ref $module_package_dist_plugin; + } + } +} + +# Module::Package, Module::Install::Package and Module::Package::Plugin +# must all have the same version. Seems wise. +sub module_package_internals_version_check { + my ($self, $version) = @_; + return if $version < 0.1800001; # XXX BOOTBUGHACK!! + die <<"..." unless $version == $VERSION; + +Error! Something has gone awry: + Module::Package version=$version is using + Module::Install::Package version=$VERSION +If you are the author of this module, try upgrading Module::Package. +Otherwise, please notify the author of this error. + +... +} + +# Find and load the author side plugin: +sub _load_plugin { + my ($self, $spec, $namespace) = @_; + $spec ||= ''; + $namespace ||= 'Module::Package'; + my $version = ''; + $Module::Package::plugin_version = 0; + if ($spec =~ s/\s+(\S+)\s*//) { + $version = $1; + $Module::Package::plugin_version = $version; + } + my ($module, $plugin) = + not($spec) ? ('Plugin', "Plugin::basic") : + ($spec =~ /^\w(\w|::)*$/) ? ($spec, $spec) : + ($spec =~ /^:(\w+)$/) ? ('Plugin', "Plugin::$1") : + ($spec =~ /^(\S*\w):(\w+)$/) ? ($1, "$1::$2") : + die "$spec is invalid"; + $module = "${namespace}::${module}"; + $plugin = "${namespace}::${plugin}"; + eval "use $module $version (); 1" or die $@; + return $plugin->new(); +} + +# Find and load the user side plugin: +sub _load_dist_plugin { + my ($self, $spec, $namespace) = @_; + $spec ||= ''; + $namespace ||= 'Module::Package::Dist'; + my $r = eval { $self->_load_plugin($spec, $namespace); }; + return $r if ref $r; + return; +} + +#-----------------------------------------------------------------------------# +# These are the user side analogs to the author side plugin API calls. +# Prefix with '_' to not pollute Module::Install plugin space. +#-----------------------------------------------------------------------------# +sub _initial { + my ($self) = @_; +} + +sub _main { + my ($self) = @_; +} + +# NOTE These must match Module::Package::Plugin::final. +sub _final { + my ($self) = @_; + $self->_all_from; + $self->_requires_from; + $self->_install_bin; + $self->_install_share; + $self->_WriteAll; +} + +#-----------------------------------------------------------------------------# +# This section is where all the useful code bits go. These bits are needed by +# both Author and User side runs. +#-----------------------------------------------------------------------------# + +my $all_from = 0; +sub _all_from { + my $self = shift; + return if $all_from++; + return if $self->name; + my $file = shift || "$main::PM" or die "all_from has no file"; + $self->all_from($file); +} + +my $requires_from = 0; +sub _requires_from { + my $self = shift; + return if $requires_from++; + return unless $self->package_options->{requires_from}; + my $file = shift || "$main::PM" or die "requires_from has no file"; + $self->requires_from($main::PM) +} + +my $install_bin = 0; +sub _install_bin { + my $self = shift; + return if $install_bin++; + return unless $self->package_options->{install_bin}; + return unless -d 'bin'; + my @bin; + File::Find::find(sub { + return unless -f $_; + push @bin, $File::Find::name; + }, 'bin'); + $self->install_script($_) for @bin; +} + +my $install_share = 0; +sub _install_share { + my $self = shift; + return if $install_share++; + return unless $self->package_options->{install_share}; + return unless -d 'share'; + $self->install_share; +} + +my $WriteAll = 0; +sub _WriteAll { + my $self = shift; + return if $WriteAll++; + $self->WriteAll(@_); +} + +# Base package for Module::Package plugin distributed components. +package Module::Package::Dist; + +sub new { + my ($class, %args) = @_; + bless \%args, $class; +} + +sub mi { + @_ > 1 ? ($_[0]->{mi}=$_[1]) : $_[0]->{mi}; +} + +sub _initial { + my ($self) = @_; +} + +sub _main { + my ($self) = @_; +} + +sub _final { + my ($self) = @_; +} + +1; + +#-----------------------------------------------------------------------------# +# Take a guess at the primary .pm and .pod files for 'all_from', and friends. +# Put them in global magical vars in the main:: namespace. +#-----------------------------------------------------------------------------# +package Module::Package::PM; +use overload '""' => sub { + $_[0]->guess_pm unless @{$_[0]}; + return $_[0]->[0]; +}; +sub set { $_[0]->[0] = $_[1] } +sub guess_pm { + my $pm = ''; + my $self = shift; + if (-e 'META.yml') { + open META, 'META.yml' or die "Can't open 'META.yml' for input:\n$!"; + my $meta = do { local $/; }; + close META; + $meta =~ /^module_name: (\S+)$/m + or die "Can't get module_name from META.yml"; + $pm = $1; + $pm =~ s!::!/!g; + $pm = "lib/$pm.pm"; + } + else { + require File::Find; + my @array = (); + File::Find::find(sub { + return unless /\.pm$/; + my $name = $File::Find::name; + my $num = ($name =~ s!/+!/!g); + my $ary = $array[$num] ||= []; + push @$ary, $name; + }, 'lib'); + shift @array while @array and not defined $array[0]; + die "Can't guess main module" unless @array; + (($pm) = sort @{$array[0]}) or + die "Can't guess main module"; + } + my $pmc = $pm . 'c'; + $pm = $pmc if -e $pmc; + $self->set($pm); +} +$main::PM = bless [$main::PM ? ($main::PM) : ()], __PACKAGE__; + +package Module::Package::POD; +use overload '""' => sub { + return $_[0]->[0] if @{$_[0]}; + (my $pod = "$main::PM") =~ s/\.pm/.pod/ + or die "Module::Package's \$main::PM value should end in '.pm'"; + return -e $pod ? $pod : ''; +}; +sub set { $_[0][0] = $_[1] } +$main::POD = bless [$main::POD ? ($main::POD) : ()], __PACKAGE__; + +1; + +=head1 SYNOPSIS + + use inc::Module::Package ; + +=head1 DESCRIPTION + +This Module::Install plugin provides user-side support for L. diff --git a/lib/Module/Install/Package.pod b/lib/Module/Install/Package.pod new file mode 100644 index 0000000..e12fea0 --- /dev/null +++ b/lib/Module/Install/Package.pod @@ -0,0 +1,38 @@ +=encoding utf8 + +=head1 NAME + +Module::Install::Package - Module::Install support for Module::Package + +=head1 SYNOPSIS + + use inc::Module::Package ; + +=head1 DESCRIPTION + +This Module::Install plugin provides user-side support for L. + +=head1 SEE ALSO + +=over + +=item * + +L + +=back + +=head1 AUTHOR + +Ingy döt Net + +=head1 COPYRIGHT AND LICENSE + +Copyright (c) 2011. Ingy döt Net. + +This program is free software; you can redistribute it and/or modify it +under the same terms as Perl itself. + +See http://www.perl.com/perl/misc/Artistic.html + +=cut diff --git a/lib/Module/Package.pm b/lib/Module/Package.pm new file mode 100644 index 0000000..1436570 --- /dev/null +++ b/lib/Module/Package.pm @@ -0,0 +1,224 @@ +## +# name: Module::Package +# abstract: Postmodern Perl Module Packaging +# author: Ingy döt Net +# license: perl +# copyright: 2011 +# see: +# - Module::Package::Plugin +# - Module::Install::Package +# - Module::Package::Tutorial + +package Module::Package; +use 5.005; +use strict; + +BEGIN { + $Module::Package::VERSION = '0.30'; + $inc::Module::Package::VERSION ||= $Module::Package::VERSION; + @inc::Module::Package::ISA = __PACKAGE__; +} + +sub import { + my $class = shift; + $INC{'inc/Module/Install.pm'} = __FILE__; + unshift @INC, 'inc' unless $INC[0] eq 'inc'; + eval "use Module::Install 1.01 (); 1" or $class->error($@); + + package main; + Module::Install->import(); + eval { + module_package_internals_version_check($Module::Package::VERSION); + module_package_internals_init(@_); + }; + if ($@) { + $Module::Package::ERROR = $@; + die $@; + } +} + +# XXX Remove this when things are stable. +sub error { + my ($class, $error) = @_; + if (-e 'inc' and not -e 'inc/.author') { + require Data::Dumper; + $Data::Dumper::Sortkeys = 1; + my $dump1 = Data::Dumper::Dumper(\%INC); + my $dump2 = Data::Dumper::Dumper(\@INC); + die <<"..."; +This should not have happened. Hopefully this dump will explain the problem: + +inc::Module::Package: $inc::Module::Package::VERSION +Module::Package: $Module::Package::VERSION +inc::Module::Install: $inc::Module::Install::VERSION +Module::Install: $Module::Install::VERSION + +Error: $error + +%INC: +$dump1 +\@INC: +$dump2 +... + } + else { + die $error; + } +} + +1; + +=head1 SYNOPSIS + +In your C: + + use inc::Module::Package; + +or one of these invocations: + + # These two are functionally the same as above: + use inc::Module::Package ':basic'; + use inc::Module::Package 'Plugin:basic'; + + # With Module::Package::Catalyst plugin options + use inc::Module::Package 'Catalyst'; + + # With Module::Package::Catalyst::common inline plugin class + use inc::Module::Package 'Catalyst:common'; + + # Pass options to the Module::Package::Ingy::modern constructor + use inc::Module::Package 'Ingy:modern', + option1 => 'value1', + option2 => 'value2'; + +=head1 DESCRIPTION + +This module is a dropin replacement for L. It does everything +Module::Install does, but just a bit better. + +Actually this module is simply a wrapper around Module::Install. It attempts +to drastically reduce what goes in a Makefile.PL, while at the same time, +fixing many of the problems that people have had with Module::Install (and +other module frameworks) over the years. + +=head1 PROPAGANDA + +Module::Install took Makefile.PL authoring from a black art to a small set of +powerful and reusable instructions. It allowed packaging gurus to take their +fancy tricks and make them into one liners for the rest of us. + +As the number of plugins has grown over the years, using Module::Install has +itself become a bit of a black art. It's become hard to know all the latest +tricks, put them in the correct order, and make sure you always use the +correct sets for your various Perl modules. + +Added to this is the fact that there are a few problems in Module::Install +design and general usage that are hard to fix and deploy with certainty that +it will work in all cases. + +This is where Module::Package steps in. Module::Package is the next logical +step in Makefile.PL authoring. It allows gurus to create well tested sets of +Module::Install directives, and lets the rest of us use Makefile.PLs that are +one line long. For example: + + use inc::Module::Package 'Catalyst:widget'; + +could be the one line Makefile.PL for a Catalyst widget (whatever that is) +module distribution. Assuming someone creates a module called +Module::Package::Catalyst, with an inline class called +Module::Package::Catalyst::widget that inherited from +L. + +Module::Package is pragmatic. Even though you can do everything in one line, +you are still able to make any Module::Install calls as usual. Also you can +pass parameters to the Module::Package plugin. + + use inc::Module::Package 'Catalyst:widget', + deps_list => 0, + some_cataylst_thing => '...'; + + # All Module::Install plugins still work! + requires 'Some::Module' => 3.14; + +This allows Module::Package::Catalyst to be configurable, even on the +properties like C that are inherited from +L. + +The point here is that with Module::Package, module packaging just got a whole +lot more powerful and simple. A rare combination! + +=head1 FEATURES + +Module::Package has many advantages over vanilla Module::Install. + +=head2 Smaller Makefile.PL Files + +In the majority of cases you can reduce your Makefile.PL to a single command. +The core Module::Package invokes the Module::Install plugins that it thinks +you want. You can also name the Module::Package plugin that does exactly the +plugins you want. + +=head2 Reduces Module::Install Bloat + +Somewhere Module::Install development went awry, and allowed modules that only +have useful code for an author, to be bundled into a distribution. Over time, +this has created a lot of wasted space on CPAN mirrors. Module::Package fixes +this. + +=head2 Collaborator Plugin Discovery + +An increasing problem with Module::Install is that when people check out your +module source from a repository, they don't know which Module::Install plugin +modules you have used. That's because the Makefile.PL only requires the +function names, not the module names that they come from. + +Many people have realized this problem, and worked around it in various +suboptimal ways. Module::Package manages this problem for you. + +=head2 Feature Grouping and Reuse + +Module::Install has lots of plugins. Although it is possible with plain +Module::Install, nobody seems to make plugins that group other plugins. This +also might introduce subtle problems of using groups with other groups. + +Module::Package has object oriented plugins whose main purpose is to create +these groups. They inherit base functionality, subclass it to their design +goals and can define options for the user to tweak how they will operate. + +=head1 USAGE + +The basic anatomy of a Makefile.PL call to Module::Package is: + + use inc::Module::Package 'PluginName:flavor ', + $option1 => $value1; + +The C part uses the Module::Install C bootstrapping +trick. + +C (note the single ':') resolves to the inline class +C, within the module +C. Module::Package::PluginName::flavor must be a +subclass of L. + +An optional version can be used after the plugin name. + +Optional key/value pairs can follow the Plugin specification. They are used to +pass information to the plugin. See Plugin docs for more details. + +If C<:flavor> is omitted, the class Module::Package::PluginName is +used. The idea is that you can create a single module with many different +plugin styles. + +If C is omitted, then C<:flavor> is used against +L. These are a set of common plugin classes that you +can use. + +If C is omitted altogether, it is the same as saying +'Plugin:basic'. Note that you need to specify the ':basic' plugin if you want +to also pass it options. + +=head1 STATUS + +This is still an early release. We are still shaking out the bugs. You might +want to hold off for a bit longer before using Module::Package for important +modules. diff --git a/lib/Module/Package.pod b/lib/Module/Package.pod new file mode 100644 index 0000000..c63451e --- /dev/null +++ b/lib/Module/Package.pod @@ -0,0 +1,193 @@ +=encoding utf8 + +=head1 NAME + +Module::Package - Postmodern Perl Module Packaging + +=head1 SYNOPSIS + +In your C: + + use inc::Module::Package; + +or one of these invocations: + + # These two are functionally the same as above: + use inc::Module::Package ':basic'; + use inc::Module::Package 'Plugin:basic'; + + # With Module::Package::Catalyst plugin options + use inc::Module::Package 'Catalyst'; + + # With Module::Package::Catalyst::common inline plugin class + use inc::Module::Package 'Catalyst:common'; + + # Pass options to the Module::Package::Ingy::modern constructor + use inc::Module::Package 'Ingy:modern', + option1 => 'value1', + option2 => 'value2'; + +=head1 DESCRIPTION + +This module is a dropin replacement for L. It does everything +Module::Install does, but just a bit better. + +Actually this module is simply a wrapper around Module::Install. It attempts +to drastically reduce what goes in a Makefile.PL, while at the same time, +fixing many of the problems that people have had with Module::Install (and +other module frameworks) over the years. + +=head1 PROPAGANDA + +Module::Install took Makefile.PL authoring from a black art to a small set of +powerful and reusable instructions. It allowed packaging gurus to take their +fancy tricks and make them into one liners for the rest of us. + +As the number of plugins has grown over the years, using Module::Install has +itself become a bit of a black art. It's become hard to know all the latest +tricks, put them in the correct order, and make sure you always use the +correct sets for your various Perl modules. + +Added to this is the fact that there are a few problems in Module::Install +design and general usage that are hard to fix and deploy with certainty that +it will work in all cases. + +This is where Module::Package steps in. Module::Package is the next logical +step in Makefile.PL authoring. It allows gurus to create well tested sets of +Module::Install directives, and lets the rest of us use Makefile.PLs that are +one line long. For example: + + use inc::Module::Package 'Catalyst:widget'; + +could be the one line Makefile.PL for a Catalyst widget (whatever that is) +module distribution. Assuming someone creates a module called +Module::Package::Catalyst, with an inline class called +Module::Package::Catalyst::widget that inherited from +L. + +Module::Package is pragmatic. Even though you can do everything in one line, +you are still able to make any Module::Install calls as usual. Also you can +pass parameters to the Module::Package plugin. + + use inc::Module::Package 'Catalyst:widget', + deps_list => 0, + some_cataylst_thing => '...'; + + # All Module::Install plugins still work! + requires 'Some::Module' => 3.14; + +This allows Module::Package::Catalyst to be configurable, even on the +properties like C that are inherited from +L. + +The point here is that with Module::Package, module packaging just got a whole +lot more powerful and simple. A rare combination! + +=head1 FEATURES + +Module::Package has many advantages over vanilla Module::Install. + +=head2 Smaller Makefile.PL Files + +In the majority of cases you can reduce your Makefile.PL to a single command. +The core Module::Package invokes the Module::Install plugins that it thinks +you want. You can also name the Module::Package plugin that does exactly the +plugins you want. + +=head2 Reduces Module::Install Bloat + +Somewhere Module::Install development went awry, and allowed modules that only +have useful code for an author, to be bundled into a distribution. Over time, +this has created a lot of wasted space on CPAN mirrors. Module::Package fixes +this. + +=head2 Collaborator Plugin Discovery + +An increasing problem with Module::Install is that when people check out your +module source from a repository, they don't know which Module::Install plugin +modules you have used. That's because the Makefile.PL only requires the +function names, not the module names that they come from. + +Many people have realized this problem, and worked around it in various +suboptimal ways. Module::Package manages this problem for you. + +=head2 Feature Grouping and Reuse + +Module::Install has lots of plugins. Although it is possible with plain +Module::Install, nobody seems to make plugins that group other plugins. This +also might introduce subtle problems of using groups with other groups. + +Module::Package has object oriented plugins whose main purpose is to create +these groups. They inherit base functionality, subclass it to their design +goals and can define options for the user to tweak how they will operate. + +=head1 USAGE + +The basic anatomy of a Makefile.PL call to Module::Package is: + + use inc::Module::Package 'PluginName:flavor ', + $option1 => $value1; + +The C part uses the Module::Install C bootstrapping +trick. + +C (note the single ':') resolves to the inline class +C, within the module +C. Module::Package::PluginName::flavor must be a +subclass of L. + +An optional version can be used after the plugin name. + +Optional key/value pairs can follow the Plugin specification. They are used to +pass information to the plugin. See Plugin docs for more details. + +If C<:flavor> is omitted, the class Module::Package::PluginName is +used. The idea is that you can create a single module with many different +plugin styles. + +If C is omitted, then C<:flavor> is used against +L. These are a set of common plugin classes that you +can use. + +If C is omitted altogether, it is the same as saying +'Plugin:basic'. Note that you need to specify the ':basic' plugin if you want +to also pass it options. + +=head1 STATUS + +This is still an early release. We are still shaking out the bugs. You might +want to hold off for a bit longer before using Module::Package for important +modules. + +=head1 SEE ALSO + +=over + +=item * + +L + +=item * + +L + +=item * + +L + +=back + +=head1 AUTHOR + +Ingy döt Net + +=head1 COPYRIGHT AND LICENSE + +Copyright (c) 2011. Ingy döt Net. + +This program is free software; you can redistribute it and/or modify it +under the same terms as Perl itself. + +See http://www.perl.com/perl/misc/Artistic.html + +=cut diff --git a/lib/Module/Package/Plugin.pm b/lib/Module/Package/Plugin.pm new file mode 100644 index 0000000..f4cff39 --- /dev/null +++ b/lib/Module/Package/Plugin.pm @@ -0,0 +1,514 @@ +## +# name: Module::Package::Plugin +# abstract: Base class for Module::Package author-side plugins +# author: Ingy döt Net +# license: perl +# copyright: 2011 +# see: +# - Module::Package +# - Module::Package::Tutorial + +use 5.008003; +use utf8; + +package Module::Package::Plugin; +use Moo 0.009008; + +our $VERSION = '0.30'; + +use Cwd 0 (); +use File::Find 0 (); +use Module::Install 1.01 (); +use Module::Install::AuthorRequires 0.02 (); +use Module::Install::ManifestSkip 0.19 (); +use IO::All 0.41; + +has mi => (is => 'rw'); +has options => ( + is => 'rw', + lazy => 1, + default => sub { + my ($self) = @_; + $self->mi->package_options; + }, +); + +#-----------------------------------------------------------------------------# +# These 3 functions (initial, main and final) make up the Module::Package +# plugin API. Subclasses MUST override 'main', and should rarely override +# 'initial' and 'final'. +#-----------------------------------------------------------------------------# +sub initial { + my ($self) = @_; + # Load pkg/conf.yaml if it exists + $self->eval_deps_list; +} + +sub main { + my ($self) = @_; + my $class = ref($self); + die "$class cannot be used as a Module::Package plugin. Use a subclass" + if $class eq __PACKAGE__; + die "$class needs to provide a method called 'main()'"; +} + +sub final { + my ($self) = @_; + + $self->manifest_skip; + + # NOTE These must match Module::Install::Package::_final. + $self->all_from; + $self->requires_from; + $self->install_bin; + $self->install_share; + $self->WriteAll; + + $self->write_deps_list; +} + +#-----------------------------------------------------------------------------# +# This is where the useful methods (that author plugins can invoke) live. +#-----------------------------------------------------------------------------# +sub pm_file { return "$main::PM" } +sub pod_file { return "$main::POD" } +sub pod_or_pm_file { return "$main::POD" || "$main::PM" } + +my $deps_list_file = 'pkg/deps_list.pl'; +sub eval_deps_list { + my ($self) = @_; + return if not $self->options->{deps_list}; + my $data = ''; + if (-e 'Makefile.PL') { + my $text = io('Makefile.PL')->all; + if ($text =~ /.*\n__(?:DATA|END)__\r?\n(.*)/s) { + $data = $1; + } + } + if (-e $deps_list_file and -s $deps_list_file) { + package main; + require $deps_list_file; + } + elsif ($data) { + package main; + eval $data; + die $@ if $@; + } +} + +sub write_deps_list { + my ($self) = @_; + return if not $self->options->{deps_list}; + my $text = $self->generate_deps_list; + if (-e $deps_list_file) { + my $old_text = io($deps_list_file)->all; + $text .= "\n1;\n" if $text; + if ($text ne $old_text) { + warn "Updating $deps_list_file\n"; + io($deps_list_file)->print($text); + } + $text = ''; + } + if ( + -e 'Makefile.PL' and + io('Makefile.PL')->all =~ /^__(?:DATA|END)__$/m + ) { + my $perl = io('Makefile.PL')->all; + my $old_perl = $perl; + $perl =~ s/(.*\n__(?:DATA|END)__\r?\n).*/$1/s or die $perl; + if (-e $deps_list_file) { + io('Makefile.PL')->print($perl); + return; + } + $perl .= "\n" . $text if $text; + if ($perl ne $old_perl) { + warn "Updating deps_list in Makefile.PL\n"; + io('Makefile.PL')->print($perl); + if (-e 'Makefile') { + sleep 1; + io('Makefile')->touch; + } + } + } + elsif ($text) { + warn <<"..."; +Note: Can't find a place to write deps list, and deps_list option is true. + touch $deps_list_file or add __END__ to Makefile.PL. + See 'deps_list' in Module::Package::Plugin documentation. +Deps List: +${$_ = $text; chomp; s/^/ /mg; \$_} +... + } +} + +sub generate_deps_list { + my ($self) = @_; + my $base = Cwd::cwd(); + my %skip = map {($_, 1)} + qw(Module::Package Module::Install), + $self->skip_deps(ref($self)), + (map "Module::Install::$_", qw( + Admin AuthorRequires AutoInstall Base Bundle Can Compiler + Deprecated DSL External Fetch Include Inline Makefile MakeMaker + ManifestSkip Metadata Package PAR Run Scripts Share Win32 With + WriteAll + )); + my @skip; + for my $module (keys %skip) { + if ($skip{"Module::Install::$module"}) { + push @skip, "${module}::"; + } + } + my @inc = (); + File::Find::find(sub { + return unless -f $_ and $_ =~ /\.pm$/; + my $module = $File::Find::name; + $module =~ s!inc[\/\\](.*)\.pm$!$1!; + return if -e "$base/lib/$module.pm"; + $module =~ s!/+!::!g; + return if $skip{$module}; + for my $prefix (@skip) { + return if $module =~ /^\Q$prefix\E/; + } + push @inc, $module; + }, 'inc'); + if (grep /^Module::Install::TestBase$/, @inc) { + @inc = grep not(/^(Test::|Spiffy)/), @inc; + } + if (not $Module::Package::plugin_version) { + my $module = ref($self); + $module =~ s/::[a-z].*//; + unshift @inc, $module; + }; + my $text = ''; + no strict 'refs'; + $text .= join '', map { + my $version = ${"${_}::VERSION"} || ''; + if ($version) { + "author_requires '$_' => '$version';\n"; + } + else { + "author_requires '$_';\n"; + } + } @inc; + $text = <<"..." . $text if $text; +# Deps list generated by: +author_requires 'Module::Package' => '$Module::Package::VERSION'; + +... + return $text; +} + +sub skip_deps { + my ($self, $file) = @_; + $file =~ s/^(.*)::[^A-Z].*$/$1/ + or die "Can't grok paackage '$file'"; + $file =~ s!::!/!g; + $file .= '.pm'; + $file = $INC{$file} or return (); + my $content = Module::Install::_readperl($file); + return ($content =~ m/^use\s+([^\W\d]\w*(?:::\w+)*)\s+(?:[\d\.]+)/mg); +} + +# We generate a MANIFEST.SKIP and add things to it. +# We add pkg/, because that should only contain author stuff. +# We add author only M::I plugins, so they don't get distributed. +sub manifest_skip { + my ($self) = @_; + return unless $self->options->{manifest_skip}; + $self->mi->manifest_skip; + + $self->set_author_only_defaults; + my @skips = ( + "^pkg/\n", + "^inc/.*\\.pod\n", + ); + for (sort keys %INC) { + my $path = $_; + s!/!::!g; + s!\.pm$!!; + next unless /^Module::Install::/; + no strict 'refs'; + push @skips, "^inc/$path\$\n" + if ${"${_}::AUTHOR_ONLY"} + } + + io('MANIFEST.SKIP')->append(join '', @skips); + if (-e 'pkg/manifest.skip') { + io('MANIFEST.SKIP')->append(io('pkg/manifest.skip')->all); + } + + $self->mi->clean_files('MANIFEST MANIFEST.SKIP'); +} + +sub check_use_test_base { + my ($self) = @_; + my @files; + File::Find::find(sub { + return unless -f $_ and $_ =~ /\.(pm|t)$/; + push @files, $File::Find::name; + }, 't'); + for my $file (@files) { + if (io($file)->all =~ /\bTest::Base\b/) { + $self->mi->use_test_base; + return; + } + } +} + +sub check_use_testml { + my ($self) = @_; + my $found = 0; + File::Find::find(sub { + return unless -f $_ and $_ =~ /\.t$/; + return unless io($_)->all =~ /\buse TestML\b/; + $found = 1; + }, 't'); + if ($found or -e 't/testml') { + $self->mi->use_testml; + } +} + +sub check_test_common { + my ($self) = @_; + if (-e 't/common.yaml') { + $self->mi->test_common_update; + } +} + +sub check_use_gloom { + my ($self) = @_; + my @files; + File::Find::find(sub { + return unless -f $_ and $_ =~ /\.pm$/; + return if $File::Find::name eq 'lib/Gloom.pm'; + return if $File::Find::name eq 'lib/Module/Install/Gloom.pm'; + return unless io($_)->getline =~ /\bGloom\b/; + push @files, $File::Find::name; + }, 'lib'); + for my $file (@files) { + $file =~ s/^lib\/(.*)\.pm$/$1/ or die; + $file =~ s/\//::/g; + $self->mi->use_gloom($file); + } +} + +sub strip_extra_comments { + # TODO later +} + +#-----------------------------------------------------------------------------# +# These functions are wrappers around Module::Install functions of the same +# names. They are generally safer (and simpler) to call than the real ones. +# They should almost always be chosen by Module::Package::Plugin subclasses. +#-----------------------------------------------------------------------------# +sub post_all_from { + my $self = shift; + push @{$self->{post_all_from} ||= []}, @_; +} +sub all_from { + my $self = shift; + $self->mi->_all_from(@_); + $_->() for @{$self->{post_all_from} || []}; +} +sub post_WriteAll { + my $self = shift; + push @{$self->{post_WriteAll} ||= []}, @_; +} +sub WriteAll { + my $self = shift; + $self->mi->_WriteAll(@_); + $_->() for @{$self->{post_WriteAll} || []}; +} +sub requires_from { my $self = shift; $self->mi->_requires_from(@_) } +sub install_bin { my $self = shift; $self->mi->_install_bin(@_) } +sub install_share { my $self = shift; $self->mi->_install_share(@_) } + +#-----------------------------------------------------------------------------# +# Other housekeeping stuffs +#-----------------------------------------------------------------------------# +# This gets called very last on the author side. +sub replicate_module_package { + my $target_file = 'inc/Module/Package.pm'; + if (-e 'inc/.author' and not -e $target_file) { + my $source_file = $INC{'Module/Package.pm'} + or die "Can't bootstrap inc::Module::Package"; + Module::Install::Admin->copy($source_file, $target_file); + } +} + +# TODO Check all versions possible here. +sub version_check { + my ($self, $version) = @_; + die <<"..." + +Error! Something has gone awry: + inc::Module::Package version=$inc::Module::Package::VERSION + Module::Package version=$::Module::Package::VERSION + Module::Install::Package version=$version + Module::Package::Plugin version=$VERSION +Try upgrading Module::Package. + +... + unless $version == $VERSION and + $version == $Module::Package::VERSION and + $version == $inc::Module::Package::VERSION; +} + +# This is a set of known AUTHOR_ONLY plugins. Until authors set this variable +# themselves, do it here to make sure these get added to the MANIFEST.SKIP and +# thus do not end up in the distributions, causing bloat. +sub set_author_only_defaults { + my @known_author_only = qw( + AckXXX + AuthorRequires + AutoLicense + GitHubMeta + ManifestSkip + ReadmeFromPod + ReadmeMarkdownFromPod + Repository + Stardoc + TestBase + TestML + VersionCheck + ); + for (@known_author_only) { + no strict 'refs'; + ${"Module::Install::${_}::AUTHOR_ONLY"} = 1 + unless defined ${"Module::Install::${_}::AUTHOR_ONLY"}; + } +} + +#-----------------------------------------------------------------------------# +# These are the usable subclasses that this module provides. Currently there +# is only one, ':basic'. It does the minimum amount possible. Even though it +# seems to do nothing, there is plenty of functionality that happens in the +# final() method. +#-----------------------------------------------------------------------------# +package Module::Package::Plugin::basic; +use Moo; +extends 'Module::Package::Plugin'; + +sub main { + my ($self) = @_; +} + +1; + +=head1 SYNOPSIS + + package Module::Package::Name; + + package Module::Package::Name::flavor; + use Moo; + extends 'Module::Package::Plugin'; + + sub main { + my ($self) = @_; + $self->mi->some_module_install_author_plugin; + $self->mi->other_author_plugin; + } + + 1; + +=head1 DESCRIPTION + +This module is the base class for Module::Package plugins. + +=head1 EXAMPLE + +Take a look at the L module, for a decent starting +point example. That plugin module is actually used to package Module::Package +itself. + +=head1 API + +To create a Module::Package plugin you need to subclass +Module::Package::Plugin and override the C
method, and possibly other +things. This section describes how that works. + +Makefile.PL processing happens in the following order: + + - 'use inc::Module::Package...' is invoked + - $plugin->initial is called + - BEGIN blocks in Makefile.PL are run + - $plugin->main is called + - The body of Makefile.PL is run + - $plugin->final is called + +=head2 initial + +This method is call during the processing of 'use inc::Module::Package'. You +probably don't need to subclass it. If you do you probably want to call the +SUPER method. + +It runs the deps_list, if any and guesses the primary modules file path. + +=head2 main + +This is the method you must override. Do all the things you want. You can call +C, if you need to get sequencing right, otherwise it gets called by +final(). Don't call C, it get's called automatically in final(). + +=head2 final + +This does all the things after the entire Makefile.PL body has run. You +probably don't need to override it. + +=head1 OPTIONS + +The following options are available for use from the Makefile.PL: + + use Module::Package 'Foo:bar', + deps_list => 0|1, + install_bin => 0|1, + install_share => 0|1, + manifest_skip => 0|1, + requires_from => 0|1; + +These options can be used by any subclass of this module. + +=head2 deps_list + +Default is 1. + +This option tells Module::Package to generate a C deps list, +when you run the Makefile.PL. This list will go in the file +C if that exists, or after a '__END__' statement in your +Makefile.PL. If neither is available, a reminder will be warned (only when the +author runs it). + +This list is important if you want people to be able to collaborate on your +modules easily. + +=head2 install_bin + +Default is 1. + +All files in a C directory will be installed. It will call the +C plugin for you. Set this option to 0 to disable it. + +=head2 install_share + +Default is 1. + +All files in a C directory will be installed. It will call the +C plugin for you. Set this option to 0 to disable it. + +=head2 manifest_skip + +Default is 1. + +This option will generate a sane MANIFEST.SKIP for you and delete it again +when you run C. You can add your own skips in the file called +C. You almost certainly want this option on. Set to 0 if +you are weird. + +=head2 requires_from + +Default is 1. + +This option will attempt to find all the requirements from the primary module. +If you make any of your own requires or requires_from calls, this option will +do nothing. diff --git a/lib/Module/Package/Plugin.pod b/lib/Module/Package/Plugin.pod new file mode 100644 index 0000000..2ba03af --- /dev/null +++ b/lib/Module/Package/Plugin.pod @@ -0,0 +1,151 @@ +=encoding utf8 + +=head1 NAME + +Module::Package::Plugin - Base class for Module::Package author-side plugins + +=head1 SYNOPSIS + + package Module::Package::Name; + + package Module::Package::Name::flavor; + use Moo; + extends 'Module::Package::Plugin'; + + sub main { + my ($self) = @_; + $self->mi->some_module_install_author_plugin; + $self->mi->other_author_plugin; + } + + 1; + +=head1 DESCRIPTION + +This module is the base class for Module::Package plugins. + +=head1 EXAMPLE + +Take a look at the L module, for a decent starting +point example. That plugin module is actually used to package Module::Package +itself. + +=head1 API + +To create a Module::Package plugin you need to subclass +Module::Package::Plugin and override the C
method, and possibly other +things. This section describes how that works. + +Makefile.PL processing happens in the following order: + + - 'use inc::Module::Package...' is invoked + - $plugin->initial is called + - BEGIN blocks in Makefile.PL are run + - $plugin->main is called + - The body of Makefile.PL is run + - $plugin->final is called + +=head2 initial + +This method is call during the processing of 'use inc::Module::Package'. You +probably don't need to subclass it. If you do you probably want to call the +SUPER method. + +It runs the deps_list, if any and guesses the primary modules file path. + +=head2 main + +This is the method you must override. Do all the things you want. You can call +C, if you need to get sequencing right, otherwise it gets called by +final(). Don't call C, it get's called automatically in final(). + +=head2 final + +This does all the things after the entire Makefile.PL body has run. You +probably don't need to override it. + +=head1 OPTIONS + +The following options are available for use from the Makefile.PL: + + use Module::Package 'Foo:bar', + deps_list => 0|1, + install_bin => 0|1, + install_share => 0|1, + manifest_skip => 0|1, + requires_from => 0|1; + +These options can be used by any subclass of this module. + +=head2 deps_list + +Default is 1. + +This option tells Module::Package to generate a C deps list, +when you run the Makefile.PL. This list will go in the file +C if that exists, or after a '__END__' statement in your +Makefile.PL. If neither is available, a reminder will be warned (only when the +author runs it). + +This list is important if you want people to be able to collaborate on your +modules easily. + +=head2 install_bin + +Default is 1. + +All files in a C directory will be installed. It will call the +C plugin for you. Set this option to 0 to disable it. + +=head2 install_share + +Default is 1. + +All files in a C directory will be installed. It will call the +C plugin for you. Set this option to 0 to disable it. + +=head2 manifest_skip + +Default is 1. + +This option will generate a sane MANIFEST.SKIP for you and delete it again +when you run C. You can add your own skips in the file called +C. You almost certainly want this option on. Set to 0 if +you are weird. + +=head2 requires_from + +Default is 1. + +This option will attempt to find all the requirements from the primary module. +If you make any of your own requires or requires_from calls, this option will +do nothing. + +=head1 SEE ALSO + +=over + +=item * + +L + +=item * + +L + +=back + +=head1 AUTHOR + +Ingy döt Net + +=head1 COPYRIGHT AND LICENSE + +Copyright (c) 2011. Ingy döt Net. + +This program is free software; you can redistribute it and/or modify it +under the same terms as Perl itself. + +See http://www.perl.com/perl/misc/Artistic.html + +=cut diff --git a/lib/Module/Package/Tutorial.pod b/lib/Module/Package/Tutorial.pod new file mode 100644 index 0000000..f215cb4 --- /dev/null +++ b/lib/Module/Package/Tutorial.pod @@ -0,0 +1,57 @@ +=encoding utf8 + +=head1 NAME + +Module::Package::Tutorial - A Hands on Guide + +=head1 INTRODUCTION + +Welcome to Module::Package. This tutorial is for people who want to package +modules for CPAN, who want to make sure they are doing it the best they can, +but who also want to spend more time working on their code than on becoming an +expert packager. This tutorial is also for people who want to take their time +and effort spent on packaging, and share new ideas and tricks with others. + +I'll start by taking a typical Makefile.PL written with Module::Install and +show you how to turn this into various Module::Package configurations, +eventually ending up with a single line Makefile.PL. Then I'll show you the +ins and outs of making your own Module::Install plugin module to handle your +common needs. + +=head1 Makefile.PL 2.0 + +I won't start with 1.0. Those days are long past. Here's what a typical +Makefile.PL looks like these days. + + use strict; + use inc::Module::Install; + + name 'Foo-Bar'; + all_from 'lib/Foo/Bar.pm'; + build_requires 'Test::More'; + + auto_include_deps; + sign; + + WriteAll; + +... This doc is a work in progress. Stay tuned ... + +Here's the the final version: + + use Module::Package 'All:good'; + +=head1 AUTHOR + +Ingy döt Net + +=head1 COPYRIGHT AND LICENSE + +Copyright (c) 2011. Ingy döt Net. + +This program is free software; you can redistribute it and/or modify it +under the same terms as Perl itself. + +See http://www.perl.com/perl/misc/Artistic.html + +=cut diff --git a/lib/inc/Module/Package.pm b/lib/inc/Module/Package.pm new file mode 100644 index 0000000..ab37b3e --- /dev/null +++ b/lib/inc/Module/Package.pm @@ -0,0 +1,69 @@ +## +# name: inc::Module::Package +# abstract: Module::Package Bootstrapper +# author: Ingy döt Net +# license: perl +# copyright: 2011 +# see: +# - Module::Package + +package inc::Module::Package; + +# Use BEGIN so unshift runs before use. +BEGIN { + # This version is here in case of emergencies. + $inc::Module::Package::VERSION = '0.30'; + + # Borrowed from inc::Module::Install... + my $author = $^O eq 'VMS' ? './inc/_author' : './inc/.author'; + + # Do this because inc::Module::Install does it. We don't ever call that. + $Module::Install::AUTHOR = 1 + if -d $author or not(-d 'inc'); + + # Deleting the author's inc/ dir happens in Module::Install anyway, + # but doing it here prevents a subtle Module::Package bug. + if (-d $author) { + require File::Path; + File::Path::rmtree('inc'); + } + + # Make sure we pick up the local modules on user install. + unshift @INC, 'inc' unless $INC[0] eq 'inc'; +} + +# Bare block contains the 'main' scope. +{ + # Pretend we are a Makefile.PL. Module::Install wants this. + package main; + + # Load the real Module::Package. + use Module::Package (); +} + +# Tell Module::Package to begin the magic. +sub import { + my $class = shift; + Module::Package->import(@_); + + # Make sure we got the correct Module::Package. +# TODO: Need code review on this first. Might cause more harm than good. +# die "Module::Package Bootstrapping Error" +# unless $INC{'Module/Package.pm'} =~ /^inc/ +# or -e 'inc/.author'; +} + +# Be true to your perl. +1; + +=head1 SYNOPSIS + +In you C: + + use inc::Module::Package ; + +=head1 DESCRIPTION + +This is the L bootstrapping module. It works something like +L. This bootstrap module should only be loaded in an +author environment. diff --git a/lib/inc/Module/Package.pod b/lib/inc/Module/Package.pod new file mode 100644 index 0000000..5080861 --- /dev/null +++ b/lib/inc/Module/Package.pod @@ -0,0 +1,42 @@ +=encoding utf8 + +=head1 NAME + +inc::Module::Package - Module::Package Bootstrapper + +=head1 SYNOPSIS + +In you C: + + use inc::Module::Package ; + +=head1 DESCRIPTION + +This is the L bootstrapping module. It works something like +L. This bootstrap module should only be loaded in an +author environment. + +=head1 SEE ALSO + +=over + +=item * + +L + +=back + +=head1 AUTHOR + +Ingy döt Net + +=head1 COPYRIGHT AND LICENSE + +Copyright (c) 2011. Ingy döt Net. + +This program is free software; you can redistribute it and/or modify it +under the same terms as Perl itself. + +See http://www.perl.com/perl/misc/Artistic.html + +=cut diff --git a/t/use_ok.t b/t/use_ok.t new file mode 100644 index 0000000..8f21168 --- /dev/null +++ b/t/use_ok.t @@ -0,0 +1,11 @@ +use Test::More tests => 3; + +# use_ok calls import and that sets off fireworks! +require Module::Package; +pass 'Module::Package is ok'; + +use_ok 'Module::Package::Plugin'; + +# INIT block causes warnings here +local $^W; +use_ok 'Module::Install::Package';