The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
Doit-0.028_50
River stage zero No dependents
5 ++
/ Doit::Ini

NAME

Doit::Ini - commands for changing ini files

SYNOPSIS

    use Doit;
    my $doit = Doit->init;
    $doit->add_component('ini'); # requires Config::IOD::INI or Config::IniFiles to be installed

    my $changed = $doit->ini_change('/path/to/file.ini', 'section1.key1' => 'newval1', 'section2.key2' => 'newval2', ...);

    $doit->ini_set_implementation('Config::IniFiles');
    $doit->ini_change('/path/to/file.ini', sub {
        my $self = shift;
        $self->confobj->setval('section', 'key', 'newval');
    });

    my $HoH = $doit->ini_info_as_HoH('/path/to/file.ini');

DESCRIPTION

Doit::Ini is a Doit component providing methods for changing ini files. It has to be added to a script using Doit's add_component:

    $doit->add_component('ini');

Note that a 3rd party CPAN module is required to do the actual ini file handling. Currently supported are:

Non-ini files (e.g. shell config files) can also be handled with some restrictions (see "BUGS"). A pseudo section "GLOBAL" is used for section-less key-values.

DOIT COMMANDS

The following commands are added to the Doit runner object:

ini_change

Change an existing ini file. Return 1 if a change was actually done, otherwise 0. There is a simple mode with key-value arguments, and a mode where an anonymous subroutine may be provided.

    $doit->ini_change("/path/to/file.ini", "section.key" => "newval", ...)

Set the existing key in section to the value newval. It's possible to specify multiple key-value pairs. Note that it's only possible to change existing keys (this may change in a future implementation).

    $doit->ini_change("/path/to/file.ini", sub {
        my($self) = @_;
        $self->confobj->setval('section','key','newval'); # if Config::IniFiles is used
        $self->confobj->set_value('section','key','newval'); # if Config::IOD::INI is used
    });

The anonymous subroutine is called with the adapter object. Use $self->confobj to get to the underlying implementation object where the native methods like setval (in the case of Config::IniFiles) respective set_value (in the case of Config::IOD::INI) may be used. It's also possible to use other methods e.g. to insert new keys or delete existing ones. To make sure that a specific ini implementation module is used, call "ini_set_implementation" with a single module.

ini_info_as_HoH

    my $HoH = $doit->ini_info_as_HoH('/path/to/file.ini');

Return a hash-of-hash reference of the ini contents. First hash level is the ini sections, second hash level is the ini parameters.

ini_set_implementation

    $doit->ini_set_implementation(qw(Config::IOD::INI Config::IniFiles));

Define which ini modules are used. The specified modules are checked for availability, and the first available one is used. The default order is as shown in the sample above.

ini_adapter_class

    my $adapter_class = $doit->ini_adapter_class;

Return which adapter class is available and will be used for ini file operations. If no suitable implementation is available, then undef is returned. Note that the adapter class has Doit::Ini:: prepended --- so if Config::IniFiles is chosen, then Doit::Ini::Config::IniFiles is returned.

BUGS

ini_change tries to do minimal changes, preserving whitespace, comments and order of sections andkeys. However, it seems that some whitespace may be lost when using Config::IniFiles.

Currently Unix newlines are used when writing files, even on Windows systems. This may change in future (i.e. preserving original line endings).

Config::IOD::INI and Config::IniFiles handle quotes in values differently: the former strips quotation marks, the latter keeps it.

AUTHOR

Slaven Rezic <srezic@cpan.org>

COPYRIGHT

Copyright (c) 2022 Slaven Rezic. All rights reserved. This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

SEE ALSO

Doit, Config::IOD::INI, Config::IniFiles.