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

package SQL::Translator::Producer::TT::Table;

# -------------------------------------------------------------------
# $Id: Table.pm 1440 2009-01-17 16:31:57Z jawnsy $
# -------------------------------------------------------------------
# Copyright (C) 2002-2009 SQLFairy Authors
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License as
# published by the Free Software Foundation; version 2.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
# 02111-1307  USA
# -------------------------------------------------------------------

=pod

=head1 NAME

SQL::Translator::Producer::TT::Table -
    Produces output using the Template Toolkit from a SQL schema, per table.

=head1 SYNOPSIS

  # Normal STDOUT version
  #
  my $translator     = SQL::Translator->new(
      from           => 'MySQL',
      filename       => 'foo_schema.sql',
      to             => 'TT::Table',
      producer_args  => {
          tt_table     => 'foo_table.tt',
      },
  );
  print $translator->translate;

  # To generate a file per table
  #
  my $translator     = SQL::Translator->new(
      from           => 'MySQL',
      filename       => 'foo_schema.sql',
      to             => 'TT::Table',
      producer_args  => {
          tt_table       => 'foo_table.tt.html',
          mk_files      => 1,
          mk_files_base => "./doc/tables",
          mk_file_ext   => ".html",
          on_exists     => "replace",
      },
  );
  #
  # ./doc/tables/ now contains the templated tables as $tablename.html
  #

=head1 DESCRIPTION

Produces schema output using a given Template Tookit template,
processing that template for each table in the schema. Optionally
allows you to write the result for each table to a separate file.

It needs one additional producer_arg of C<tt_table> which is the file
name of the template to use.  This template will be passed a template
var of C<table>, which is the current
L<SQL::Translator::Producer::Table> table we are producing, which you
can then use to walk the schema via the methods documented in that
module. You also get L<schema> as a shortcut to the
L<SQL::Translator::Producer::Schema> for the table and C<translator>,
the L<SQL::Translator> object for this parse in case you want to get
access to any of the options etc set here.

Here's a brief example of what the template could look like:

  [% table.name %]
  ================
  [% FOREACH field = table.get_fields %]
      [% field.name %]   [% field.data_type %]([% field.size %])
  [% END -%]

See F<t/data/template/table.tt> for a more complete example.

You can also set any of the options used to initiallize the Template
object by adding them to your producer_args. See Template Toolkit docs
for details of the options.

  $translator          = SQL::Translator->new(
      to               => 'TT',
      producer_args    => {
          ttfile       => 'foo_template.tt',
          INCLUDE_PATH => '/foo/templates/tt',
          INTERPOLATE  => 1,
      },
  );

If you set C<mk_files> and its additional options the producer will
write a separate file for each table in the schema. This is useful for
producing things like HTML documentation where every table gets its
own page (you could also use TTSchema producer to add an index page).
Its also particulary good for code generation where you want to
produce a class file per table.

=head1 OPTIONS

=over 4

=item tt_table

File name of the template to run for each table.

=item mk_files

Set to true to output a file for each table in the schema (as well as
returning the whole lot back to the Translalor and hence STDOUT). The
file will be named after the table, with the optional C<mk_files_ext>
added and placed in the directory C<mk_files_base>.

=item mk_files_ext

Extension (without the dot) to add to the filename when using mk_files.

=item mk_files_base = DIR

Dir to build the table files into when using mk_files. Defaults to the
current directory.

=item mk_file_dir

Set true and if the file needs to written to a directory that doesn't
exist, it will be created first.

=item on_exists [Default:replace]

What to do if we are running with mk_files and a file already exists
where we want to write our output. One of "skip", "die", "replace",
"insert".  The default is die.

B<replace> - Over-write the existing file with the new one, clobbering
anything already there.

B<skip> - Leave the origional file as it was and don't write the new
version anywhere.

B<die> - Die with an existing file error.

B<insert> - Insert the generated output into the file bewteen a set of
special comments (defined by the following options.) Any code between
the comments will be overwritten (ie the results from a previous
produce) but the rest of the file is left alone (your custom code).
This is particularly useful for code generation as it allows you to
generate schema derived code and then add your own custom code
to the file.  Then when the schema changes you just re-produce to
insert the new code.

=item insert_comment_start

The comment to look for in the file when on_exists is C<insert>. Default
is C<SQLF INSERT START>. Must appear on it own line, with only
whitespace either side, to be recognised.

=item insert_comment_end

The end comment to look for in the file when on_exists is C<insert>.
Default is C<SQLF INSERT END>. Must appear on it own line, with only
whitespace either side, to be recognised.

=back

=cut

# -------------------------------------------------------------------

use strict;

use vars qw[ $DEBUG @EXPORT_OK ];
$DEBUG   = 0 unless defined $DEBUG;

use File::Path;
use Template;
use Data::Dumper;
use Exporter;
use base qw(Exporter);
@EXPORT_OK = qw(produce);

use SQL::Translator::Utils 'debug';

my $Translator;

sub produce {
    $Translator = shift;
    local $DEBUG   = $Translator->debug;
    my $scma       = $Translator->schema;
    my $pargs      = $Translator->producer_args;
    my $file       = $pargs->{'tt_table'} or die "No template file given!";
    $pargs->{on_exists} ||= "die";

    debug "Processing template $file\n";
    my $out;
    my $tt       = Template->new(
        DEBUG    => $DEBUG,
        ABSOLUTE => 1, # Set so we can use from the command line sensibly
        RELATIVE => 1, # Maybe the cmd line code should set it! Security!
        %$pargs,        # Allow any TT opts to be passed in the producer_args
    ) || die "Failed to initialize Template object: ".Template->error;

	for my $tbl ( sort {$a->order <=> $b->order} $scma->get_tables ) {
		my $outtmp;
        $tt->process( $file, {
            translator => $Translator,
            schema     => $scma,
            table      => $tbl,
        }, \$outtmp ) 
		or die "Error processing template '$file' for table '".$tbl->name
	          ."': ".$tt->error;
        $out .= $outtmp;

        # Write out the file...
		write_file(  table_file($tbl), $outtmp ) if $pargs->{mk_files};
    }

    return $out;
};

# Work out the filename for a given table.
sub table_file {
    my ($tbl) = shift;
    my $pargs = $Translator->producer_args;
    my $root  = $pargs->{mk_files_base};
    my $ext   = $pargs->{mk_file_ext};
    return "$root/$tbl.$ext";
}

# Write the src given to the file given, handling the on_exists arg.
sub write_file {
	my ($file, $src) = @_;
    my $pargs = $Translator->producer_args;
    my $root = $pargs->{mk_files_base};

    if ( -e $file ) {
        if ( $pargs->{on_exists} eq "skip" ) {
            warn "Skipping existing $file\n";
            return 1;
        }
        elsif ( $pargs->{on_exists} eq "die" ) {
            die "File $file already exists.\n";
        }
        elsif ( $pargs->{on_exists} eq "replace" ) {
            warn "Replacing $file.\n";
        }
        elsif ( $pargs->{on_exists} eq "insert" ) {
            warn "Inserting into $file.\n";
            $src = insert_code($file, $src);
        }
        else {
            die "Unknown on_exists action: $pargs->{on_exists}\n";
        }
    }
    else {
        warn "Creating $file.\n";
    }

    my ($dir) = $file =~ m!^(.*)/!; # Want greedy, eveything before the last /
	if ( $dir and not -d $dir and $pargs->{mk_file_dir} ) { mkpath($dir); }

    debug "Writing to $file\n";
	open( FILE, ">$file") or die "Error opening file $file : $!\n";
	print FILE $src;
	close(FILE);
}

# Reads file and inserts code between the insert comments and returns the new
# source.
sub insert_code {
    my ($file, $src) = @_;
    my $pargs = $Translator->producer_args;
    my $cstart = $pargs->{insert_comment_start} || "SQLF_INSERT_START";
    my $cend   = $pargs->{insert_comment_end}   || "SQLF_INSERT_END";

    # Slurp in the origional file
    open ( FILE, "<", "$file") or die "Error opening file $file : $!\n";
    local $/ = undef;
    my $orig = <FILE>;
    close(FILE);

    # Insert the new code between the insert comments
    unless (
        $orig =~ s/^\s*?$cstart\s*?\n.*?^\s*?$cend\s*?\n/\n$cstart\n$src\n$cend\n/ms
    ) {
        warn "No insert done\n";
    }

    return $orig;
}

1;

# -------------------------------------------------------------------

=pod

=head1 AUTHOR

Mark Addison E<lt>grommit@users.sourceforge.netE<gt>.

=head1 TODO

- Some tests for the various on exists options (they have been tested
implicitley through use in a project but need some proper tests).

- More docs on code generation strategies.

- Better hooks for filename generation.

- Integrate with L<TT::Base> and L<TTSchema>.

=head1 SEE ALSO

SQL::Translator.

=cut
Commit	Line	Data
0be5b227	1	package SQL::Translator::Producer::TT::Table;
	2
	3	# -------------------------------------------------------------------
d4f84dd1	4	# $Id: Table.pm 1440 2009-01-17 16:31:57Z jawnsy $
0be5b227	5	# -------------------------------------------------------------------
478f608d	6	# Copyright (C) 2002-2009 SQLFairy Authors
0be5b227	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
	23	=pod
	24
	25	=head1 NAME
	26
	27	SQL::Translator::Producer::TT::Table -
	28	Produces output using the Template Toolkit from a SQL schema, per table.
	29
	30	=head1 SYNOPSIS
	31
	32	# Normal STDOUT version
	33	#
	34	my $translator = SQL::Translator->new(
	35	from => 'MySQL',
	36	filename => 'foo_schema.sql',
	37	to => 'TT::Table',
	38	producer_args => {
	39	tt_table => 'foo_table.tt',
	40	},
	41	);
	42	print $translator->translate;
	43
	44	# To generate a file per table
	45	#
	46	my $translator = SQL::Translator->new(
	47	from => 'MySQL',
	48	filename => 'foo_schema.sql',
	49	to => 'TT::Table',
	50	producer_args => {
	51	tt_table => 'foo_table.tt.html',
	52	mk_files => 1,
	53	mk_files_base => "./doc/tables",
	54	mk_file_ext => ".html",
	55	on_exists => "replace",
	56	},
	57	);
	58	#
	59	# ./doc/tables/ now contains the templated tables as $tablename.html
	60	#
	61
	62	=head1 DESCRIPTION
	63
f65806ce	64	Produces schema output using a given Template Tookit template,
	65	processing that template for each table in the schema. Optionally
	66	allows you to write the result for each table to a separate file.
0be5b227	67
0be5b227	68	It needs one additional producer_arg of C<tt_table> which is the file
f65806ce	69	name of the template to use. This template will be passed a template
f65806ce	70	var of C<table>, which is the current
1672901e	71	L<SQL::Translator::Producer::Table> table we are producing, which you
f65806ce	72	can then use to walk the schema via the methods documented in that
1672901e	73	module. You also get L<schema> as a shortcut to the
	74	L<SQL::Translator::Producer::Schema> for the table and C<translator>,
	75	the L<SQL::Translator> object for this parse in case you want to get
f65806ce	76	access to any of the options etc set here.
0be5b227	77
	78	Here's a brief example of what the template could look like:
	79
	80	[% table.name %]
	81	================
	82	[% FOREACH field = table.get_fields %]
	83	[% field.name %] [% field.data_type %]([% field.size %])
	84	[% END -%]
	85
	86	See F<t/data/template/table.tt> for a more complete example.
	87
f65806ce	88	You can also set any of the options used to initiallize the Template
	89	object by adding them to your producer_args. See Template Toolkit docs
	90	for details of the options.
0be5b227	91
	92	$translator = SQL::Translator->new(
	93	to => 'TT',
	94	producer_args => {
	95	ttfile => 'foo_template.tt',
	96	INCLUDE_PATH => '/foo/templates/tt',
	97	INTERPOLATE => 1,
	98	},
	99	);
	100
f65806ce	101	If you set C<mk_files> and its additional options the producer will
	102	write a separate file for each table in the schema. This is useful for
	103	producing things like HTML documentation where every table gets its
	104	own page (you could also use TTSchema producer to add an index page).
	105	Its also particulary good for code generation where you want to
	106	produce a class file per table.
0be5b227	107
	108	=head1 OPTIONS
	109
	110	=over 4
	111
	112	=item tt_table
	113
	114	File name of the template to run for each table.
	115
	116	=item mk_files
	117
f65806ce	118	Set to true to output a file for each table in the schema (as well as
	119	returning the whole lot back to the Translalor and hence STDOUT). The
	120	file will be named after the table, with the optional C<mk_files_ext>
	121	added and placed in the directory C<mk_files_base>.
0be5b227	122
	123	=item mk_files_ext
	124
	125	Extension (without the dot) to add to the filename when using mk_files.
	126
	127	=item mk_files_base = DIR
	128
f65806ce	129	Dir to build the table files into when using mk_files. Defaults to the
f65806ce	130	current directory.
0be5b227	131
	132	=item mk_file_dir
	133
f65806ce	134	Set true and if the file needs to written to a directory that doesn't
f65806ce	135	exist, it will be created first.
0be5b227	136
	137	=item on_exists [Default:replace]
	138
f65806ce	139	What to do if we are running with mk_files and a file already exists
	140	where we want to write our output. One of "skip", "die", "replace",
	141	"insert". The default is die.
0be5b227	142
f65806ce	143	B<replace> - Over-write the existing file with the new one, clobbering
f65806ce	144	anything already there.
0be5b227	145
f65806ce	146	B<skip> - Leave the origional file as it was and don't write the new
f65806ce	147	version anywhere.
0be5b227	148
	149	B<die> - Die with an existing file error.
	150
f65806ce	151	B<insert> - Insert the generated output into the file bewteen a set of
	152	special comments (defined by the following options.) Any code between
	153	the comments will be overwritten (ie the results from a previous
	154	produce) but the rest of the file is left alone (your custom code).
	155	This is particularly useful for code generation as it allows you to
1672901e	156	generate schema derived code and then add your own custom code
1672901e	157	to the file. Then when the schema changes you just re-produce to
f65806ce	158	insert the new code.
0be5b227	159
	160	=item insert_comment_start
	161
1672901e	162	The comment to look for in the file when on_exists is C<insert>. Default
f65806ce	163	is C<SQLF INSERT START>. Must appear on it own line, with only
f65806ce	164	whitespace either side, to be recognised.
0be5b227	165
	166	=item insert_comment_end
	167
1672901e	168	The end comment to look for in the file when on_exists is C<insert>.
f65806ce	169	Default is C<SQLF INSERT END>. Must appear on it own line, with only
f65806ce	170	whitespace either side, to be recognised.
0be5b227	171
	172	=back
	173
	174	=cut
	175
	176	# -------------------------------------------------------------------
	177
	178	use strict;
	179
478f608d	180	use vars qw[ $DEBUG @EXPORT_OK ];
0be5b227	181	$DEBUG = 0 unless defined $DEBUG;
	182
	183	use File::Path;
	184	use Template;
	185	use Data::Dumper;
	186	use Exporter;
	187	use base qw(Exporter);
	188	@EXPORT_OK = qw(produce);
	189
	190	use SQL::Translator::Utils 'debug';
	191
	192	my $Translator;
	193
	194	sub produce {
	195	$Translator = shift;
	196	local $DEBUG = $Translator->debug;
	197	my $scma = $Translator->schema;
	198	my $pargs = $Translator->producer_args;
	199	my $file = $pargs->{'tt_table'} or die "No template file given!";
	200	$pargs->{on_exists} \|\|= "die";
	201
	202	debug "Processing template $file\n";
	203	my $out;
	204	my $tt = Template->new(
	205	DEBUG => $DEBUG,
	206	ABSOLUTE => 1, # Set so we can use from the command line sensibly
	207	RELATIVE => 1, # Maybe the cmd line code should set it! Security!
	208	%$pargs, # Allow any TT opts to be passed in the producer_args
	209	) \|\| die "Failed to initialize Template object: ".Template->error;
	210
	211	for my $tbl ( sort {$a->order <=> $b->order} $scma->get_tables ) {
	212	my $outtmp;
	213	$tt->process( $file, {
	214	translator => $Translator,
	215	schema => $scma,
	216	table => $tbl,
	217	}, \$outtmp )
	218	or die "Error processing template '$file' for table '".$tbl->name
	219	."': ".$tt->error;
	220	$out .= $outtmp;
	221
	222	# Write out the file...
	223	write_file( table_file($tbl), $outtmp ) if $pargs->{mk_files};
	224	}
	225
	226	return $out;
	227	};
	228
	229	# Work out the filename for a given table.
	230	sub table_file {
	231	my ($tbl) = shift;
	232	my $pargs = $Translator->producer_args;
	233	my $root = $pargs->{mk_files_base};
	234	my $ext = $pargs->{mk_file_ext};
	235	return "$root/$tbl.$ext";
	236	}
	237
	238	# Write the src given to the file given, handling the on_exists arg.
	239	sub write_file {
	240	my ($file, $src) = @_;
	241	my $pargs = $Translator->producer_args;
	242	my $root = $pargs->{mk_files_base};
	243
	244	if ( -e $file ) {
245	if ( $pargs->{on_exists} eq "skip" ) {
246	warn "Skipping existing $file\n";
247	return 1;
248	}
249	elsif ( $pargs->{on_exists} eq "die" ) {
250	die "File $file already exists.\n";
251	}
252	elsif ( $pargs->{on_exists} eq "replace" ) {
253	warn "Replacing $file.\n";
254	}
255	elsif ( $pargs->{on_exists} eq "insert" ) {
256	warn "Inserting into $file.\n";
257	$src = insert_code($file, $src);
258	}
259	else {
260	die "Unknown on_exists action: $pargs->{on_exists}\n";
261	}
262	}
263	else {
264	warn "Creating $file.\n";
265	}
266
267	my ($dir) = $file =~ m!^(.*)/!; # Want greedy, eveything before the last /
268	if ( $dir and not -d $dir and $pargs->{mk_file_dir} ) { mkpath($dir); }
269
270	debug "Writing to $file\n";
271	open( FILE, ">$file") or die "Error opening file $file : $!\n";
272	print FILE $src;
273	close(FILE);
274	}
275
276	# Reads file and inserts code between the insert comments and returns the new
277	# source.
278	sub insert_code {
279	my ($file, $src) = @_;
280	my $pargs = $Translator->producer_args;
281	my $cstart = $pargs->{insert_comment_start} \|\| "SQLF_INSERT_START";
282	my $cend = $pargs->{insert_comment_end} \|\| "SQLF_INSERT_END";
283
284	# Slurp in the origional file
285	open ( FILE, "<", "$file") or die "Error opening file $file : $!\n";
286	local $/ = undef;
287	my $orig = <FILE>;
288	close(FILE);
289
290	# Insert the new code between the insert comments
291	unless (
292	$orig =~ s/^\s?$cstart\s?\n.?^\s?$cend\s*?\n/\n$cstart\n$src\n$cend\n/ms
293	) {
294	warn "No insert done\n";
295	}
296
297	return $orig;
298	}
299
300	1;
301
302	# -------------------------------------------------------------------
303
304	=pod
305
306	=head1 AUTHOR
307
308	Mark Addison E<lt>grommit@users.sourceforge.netE<gt>.
309
310	=head1 TODO
311
1672901e	312	- Some tests for the various on exists options (they have been tested
0be5b227	313	implicitley through use in a project but need some proper tests).
0be5b227	314
1672901e	315	- More docs on code generation strategies.
0be5b227	316
1672901e	317	- Better hooks for filename generation.
0be5b227	318
1672901e	319	- Integrate with L<TT::Base> and L<TTSchema>.
0be5b227	320
	321	=head1 SEE ALSO
	322
	323	SQL::Translator.
	324
	325	=cut