simplified hosts to be standard file data structure, also preserves comments

[scpubgit/System-Introspector.git] / lib / System / Introspector / Probe / Hosts.pm

package System::Introspector::Probe::Hosts;
use Moo;

use System::Introspector::Util qw(
    output_from_file
    transform_exceptions
);

has hosts_file => (
    is      => 'ro',
    default => sub { '/etc/hosts' },
);

sub gather {
    my ($self) = @_;
    my $file = $self->hosts_file;
    return {
        hosts_file => transform_exceptions {
            return {
                file_name => $file,
                body => scalar output_from_file $file,
            };
        },
    };
}

1;

__END__

=head1 NAME

System::Introspector::Hosts - Gather known hosts

=head1 DESCRIPTION

Reads a C<hosts> file to produce a list of known hosts

=head1 ATTRIBUTES

=head2 hosts_file

The path to the C<hosts> file that should be read. Defaults to C</etc/hosts>.

=head1 SEE ALSO

=over

=item L<System::Introspector>

=back

=cut