File Coverage

blib/lib/Env/AsYaml.pm

Criterion	Covered	Total	%
statement	46	66	69.7
branch	1	12	8.3
condition	8	15	53.3
subroutine	15	17	88.2
pod	2	2	100.0
total	72	112	64.2

package Env::AsYaml;
# Last modified: Tue Sep 02 2025 01:10:52 PM -04:00 [EDT]
# First created: Sat Aug 09 2025 05:38:14 PM -04:00 [EDT]

use v5.18;
use strict;
use utf8;
use warnings;

=head1 NAME/ABSTRACT

Env::AsYaml is intended to be a tool for examination of the environment in
which the user is running programs, starting processes or for otherwise
troubleshooting the system.

=head1 VERSION

Version 0.35

=cut

our $VERSION = '0.35';

=head1 SYNOPSIS

This module checks the environment it's running in and prints it to STDOUT as
YAML. Env vars that are lists (such as C<$PATH>) are formatted in YAML as lists.

    use Env::AsYaml;   # auto-imports 'showPathLists' and 'showScalars'

=cut

use vars qw( @Wanted @Bare );
  # ---------------------- ### ---------------------- #
  BEGIN {
     @Wanted = map { push @Bare=> $_; q%@% .$_ } grep {
                $_ eq "PERL5LIB"
             || $_ eq "PATH"
             || /^XDG_[A-Z]+_DIRS\z/
             || ( /^[_A-Z0-9]+PATH\z/ && !/^XDG_.+_PATH\z/ )
             || /PSModulePath/i   # does not work on cygwin, why?
                  } sort keys %ENV;

      eval "use Env qw/@Wanted/ ;";
  }
  # ---------------------- ### ---------------------- #

use Env::Paths::2yaml;
use Env::Scalars::scalars2yaml;
use YAML::Any;
use Getopt::Std;
require Exporter;
our @ISA = qw(Exporter);
our @EXPORT = qw(showPathLists showScalars);
use Data::Dump::Color;
$Data::Dump::Color::INDEX = 0;
$Data::Dump::Color::COLOR = 'true';

=head1 EXPORTS

These subroutines are available to import ("@EXPORT_OK").
    showPathLists showScalars

=head1 SUBROUTINES/METHODS

=head2 showPathLists

Use Env::Paths::2yaml to transmute all env path lists into YAML serialization.

=head2

=cut

sub showPathLists {
    use Env::Paths::2yaml qw( ToYaml );
    my $dd = defined $_[0] ? 'true' : '';
# It's nasty to hard-code it this way but this stuff in my env is just
# in the way:
@Bare = grep { $_ ne 'ORIGINAL_PATH'
            && $_ ne 'AMDRMSDKPATH'
            && $_ ne 'HOMEPATH' } @Bare;

    my( $accumulator , @all_docs );
    for my $kstr ( @Bare ) {
        no strict 'refs'; # a symbolic reference below:
        my $seq = ToYaml( $kstr, @{$kstr} );
        my $yaml_segment = join q[]=> @$seq;
        $accumulator .= qq[\n---\n] . $yaml_segment;
    }
    print $accumulator;

# Load YAML here, to dump the data in color if desired.
    @all_docs = Load( $accumulator );

    if ($dd) { #   Dump as perl data, in vivid technicolor.
        print qq[\n];
        dd( @all_docs );
    }
}

=head2 showScalars

Print simple scalar strings present in the environment.

=cut

use Env::Scalars::scalars2yaml qw( s2yaml );
sub showScalars {
    my $simples = s2yaml();
    my $dd = defined $_[0] ? 'true' : '';
    say qq[\n---];
    say for @$simples;
    if ($dd) {
        dd( $simples );
    }
}

__END__