File Coverage

blib/lib/Config/MVP/Reader/Hash.pm

Criterion	Covered	Total	%
statement	19	19	100.0
branch	3	4	75.0
condition	2	3	66.6
subroutine	3	3	100.0
pod	1	1	100.0
total	28	30	93.3

package Config::MVP::Reader::Hash 2.200013;
# ABSTRACT: a reader that tries to cope with a plain old hashref

use Moose;
extends 'Config::MVP::Reader';

#pod =head1 SYNOPSIS
#pod
#pod   my $sequence = Config::MVP::Reader::Hash->new->read_config( \%config );
#pod
#pod =head1 DESCRIPTION
#pod
#pod In some ways, this is the L<Config::MVP::Reader> of last resort.  Given a
#pod hashref, it attempts to interpret it as a Config::MVP::Sequence.  Because
#pod hashes are generally unordered, order can't be relied upon unless the hash tied
#pod to have order (presumably with L<Tie::IxHash>).  The hash keys are assumed to
#pod be section names and will be used as the section package moniker unless a
#pod L<__package> entry is found.
#pod
#pod =cut

sub read_into_assembler {
  my ($self, $location, $assembler) = @_;

  confess "no hash given to $self" unless my $hash = $location;

  for my $name (keys %$hash) {
    my $payload = { %{ $hash->{ $name } } };
    my $package = delete($payload->{__package}) || $name;

    $assembler->begin_section($package, $name);

    for my $key (%$payload) {
      my $val = $payload->{ $key };
      my @values = ref $val ? @$val : $val;
      $assembler->add_value($key => $_) for @values;
    }

    $assembler->end_section;
  }

  return $assembler->sequence;
}

no Moose;
__PACKAGE__->meta->make_immutable;
1;

__END__

=pod

=encoding UTF-8

=head1 NAME

Config::MVP::Reader::Hash - a reader that tries to cope with a plain old hashref

=head1 VERSION

version 2.200013

=head1 SYNOPSIS

  my $sequence = Config::MVP::Reader::Hash->new->read_config( \%config );

=head1 DESCRIPTION

In some ways, this is the L<Config::MVP::Reader> of last resort.  Given a
hashref, it attempts to interpret it as a Config::MVP::Sequence.  Because
hashes are generally unordered, order can't be relied upon unless the hash tied
to have order (presumably with L<Tie::IxHash>).  The hash keys are assumed to
be section names and will be used as the section package moniker unless a
L<__package> entry is found.

=head1 PERL VERSION

This module should work on any version of perl still receiving updates from
the Perl 5 Porters.  This means it should work on any version of perl released
in the last two to three years.  (That is, if the most recently released
version is v5.40, then this module should work on both v5.40 and v5.38.)

Although it may work on older versions of perl, no guarantee is made that the
minimum required version will not be increased.  The version may be increased
for any reason, and there is no promise that patches will be accepted to lower
the minimum required perl.

=head1 AUTHOR

Ricardo Signes <[e-mail]>

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2022 by Ricardo Signes.

This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.

=cut