File Coverage

blib/lib/Eliza/Chatbot/ScriptParser.pm

Criterion	Covered	Total	%
statement	64	64	100.0
branch	19	22	86.3
condition			n/a
subroutine	6	6	100.0
pod	1	1	100.0
total	90	93	96.7

package Eliza::Chatbot::ScriptParser;

use Moo;
use MooX::LazierAttributes;

attributes (
    script_file => [rw, q{}],
    [qw/quit initial final/] => [rw, [], {lzy}],
    [qw/decomp reasmb reasmb_for_memory pre post synon key unique_words/] => [rw, { }, { lzy }],
);

sub parse_script_data {
    my $self = shift;
    my @script_lines = $self->_open_script_file($self->script_file);
    my ($thiskey, $decomp);
    # Examine each line of the script data
    for my $line (@script_lines) {

        # Skip comments and lines with only whitespace
        next if $line =~ /^[\s*#|\s*]$/;

        # mehhh may be slow who knows
        $self->_unique_words($line);

        # Split entrytype and entry, using a colon as the delimiter
        my ($entry_type, $entry) = split /:/, $line;
        # remove the whitespace
        $entry_type = _trim_string($entry_type);
        $entry = _trim_string($entry);

        for ($entry_type) {
            /quit|initial|final/ and do { push @{$self->$_}, $entry; last; };
            /decomp/ and do {
                die "$0: error parsing script: decomp rule with no keyword. \n"
                    unless $thiskey;
                $decomp = join($;, $thiskey, $entry);
                push @{$self->$_->{$thiskey}}, $entry;
                last;
            };
            /reasmb|reasmb_for_mempory/ and do {
                die "$0: error parsing scrip reassembly rule with no decomposition rule"
                    unless $decomp;
                push @{$self->$_->{$decomp}}, $entry;
                last;
            };
            # everything else we have a key - split on first space
            my ($key, $value) = split(/\s/, $entry);
            /pre|post/ and do { $self->$_->{$key} = $value; last; };
            /synon/ and do { $self->$_->{$key} = [ split /\ /, $value ]; last; };
            /key/ and do {
                $thiskey = $key;
                $decomp = "";
                $self->$_->{$key} = $value;
                last;
            };
        }
    }
}

sub _unique_words {
    my ($self, $line) = @_;
    $line =~ s/[^a-zA-Z\'\s+]//g;
    my @words = split(' ', $line);
    foreach my $word ( @words ) {
        $self->unique_words->{$word}++;
    }
    return;
};

sub _trim_string {
    my $string = shift;
    $string =~ s/^\s+|\s+$//g;
    return $string;
}

sub _open_script_file {
    my ($self, $script_file) = @_;
    my @script_lines;
    if ($script_file) {
        # If we have an external script file, open it
        open (my $fh, "<", $script_file)
            or die "Could not read from file $script_file : $!\n";

        @script_lines = <$fh>;
        close ($fh);

        $self->script_file($script_file);
    }
    else {
        # Otherwise, read in the data from the bottom of this file.
        # This data might be read several times, so we save the offset pointer
        my $where = tell(DATA);
        @script_lines = ;

        # and reset it when we're done.
        seek(DATA, $where, 0);
        $self->script_file('none');
    }
    return @script_lines;
}

1;

=head1 Name

Eliza::Chatbot::ScriptParser

=head1 Version

Version 0.08

=head1 Options

=over

=item script_file

=item quit

=item initial

=item final

=item decomp

=item reasmb

=item reasmb_for_memory

=item pre

=item post

=item synon

=item key

=item unique_words

=back

=head1 SUBROUTINES/METHODS

=head2 parse_script_data()

    $self->parse_script_data;
    $self->parse_script_data( $script_file );

parse_script_data() is invoked from the _initialize() method, which is called from
the new() function.  However, you can also call this method at any time against
an already-instantiated Eliza instance.  In that case, the new script data is I
to the old script data.  The old script data is not deleted.

You can pass a parameter to this function, which is the name of the script file,
and it will read in and parse that file.  If you do not pass any parameter to
this method, then it will read the data embedded at the end of the module as its
default script data.

If you pass the name of a script file to parse_script_data(), and that file is
not available for reading, then the module dies.

=head1 Format of the script file

This module includes a default script file within itself, so it is not necessary
to explicitly specify a script file when instantiating an Eliza object. Each line
in the script file can specify a key, a decomposition rule, or a reassembly rule.

    key: remember 5
        decomp: * i remember *
            reasmb: Do you often think of (2) ?
            reasmb: Does thinking of (2) bring anything else to mind ?
        decomp: * do you remember *
            reasmb: Did you think I would forget (2) ?
            reasmb: What about (2) ?
            reasmb: goto what
    pre: equivalent alike
    synon: belief feel think believe wish

The number after the key specifies the rank. If a user's input contains the keyword, then
the transform() function will try to match one of the decomposition rules for that keyword.
If one matches, then it will select one of the reassembly rules at random.  The number
(2) here means "use whatever set of words matched the second asterisk in the decomposition
rule." If you specify a list of synonyms for a word, the you should use a "@" when you use that
word in a decomposition rule:

    decomp: * i @belief i *
        reasmb: Do you really think so ?
        reasmb: But you are not sure you (3).

Otherwise, the script will never check to see if there are any synonyms for that keyword.
Reassembly rules should be marked with I rather than I when it is appropriate for use when a user's comment has been extracted from memory.

    key: my 2
        decomp: * my *
            reasm_for_memory: Let's discuss further why your (2).
            reasm_for_memory: Earlier you said your (2).
            reasm_for_memory: But your (2).
            reasm_for_memory: Does that have anything to do with the fact that your (2) ?

=head1 AUTHOR

LNATION [e-mail]

=head1 LICENSE AND COPYRIGHT

Copyright 2017 Robert Acock.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

=cut

__DATA__