X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2Flocal%2Flib.pm;h=6c629c1733ee22ba8d37ab60871d11749d6c2acb;hb=9a021b2b54372f72e6c17f3add625c94b2bb5a98;hp=ef47d5ddb85da4d845f199bae3aa8e3f60210db6;hpb=d211388dcd1403b35a553c986ff1ab483c4dc33a;p=p5sagit%2Flocal-lib.git diff --git a/lib/local/lib.pm b/lib/local/lib.pm index ef47d5d..6c629c1 100644 --- a/lib/local/lib.pm +++ b/lib/local/lib.pm @@ -3,20 +3,46 @@ use warnings; package local::lib; -use 5.8.1; # probably works with earlier versions but I'm not supporting them - # (patches would, of course, be welcome) +use 5.008001; # probably works with earlier versions but I'm not supporting them + # (patches would, of course, be welcome) use File::Spec (); use File::Path (); use Carp (); use Config; -our $VERSION = '1.001000'; # 1.1.0 +our $VERSION = '1.004001'; # 1.4.1 sub import { - my ($class, $path) = @_; + my ($class, @args) = @_; + + # The path is required, but last in the list, so we pop, not shift here. + my $path = pop @args; $path = $class->resolve_path($path); $class->setup_local_lib_for($path); + + # Handle the '--self-contained' option + my $flag = shift @args; + no warnings 'uninitialized'; # the flag is optional + # make sure fancy dashes cause an error + if ($flag =~ /−/) { + die <<'DEATH'; +WHOA THERE! It looks like you've got some fancy dashes in your commandline! +These are *not* the traditional -- dashes that software recognizes. You +probably got these by copy-pasting from the perldoc for this module as +rendered by a UTF8-capable formatter. This most typically happens on an OS X +terminal, but can happen elsewhere too. Please try again after replacing the +dashes with normal minus signs. +DEATH + } + if ($flag eq '--self-contained') { + # The only directories that remain are those that we just defined and those where core modules are stored. + @INC = ($Config::Config{privlibexp}, $Config::Config{archlibexp}, split ':', $ENV{PERL5LIB}); + } + elsif (defined $flag) { + die "unrecognized import argument: $flag"; + } + } sub pipeline; @@ -195,12 +221,12 @@ sub ensure_dir_structure_for { } } -sub INTERPOLATE_PATH () { 1 } -sub LITERAL_PATH () { 0 } +sub INTERPOLATE_ENV () { 1 } +sub LITERAL_ENV () { 0 } sub print_environment_vars_for { my ($class, $path) = @_; - my @envs = $class->build_environment_vars_for($path, LITERAL_PATH); + my @envs = $class->build_environment_vars_for($path, LITERAL_ENV); my $out = ''; # rather basic csh detection, goes on the assumption that something won't @@ -247,7 +273,7 @@ sub build_csh_env_declaration { sub setup_env_hash_for { my ($class, $path) = @_; - my %envs = $class->build_environment_vars_for($path, INTERPOLATE_PATH); + my %envs = $class->build_environment_vars_for($path, INTERPOLATE_ENV); @ENV{keys %envs} = values %envs; } @@ -259,10 +285,15 @@ sub build_environment_vars_for { PERL5LIB => join(':', $class->install_base_perl_path($path), $class->install_base_arch_path($path), + ($ENV{PERL5LIB} ? + ($interpolate == INTERPOLATE_ENV + ? ($ENV{PERL5LIB}) + : ('$PERL5LIB')) + : ()) ), PATH => join(':', $class->install_base_bin_path($path), - ($interpolate == INTERPOLATE_PATH + ($interpolate == INTERPOLATE_ENV ? $ENV{PATH} : '$PATH') ), @@ -301,6 +332,13 @@ In code - From the shell - + # Install LWP and it's missing dependencies to the 'my_lwp' directory + perl -MCPAN -Mlocal::lib=my_lwp -e 'CPAN::install(LWP)' + + # Install LWP and *all non-core* dependencies to the 'my_lwp' directory + perl -MCPAN -Mlocal::lib=--self-contained,my_lwp -e 'CPAN::install(LWP)' + + # Just print out useful shell commands $ perl -Mlocal::lib export MODULEBUILDRC=/home/username/perl/.modulebuildrc export PERL_MM_OPT='INSTALL_BASE=/home/username/perl' @@ -309,20 +347,52 @@ From the shell - To bootstrap if you don't have local::lib itself installed - - $ perl -MCPAN -eshell # you only need to do this if you don't have a ~/.cpan - cpan> exit + $ perl Makefile.PL --bootstrap $ make test && make install + $ echo 'eval $(perl -I$HOME/perl5/lib/perl5 -Mlocal::lib)' >>~/.bashrc + # Or for C shells... + $ /bin/csh % echo $SHELL /bin/csh % perl -I$HOME/perl5/lib/perl5 -Mlocal::lib >> ~/.cshrc -You can also pass --boostrap=~/foo to get a different location (adjust the -bashrc / cshrc line appropriately) +You can also pass --boostrap=~/foo to get a different location - + + $ perl Makefile.PL --bootstrap=~/foo + $ make test && make install + + $ echo 'eval $(perl -I$HOME/foo/lib/perl5 -Mlocal::lib=$HOME/foo)' >>~/.bashrc + +If you want to install multiple Perl module environments, say for application evelopment, +install local::lib globally and then: + + $ cd ~/mydir1 + $ perl -Mlocal::lib=./ + $ eval $(perl -Mlocal::lib=./) ### To set the environment for this shell alone + $ printenv ### You will see that ~/mydir1 is in the PERL5LIB + $ perl -MCPAN -e install ... ### whatever modules you want + $ cd ../mydir2 + ... REPEAT ... + +For multiple environments for multiple apps you may need to include a modified version of +the C<< use FindBin >> instructions in the "In code" sample above. If you did something like +the above, you have a set of Perl modules at C<< ~/mydir1/lib >>. If you have a script at +C<< ~/mydir1/scripts/myscript.pl >>, you need to tell it where to find the modules you installed +for it at C<< ~/mydir1/lib >>. + +In C<< ~/mydir1/scripts/myscript.pl >>: + + use strict; + use warnings; + use local::lib "$FindBin::Bin/.."; ### points to ~/mydir1 and local::lib finds lib + use lib "$FindBin::Bin/../lib"; ### points to ~/mydir1/lib + +Put this before any BEGIN { ... } blocks that require the modules you installed. =head1 DESCRIPTION @@ -358,6 +428,148 @@ PATH is appended to, rather than clobbered. These values are then available for reference by any code after import. +=head1 METHODS + +=head2 ensure_directory_structure_for + +=over 4 + +=item Arguments: path + +=back + +Attempts to create the given path, and all required parent directories. Throws +an exception on failure. + +=head2 print_environment_vars_for + +=over 4 + +=item Arguments: path + +=back + +Prints to standard output the variables listed above, properly set to use the +given path as the base directory. + +=head2 setup_env_hash_for + +=over 4 + +=item Arguments: path + +=back + +Constructs the C<%ENV> keys for the given path, by calling +C. + +=head2 install_base_perl_path + +=over 4 + +=item Arguments: path + +=back + +Returns a path describing where to install the Perl modules for this local +library installation. Appends the directories C and C to the given +path. + +=head2 install_base_arch_path + +=over 4 + +=item Arguments: path + +=back + +Returns a path describing where to install the architecture-specific Perl +modules for this local library installation. Based on the +L method's return value, and appends the value of +C<$Config{archname}>. + +=head2 install_base_bin_path + +=over 4 + +=item Arguments: path + +=back + +Returns a path describing where to install the executable programs for this +local library installation. Based on the L method's +return value, and appends the directory C. + +=head2 modulebuildrc_path + +=over 4 + +=item Arguments: path + +=back + +Returns a path describing where to install the C<.modulebuildrc> file, based on +the given path. + +=head2 resolve_empty_path + +=over 4 + +=item Arguments: path + +=back + +Builds and returns the base path into which to set up the local module +installation. Defaults to C<~/perl5>. + +=head2 resolve_home_path + +=over 4 + +=item Arguments: path + +=back + +Attempts to find the user's home directory. If installed, uses C +for this purpose. If no definite answer is available, throws an exception. + +=head2 resolve_relative_path + +=over 4 + +=item Arguments: path + +=back + +Translates the given path into an absolute path. + +=head2 resolve_path + +=over 4 + +=item Arguments: path + +=back + +Calls the following in a pipeline, passing the result from the previous to the +next, in an attempt to find where to configure the environment for a local +library installation: L, L, +L. Passes the given path argument to +L which then returns a result that is passed to +L, which then has its result passed to +L. The result of this final call is returned from +L. + +=head1 A WARNING ABOUT UNINST=1 + +Be careful about using local::lib in combination with "make install UNINST=1". +The idea of this feature is that will uninstall an old version of a module +before installing a new one. However it lacks a safety check that the old +version and the new version will go in the same directory. Used in combination +with local::lib, you can potentially delete a globally accessible version of a +module while installing the new version in a local place. Only combine "make +install UNINST=1" and local::lib if you understand these possible consequences. + =head1 LIMITATIONS Rather basic shell detection. Right now anything with csh in its name is @@ -374,6 +586,22 @@ Should probably auto-fixup CPAN config if not already done. Patches very much welcome for any of the above. +=head1 TROUBLESHOOTING + +If you've configured local::lib to install CPAN modules somewhere in to your +home directory, and at some point later you try to install a module with C, but it fails with an error like: C and buried within the install log is an +error saying C<'INSTALL_BASE' is not a known MakeMaker parameter name>, then +you've somehow lost your updated ExtUtils::MakeMaker module. + +To remedy this situation, rerun the bootstrapping procedure documented above. + +Then, run C + +Finally, re-run C and it should install without problems. + =head1 ENVIRONMENT =over 4 @@ -391,6 +619,25 @@ Matt S Trout http://www.shadowcat.co.uk/ auto_install fixes kindly sponsored by http://www.takkle.com/ +=head1 CONTRIBUTORS + +Patches to correctly output commands for csh style shells, as well as some +documentation additions, contributed by Christopher Nehren . + +'--self-contained' feature contributed by Mark Stosberg . + +Doc patches for a custom local::lib directory contributed by Torsten Raudssus +. + +Hans Dieter Pearcey sent in some additional tests for ensuring +things will install properly, submitted a fix for the bug causing problems with +writing Makefiles during bootstrapping, contributed an example program, and +submitted yet another fix to ensure that local::lib can install and bootstrap +properly. Many, many thanks! + +pattern of Freenode IRC contributed the beginnings of the Troubleshooting +section. Many thanks! + =head1 LICENSE This library is free software under the same license as perl itself