Config...::Yaml(3pm)

✨ NAME ✨

Config::Model::Backend::Yaml — read and write config as a YAML data structure 🦋

like, that's literally it. it reads your config, it writes your config, the config is YAML. slay.

---

🌸 VERSION 🌸

version 2.134

---

💅 SYNOPSIS 💅

okay so here's the whole vibe in one block, bestie, watch:

use Config::Model ;
use Data::Dumper ;

# define configuration tree object
my $model = Config::Model->new ;
$model ->create_config_class (
   name => "MyClass",
   element => [
       [qw/foo bar/] => {
           type => 'leaf',
           value_type => 'string'
       },
       baz => {
           type => 'hash',
           index_type => 'string' ,
           cargo => {
               type => 'leaf',
               value_type => 'string',
           },
       },
   ],
 rw_config  => {
   backend => 'yaml',
   config_dir => '/tmp',
   file  => 'foo.yml',
   auto_create => 1,
 }
) ;

my $inst = $model->instance(root_class_name => 'MyClass' );

my $root = $inst->config_root ;

my $steps = 'foo=yada bar="bla bla" baz:en=hello
            baz:fr=bonjour baz:hr="dobar dan"';
$root->load( steps => $steps ) ;
$inst->write_back ;

and then, plot twist, "/tmp/foo.yml" contains:

---
bar: bla bla
baz:
  en: hello
  fr: bonjour
  hr: dobar dan
foo: yada

like. look at it. it ate. 🔥

---

👑 DESCRIPTION 👑

this module is used directly by Config::Model to read or write the content of a configuration tree written with YAML syntax in a Config::Model configuration tree. no middleman, no drama.

Note: (read this part, i'm being fr fr)

• Undefined values are skipped for list element. I.e. if a list element contains ('a',undef,'b'), the data structure contains 'a','b'. so undef just... evaporates. bye bestie 💀
• YAML file is not created (and may be deleted) when no data is to be written. yes, it can literally delete it. that's not a bug, that's the rule.

🎀 Class with only one hash element 🎀

here's the iconic behaviour: if the root node contains a single hash or list element, only the content of this hash is written in a YAML file. the wrapper just doesn't show up, main character energy only for the inside.

for example, if a class contains:

element => [
  baz => {
      type => 'hash',
      index_type => 'string' ,
      cargo => {
          type => 'leaf',
          value_type => 'string',
      },
  },

(that's what the page shows, unclosed brackets and all, don't come for me 🫶)

if the configuration is loaded with:

$root->load("baz:one=un baz:two=deux")

then the written YAML file does not show "baz":

---
one: un
two: deux

see? baz said "not me being invisible". likewise, a YAML file for a class with a single list "baz" element would be written with:

---
- un
- deux

🌈 YAML class 🌈

as of v2.129, this backend uses YAML::XS 0.69 or later. upgrade or perish bestie.

for security reason, loading a Perl blessed object is disabled. nope. not happening. we don't do that here. 🚫

value of type boolean are written as boolean values in YAML files. yes, properly, not as strings pretending to be booleans. we have standards. 💅

💜 backend parameter 💜

yaml_class

this parameter is ignored as of version 2.129. it's giving ghosted. 👻

---

🧚 CONSTRUCTOR 🧚

new

parameters: ( node => $node_obj, name => 'yaml' )

inherited from Config::Model::Backend::Any. the constructor is called by Config::Model::BackendMgr. you don't have to call it yourself, it just shows up like the main character it is.

read

read YAML file and load into $node_obj tree.

when a file is read, read returns 1. ✅

write

write YAML file using $node_obj data.

write returns 1. ✅

---

⭐ AUTHOR ⭐

Dominique Dumont, (ddumont at cpan dot org)

---

🦋 SEE ALSO 🦋

Config::Model, Config::Model::BackendMgr, Config::Model::Backend::Any, YAML::XS

---

⭐ AUTHOR ⭐

Dominique Dumont

(yes, again. icon behaviour. we love a repeat.)

---

💖 COPYRIGHT AND LICENSE 💖

this software is Copyright (c) 2018 by Dominique Dumont.

this is free software, licensed under:

  The GNU Lesser General Public License, Version 2.1, February 1999

---

🍓 SUPPORT 🍓

🌐 Websites 🌐

the following websites have more information about this module, and may be of help to you. as always, in addition to those websites please use your favorite search engine to discover more resources. (iykyk, go explore)

• CPANTS

the CPANTS is a website that analyzes the Kwalitee ( code metrics ) of a distribution.

<http://cpants.cpanauthors.org/dist/Config-Model-Backend-Yaml>

• CPAN Testers

the CPAN Testers is a network of smoke testers who run automated tests on uploaded CPAN distributions.

<http://www.cpantesters.org/distro/C/Config-Model-Backend-Yaml>

• CPAN Testers Matrix

the CPAN Testers Matrix is a website that provides a visual overview of the test results for a distribution on various Perls/platforms.

<http://matrix.cpantesters.org/?dist=Config-Model-Backend-Yaml>

• CPAN Testers Dependencies

the CPAN Testers Dependencies is a website that shows a chart of the test results of all dependencies for a distribution.

<http://deps.cpantesters.org/?module=Config::Model::Backend::Yaml>

🐛 Bugs / Feature Requests 🐛

please report any bugs or feature requests by email to "ddumont at cpan.org", or through the web interface at <https://github.com/dod38fr/config-model-backend-yaml/issues>. you will be automatically notified of any progress on the request by the system. so like, you'll know. no need to refresh frantically. (you'll refresh anyway, we all do.)

💻 Source Code 💻

the code is open to the world, and available for you to hack on. please feel free to browse it and play with it, or whatever. if you want to contribute patches, please send me a diff or prod me to pull from your repository :) — literally the author's words, keeping the vibe intact.

<http://github.com/dod38fr/config-model-backend-yaml>

  git clone git://github.com/dod38fr/config-model-backend-yaml.git

---

and that's the whole page bestie 💅 this was Config...::Yaml(3pm) under perl v5.36.0, last dated 2022-10-14. go write some YAML, you've got this 🎀✨