my @steps;
my %opts;
+ my $shelltype;
while (@args) {
my $arg = shift @args;
DEATH
}
elsif ($arg eq '--self-contained') {
- die "FATAL: The local::lib --self-contained flag has never worked reliably and the original author, Mark Stosberg, was unable or unwilling to maintain it. As such, this flag has been removed from the local::lib codebase in order to prevent misunderstandings and potentially broken builds. The local::lib authors recommend that you look at the lib::core::only module shipped with this distribution in order to create a more robust environment that is equivalent to what --self-contained provided (although quite possibly not what you originally thought it provided due to the poor quality of the documentation, for which we apologise).\n";
+ die <<'DEATH';
+FATAL: The local::lib --self-contained flag has never worked reliably and the
+original author, Mark Stosberg, was unable or unwilling to maintain it. As
+such, this flag has been removed from the local::lib codebase in order to
+prevent misunderstandings and potentially broken builds. The local::lib authors
+recommend that you look at the lib::core::only module shipped with this
+distribution in order to create a more robust environment that is equivalent to
+what --self-contained provided (although quite possibly not what you originally
+thought it provided due to the poor quality of the documentation, for which we
+apologise).
+DEATH
}
elsif( $arg =~ /^--deactivate(?:=(.*))?$/ ) {
my $path = defined $1 ? $1 : shift @args;
push @steps, ['deactivate_all'];
}
elsif ( $arg =~ /^--shelltype(?:=(.*))?$/ ) {
- my $shell = defined $1 ? $1 : shift @args;
- $opts{shelltype} = $shell;
+ $shelltype = defined $1 ? $1 : shift @args;
}
elsif ( $arg eq '--no-create' ) {
$opts{no_create} = 1;
}
if ($0 eq '-') {
- $self->print_environment_vars_for;
+ print $self->environment_vars_string($shelltype);
exit 0;
}
else {
- $self->setup_local_lib_for;
+ $self->setup_local_lib;
}
}
sub installer_options_for {
my ($class, $path) = @_;
- return {
- PERL_MM_OPT => defined $path ? "INSTALL_BASE="._mm_escape_path($path) : undef,
- PERL_MB_OPT => defined $path ? "--install_base "._mb_escape_path($path) : undef,
- };
+ return (
+ PERL_MM_OPT =>
+ defined $path ? "INSTALL_BASE="._mm_escape_path($path) : undef,
+ PERL_MB_OPT =>
+ defined $path ? "--install_base "._mb_escape_path($path) : undef,
+ );
}
sub active_paths {
}
my %args = (
- bins => [ _remove_from($self->bins, $self->install_base_bin_path($path)) ],
- libs => [ _remove_from($self->libs, $self->install_base_perl_path($path)) ],
- inc => [ _remove_from($self->inc, $self->lib_paths_for($path)) ],
+ bins => [ _remove_from($self->bins,
+ $self->install_base_bin_path($path)) ],
+ libs => [ _remove_from($self->libs,
+ $self->install_base_perl_path($path)) ],
+ inc => [ _remove_from($self->inc,
+ $self->lib_paths_for($path)) ],
roots => [ _remove_from($self->roots, $path) ],
);
- $args{extra} = $self->installer_options_for($args{roots}[0]);
+ $args{extra} = { $self->installer_options_for($args{roots}[0]) };
$self->clone(%args);
}
);
}
- $args{extra} = $self->installer_options_for(undef);
+ $args{extra} = { $self->installer_options_for(undef) };
$self->clone(%args);
}
);
}
- $args{extra} = $self->installer_options_for($path);
+ $args{extra} = { $self->installer_options_for($path) };
$self->clone(%args);
}
return $path;
}
-sub _legacy {
- my ($self, $path) = @_;
- $self = $self->new unless ref $self;
- if (defined $path) {
- $self = $self->activate($path);
- }
- $self;
-}
-
sub build_environment_vars_for {
- my ($self) = _legacy(@_);
+ my $self = $_[0]->new->activate($_[1]);
+ $self->build_environment_vars;
+}
+sub build_environment_vars {
+ my $self = shift;
(
PATH => join($_path_sep, _as_list($self->bins)),
PERL5LIB => join($_path_sep, _as_list($self->libs)),
}
sub setup_local_lib_for {
- my ($self) = _legacy(@_);
- $self->setup_env_hash_for;
+ my $self = $_[0]->new->activate($_[1]);
+ $self->setup_local_lib;
+}
+
+sub setup_local_lib {
+ my $self = shift;
+ $self->setup_env_hash;
@INC = @{$self->inc};
}
sub setup_env_hash_for {
+ my $self = $_[0]->new->activate($_[1]);
+ $self->setup_env_hash;
+}
+sub setup_env_hash {
my $self = shift;
- my %env = $self->build_environment_vars_for(@_);
+ my %env = $self->build_environment_vars;
for my $key (keys %env) {
if (defined $env{$key}) {
$ENV{$key} = $env{$key};
}
sub print_environment_vars_for {
- my $self = shift;
- print $self->environment_vars_string_for(@_);
+ print $_[0]->environment_vars_string_for(@_[1..$#_]);
}
sub environment_vars_string_for {
- my $self = _legacy(@_);
+ my $self = $_[0]->new->activate($_[1]);
+ $self->environment_vars_string;
+}
+sub environment_vars_string {
+ my ($self, $shelltype) = @_;
+
+ $shelltype ||= $self->guess_shelltype;
- my $build_method = 'build_' . $self->shelltype . '_env_declaration';
+ my $build_method = "build_${shelltype}_env_declaration";
my @envs = (
PATH => $self->bins,
=item PATH
+=item PERL_LOCAL_LIB_ROOT
+
=back
When possible, these will be appended to instead of overwritten entirely.
there are a number of caveats, and the best approach is always to perform a
build against a clean perl (i.e. site and vendor as close to empty as possible).
-=head1 OPTIONS
+=head1 IMPORT OPTIONS
Options are values that can be passed to the C<local::lib> import besides the
directory to use. They are specified as C<use local::lib '--option'[, path];>
Prevents C<local::lib> from creating directories when activating dirs. This is
likely to cause issues on Win32 systems.
-=head1 METHODS
+=head1 CLASS METHODS
=head2 ensure_dir_structure_for
library installation. Appends the directories C<lib> and C<perl5> to the given
path.
+=head2 lib_paths_for
+
+=over 4
+
+=item Arguments: $path
+
+=item Return value: @lib_paths
+
+=back
+
+Returns the list of paths perl will search for libraries, given a base path.
+This includes the base path itself, the architecture specific subdirectory, and
+perl version specific subdirectories. These paths may not all exist.
+
=head2 install_base_bin_path
=over 4
Returns a path describing where to install the executable programs for this
local library installation. Appends the directory C<bin> to the given path.
+=head2 installer_options_for
+
+=over 4
+
+=item Arguments: $path
+
+=item Return value: %installer_env_vars
+
+=back
+
+Returns a hash of environment variables that should be set to cause
+installation into the given path.
+
=head2 resolve_empty_path
=over 4
L</resolve_relative_path>. The result of this final call is returned from
L</resolve_path>.
+=head1 OBJECT INTERFACE
+
+=head2 new
+
+=over 4
+
+=item Arguments: %attributes
+
+=item Return value: $local_lib
+
+=back
+
+Constructs a new C<local::lib> object, representing the current state of
+C<@INC> and the relevant environment variables.
+
+=head1 ATTRIBUTES
+
+=head2 roots
+
+An arrayref representing active C<local::lib> directories.
+
+=head2 inc
+
+An arrayref representing C<@INC>.
+
+=head2 libs
+
+An arrayref representing the PERL5LIB environment variable.
+
+=head2 bins
+
+An arrayref representing the PATH environment variable.
+
+=head2 extra
+
+A hashref of extra environment variables (e.g. C<PERL_MM_OPT> and
+C<PERL_MB_OPT>)
+
+=head2 no_create
+
+If set, C<local::lib> will not try to create directories when activating them.
+
+=head1 OBJECT METHODS
+
+=head2 clone
+
+=over 4
+
+=item Arguments: %attributes
+
+=item Return value: $local_lib
+
+=back
+
+Constructs a new C<local::lib> object based on the existing one, overriding the
+specified attributes.
+
+=head2 activate
+
+=over 4
+
+=item Arguments: $path
+
+=item Return value: $new_local_lib
+
+=back
+
+Constructs a new instance with the specified path active.
+
+=head2 deactivate
+
+=over 4
+
+=item Arguments: $path
+
+=item Return value: $new_local_lib
+
+=back
+
+Constructs a new instance with the specified path deactivated.
+
+=head2 deactivate_all
+
+=over 4
+
+=item Arguments: None
+
+=item Return value: $new_local_lib
+
+=back
+
+Constructs a new instance with all C<local::lib> directories deactivated.
+
+=head2 environment_vars_string
+
+=over 4
+
+=item Arguments: [ $shelltype ]
+
+=item Return value: $shell_env_string
+
+=back
+
+Returns a string to set up the C<local::lib>, meant to be run by a shell.
+
+=head2 build_environment_vars
+
+=over 4
+
+=item Arguments: None
+
+=item Return value: %environment_vars
+
+=back
+
+Returns a hash with the variables listed above, properly set to use the
+given path as the base directory.
+
+=head2 setup_env_hash
+
+=over 4
+
+=item Arguments: None
+
+=item Return value: None
+
+=back
+
+Constructs the C<%ENV> keys for the given path, by calling
+L</build_environment_vars>.
+
+=head2 setup_local_lib
+
+Constructs the C<%ENV> hash using L</setup_env_hash>, and set up C<@INC>.
+
=head1 A WARNING ABOUT UNINST=1
Be careful about using local::lib in combination with "make install UNINST=1".