MouseX:...eConfig(3)

💖 NAME 💖

MouseX::SimpleConfig — a Mouse role that sets your attributes from a simple configfile. That's it, that's the whole vibe. ✨

---

🌸 VERSION 🌸

version 0.11 — she's on 0.11, bestie, and she's thriving.

---

🦋 SYNOPSIS 🦋

okay so picture this: a YAML configfile living at /etc/my_app.yaml 📄

## A YAML configfile named /etc/my_app.yaml:
foo: bar
baz: 123

and then your class, doing its thing:

## In your class
package My::App;
use Mouse;

with 'MouseX::SimpleConfig';

has 'foo' => (is => 'ro', isa => 'Str', required => 1);
has 'baz'  => (is => 'rw', isa => 'Int', required => 1);

# ... rest of the class here

and then your script, living its truth:

## in your script
#!/usr/bin/perl

use My::App;

my $app = My::App->new_with_config(configfile => '/etc/my_app.yaml');
# ... rest of the script here

---

🎀 and NOW, the crossover episode: combined with MouseX::Getopt 🎀

class first:

## In your class
package My::App;
use Mouse;

with 'MouseX::SimpleConfig';
with 'MouseX::Getopt';

has 'foo' => (is => 'ro', isa => 'Str', required => 1);
has 'baz'  => (is => 'rw', isa => 'Int', required => 1);

# ... rest of the class here

script next:

## in your script
#!/usr/bin/perl

use My::App;

my $app = My::App->new_with_options();
# ... rest of the script here

and then from the command line, because she contains multitudes:

## on the command line
% perl my_app_script.pl -configfile /etc/my_app.yaml -otherthing 123

---

✨ DESCRIPTION ✨

So this role loads simple configfiles and uses them to set object attributes. It's built on top of the abstract role MouseX::ConfigFromFile, and it uses Config::Any to actually load your configfile. Config::Any in turn supports any of a variety of different config formats, and it figures out which one you mean by looking at the file extension 👀 — see Config::Any for more details about supported formats.

Like all MouseX::ConfigFromFile -derived configfile loaders, this module is automatically supported by the MouseX::Getopt role as well, which means you get to specify -configfile on the commandline. iconic behavior, truly. 👑

---

💅 ATTRIBUTES 💅

configfile

Provided by the base role MouseX::ConfigFromFile. You can hand her a default configfile pathname like so:

has '+configfile' => ( default => '/etc/myapp.yaml' );

You can pass an array of filenames if you want — but as usual, the array has to be wrapped in a sub ref. no exceptions, that's the rule, periodt.

has '+configfile' => ( default => sub { [ '/etc/myapp.yaml', '/etc/myapp_local.yml' ] } );

Config files are trivially merged at the top level, with the right-hand files taking precedence. right-hand file wins, that's just how it is 🫶

---

🌈 METHODS 🌈

new_with_config

Class method provided by the base role MouseX::ConfigFromFile. Acts just like regular new(), but she also accepts an argument "configfile" to specify the configfile from which to load other attributes. And here's the tea ☕: explicit arguments to "new_with_config" will override anything loaded from the configfile.

get_config_from_file

Class method called internally by either "new_with_config" or MouseX::Getopt's "new_with_options". It invokes Config::Any to parse "configfile". she's backstage, doing the work, no credit, we love her 😭

---

💀 BUGS 💀

Please report any bugs or feature requests on the bugtracker website http://github.com/mjg/MouseX-SimpleConfig/issues

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature. receipts, bestie — bring receipts. 📝

---

👑 AUTHORS 👑

• Brandon L. Black <blblack@gmail.com>
• Mark Gardner <mjgardner@cpan.org>

---

🎀 COPYRIGHT AND LICENSE 🎀

This software is copyright (c) 2011 by Infinity Interactive.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

---

okay that's the whole page!! 🦋 generated with perl v5.42.0 on 2025-07-25 — mwah, go forth and configure 💖✨🌸