The Turnkey package is based on the ClassDBI package (1.35) and includes functionalit...
Brian O'Connor [Thu, 28 Aug 2003 08:51:09 +0000 (08:51 +0000)]
Turnkey SF project.  It generates a variety of xml, dbi, and visualization classes automatically
based on the schema of the input file.

lib/SQL/Translator/Producer/Turnkey.pm [new file with mode: 0644]

diff --git a/lib/SQL/Translator/Producer/Turnkey.pm b/lib/SQL/Translator/Producer/Turnkey.pm
new file mode 100644 (file)
index 0000000..db3d697
--- /dev/null
@@ -0,0 +1,627 @@
+package SQL::Translator::Producer::Turnkey;
+
+# -------------------------------------------------------------------
+# $Id: Turnkey.pm,v 1.1 2003-08-28 08:51:09 boconnor Exp $
+# -------------------------------------------------------------------
+# Copyright (C) 2003 Allen Day <allenday@ucla.edu>,
+#                    Ying Zhang <zyolive@yahoo.com>
+#
+# 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
+# -------------------------------------------------------------------
+
+use strict;
+use vars qw[ $VERSION $DEBUG ];
+$VERSION = sprintf "%d.%02d", q$Revision: 1.1 $ =~ /(\d+)\.(\d+)/;
+$DEBUG   = 1 unless defined $DEBUG;
+
+use SQL::Translator::Schema::Constants;
+use SQL::Translator::Utils qw(header_comment);
+use Data::Dumper;
+use Template;
+
+my %CDBI_auto_pkgs = (
+    MySQL      => 'mysql',
+    PostgreSQL => 'Pg',
+    Oracle     => 'Oracle',
+);
+
+# -------------------------------------------------------------------
+sub produce {
+    my $t             = shift;
+       my $create        = undef;
+    local $DEBUG      = $t->debug;
+    my $no_comments   = $t->no_comments;
+    my $schema        = $t->schema;
+    my $args          = $t->producer_args;
+    my $db_user       = $args->{'db_user'} || '';
+    my $db_pass       = $args->{'db_pass'} || '';
+    my $main_pkg_name = $args->{'main_pkg_name'} ||
+                           $t->format_package_name('DBI');
+    my $header        = header_comment(__PACKAGE__, "# ");
+    my $parser_type   = ( split /::/, $t->parser_type )[-1];
+    my $from          = $CDBI_auto_pkgs{ $parser_type } || '';
+    my $dsn           = $args->{'dsn'} || sprintf( 'dbi:%s:_',
+                            $CDBI_auto_pkgs{ $parser_type }
+                            ? $CDBI_auto_pkgs{ $parser_type } : $parser_type
+                        );
+    my $sep           = '# ' . '-' x 67;
+
+    #
+    # Identify "link tables" (have only PK and FK fields).
+    #
+    my %linkable;
+    my %linktable;
+    foreach my $table ( $schema->get_tables ) {
+        my $is_link = 1;
+        foreach my $field ( $table->get_fields ) {
+            unless ( $field->is_primary_key or $field->is_foreign_key ) {
+                $is_link = 0; 
+                last;
+            }
+        }
+
+        next unless $is_link;
+      
+        foreach my $left ( $table->get_fields ) {
+            next unless $left->is_foreign_key;
+            my $lfk           = $left->foreign_key_reference or next;
+            my $lr_table      = $schema->get_table( $lfk->reference_table )
+                                 or next;
+            my $lr_field_name = ($lfk->reference_fields)[0];
+            my $lr_field      = $lr_table->get_field($lr_field_name);
+            next unless $lr_field->is_primary_key;
+
+            foreach my $right ( $table->get_fields ) {
+                next if $left->name eq $right->name;
+        
+                my $rfk      = $right->foreign_key_reference or next;
+                my $rr_table = $schema->get_table( $rfk->reference_table )
+                               or next;
+                my $rr_field_name = ($rfk->reference_fields)[0];
+                my $rr_field      = $rr_table->get_field($rr_field_name);
+                next unless $rr_field->is_primary_key;
+        
+                $linkable{ $lr_table->name }{ $rr_table->name } = $table;
+                $linkable{ $rr_table->name }{ $lr_table->name } = $table;
+                $linktable{ $table->name } = $table;
+            }
+        }
+    }
+
+    #
+    # Iterate over all tables
+    #
+    my ( %packages, $order );
+    for my $table ( $schema->get_tables ) {
+        my $table_name = $table->name or next;
+
+        my $table_pkg_name = $t->format_package_name($table_name);
+        $packages{ $table_pkg_name } = {
+            order     => ++$order,
+            pkg_name  => $table_pkg_name,
+            base      => $main_pkg_name,
+            table     => $table_name,
+        };
+
+        #
+        # Primary key may have a differenct accessor method name
+        #
+        if ( my $constraint = $table->primary_key ) {
+            my $field          = ($constraint->fields)[0];
+                       $packages{ $table_pkg_name }{'columns_primary'} = $field;
+
+            if ( my $pk_xform = $t->format_pk_name ) {
+                my $pk_name = $pk_xform->( $table_pkg_name, $field );
+
+                $packages{ $table_pkg_name }{'pk_accessor'} = 
+                    "#\n# Primary key accessor\n#\n".
+                    "sub $pk_name {\n    shift->$field\n}\n\n";
+                               
+            }
+        }
+
+        my $is_data = 0;
+        foreach my $field ( $table->get_fields ) {
+                 if ( !$field->is_foreign_key and !$field->is_primary_key ) {
+                       push @{ $packages{ $table_pkg_name }{'columns_essential'} }, $field->name;
+                       $is_data++;
+                 } elsif ( !$field->is_primary_key ) {
+                       push @{ $packages{ $table_pkg_name }{'columns_others'} }, $field->name;
+                 }
+               }
+
+               my %linked;
+               if ( $is_data ) {
+                 foreach my $link ( keys %{ $linkable{ $table_name } } ) {
+                       my $linkmethodname;
+
+                       if ( my $fk_xform = $t->format_fk_name ) {
+                         # ADD CALLBACK FOR PLURALIZATION MANGLING HERE
+                         $linkmethodname = $fk_xform->($linkable{$table_name}{$link}->name,
+                                                                                       ($schema->get_table($link)->primary_key->fields)[0]).'s';
+                       } else {
+                         # ADD CALLBACK FOR PLURALIZATION MANGLING HERE
+                         $linkmethodname = $linkable{$table_name}{$link}->name.'_'.
+                               ($schema->get_table($link)->primary_key->fields)[0].'s';
+                       }
+
+                       my @rk_fields = ();
+                       my @lk_fields = ();
+                       foreach my $field ($linkable{$table_name}{$link}->get_fields) {
+                         next unless $field->is_foreign_key;
+
+                         next unless(
+                                                 $field->foreign_key_reference->reference_table eq $table_name
+                                                 ||
+                                                 $field->foreign_key_reference->reference_table eq $link
+                                                );
+                         push @lk_fields, ($field->foreign_key_reference->reference_fields)[0]
+                               if $field->foreign_key_reference->reference_table eq $link;
+                         push @rk_fields, $field->name
+                               if $field->foreign_key_reference->reference_table eq $table_name;
+                       }
+
+                       #if one possible traversal via link table
+                       if (scalar(@rk_fields) == 1 and scalar(@lk_fields) == 1) {
+                         foreach my $rk_field (@rk_fields) {
+                               #push @{ $packages{ $table_pkg_name }{'has_many'}{ $link } },
+                               push @{ $packages{ $table_pkg_name }{'has_many'}{$link}{'link_one_one'} },
+                                 "sub ".$linkmethodname." { my \$self = shift; ".
+                                       "return map \$_->".
+                                         ($schema->get_table($link)->primary_key->fields)[0].
+                                               ", \$self->".$linkable{$table_name}{$link}->name.
+                                                 "_".$rk_field." }\n\n";
+                               #push @{ $packages{ $table_pkg_name }{'has_many'}{ $link }{'one_one'} },
+                               #  {link_method_name => $linkmethodname, primary_key_field => ($schema->get_table($link)->primary_key->fields)[0],
+                               #   table_name => $linkable{$table_name}{$link}->name, rk_field => $rk_field};
+                         }
+                         #else there is more than one way to traverse it.  ack!
+                         #let's treat these types of link tables as a many-to-one (easier)
+                         #
+                         #NOTE: we need to rethink the link method name, as the cardinality
+                         #has shifted on us.
+                       } elsif (scalar(@rk_fields) == 1) {
+                         foreach my $rk_field (@rk_fields) {
+                               # ADD CALLBACK FOR PLURALIZATION MANGLING HERE
+                               #push @{ $packages{ $table_pkg_name }{'has_many'}{ $link } },
+                               push @{ $packages{ $table_pkg_name }{'has_many'}{ $link }{'link_many_one'} },
+                                 "sub " . $linkable{$table_name}{$link}->name .
+                                       "s { my \$self = shift; return \$self->" .
+                                         $linkable{$table_name}{$link}->name . "_" .
+                                               $rk_field . "(\@_) }\n\n";
+                               #push @{ $packages{ $table_pkg_name }{'has_many'}{ $link }{'many_one'} },
+                               #  {
+                               #    table_name => $linkable{$table_name}{$link}->name, rk_field => $rk_field
+                               #  };
+                         }
+                       } elsif (scalar(@lk_fields) == 1) {
+                         #these will be taken care of on the other end...
+                       } else {
+                         #many many many.  need multiple iterations here, data structure revision
+                         #to handle N FK sources.  This code has not been tested and likely doesn't
+                         #work here
+                         foreach my $rk_field (@rk_fields) {
+                               # ADD CALLBACK FOR PLURALIZATION MANGLING HERE
+                               #push @{ $packages{ $table_pkg_name }{'has_many'}{ $link } },
+                               push @{ $packages{ $table_pkg_name }{'has_many'}{ $link }{'link_many_many'} },
+                                 "sub " . $linkable{$table_name}{$link}->name . "_" . $rk_field .
+                                       "s { my \$self = shift; return \$self->" .
+                                         $linkable{$table_name}{$link}->name . "_" .
+                                               $rk_field . "(\@_) }\n\n";
+                               #push @{ $packages{ $table_pkg_name }{'has_many'}{ $link }{'many_many'} },
+                               #  {
+                               #   table_name => $linkable{$table_name}{$link}->name, rk_field => $rk_field
+                               #  };
+                         }
+                       }
+                 }
+        }
+
+
+        #
+        # Use foreign keys to set up "has_a/has_many" relationships.
+        #
+        foreach my $field ( $table->get_fields ) {
+            if ( $field->is_foreign_key ) {
+                my $table_name = $table->name;
+                my $field_name = $field->name;
+                my $fk_method  = $t->format_fk_name($table_name, $field_name);
+                my $fk         = $field->foreign_key_reference;
+                my $ref_table  = $fk->reference_table;
+                my $ref_pkg    = $t->format_package_name($ref_table);
+                my $ref_field  = ($fk->reference_fields)[0];
+
+                push @{ $packages{ $table_pkg_name }{'has_a'} },
+                    "$table_pkg_name->has_a(\n".
+                    "    $field_name => '$ref_pkg'\n);\n\n".
+                    "sub $fk_method {\n".
+                    "    return shift->$field_name\n}\n\n"
+                ;
+                               
+                               
+                #
+                # If this table "has a" to the other, then it follows 
+                # that the other table "has many" of this one, right?
+                #
+                               # No... there is the possibility of 1-1 cardinality
+
+                               #if there weren't M-M relationships via the has_many
+                               #being set up here, create nice pluralized method alias
+                               #rather for user as alt. to ugly tablename_fieldname name
+                               if(! $packages{ $ref_pkg }{ 'has_many' }{ $table_name } ){
+                                 # ADD CALLBACK FOR PLURALIZATION MANGLING HERE
+                                 #push @{ $packages{ $ref_pkg }{'has_many'}{ $table_name } },
+                               #       "sub $table_name\s {\n    return shift->$table_name\_$field_name\n}\n\n";
+                                 push @{ $packages{ $ref_pkg }{'has_many'}{ $table_name }{'fk_pluralized'} },
+                                       { table_name => $table_name, field_name => $field_name };
+
+                               #else ugly
+                               } else {
+                               }
+
+                               #push @{ $packages{ $ref_pkg }{'has_many'}{ $table_name } },
+                               #  "$ref_pkg->has_many(\n    '${table_name}_${field_name}', ".
+                               #  "'$table_pkg_name' => '$field_name'\n);\n\n";
+                               push @{ $packages{ $ref_pkg }{'has_many'}{ $table_name }{pluralized} },
+                                 { ref_pkg => $ref_pkg, table_pkg_name => $table_pkg_name, table_name => $table_name, field_name => $field_name };
+            }
+               }
+       }
+
+       my %metadata;
+       $metadata{"packages"} = \%packages;
+       $metadata{"linkable"} = \%linkable;
+       return(translateForm($t, \%metadata));
+}
+
+###########################################
+# Here documents for the tt2 templates    #
+###########################################
+
+my $turnkey_atom_tt2 = <<'EOF';
+[% ###### DOCUMENT START ###### %]
+
+[% FOREACH package = linkable %]
+
+##############################################
+
+package Durian::Atom::[% package.key FILTER ucfirst %];
+
+[% pname = package.key FILTER ucfirst%]
+[% pkey = "Durian::Model::${pname}" %]
+
+use base qw(Durian::Atom);
+use Data::Dumper;
+
+sub can_render {
+       return 1;
+}
+
+sub render {
+       my $self = shift;
+       my $dbobject = shift;
+    # Assumption here that if it's not rendering on it's own dbobject
+    # then it's a list. This will be updated when AtomLists are implemented -boconnor
+       if(ref($dbobject) eq 'Durian::Model::[% package.key FILTER ucfirst %]') {
+               return(_render_record($dbobject));
+       }
+       else { return(_render_list($dbobject)); }
+}
+
+sub _render_record {
+       my $dbobject = shift;
+       my @output = ();
+       my $row = {};
+       my $field_hash = {};
+       [% FOREACH field = packages.$pkey.columns_essential %]
+       $field_hash->{[% field %]} = $dbobject->[% field %]();
+    [% END %]
+       $row->{data} = $field_hash;
+       $row->{id} = $dbobject->id();
+       push @output, $row;
+       return(\@output);
+}
+
+sub _render_list {
+       my $dbobject = shift;
+       my @output = ();
+       my @objects = $dbobject->[% package.key %]s;
+       foreach my $object (@objects)
+    {
+               my $row = {};
+           my $field_hash = {};
+         [% FOREACH field = packages.$pkey.columns_essential %]
+               $field_hash->{[% field %]} = $object->[% field %]();
+         [% END %]
+               $row->{data} = $field_hash;
+           $row->{id} = $object->id();
+           push @output, $row;
+    }
+       return(\@output);
+}
+
+sub head {
+       return 1;
+}
+
+1;
+
+[% END %]
+EOF
+
+my $turnkey_dbi_tt2 = <<EOF;
+[% #######  MACRO START ###### %]
+
+[% MACRO printPackage(package) BLOCK %]
+# --------------------------------------------
+package [% package.pkg_name %];
+use base '[% package.base %]';
+use Class::DBI::Pager;
+
+[% package.pkg_name %]->set_up_table('[% package.table %]');
+[% package.pkg_name %]->columns(Primary => qw/[% printList(package.columns_primary) %]/);
+[% package.pkg_name %]->columns(Essential => qw/[% printList(package.columns_essential) %]/);
+
+[% printPKAccessors(package.columns_primary, package.table) %]
+[% printHasMany(package.has_many, package.table) %]
+[% printHasA(package.has_a, package.pkg_name) %]
+
+[% END %]
+
+[% MACRO printPKAccessors(array, name) BLOCK %]
+#
+# Primary key accessor
+#
+[% FOREACH item = array %]
+sub [% name %] {
+  shift->[% item %];
+}
+[% END %]
+[% END %]
+
+[% MACRO printHasMany(hash, name) BLOCK %]
+#
+# Has Many
+#
+[% FOREACH group = hash %][% FOREACH item = group.value %][% FOREACH arr = item.value %]
+# Key: [% group.key %]
+# Relationship: [% item.key %]
+  [% IF item.key == 'fk_pluralized' %]
+sub [% arr.table_name -%]s {
+      return shift->[% arr.table_name %]_[% arr.field_name %]
+       };
+  [% ELSIF item.key == 'pluralized' %]
+[% arr.ref_pkg %]->has_many('[% arr.table_name %]_[% arr.field_name %]', '[% arr.table_pkg_name %]' => '[% arr.field_name %]');
+  [% ELSIF item.key == 'link_one_one' %]
+    [% FOREACH line = item.value %]
+[% line %]
+    [% END %]
+  [% ELSIF item.key == 'link_many_one' %]
+    [% FOREACH line = item.value %]
+[% line %]
+    [% END %]
+  [% ELSIF item.key == 'link_many_many' %]
+    [% FOREACH line = item.value %]
+[% line %]
+    [% END %]
+  [% END %]
+
+[% END %][% END %][% END %][% END %]
+
+[% MACRO printHasA(hash, pkg_name) BLOCK %]
+#
+# Has A
+#
+[% #name %]
+[% FOREACH item = hash %][% item %]
+[% END %][% END %]
+
+[% MACRO printList(array) BLOCK %][% FOREACH item = array %][% item %] [% END %][% END %]
+
+
+[% ###### DOCUMENT START ###### %]
+
+package Durian::Model::DBI;
+
+# Created by SQL::Translator::Producer::ClassDBI
+# Template used AutoDBI.tt2
+
+use strict;
+use base qw(Class::DBI::Pg);
+
+Durian::Model::DBI->set_db('Main', '[% db_str  %]', '[% db_user %]', '[% db_pass %]');
+
+[% FOREACH package = packages %]
+    [% printPackage(package.value) %]
+[% END %]
+EOF
+
+my $turnkey_xml_tt2 = <<EOF;
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE Durian SYSTEM "Durian.dtd">
+<Durian>
+
+<!-- The basic layout is fixed -->
+  <container bgcolor="#FFFFFF" cellpadding="0" cellspacing="0" height="90%" orientation="vertical" type="root" width="100%" xlink:label="RootContainer">
+       <container cellpadding="3" cellspacing="0" orientation="horizontal" type="container" height="100%" width="100%" xlink:label="MiddleContainer">
+         <container align="center" cellpadding="2" cellspacing="0" class="leftbar" orientation="vertical" type="minor" width="0%" xlink:label="MidLeftContainer"/>
+         <container cellpadding="0" cellspacing="0" orientation="vertical" width="100%" type="major" xlink:label="MainContainer"/>
+       </container>
+  </container>
+
+<!-- Atom Classes -->
+[% FOREACH package = linkable %]
+  <atom class="Durian::Atom::[% package.key FILTER ucfirst %]"  name="[% package.key FILTER ucfirst %]" xlink:label="[% package.key FILTER ucfirst %]Atom"/>
+[% END %]
+
+<!-- Atom Bindings -->
+<atomatombindings>
+[% FOREACH focus_atom = linkable %]
+  [% FOREACH link_atom = focus_atom.value %]
+  <atomatombinding xlink:from="#[% focus_atom.key FILTER ucfirst %]Atom" xlink:to="#[% link_atom.key FILTER ucfirst %]Atom" xlink:label="[% focus_atom.key FILTER ucfirst %]Atom2[% link_atom.key FILTER ucfirst %]Atom"/>
+  [% END %]
+[% END %]
+</atomatombindings>
+
+<atomcontainerbindings>
+       [% FOREACH focus_atom = linkable %]
+       <atomcontainerbindingslayout xlink:label="Durian::Model::[% focus_atom.key FILTER ucfirst %]">
+         [% FOREACH link_atom = focus_atom.value %]
+         <atomcontainerbinding xlink:from="#MidLeftContainer" xlink:label="MidLeftContainer2[% link_atom.key FILTER ucfirst %]Atom"  xlink:to="#[% link_atom.key FILTER ucfirst %]Atom"/>
+         [% END %]
+         <atomcontainerbinding xlink:from="#MainContainer"    xlink:label="MainContainer2[% focus_atom.key FILTER ucfirst %]Atom"    xlink:to="#[% focus_atom.key FILTER ucfirst %]Atom"/>
+    </atomcontainerbindingslayout>
+       [% END %]
+   </atomcontainerbindings>
+
+  <uribindings>
+    <uribinding uri="/" class="Durian::Util::Frontpage"/>
+  </uribindings>
+
+  <classbindings>
+       [% FOREACH focus_atom = linkable %]
+     <classbinding class="Durian::Model::[% focus_atom.key FILTER ucfirst %]" plugin="#[% focus_atom.key FILTER ucfirst %]Atom" rank="0"/>
+       [% END %]
+  </classbindings>
+
+</Durian>
+EOF
+
+my $turnkey_template_tt2 = <<'EOF';
+[% TAGS [- -] %]
+[% MACRO renderpanel(panel,dbobject) BLOCK %]
+  <!-- begin panel: [% panel.label %] -->
+  <table border="0" width="[% panel.width %]" height="[% panel.height %]" bgcolor="[% panel.bgcolor %]" valign="top" cellpadding="[% panel.cellpadding %]" cellspacing="[% panel.cellspacing %]" align="[% panel.align %]" valign="[% panel.valign %]">
+    <tr>
+    [% FOREACH p = panel.containers %]
+      [% IF p.can_render(panel) %]
+        <td valign="top" class="[% p.class %]" align="[% panel.align %]" height="[% p.height || 1 %]" width="[% p.width %]">
+          [% IF p.type == 'Container' %]
+            [% renderpanel(p,dbobject) %]
+          [% ELSE %]
+            <table cellpadding="0" cellspacing="0" align="left" height="100%" width="100%">
+              [% IF p.name %]
+                <tr bgcolor="#4444FF" height="1">
+                  <td><font color="#FFFFFF">[% p.name %][% IF panel.type == 'major' %]: [% dbobject.name %][% END %]</font></td>
+                  <td align="right" width="0"><!--<nobr><img src="/images/v.gif"/><img src="/images/^.gif"/>[% IF p.delible == 'yes' %]<img src="/images/x.gif"/>[% END %]</nobr>--></td>
+                </tr>
+              [% END %]
+              <tr><td colspan="2" bgcolor="#FFFFFF">
+              <!-- begin atom: [% p.label %] -->
+              <table cellpadding="0" cellspacing="0" align="left" height="100%" width="100%"><!-- [% ref(atom) %] [% ref(dbobject) %] -->
+                [% renderatom(p,dbobject) %] <!-- used to be renderplugin(p,panel) -->
+              </table>
+            </table>
+          [% END %]
+        </td>
+        [% IF panel.orientation == 'vertical' %]
+          </tr><tr>
+        [% END %]
+      [% END %]
+    [% END %]
+    </tr>
+  </table>
+  <!-- end panel: [% panel.label %] -->
+[% END %]
+[% MACRO renderatom(atom, dbobject) SWITCH atom.name %]
+  [- FOREACH package = linkable -]
+    [% CASE '[- package.key FILTER ucfirst -]' %]
+      [% render[- package.key FILTER ucfirst -]Atom(atom.render(dbobject)) %]
+  [- END -]
+    [% CASE DEFAULT %]
+      [% renderlist(atom.render(dbobject)) %]
+[% END %]
+[- FOREACH package = linkable -]
+[% MACRO render[- package.key FILTER ucfirst -]Atom(lstArr) BLOCK %]
+  [% FOREACH record = lstArr %]
+    [% fields = record.data %]
+    [- pname = package.key FILTER ucfirst -]
+    [- pkey = "Durian::Model::${pname}" -]
+    [- FOREACH field = packages.$pkey.columns_essential -]
+      <tr><td><b>[- field -]</b></td><td>[% fields.[- field -] %]</td></tr>
+    [- END -]
+    [% id = record.id %]
+    <tr><td><a href="?id=[% id %];class=Durian::Model::[- package.key FILTER ucfirst -]">Link</a></td><td></td></tr>
+  [% END %]
+[% END %]
+[- END -]
+[% MACRO renderlist(lstArr) BLOCK %]
+  [%  FOREACH item = lstArr %]
+    <tr>[% item %]</tr>
+  [% END %]
+[% END %]
+EOF
+
+sub translateForm
+{
+  my $t = shift;
+  my $output = shift;
+  my $args = $t->producer_args;
+  my $tt2     = $args->{'template'};
+  my $tt2Ref;
+  if ($tt2 eq 'atom') { $tt2Ref = \$turnkey_atom_tt2; }
+  if ($tt2 eq 'dbi') { $tt2Ref = \$turnkey_dbi_tt2; }
+  if ($tt2 eq 'xml') { $tt2Ref = \$turnkey_xml_tt2; }
+  if ($tt2 eq 'template') { $tt2Ref = \$turnkey_template_tt2; }
+
+  my $vars = {
+                               packages  => $output->{packages},
+                           linkable  => $output->{linkable},
+                           linktable => $output->{linktable},
+                           db_str    => $args->{db_str},
+                           db_user   => $args->{db_user},
+                           db_pass   => $args->{db_pass},
+  };
+  my $config = {
+      EVAL_PERL    => 1,               # evaluate Perl code blocks
+  };
+
+  # create Template object
+  my $template = Template->new($config);
+
+  my $result;
+  # specify input filename, or file handle, text reference, etc.
+  # process input template, substituting variables
+  $template->process($tt2Ref, $vars, \$result) || die $template->error();
+  return($result);
+}
+
+1;
+
+# -------------------------------------------------------------------
+
+=pod
+
+=head1 NAME
+
+SQL::Translator::Producer::ClassDBI - create Class::DBI classes from schema
+
+=head1 SYNOPSIS
+
+Use this producer as you would any other from SQL::Translator.  See
+L<SQL::Translator> for details.
+
+This package utilizes SQL::Translator's formatting methods
+format_package_name(), format_pk_name(), format_fk_name(), and
+format_table_name() as it creates classes, one per table in the schema
+provided.  An additional base class is also created for database connectivity
+configuration.  See L<Class::DBI> for details on how this works.
+
+=head1 AUTHORS
+
+Allen Day E<lt>allenday@ucla.eduE<gt>
+Ying Zhang E<lt>zyolive@yahoo.comE<gt>,
+Ken Y. Clark E<lt>kclark@cpan.orgE<gt>,
+Brian O'Connor E<lt>brian.oconnor@excite.comE<gt>.