X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FSQL%2FTranslator%2FProducer%2FClassDBI.pm;h=4d26ee47b0a51e56f6bac7441d5b335f3a68b629;hb=c0ec0e22d3f0e3852c00daac5ef5763010b410c3;hp=49c01a254b124ac87188b267dcd377f4c00bc217;hpb=9c6eb8e378d8dbb1c56606c90dfd7cbb9a38bff6;p=dbsrgits%2FSQL-Translator.git

diff --git a/lib/SQL/Translator/Producer/ClassDBI.pm b/lib/SQL/Translator/Producer/ClassDBI.pm
old mode 100755
new mode 100644
index 49c01a2..4d26ee4
--- a/lib/SQL/Translator/Producer/ClassDBI.pm
+++ b/lib/SQL/Translator/Producer/ClassDBI.pm
@@ -1,33 +1,13 @@
 package SQL::Translator::Producer::ClassDBI;
 
-# -------------------------------------------------------------------
-# $Id: ClassDBI.pm,v 1.37 2003-10-15 19:46:15 allenday 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.37 $ =~ /(\d+)\.(\d+)/;
+use warnings;
+our $DEBUG;
+our $VERSION = '1.59';
 $DEBUG = 1 unless defined $DEBUG;
 
 use SQL::Translator::Schema::Constants;
-use SQL::Translator::Utils qw(header_comment);
+use SQL::Translator::Utils qw(debug header_comment);
 use Data::Dumper;
 
 my %CDBI_auto_pkgs = (
@@ -36,35 +16,46 @@ my %CDBI_auto_pkgs = (
     Oracle     => 'Oracle',
 );
 
-# -------------------------------------------------------------------
 sub produce {
-    my $t      = shift;
-    my $create = undef;
-    local $DEBUG = $t->debug;
+    my $t             = shift;
+    local $DEBUG      = $t->debug;
     my $no_comments   = $t->no_comments;
     my $schema        = $t->schema;
     my $args          = $t->producer_args;
+    my @create;
+
+    if ( my $fmt = $args->{'format_pkg_name'} ) {
+        $t->format_package_name( $fmt );
+    }
+
+    if ( my $fmt = $args->{'format_fk_name'} ) {
+        $t->format_fk_name( $fmt );
+    }
+
     my $db_user       = $args->{'db_user'} || '';
-    my $db_pass       = $args->{'db_pass'} || '';
-    my $main_pkg_name = $args->{'main_pkg_name'} ||
+    my $db_pass       = $args->{'db_password'} || '';
+    my $main_pkg_name = $args->{'package_name'} ||
+                        # $args->{'main_pkg_name'} || # keep this? undocumented
                         $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 $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 ) {
+    for my $table ( $schema->get_tables ) {
+        debug("PKG: Table = ", $table->name, "\n");
         my $is_link = 1;
-        foreach my $field ( $table->get_fields ) {
+        for my $field ( $table->get_fields ) {
             unless ( $field->is_primary_key or $field->is_foreign_key ) {
                 $is_link = 0;
                 last;
@@ -106,8 +97,8 @@ sub produce {
     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} = {
+        my $table_pkg_name = join '::', $main_pkg_name, $t->format_package_name($table_name);
+        $packages{ $table_pkg_name } = {
             order    => ++$order,
             pkg_name => $table_pkg_name,
             base     => $main_pkg_name,
@@ -115,20 +106,20 @@ sub produce {
         };
 
         #
-        # Primary key may have a differenct accessor method name
+        # Primary key may have a different 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";
-            }
-        }
+#        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 ) {
@@ -171,11 +162,11 @@ sub produce {
                 {
                     next unless $field->is_foreign_key;
 
-                    next unless ( 
+                    next unless (
                         $field->foreign_key_reference->reference_table eq
                            $table_name
-                        || 
-                        $field->foreign_key_reference->reference_table eq $link 
+                        ||
+                        $field->foreign_key_reference->reference_table eq $link
                     );
 
                     push @lk_fields,
@@ -263,39 +254,40 @@ sub produce {
             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_method  = $t->format_fk_name( $table_name, $field_name );
+                my $fk_method  = join('::', $table_pkg_name,
+                    $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];
+#                my $fk_method  = join('::',
+#                    $table_pkg_name, $t->format_fk_name( $ref_table )
+#                );
 
                 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";
+                  . "    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";
-                    # else ugly
-                }
-                else {
-                }
+#                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";
+#                    # else ugly
+#                }
+#                else {
+#                }
 
                 push @{ $packages{$ref_pkg}{'has_many'}{$table_name} },
                   "$ref_pkg->has_many(\n    '${table_name}_${field_name}', "
@@ -309,7 +301,7 @@ sub produce {
     # Now build up text of package.
     #
     my $base_pkg = sprintf( 'Class::DBI%s', $from ? "::$from" : '' );
-    $create .= join ( "\n",
+    push @create, join ( "\n",
         "package $main_pkg_name;\n",
         $header,
         "use strict;",
@@ -321,9 +313,10 @@ sub produce {
         sort { $packages{ $a }{'order'} <=> $packages{ $b }{'order'} }
         keys %packages
     ) {
-        my $pkg = $packages{$pkg_name};
+        my $pkg = $packages{$pkg_name} or next;
+        next unless $pkg->{'pkg_name'};
 
-        $create .= join ( "\n",
+        push @create, join ( "\n",
             $sep,
             "package " . $pkg->{'pkg_name'} . ";",
             "use base '" . $pkg->{'base'} . "';",
@@ -331,86 +324,50 @@ sub produce {
         );
 
                 if ( $from ) {
-                    $create .= 
-                        $pkg->{'pkg_name'}."->set_up_table('".$pkg->{'table'}."');\n\n";
+                    push @create, join('',
+                        $pkg->{'pkg_name'},
+                        "->set_up_table('",
+                        $pkg->{'table'},
+                        "');\n\n"
+                    );
                 }
                 else {
                     my $table       = $schema->get_table( $pkg->{'table'} );
                     my @field_names = map { $_->name } $table->get_fields;
-        
-                    $create .= join("\n",
+
+                    push @create, join("\n",
                         $pkg_name."->table('".$pkg->{'table'}."');\n",
                         $pkg_name."->columns(All => qw/".
                         join(' ', @field_names)."/);\n\n",
                     );
                 }
 
-        #
-        # The approach here is to do lazy loading on the expensive
-        # columns (expensive defined as those columns which require
-        # construction of a referenced object) fields which are
-        # strictly data (ie, not references) are treated as essential
-        # b/c they don't require much time to set up.
-        #
-#        $create .= $pkg_name . "->table('" . $pkg->{'table'} . "');\n";
-
-        #
-        # Set up primary key field.
-        #
-#        if ( $pkg->{'_columns_primary'} ) {
-#            $create .= $pkg_name
-#              . "->columns(Primary   => qw/"
-#              . $pkg->{'_columns_primary'} . "/);\n";
-#        }
-#        else {
-#            die "Class::DBI isn't going to like that you don't " .
-#              "have a primary key field for table " . $pkg->{'table'};
-#        }
-
-        #
-        # Set up non-FK fields to be populated at construction.
-        #
-#        if ( $pkg->{'_columns_essential'} ) {
-#            $create .= $pkg_name
-#              . "->columns(Essential => qw/"
-#              . join ( ' ', @{ $pkg->{'_columns_essential'} } ) . "/);\n";
-#        }
-
-        #
-        # Set up FK fields for lazy loading on request.
-        #
-#        if ( $pkg->{'_columns_others'} ) {
-#            $create .= $pkg_name
-#              . "->columns(Others    => qw/"
-#              . join ( ' ', @{ $pkg->{'_columns_others'} } ) . "/);\n";
-#        }
-
-        $create .= "\n";
+        push @create, "\n";
 
         if ( my $pk = $pkg->{'pk_accessor'} ) {
-            $create .= $pk;
+            push @create, $pk;
         }
 
         if ( my @has_a = @{ $pkg->{'has_a'} || [] } ) {
-            $create .= $_ for @has_a;
+            push @create, $_ for @has_a;
         }
 
         foreach my $has_many_key ( keys %{ $pkg->{'has_many'} } ) {
             if ( my @has_many = @{ $pkg->{'has_many'}{$has_many_key} || [] } ) {
-                $create .= $_ for @has_many;
+                push @create, $_ for @has_many;
             }
         }
     }
 
-    $create .= "1;\n";
+    push @create, "1;\n";
 
-    return $create;
+    return wantarray
+        ? @create
+        : join('', @create);
 }
 
 1;
 
-# -------------------------------------------------------------------
-
 =pod
 
 =head1 NAME
@@ -422,7 +379,7 @@ SQL::Translator::Producer::ClassDBI - create Class::DBI classes from schema
 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
+This package uses 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
@@ -432,4 +389,4 @@ configuration.  See L<Class::DBI> for details on how this works.
 
 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>.
+Ken Youens-Clark E<lt>kclark@cpan.orgE<gt>.