Fixing up "view_field" to use all the field attributes.
[dbsrgits/SQL-Translator.git] / lib / SQL / Translator / Producer / POD.pm
CommitLineData
2a267f86 1package SQL::Translator::Producer::POD;
2
3# -------------------------------------------------------------------
cb002bb5 4# $Id: POD.pm,v 1.3 2003-08-26 03:59:15 kycl4rk Exp $
2a267f86 5# -------------------------------------------------------------------
6# Copyright (C) 2003 Ken Y. Clark <kclark@cpan.org>
7#
8# This program is free software; you can redistribute it and/or
9# modify it under the terms of the GNU General Public License as
10# published by the Free Software Foundation; version 2.
11#
12# This program is distributed in the hope that it will be useful, but
13# WITHOUT ANY WARRANTY; without even the implied warranty of
14# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15# General Public License for more details.
16#
17# You should have received a copy of the GNU General Public License
18# along with this program; if not, write to the Free Software
19# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
20# 02111-1307 USA
21# -------------------------------------------------------------------
22
23use strict;
24use vars qw[ $VERSION ];
cb002bb5 25$VERSION = sprintf "%d.%02d", q$Revision: 1.3 $ =~ /(\d+)\.(\d+)/;
2a267f86 26
27use SQL::Translator::Schema::Constants;
28use SQL::Translator::Utils qw(header_comment);
29
30# -------------------------------------------------------------------
31sub produce {
32 my $t = shift;
33 my $schema = $t->schema;
34 my $schema_name = $schema->name || 'Schema';
35 my $args = $t->producer_args;
cb002bb5 36 my $title = $args->{'title'} || $schema_name;
2a267f86 37
cb002bb5 38 my $pod = "=pod\n\n=head1 DESCRIPTION\n\n$title\n\n=head1 TABLES\n\n";
2a267f86 39
40 for my $table ( $schema->get_tables ) {
41 my $table_name = $table->name or next;
42 my @fields = $table->get_fields or next;
43 $pod .= "=head2 $table_name\n\n=head3 FIELDS\n\n";
44
45 #
46 # Fields
47 #
b9124e4b 48 for my $field ( @fields ) {
2a267f86 49 $pod .= "=head4 " . $field->name . "\n\n=over 4\n\n";
50
51 my $data_type = $field->data_type;
52 my $size = $field->size;
53 $data_type .= "($size)" if $size;
54
55 $pod .= "=item * $data_type\n\n";
56 $pod .= "=item * PRIMARY KEY\n\n" if $field->is_primary_key;
57
58 my $default = $field->default_value;
59 $pod .= "=item * Default '$default' \n\n" if defined $default;
60
61 $pod .= sprintf( "=item * Nullable '%s' \n\n",
62 $field->is_nullable ? 'Yes' : 'No' );
63
64 $pod .= "=back\n\n";
65 }
66
67 #
68 # Indices
69 #
70 if ( my @indices = $table->get_indices ) {
71 $pod .= "=head3 INDICES\n\n";
72 for my $index ( @indices ) {
73 $pod .= "=head4 " . $index->type . "\n\n=over 4\n\n";
74 $pod .= "=item * Fields = " .
75 join(', ', $index->fields ) . "\n\n";
76 $pod .= "=back\n\n";
77 }
78 }
79
80 #
81 # Constraints
82 #
83 if ( my @constraints = $table->get_constraints ) {
84 $pod .= "=head3 CONSTRAINTS\n\n";
85 for my $c ( @constraints ) {
86 $pod .= "=head4 " . $c->type . "\n\n=over 4\n\n";
87 $pod .= "=item * Fields = " .
88 join(', ', $c->fields ) . "\n\n";
89
90 if ( $c->type eq FOREIGN_KEY ) {
b9124e4b 91 $pod .= "=item * Reference Table = L</" .
92 $c->reference_table . ">\n\n";
2a267f86 93 $pod .= "=item * Reference Fields = " .
b9124e4b 94 join(', ', map {"L</$_>"} $c->reference_fields ) .
95 "\n\n";
2a267f86 96 }
97
98 if ( my $update = $c->on_update ) {
99 $pod .= "=item * On update = $update";
100 }
101
102 if ( my $delete = $c->on_delete ) {
103 $pod .= "=item * On delete = $delete";
104 }
105
106 $pod .= "=back\n\n";
107 }
108 }
109 }
110
b9124e4b 111 my $header = ( map { $_ || () } split( /\n/, header_comment('', '') ) )[0];
112 $header =~ s/^Created by //;
113 $pod .= "=head1 PRODUCED BY\n\n$header\n\n=cut";
114
2a267f86 115 return $pod;
116}
117
1181;
119
120# -------------------------------------------------------------------
121# Expect poison from the standing water.
122# William Blake
123# -------------------------------------------------------------------
124
125=head1 NAME
126
127SQL::Translator::Producer::POD - POD producer for SQL::Translator
128
129=head1 SYNOPSIS
130
131 use SQL::Translator::Producer::POD;
132
133=head1 DESCRIPTION
134
135Creates a POD description of each table, field, index, and constraint.
b9124e4b 136A good starting point for text documentation of a schema. You can
137easily convert the output to HTML or text using "perldoc" or other
138interesting formats using Pod::POM or Template::Toolkit.
2a267f86 139
140=head1 AUTHOR
141
142Ken Y. Clark E<lt>kclark@cpan.orgE<gt>
143
144=head1 SEE ALSO
145
b9124e4b 146perldoc, perlpod, Pod::POM, Template::Toolkit.
2a267f86 147
148=cut