yaml::node(3) [suse man page]

YAML::Node(3)						User Contributed Perl Documentation					     YAML::Node(3)

NAME

       YAML::Node - A generic data node that encapsulates YAML information

SYNOPSIS

	   use YAML;
	   use YAML::Node;

	   my $ynode = YAML::Node->new({}, 'ingerson.com/fruit');
	   %$ynode = qw(orange orange apple red grape green);
	   print Dump $ynode;

       yields:

	   --- !ingerson.com/fruit
	   orange: orange
	   apple: red
	   grape: green

DESCRIPTION

       A generic node in YAML is similar to a plain hash, array, or scalar node in Perl except that it must also keep track of its type. The type
       is a URI called the YAML type tag.

       YAML::Node is a class for generating and manipulating these containers.	A YAML node (or ynode) is a tied hash, array or scalar. In most
       ways it behaves just like the plain thing. But you can assign and retrieve and YAML type tag URI to it. For the hash flavor, you can also
       assign the order that the keys will be retrieved in. By default a ynode will offer its keys in the same order that they were assigned.

       YAML::Node has a class method call new() that will return a ynode. You pass it a regular node and an optional type tag. After that you can
       use it like a normal Perl node, but when you YAML::Dump it, the magical properties will be honored.

       This is how you can control the sort order of hash keys during a YAML serialization. By default, YAML sorts keys alphabetically. But notice
       in the above example that the keys were Dumped in the same order they were assigned.

       YAML::Node exports a function called ynode(). This function returns the tied object so that you can call special methods on it like
       ->keys().

       keys() works like this:

	   use YAML;
	   use YAML::Node;

	   %$node = qw(orange orange apple red grape green);
	   $ynode = YAML::Node->new($node);
	   ynode($ynode)->keys(['grape', 'apple']);
	   print Dump $ynode;

       produces:

	   ---
	   grape: green
	   apple: red

       It tells the ynode which keys and what order to use.

       ynodes will play a very important role in how programs use YAML. They are the foundation of how a Perl class can marshall the Loading and
       Dumping of its objects.

       The upcoming versions of YAML.pm will have much more information on this.

AUTHOR

       Ingy dA~Xt Net <ingy@cpan.org>

COPYRIGHT

       Copyright (c) 2006. Ingy dA~Xt Net. All rights reserved.

       Copyright (c) 2002. Brian Ingerson. All rights reserved.

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

       See <http://www.perl.com/perl/misc/Artistic.html>

perl v5.12.1							    2010-01-03							     YAML::Node(3)

Test::YAML::Valid(3pm)					User Contributed Perl Documentation				    Test::YAML::Valid(3pm)

NAME

       Test::YAML::Valid - Test for valid YAML

VERSION

       Version 0.04

SYNOPSIS

       This module lets you easily test the validity of YAML:

	   use Test::More tests => 3;
	   use Test::YAML::Valid;

	   yaml_string_ok(YAML::Dump({foo => 'bar'}), 'YAML generates good YAML?');
	   yaml_string_ok('this is not YAML, is it?', 'This one will fail');
	   yaml_file_ok('/path/to/some/YAML', '/path/to/some/YAML is YAML');
	   yaml_files_ok('/path/to/YAML/files/*', 'all YAML files are valid');

       You can also test with YAML::Syck instead of YAML by passing "-Syck" in the import list:

	   use Test::YAML::Valid qw(-Syck);
	   yaml_string_ok(...); # uses YAML::Syck::Load instead of YAML::Load

       It's up to you to make sure you have YAML::Syck if you specify the "-Syck" option, since it's an optional prerequisite to this module.  If
       it's requested but not found, a warning will be issued and YAML will be used instead.

       As of version 0.04, you can use any module you want in the same way; "-Tiny" for YAML::Tiny and "-XS" for YAML::XS.

EXPORT

       o   yaml_string_ok

       o   yaml_file_ok

       o   yaml_files_ok

FUNCTIONS

   yaml_string_ok($yaml, [$message])
       Test will pass if $yaml contains valid YAML (according to YAML.pm) and fail otherwise.  Returns the result of loading the YAML.

   yaml_file_ok($filename, [$message])
       Test will pass if $filename is a valid YAML file (according to YAML.pm) and fail otherwise.  Returns the result of loading the YAML.

   yaml_files_ok($file_glob_string, [$message])
       Test will pass if all files matching the glob $file_glob_string contain valid YAML.  If a file is not valid, the test will fail and no
       further files will be examined.

       Returns a list of all loaded YAML;

AUTHOR

       Jonathan Rockway, "<jrockway at cpan.org>"

BUGS

       Please report any bugs or feature requests to "bug-test-yaml-valid at rt.cpan.org", or through the web interface at
       <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Test-YAML-Valid>.  I will be notified, and then you'll automatically be notified of
       progress on your bug as I make changes.

SUPPORT

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

	   perldoc Test::YAML::Valid

       You can also look for information at:

       o   AnnoCPAN: Annotated CPAN documentation

	   <http://annocpan.org/dist/Test-YAML-Valid>

       o   CPAN Ratings

	   <http://cpanratings.perl.org/d/Test-YAML-Valid>

       o   RT: CPAN's request tracker

	   <http://rt.cpan.org/NoAuth/Bugs.html?Dist=Test-YAML-Valid>

       o   Search CPAN

	   <http://search.cpan.org/dist/Test-YAML-Valid>

ACKNOWLEDGEMENTS

       Stevan Little "<stevan.little@iinteractive.com>" contributed "yaml_files_ok" and some more tests.

COPYRIGHT &; LICENSE
       Copyright 2007 Jonathan Rockway, all rights reserved.

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

perl v5.10.1							    2010-01-09						    Test::YAML::Valid(3pm)