File Coverage

blib/lib/Config/MySQL/Reader.pm

Criterion	Covered	Total	%
statement	19	20	95.0
branch	5	6	83.3
condition			n/a
subroutine	6	6	100.0
pod	3	3	100.0
total	33	35	94.2

package Config::MySQL::Reader;

use warnings;
use strict;

use base 'Config::INI::Reader';

=head1 NAME

Config::MySQL::Reader - Read MySQL-style configuration files

=head1 VERSION

Version 0.01

=cut

our $VERSION = '0.02';

=head1 SYNOPSIS

If F contains

    [mysqld]
    datadir=/var/lib/mysql
    skip-locking

    [mysqldump]
    quick
    max_allowed_packet = 16M

    !include /etc/my_other.cnf
    !include /etc/my_extra.cnf

Then when your program contains

    my $config = Config::MySQL::Reader->read_file('my.cnf');

C<$config> will contain

    {
        '_' => {
            '!include' => [
                '/etc/my_other.cnf',
                '/etc/my_extra.cnf',
            ],
        },
        'mysqld' => {
            'datadir'      => '/var/lib/mysql',
            'skip-locking' => undef,
        },
        'mysqldump' => {
            'quick'              => undef,
            'max_allowed_packet' => '16M',
        },
    }

=head1 DECSRIPTION

This module extends L to support reading
MySQL-style configuration files.  Although deceptively similar to
standard C<.INI> files, they can include bare boolean options with no value
assignment and additional features like C and C.

C does not read files included by the C
and C directives, but does preserve the directives so that you can
safely read, modify, and re-write configuration files without losing
them. If you need to read the contents of included files, you may want to look
at L which handles this automatically (but does not
handle roundtripping).

=head1 METHODS FOR READING CONFIG

=head2 read_file, read_string, and read_handle

See L for usage details.

=head1 OVERRIDDEN METHODS

=head2 parse_value_assignment

Copes with MySQL-style boolean properties that have no value assignment.

=cut

sub parse_value_assignment {
    return ( $1, $2 ) if $_[1] =~ /^\s*([^=\s][^=]*?)(?:\s*=\s*(.*?)\s*)?$/;
    return;
}

=head2 can_ignore

Handle C and C directives. Comments can start with hash too.

=cut

sub can_ignore {
    my ( $self, $line ) = @_;
    if ( $line =~ /^\s*(\!include(?:dir)?)\s+(.*?)\s*$/ ) {
        push @{$self->{data}{$self->starting_section}{$1}}, $2;
        return 1;
    }
    return $line =~ /\A\s*(?:;|#|$)/ ? 1 : 0;
}

=head2 preprocess_line

Strip inline comments (starting with ; or #)

=cut

sub preprocess_line {
    my ($self, $line) = @_;
    ${$line} =~ s/\s+[;#].*$//g;
}

=head1 SEE ALSO

=over 4

=item L

=item L

=item L

=back

=head1 AUTHOR

Iain Arnell, C<<  >>

=head1 BUGS

Please report any bugs or feature requests to C, or through
the web interface at L.  I will be notified, and then you'll
automatically be notified of progress on your bug as I make changes.


=head1 SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc Config::MySQL::Reader


You can also look for information at:

=over 4

=item * RT: CPAN's request tracker

L

=item * AnnoCPAN: Annotated CPAN documentation

L

=item * CPAN Ratings

L

=item * Search CPAN

L

=back


=head1 ACKNOWLEDGEMENTS

Thanks to Ricardo Signes for Config-INI.

=head1 COPYRIGHT & LICENSE

Copyright 2010 Iain Arnell.

This program is free software; you can redistribute it and/or modify it
under the terms of either: the GNU General Public License as published
by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.


=cut

1;    # End of Config::MySQL::Reader