Added refactored comment producing using header_comment.

[dbsrgits/SQL-Translator.git] / lib / SQL / Translator / Producer / XML.pm

diff --git a/lib/SQL/Translator/Producer/XML.pm b/lib/SQL/Translator/Producer/XML.pm
index e71b281..d17fdd9 100644 (file)
--- a/lib/SQL/Translator/Producer/XML.pm
+++ b/lib/SQL/Translator/Producer/XML.pm
@@ -1,7 +1,7 @@
 package SQL::Translator::Producer::XML;
 
 # -------------------------------------------------------------------
-# $Id: XML.pm,v 1.5 2003-01-27 17:04:48 dlc Exp $
+# $Id: XML.pm,v 1.6 2003-04-25 11:47:25 dlc Exp $
 # -------------------------------------------------------------------
 # Copyright (C) 2003 Ken Y. Clark <kclark@cpan.org>,
 #                    darren chamberlain <darren@cpan.org>,
@@ -22,30 +22,21 @@ package SQL::Translator::Producer::XML;
 # 02111-1307  USA
 # -------------------------------------------------------------------
 
-=head1 NAME
-
-SQL::Translator::Producer::XML - XML output
-
-=head1 SYNOPSIS
-
-  use SQL::Translator::Producer::XML;
-
-=head1 DESCRIPTION
-
-Meant to create some sort of usable XML output.
-
-=cut
-
 use strict;
 use vars qw[ $VERSION $XML ];
-$VERSION = sprintf "%d.%02d", q$Revision: 1.5 $ =~ /(\d+)\.(\d+)/;
+$VERSION = sprintf "%d.%02d", q$Revision: 1.6 $ =~ /(\d+)\.(\d+)/;
+
+use SQL::Translator::Utils qw(header_comment);
 
 # -------------------------------------------------------------------
 sub produce {
     my ( $translator, $data ) = @_;
+    my $prargs = $translator->producer_args;
     my $indent = 0;
-    aggregate( '<schema>', $indent );
-    
+    aggregate('<?xml version="1.0"?>', $indent);
+    aggregate('<schema>', $indent);
+    aggregate('<!-- ' . header_comment('', '') . '-->');
+
     $indent++;
     for my $table ( 
         map  { $_->[1] }
@@ -75,11 +66,12 @@ sub produce {
             for my $key ( keys %$field ) {
                 my $val = defined $field->{ $key } ? $field->{ $key } : '';
                    $val = ref $val eq 'ARRAY' ? join(',', @$val) : $val;
-                aggregate( "<$key>$val</$key>", $indent );
+                aggregate("<$key>$val</$key>", $indent)
+                    if ($val || (!$val && $prargs->{'emit_empty_tags'}));
             }
 
             $indent--;
-            aggregate( "</field>", $indent-- );
+            aggregate("</field>", $indent--);
         }
         aggregate( "</fields>", $indent );
 
@@ -119,6 +111,7 @@ sub aggregate {
 }
 
 1;
+__END__
 
 # -------------------------------------------------------------------
 # The eyes of fire, the nostrils of air,
@@ -126,6 +119,74 @@ sub aggregate {
 # William Blake
 # -------------------------------------------------------------------
 
+=head1 NAME
+
+SQL::Translator::Producer::XML - XML output
+
+=head1 SYNOPSIS
+
+  use SQL::Translator::Producer::XML;
+
+=head1 DESCRIPTION
+
+Meant to create some sort of usable XML output.
+
+=head1 ARGS
+
+Takes the following optional C<producer_args>:
+
+=over 4
+
+=item emit_empty_tags
+
+If this is set to a true value, then tags corresponding to value-less
+elements will be emitted.  For example, take this schema:
+
+  CREATE TABLE random (
+    id int auto_increment PRIMARY KEY,
+    foo varchar(255) not null default '',
+    updated timestamp
+  );
+
+With C<emit_empty_tags> = 1, this will be dumped with XML similar to:
+
+  <table>
+    <name>random</name>
+    <order>1</order>
+    <fields>
+      <field>
+        <is_auto_inc>1</is_auto_inc>
+        <list></list>
+        <is_primary_key>1</is_primary_key>
+        <data_type>int</data_type>
+        <name>id</name>
+        <constraints></constraints>
+        <null>1</null>
+        <order>1</order>
+        <size></size>
+        <type>field</type>
+      </field>
+
+With C<emit_empty_tags> = 0, you'd get:
+
+  <table>
+    <name>random</name>
+    <order>1</order>
+    <fields>
+      <field>
+        <is_auto_inc>1</is_auto_inc>
+        <is_primary_key>1</is_primary_key>
+        <data_type>int</data_type>
+        <name>id</name>
+        <null>1</null>
+        <order>1</order>
+        <type>field</type>
+      </field>
+
+This can lead to dramatic size savings.
+
+=back
+
 =pod
 
 =head1 AUTHOR