TextRender: support yaml multi doc rendering

Author: stdweird

src/main/perl/TextRender.pm

@@ -125,7 +125,7 @@ The rendering module to use: either one of the following reserved values
 
 =item json
 
-JSON format (using C<JSON::XS>) (JSON true and false have to be resp. C<\1> and c<\0>)
+JSON format (using C<JSON::XS>) (JSON true and false have to be resp. C<\1> and C<\0>)
 
 =item yaml
 
@@ -135,6 +135,14 @@ C<$YAML_BOOL_PREFIX."false"> (There are known problems with creating hashrefs us
 C<< $YAML_BOOL->{yes} >> value for true; Perl seems to mess up the structure when creating
 the hashrefs))
 
+=item yamlmulti
+
+Multi-document YAML, the keys of the passed contents are sorted and
+the list of the corresponding values is used to generate the multi-document YAML.
+(The keys are only used for sorting)
+
+See C<yaml> module for details on handling booleans.
+
 =item properties
 
 Java properties format (using C<Config::Properties>),
@@ -465,12 +473,21 @@ sub _yaml_replace_boolean_prefix
 
 sub render_yaml
 {
-    my ($self, $cfg) = @_;
+    my ($self) = @_;
 
     my $txt = YAML::XS::Dump($self->{contents});
     return $self->_yaml_replace_boolean_prefix($txt);
 }
 
+sub render_yamlmulti
+{
+    my ($self) = @_;
+
+    my @keys = sort keys %{$self->{contents}};
+    my $txt = YAML::XS::Dump(@{$self->{contents}}{@keys});
+    return $self->_yaml_replace_boolean_prefix($txt);
+}
+
 # Warning: the rendered text has a header with localtime(),
 # so the contents will always appear changed.
 sub render_properties

src/test/perl/textrender.t

@@ -524,6 +524,73 @@ $txt =~ s/\s//g;
 is("$txt", '---no:falseyes:true',
    "yaml module renders booleans true/false correctly when using prefixing");
 
+=pod
+
+=head3 yamlmulti
+
+Test yaml/YAML::XS multi-documents
+
+=cut
+
+my $multicontents = {
+    'doc0' => {
+        'name_level0_doc0' => 'value_level0_doc0',
+            'level1_doc0' => {
+                'name_level1_doc0' => 'value_level1_doc0',
+        }
+    },
+    'doc1' => {
+        'name_level0_doc1' => 'value_level0_doc1',
+        'level1_doc1' => {
+            'name_level1_doc1' => 'value_level1_doc1',
+        }
+    }
+};
+
+
+my $multires = <<EOF;
+---
+level1_doc0:
+  name_level1_doc0: value_level1_doc0
+name_level0_doc0: value_level0_doc0
+---
+level1_doc1:
+  name_level1_doc1: value_level1_doc1
+name_level0_doc1: value_level0_doc1
+EOF
+$trd = CAF::TextRender->new('yamlmulti', $multicontents);
+ok($trd->load_module('YAML::XS'), "YAML::XS loaded");
+ok(! $trd->{method_is_tt}, "method_is_tt false for yamlmulti");
+is("$trd", $multires, "yamlmulti module rendered correctly");
+
+# true/false tests
+$trd = CAF::TextRender->new('yamlmulti', {'a' => $YAML_BOOL}, eol=>0);
+$txt = "$trd";
+$txt =~ s/\s//g;
+is($txt, '---no:falseyes:true',
+   "yamlmulti module renders booleans true/false correctly");
+
+# but this goes wrong
+$trd = CAF::TextRender->new('yamlmulti', {
+    'a' => {'yes' => $YAML_BOOL->{'yes'}},
+    'b' => {'no' => $YAML_BOOL->{'no'}},
+}, eol=>0);
+
+$txt = "$trd";
+$txt =~ s/\s//g;
+is("$txt", "---yes:1---no:''",
+   "yamlmulti module renders booleans true/false incorrect when constructing hashref");
+
+# so use the CAF::TextRender prefixing
+$trd = CAF::TextRender->new('yamlmulti', {
+    'a' => {'yes' => $YAML_BOOL_PREFIX."true"},
+    'b' => {'no' => $YAML_BOOL_PREFIX."false"},
+}, eol=>0);
+$txt = "$trd";
+$txt =~ s/\s//g;
+is("$txt", '---yes:true---no:false',
+   "yamlmulti module renders booleans true/false correctly when using prefixing");
+
 
 =pod