Venus::Config

Config Class

Config Class for Perl 5

method: edit_file method: new method: read_env method: read_env_file method: read_file method: read_json method: read_json_file method: read_perl method: read_perl_file method: read_yaml method: read_yaml_file method: write_env method: write_env_file method: write_file method: write_json method: write_json_file method: write_perl method: write_perl_file method: write_yaml method: write_yaml_file

package main;

use Venus::Config;

my $config = Venus::Config->new;

# $config = $config->read_file('app.pl');

# "..."

This package provides methods for loading Perl, YAML, and JSON configuration files, and fetching configuration information.

Venus::Kind::Utility

Venus::Role::Buildable Venus::Role::Valuable

The edit_file method does an in-place edit, i.e. it loads a Perl, YAML, or JSON configuration file, passes the decoded data to the method or callback provided, and writes the results of the method or callback to the file.

edit_file(string $file, string | coderef $code) (Venus::Config)

{ since => '3.10', }

The new method constructs an instance of the package.

new(any @args) (Venus::Config)

{ since => '4.15', }

The read_env method returns a new Venus::Config object based on the string of key/value pairs provided. This method supports multiline values when enclosed in double or single quotes.

read_env(string $data) (Venus::Config)

{ since => '4.15', }

The read_env_file method uses Venus::Path to return a new Venus::Config object based on the file provided.

read_env_file(string $file) (Venus::Config)

{ since => '4.15', }

=example-1 read_env_file

# given: synopsis

package main;

$config = $config->read_env_file('t/conf/read.env');

# bless(..., 'Venus::Config')

The read_file method load a Perl, YAML, or JSON configuration file, based on the file extension, and returns a new Venus::Config object.

read_file(string $path) (Venus::Config)

{ since => '2.91', }

=example-1 read_file

package main;

use Venus::Config;

my $config = Venus::Config->read_file('t/conf/read.perl');

# bless(..., 'Venus::Config')

The read_json method returns a new Venus::Config object based on the JSON string provided.

read_json(string $data) (Venus::Config)

{ since => '2.91', }

=example-1 read_json

# given: synopsis

package main;

$config = $config->read_json(q(
{
  "$metadata": {
    "tmplog": "/tmp/log"
  },
  "$services": {
    "log": { "package": "Venus/Path", "argument": { "$metadata": "tmplog" } }
  }
}
));

# bless(..., 'Venus::Config')

The read_json_file method uses Venus::Path to return a new Venus::Config object based on the file provided.

read_json_file(string $file) (Venus::Config)

{ since => '2.91', }

=example-1 read_json_file

# given: synopsis

package main;

$config = $config->read_json_file('t/conf/read.json');

# bless(..., 'Venus::Config')

The read_perl method returns a new Venus::Config object based on the Perl string provided.

read_perl(string $data) (Venus::Config)

{ since => '2.91', }

=example-1 read_perl

# given: synopsis

package main;

$config = $config->read_perl(q(
{
  '$metadata' => {
    tmplog => "/tmp/log"
  },
  '$services' => {
    log => { package => "Venus/Path", argument => { '$metadata' => "tmplog" } }
  }
}
));

# bless(..., 'Venus::Config')

The read_perl_file method uses Venus::Path to return a new Venus::Config object based on the file provided.

read_perl_file(string $file) (Venus::Config)

{ since => '2.91', }

=example-1 read_perl_file

# given: synopsis

package main;

$config = $config->read_perl_file('t/conf/read.perl');

# bless(..., 'Venus::Config')

The read_yaml method returns a new Venus::Config object based on the YAML string provided.

read_yaml(string $data) (Venus::Config)

{ since => '2.91', }

=example-1 read_yaml

# given: synopsis

package main;

$config = $config->read_yaml(q(
'$metadata':
  tmplog: /tmp/log
'$services':
  log:
    package: "Venus/Path"
    argument:
      '$metadata': tmplog
));

# bless(..., 'Venus::Config')

The read_yaml_file method uses Venus::Path to return a new Venus::Config object based on the YAML string provided.

read_yaml_file(string $file) (Venus::Config)

{ since => '2.91', }

=example-1 read_yaml_file

# given: synopsis

package main;

$config = $config->read_yaml_file('t/conf/read.yaml');

# bless(..., 'Venus::Config')

The write_env method returns a string representing environment variable key/value pairs based on the "value" held by the underlying Venus::Config object. Multiline values are escaped using \n notation and enclosed in double quotes.

write_env() (string)

{ since => '4.15', }

The write_env_file method saves a environment configuration file and returns a new Venus::Config object.

write_env_file(string $path) (Venus::Config)

{ since => '4.15', }

=example-1 write_env_file

# given: synopsis

my $value = $config->value({
  APPNAME => "Example",
  APPTAG => "Godzilla",
  APPVER => 0.01,
});

$config = $config->write_env_file('t/conf/write.env');

# bless(..., 'Venus::Config')

The write_file method saves a Perl, YAML, or JSON configuration file, based on the file extension, and returns a new Venus::Config object.

write_file(string $path) (Venus::Config)

{ since => '2.91', }

=example-1 write_file

# given: synopsis

my $value = $config->value({
  '$services' => {
    log => { package => "Venus/Path", argument => { value => "." } }
  }
});

$config = $config->write_file('t/conf/write.perl');

# bless(..., 'Venus::Config')

The write_json method returns a JSON encoded string based on the "value" held by the underlying Venus::Config object.

write_json() (string)

{ since => '2.91', }

=example-1 write_json

# given: synopsis

my $value = $config->value({
  '$services' => {
    log => { package => "Venus::Path" },
  },
});

my $json = $config->write_json;

# '{ "$services":{ "log":{ "package":"Venus::Path" } } }'

The write_json_file method saves a JSON configuration file and returns a new Venus::Config object.

write_json_file(string $path) (Venus::Config)

{ since => '2.91', }

=example-1 write_json_file

# given: synopsis

my $value = $config->value({
  '$services' => {
    log => { package => "Venus/Path", argument => { value => "." } }
  }
});

$config = $config->write_json_file('t/conf/write.json');

# bless(..., 'Venus::Config')

The write_perl method returns a FILE encoded string based on the "value" held by the underlying Venus::Config object.

write_perl() (string)

{ since => '2.91', }

=example-1 write_perl

# given: synopsis

my $value = $config->value({
  '$services' => {
    log => { package => "Venus::Path" },
  },
});

my $perl = $config->write_perl;

# '{ "\$services" => { log => { package => "Venus::Path" } } }'

The write_perl_file method saves a Perl configuration file and returns a new Venus::Config object.

write_perl_file(string $path) (Venus::Config)

{ since => '2.91', }

=example-1 write_perl_file

# given: synopsis

my $value = $config->value({
  '$services' => {
    log => { package => "Venus/Path", argument => { value => "." } }
  }
});

$config = $config->write_perl_file('t/conf/write.perl');

# bless(..., 'Venus::Config')

The write_yaml method returns a FILE encoded string based on the "value" held by the underlying Venus::Config object.

write_yaml() (string)

{ since => '2.91', }

=example-1 write_yaml

# given: synopsis

my $value = $config->value({
  '$services' => {
    log => { package => "Venus::Path" },
  },
});

my $yaml = $config->write_yaml;

# '---\n$services:\n\s\slog:\n\s\s\s\spackage:\sVenus::Path'

The write_yaml_file method saves a YAML configuration file and returns a new Venus::Config object.

write_yaml_file(string $path) (Venus::Config)

{ since => '2.91', }

=example-1 write_yaml_file

# given: synopsis

my $value = $config->value({
  '$services' => {
    log => { package => "Venus/Path", argument => { value => "." } }
  }
});

$config = $config->write_yaml_file('t/conf/write.yaml');

# bless(..., 'Venus::Config')

t/Venus.t: present: authors t/Venus.t: present: license

cpanm Venus

perl -MCPAN -e shell
install Venus