Swipe the MANIFEST.SKIP from Devel::REPL.
[p5sagit/local-lib.git] / lib / local / lib.pm
index 44db092..79f8476 100644 (file)
@@ -3,20 +3,35 @@ 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.003000'; # 1.2.0
 
 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 
+  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 +210,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 +262,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 +274,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 +321,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'
@@ -360,6 +387,16 @@ PATH is appended to, rather than clobbered.
 
 These values are then available for reference by any code after import.
 
+=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
@@ -398,6 +435,8 @@ auto_install fixes kindly sponsored by http://www.takkle.com/
 Patches to correctly output commands for csh style shells, as well as some
 documentation additions, contributed by Christopher Nehren <apeiron@cpan.org>.
 
+'--self-contained' feature contributed by Mark Stosberg <mark@summersault.com>.
+
 =head1 LICENSE
 
 This library is free software under the same license as perl itself