Changed test to match what's returned for the size of a "text" field.

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

package SQL::Translator::Producer::TTSchema;

=pod 

=head1 NAME

SQL::Translator::Producer::TTSchema - Produces output using the template toolkit
from a SQL schema.

=cut


use strict;
use warnings;

use vars qw[ $DEBUG $VERSION @EXPORT_OK ];
#$VERSION = sprintf "%d.%02d", q$Revision: 1.1 $ =~ /(\d+)\.(\d+)/;
$VERSION = 0.1;
$DEBUG   = 0 unless defined $DEBUG;

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

use base qw/SQL::Translator::Producer/;  # Doesn't do anything at the mo!
use Template;

sub debug {
    warn @_,"\n" if $DEBUG;
}

sub produce {
    my $translator = shift;
    local $DEBUG = $translator->debug;
    my $scma = $translator->schema;
    my $args = $translator->producer_args;
    my $file = delete $args->{ttfile} or die "No template file!";
   
    debug "Processing template $file\n";
    my $out;
    my $tt = Template->new(
        DEBUG => $DEBUG,
        ABSOLUTE => 1, # Set so we can use from the command line sensible.
        RELATIVE => 1, #   Maybe the cmd line code should set it! Security!
        %$args,        # Allow any TT opts to be passed in the producer_args
        
    ) || die "Failed to initialize Template object: ".Template->error;
    $tt->process($file,{ schema => $scma },\$out) 
    or die "Error processing template '$file': ".$tt->error;

    return $out;
};

1;

__END__

=pod

=head1 SYNOPSIS

  use SQL::Translator;
  $translator = SQL::Translator->new(
      from      => "MySQL",
      filename  => "foo_schema.sql",
      to        => "TT",
      producer_args  => {
          ttfile => "foo_template.tt",
      },
  );
  print $translator->translate;

=head1 DESCRIPTION

Produces schema output using a given Template Tookit template.

It needs one additional producer_arg of C<ttfile> that is the file name of the
template to use. This template has one var added to it called C<schema>, which 
is the SQL::Translator::Producer::Schema object so you can then template via 
its methods.

    database: [% schema.database %]
    tables:
    [% FOREACH table = schema.get_tables %]
        [% table.name %]
        ================
        [% FOREACH field = table.get_fields %]
            [% field.name %]   [% field.datatype %]([% field.size %])
        [% END -%]
    [% END %]

See F<t/data/template/basic.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,
      },
  );

=head1 TODO

B<More template vars?> e.g. [% tables %] as a shortcut for
[% schema.get_tables %].

=cut