File Coverage

blib/lib/Docker/Names/Random.pm

Criterion	Covered	Total	%
statement	51	52	98.0
branch	3	4	75.0
condition	2	3	66.6
subroutine	12	12	100.0
pod	2	2	100.0
total	70	73	95.8

package Docker::Names::Random;

## no critic (Documentation::RequirePodAtEnd)
## no critic (Documentation::RequirePodSections)

use strict;
use warnings;
use 5.010;
use feature qw( state );
use utf8;    # The __DATA__ is UTF-8
use English qw(-no_match_vars);

# ABSTRACT: Create random strings like Docker does for container names.

our $VERSION = '0.0.2'; # VERSION: generated by DZP::OurPkgVersion

use Exporter 'import';
our @EXPORT_OK   = qw( docker_name );
our %EXPORT_TAGS = ( 'all' => [qw( docker_name )] );

use YAML::PP;
use Hash::Util qw( lock_keys );


# Internal functions

sub _get_data {
    state $ypp = YAML::PP->new;
    local $INPUT_RECORD_SEPARATOR = undef;
    state $data = $ypp->load_string();
    return $data;
}

sub new {
    my $class = shift;

    my $data = _get_data();
    my $self = { data => $data };
    bless $self, $class;
    lock_keys( %{$self} );
    return $self;
}


sub docker_name {
    my $self = shift;
    my $data;
    if ( defined $self ) {
        $data = $self->{'data'};
    }
    else {

        # We are not running as an object method
        $data = _get_data();
    }

    my ( $adj, $surname );

  CREATE_NAME:
    my $r_for_adj = int( rand( scalar @{ $data->{'adjectives'} } ) );
    $adj = $data->{'adjectives'}->[$r_for_adj]->{'word'};
    my $r_for_name = int( rand( scalar @{ $data->{'names'} } ) );
    $surname = $data->{'names'}->[$r_for_name]->{'surname'};

    if ( $adj eq 'boring' && $surname eq 'wozniak' ) {

        # Steve Wozniak is not boring
        goto 'CREATE_NAME';
    }

    return $adj . q{_} . $surname;
}


1;

=pod

=encoding UTF-8

=head1 NAME

Docker::Names::Random - Create random strings like Docker does for container names.

=head1 VERSION

version 0.0.2

=head1 SYNOPSIS

    # As an object (if you create many, this is more efficient).
    require Docker::Names::Random;

    my $dnr = Docker::Names::Random->new();
    my $random_name1 = $dnr->docker_name();

    # As an imported function.
    use Docker::Names::Random qw( docker_name );
    # OR
    use Docker::Names::Random qw( :all );

    my $random_name2 = docker_name();

=head1 DESCRIPTION

If you are using Docker, you may have noticed that it
creates random names for containers when you haven't provided any
specific name. These names are a combination of an adjective
and a proper name of an individual. The individuals are
famous men and women picked from the history of scientific exploration
and engineering.

This package allows you to use the same system in your own programs.
You would get combinations like
I,
I,
I,
I,
I and
I.

The combination I is not allowed because
L is not boring.
This same limitation exists in the
L.

=for stopwords overthruster Docker::Names::Random Docker Names Random

=head1 STATUS

This module is currently being developed so changes in the API are possible,
though unlikely.

=head1 METHODS

=head2 new

Create object.

    require Docker::Names::Random;
    my $dnr = Docker::Names::Random->new();

=head2 docker_name

Return a random string.

    my $random_name = $dnr->docker_name();

=head1 FUNCTIONS

=head2 docker_name

Return a random string.

    use Docker::Names::Random qw( docker_name );
    # OR
    use Docker::Names::Random qw( :all );

    my $random_name = docker_name();

=head1 AUTHOR

Mikko Johannes Koivunalho

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2020 by Mikko Johannes Koivunalho.

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

__DATA__